@@ -71,30 +71,41 @@ matching. The existing nwsapi factory API and selector support are unchanged.
7171
7272Run the development tools with Node.js ≥ 22. This does not change the library's
7373runtime support.
74- Use npm ≥ 11.19 .0 within v11 or ≥ 12.0.2, or pnpm ≥ 11.25.0 within v11
75- or ≥ 12.3.4. New dependency resolutions use a one-day release-age delay. Dependency
74+ Use pnpm ≥ 11.25 .0 within v11 or ≥ 12.3.4. New dependency resolutions use a
75+ one-day release-age delay. Dependency
7676scripts need explicit approval. These requirements apply to contributors, not
7777library consumers.
7878CI runs lint, formatting checks, Node tests, the build and WPT in one Node.js 26 job.
7979
80- The coverage badge starts as `n/a`; `pnpm run test:coverage` measures and updates it.
80+ ` pnpm run test:coverage` measures the engine with WPT in Chromium and the adapter
81+ with Node tests, then updates the badge. It needs the WPT checkout and Chromium
82+ (see setup below). Known WPT failures remain visible in the test report.
8183
8284` ` ` sh
8385pnpm install
8486pnpm test
8587pnpm run lint
8688pnpm run format:check
89+ pnpm run type
8790pnpm run build
8891` ` `
8992
90- Alternatively, use `npm ci` and `npm run <script>`. Keep both lockfiles
91- updated when changing dependencies.
93+ Dependency versions are pinned in the `pnpm-workspace.yaml` catalog. Keep
94+ ` pnpm-lock.yaml` updated when changing dependencies. npm remains supported for
95+ installing the published package, but cannot install this repository's catalogs.
9296
9397Vitest runs the Node tests. Use `pnpm run test:watch` while editing or
9498` pnpm run test:coverage` for coverage. Oxlint checks code, Oxfmt formats tooling
9599and tests, and Rolldown transforms the `.mts` sources and minifies the browser build.
96100Runtime source is not reformatted.
97101
102+ ` pnpm run type` runs incremental TypeScript checks without emitting files.
103+ Oxlint also checks types. Coverage enforces the aggregate minimums in
104+ ` .config/coverage.config.mts` ; HTML reports are generated only in CI.
105+
106+ Run `pnpm run ci:local` before pushing to test the GitHub Actions workflows locally.
107+ It needs Docker and GitHub CLI authentication, and pauses on failures for fixes.
108+
98109Node tests need no browser or WPT checkout. See [upstream testing](docs/upstream.md)
99110for Chromium setup and known failures. `pnpm run clean` removes generated JavaScript.
100111
0 commit comments