@graphty/layout 1.0.1 → 1.1.1

package/.github/workflows/ci.yml

@@ -0,0 +1,105 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Run TypeScript compiler
+        run: npm run build
+        
+      - name: Run tests
+        run: npm run test:run
+        
+      - name: Run tests with coverage
+        run: npm run test:coverage
+        if: matrix.node-version == '20.x'
+        
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        if: matrix.node-version == '20.x'
+        with:
+          file: ./coverage/lcov.info
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Check TypeScript types
+        run: npx tsc --noEmit
+        
+      - name: Run commitlint on PR title
+        if: github.event_name == 'pull_request'
+        run: echo "${{ github.event.pull_request.title }}" | npx commitlint
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [test, lint]
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+        
+      - name: Build package
+        run: npm run build
+        
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.releaserc.json

@@ -0,0 +1,22 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json", "package-lock.json", "CHANGELOG.md"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+## [1.1.1](https://github.com/graphty-org/layout/compare/v1.1.0...v1.1.1) (2025-07-12)
+
+
+### Bug Fixes
+
+* correct main entry point to dist/layout.js ([4e9f95b](https://github.com/graphty-org/layout/commit/4e9f95bfae3d2974808fa4a306b677e95d9706b9))
+
+# 1.0.0 (2025-07-12)
+
+
+### Bug Fixes
+
+* flakey test ([8de0d14](https://github.com/graphty-org/layout/commit/8de0d147f7267b5715c4529db64014578ee06c97))
+* improve performance test reliability for CI ([0a41ee2](https://github.com/graphty-org/layout/commit/0a41ee238bdbaa1f4d68d864998b24bd4c59ff3d))
+* increase test timeout for CI environments ([36b20a8](https://github.com/graphty-org/layout/commit/36b20a8ea0811cdac7d97975ab0490f2cf29b6ae))
+* make ForceAtlas2 balanced layout test more tolerant ([78fb975](https://github.com/graphty-org/layout/commit/78fb975053dd25d26e351626170fe73d2b68b677))
+* remove conflicting .releaserc file ([1fffa82](https://github.com/graphty-org/layout/commit/1fffa821219774efab8203fc2ea7943493ad1825))
+* resolve CI pipeline and test coverage issues ([9c60656](https://github.com/graphty-org/layout/commit/9c606562074bafc234499f4f2637a55730195af3))
+* update tests to import from TypeScript source instead of dist ([d000b23](https://github.com/graphty-org/layout/commit/d000b23c301fe84807958e54f29ba4ca682818fd))
+
+
+### Features
+
+* add layout helpers ([d43562c](https://github.com/graphty-org/layout/commit/d43562c02a68720f96905ad4c969e12c0a0e5db4))

package/CLAUDE.md

@@ -0,0 +1,104 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+@graphty/layout is a TypeScript graph layout library that ports NetworkX Python algorithms to JavaScript. All layout algorithms are implemented in a single file: `layout.ts`.
+
+## Key Commands
+
+### Development
+```bash
+# Build TypeScript to JavaScript
+npm run build
+
+# Watch mode for development
+npm run watch
+# or
+npm run dev
+
+# Currently no test framework is configured
+# npm test exits with error code 1
+```
+
+### Git Commits
+This project uses conventional commits with commitizen:
+```bash
+# Use commitizen for formatted commits
+npm run commit
+```
+
+Commit types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
+
+## Architecture
+
+The entire library is contained in `layout.ts` with the following structure:
+
+1. **Type System** (lines 1-50):
+   - `Node`: string | number
+   - `Edge`: [Node, Node] 
+   - `Graph`: Interface with adjacency(), nodes(), edges() methods
+   - `PositionMap`: Map<Node, Position> for storing layouts
+
+2. **NumPy-like Utilities** (lines 50-500):
+   - Array manipulation functions under `np` object
+   - Used for mathematical operations in layout algorithms
+
+3. **Layout Algorithms** (lines 500-2591):
+   - Force-directed: springLayout, forceatlas2Layout, arfLayout, kamadaKawaiLayout
+   - Geometric: randomLayout, circularLayout, shellLayout, spiralLayout
+   - Specialized: spectralLayout, bipartiteLayout, multipartiteLayout, bfsLayout, planarLayout
+   - Utilities: rescaleLayout, rescaleLayoutDict
+
+Each algorithm returns a `PositionMap` with node positions.
+
+## Module System
+
+This is an ES module project (`"type": "module"` in package.json). When importing:
+```typescript
+import { springLayout, circularLayout } from '@graphty/layout';
+```
+
+## Common Tasks
+
+### Adding a New Layout Algorithm
+1. Add the function to `layout.ts` following the existing pattern
+2. Export it at the bottom of the file
+3. Update README.md with documentation and example
+4. Add an example HTML file in `examples/`
+
+### Modifying Build Output
+Edit `tsconfig.json`. Current settings:
+- Target: ES2020
+- Module: ES2020
+- Output: `dist/` directory
+- Generates declaration files and source maps
+
+## Testing
+
+### Running Tests
+```bash
+npm test           # Run tests in watch mode
+npm run test:run   # Run tests once
+npm run test:coverage  # Run with coverage report
+```
+
+### Testing Preferences
+- Use `assert` instead of `expect` for test assertions
+- Tests are organized by layout algorithm in `test/` directory
+- Each test file covers: basic functionality, parameter variations, edge cases, and algorithm-specific behaviors
+- Graph generation utilities are available for creating test graphs
+
+## Important Notes
+
+- All algorithms should match NetworkX Python library behavior where possible
+- Graph interface is minimal - algorithms work with any object providing nodes() and edges() methods
+- Examples in `examples/` directory demonstrate usage patterns
+- Tests serve as additional documentation for expected behavior
+
+## Claude Preferences
+
+- NEVER automatically stage files with git add or create commits
+- NEVER create commits unless explicitly requested by the user
+- User prefers to handle git operations manually

package/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Graphty Layout Algorithms