mirror of
https://github.com/vercel-labs/scriptc.git
synced 2026-10-21 05:50:55 +08:00
Chris Tate
9deedfd074
- RELEASING.md documents the lockstep three-package prepare flow and the marked-changelog convention - CHANGELOG.md starts with an Unreleased section and the marked 0.0.1 entry that becomes the GitHub release body - AGENTS.md states repo-wide build/test conventions and defers docs-site specifics to docs/AGENTS.md - scripts/sync-versions.mjs stamps runtime and compiler from the CLI version; the workflow's sync check now hints at it - release.yml gains a github-release job that tags v<version> after a successful publish, never gating npm
1.5 KiB
1.5 KiB
Agent Guide
Guidance for agents (and humans) working on this repository. These conventions apply repo-wide; the docs site under docs/ additionally has its own conventions in docs/AGENTS.md.
Build and test
pnpm install && pnpm -r build # build the workspace
SCRIPTC_TEST_WORKERS=4 pnpm test # plain lane: differential corpus + diagnostics snapshots
SCRIPTC_SAN=1 pnpm test # sanitized lane: the same corpus under ASan + refcount audit
Both lanes green is the bar before shipping any change. SCRIPTC_TEST_WORKERS caps the vitest worker pool so concurrent agents don't contend for cores; full-suite runs also queue behind an advisory lock per lane.
Corpus programs are differential tests against Node: every program runs under Node and as a compiled native binary, and stdout, stderr, and exit codes must match byte-for-byte. A new feature lands with corpus programs that pin its behavior both ways.
Where things live
packages/compiler— the frontend (tsc API to IR), the typed IR with validator and serializer, and the LLVM and C backends.packages/runtime— the C runtime compiled into every scriptc binary.packages/cli—scriptc build | run | coverage.tests/— the differential corpus, diagnostics snapshots, and the harness.docs/— the documentation site (standalone pnpm workspace); seedocs/AGENTS.md.scripts/— repo tooling, including the release version stamp.
Releases
Releases are maintainer-run; see RELEASING.md.