Skip to content
Merged
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
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ jobs:
- run: npm ci
- run: npm run lint
- run: npm run typecheck
- run: npm run build
- name: Package contents
run: npm pack --dry-run

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ jobs:
exit 1
fi
- run: npm run check
- run: npm run build
- name: Publish
run: |
# npm publish builds dist/ first (the prepare script).
# An empty NPM_TOKEN must not override trusted publishing (OIDC).
if [ -z "${NODE_AUTH_TOKEN:-}" ]; then unset NODE_AUTH_TOKEN; fi
version="$(node -p 'require("./package.json").version')"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ jobs:
exit 1
fi
- run: npm run check
- run: npm run build
- name: Publish
run: |
# npm publish builds dist/ first (the prepare script).
# An empty NPM_TOKEN must not override trusted publishing (OIDC).
if [ -z "${NODE_AUTH_TOKEN:-}" ]; then unset NODE_AUTH_TOKEN; fi
version="$(node -p 'require("./package.json").version')"
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,15 +218,17 @@ The 0.x API still works: `createConnection()`, the `connect`, `rect`, `resize`,
## Development

```bash
npm install
npm install # also builds dist/ (the prepare script)
npm run check # lint (Biome), typecheck (tsc), unit tests (node:test)
npm run build # dist/ for publishing
npm run build # rebuild dist/ after changing src/
npm run servers:up # VNC servers in Docker on 127.0.0.1:159xx (see docker/README.md)
npm run test:integration # every encoding, pixel format and security type against them
npm run servers:down
```

The sources run directly on Node (type stripping): `node examples/screenshot.ts host 5900 > screen.png`.
To try an unreleased branch in another project, `npm install github:sidorares/node-rfb2#<branch>`; npm
runs `prepare` there too, so the install has `dist/`.

Integration tests skip servers that aren't running; CI starts them all (`.github/workflows/ci.yml`).
Commits on `master` use [Conventional Commits](https://www.conventionalcommits.org). release-please
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
"servers:up": "docker compose -f docker/compose.yaml up -d --build --wait",
"servers:down": "docker compose -f docker/compose.yaml down",
"check": "npm run lint && npm run typecheck && npm test",
"prepack": "npm run build"
"prepare": "npm run build"
},
"devDependencies": {
"@biomejs/biome": "^2.5.15",
Expand Down
Loading