Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ jobs:

- name: Type check
run: bun run check-types

- name: Test
run: bun run test
20 changes: 19 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,24 @@ bun check # Check for issues
bun check:fix # Auto-fix issues
```

### Tests

Run the whole suite from the repo root:

```bash
bun test # every package, via Turborepo
```

Run one package while you work on it:

```bash
bun test --cwd packages/core
```

Use `bun test` from the **root**, not bare `bun test` inside a package that has
not been built — several packages import their workspace dependencies from
`dist/`, and the root task builds those first.

### Project structure

| Package | What it does |
Expand All @@ -52,7 +70,7 @@ New node kinds and sidebar panels can ship as a plugin instead of editing the bu

1. **Fork the repo** and create a branch from `main`
2. **Make your changes** and test locally with `bun dev`
3. **Run `bun check`** to make sure linting passes
3. **Run `bun check` and `bun test`** to make sure linting and tests pass
4. **Open a PR** with a clear description of what changed and why
5. **Link related issues** if applicable (e.g., "Fixes #42")

Expand Down
1 change: 1 addition & 0 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ The editor works fully without any environment variables.
| `bun check` | Lint and format check (Biome) |
| `bun check:fix` | Auto-fix lint and format issues |
| `bun check-types` | TypeScript type checking |
| `bun test` | Run every package's test suite |

## Contributing

Expand Down
3 changes: 2 additions & 1 deletion apps/editor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"build": "dotenv -e ../../.env.local -- next build",
"start": "next start",
"lint": "biome lint",
"check-types": "next typegen && tsgo --noEmit"
"check-types": "next typegen && tsgo --noEmit",
"test": "bun test lib"
},
"dependencies": {
"@iconify/react": "^6.0.2",
Expand Down
1 change: 1 addition & 0 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"check": "biome check",
"check:fix": "biome check --write",
"check-types": "turbo run check-types",
"test": "turbo run test",
"kill": "lsof -ti:3002 | xargs kill -9 2>/dev/null || echo 'No processes found on port 3002'",
"clean:cache": "rm -rf apps/*/.next apps/*/.swc apps/*/.turbo packages/*/.turbo tooling/*/.turbo .turbo node_modules/.cache",
"restart": "bun kill && bun clean:cache && bun dev",
Expand Down
3 changes: 2 additions & 1 deletion packages/editor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"./catalog": "./src/components/ui/item-catalog/catalog-items.tsx"
},
"scripts": {
"check-types": "tsgo --noEmit"
"check-types": "tsgo --noEmit",
"test": "bun test src"
},
"peerDependencies": {
"@pascal-app/core": "^0.9.2",
Expand Down
1 change: 1 addition & 0 deletions packages/ifc-converter/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"scripts": {
"build": "tsc --build",
"dev": "tsgo --build --watch",
"test": "bun test tests",
"prepublishOnly": "npm run build"
},
"dependencies": {
Expand Down
2 changes: 2 additions & 0 deletions packages/viewer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"scripts": {
"build": "tsc --build",
"dev": "tsgo --build --watch",
"test": "bun test src",
"prepublishOnly": "npm run build"
},
"peerDependencies": {
Expand All @@ -34,6 +35,7 @@
"zustand": "^5"
},
"devDependencies": {
"@pascal-app/core": "^0.9.2",
"@pascal/typescript-config": "*",
"@types/node": "^22",
"@types/react": "^19.2.2",
Expand Down
4 changes: 4 additions & 0 deletions turbo.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"check-types": {
"dependsOn": ["^build", "^check-types"]
},
"test": {
"dependsOn": ["^build"],
"outputs": []
},
"dev": {
"dependsOn": ["^build"],
"cache": false,
Expand Down