Information about the development of @photostructure/sqlite.
This project was built with substantial assistance from Claude Code, an AI coding assistant.
All code was reviewed by a human and validated by automated tests before merging:
# Install dependencies
npm install
# Build native module (recompiles only what changed once build/ exists)
npm run build:native
# Run tests
npm test
# Run benchmarks
npm run benchmark
# Watch mode for TypeScript
npm run watch
# Lint code
npm run lint
# Format code
npm run fmt
# Run specific test file
npm test -- working-with-data.test.ts
See Architecture Documentation for details on:
Releases are cut from CI: the Build & Release workflow
(.github/workflows/build.yml) is triggered manually via workflow_dispatch,
reads the version bump from the ## [Unreleased (patch|minor|major)] heading in
CHANGELOG.md, tests every platform, and pushes a signed release commit and tag.
Stage npm Release (publish.yaml) then rebuilds the prebuilds from that tag
and stages the package on npm with provenance
using OIDC trusted publishing, for a maintainer to approve with 2FA. See
RELEASE.md. The version field in package.json is owned by
build.yml — do not bump it by hand.
Before dispatching a release, run npm run preflight (full build, lint, clang-tidy,
cross-platform tests, and the sanitizer/Valgrind memory suite) and confirm no
workflow is red for the commit being released.
The project maintains synchronization with:
To avoid rate limiting when syncing from GitHub (60 requests/hour for unauthenticated requests), set up authentication:
# Set your GitHub personal access token
export GITHUB_TOKEN=your_personal_access_token
# Now sync commands will use authentication (5000 requests/hour)
npm run sync:node
npm run sync:sqlite
You can create a personal access token at: https://github.com/settings/tokens
The token only needs public repository read access.
# Sync from Node.js
npm run sync:node
# Update SQLite version
npm run sync:sqlite