@avi2dg/checks 0.21.0 → 0.22.0

package/CHANGELOG.md

@@ -2,13 +2,31 @@
 
 Every release of `@avi2dg/checks`, newest first, written by the release from its conventional commits.
 
+## 0.22.0
+
+Released 2026-09-26.
+
+### Breaking changes
+
+- replace quality.json with native configs and workflow gates [#72](https://github.com/avi2d/checks/pull/72)
+- declare test skips inline and add live and pixel test tiers [#71](https://github.com/avi2d/checks/pull/71)
+
+### Features
+
+- create GitHub releases with linked changelogs [#70](https://github.com/avi2d/checks/pull/70)
+
+### Fixes
+
+- **scripts:** run generated commitlint through bun so the runner needs no node [#69](https://github.com/avi2d/checks/pull/69)
+- **test:** allow npm pack enough time on release runners [#68](https://github.com/avi2d/checks/pull/68)
+
 ## 0.21.0
 
 Released 2026-09-26.
 
 ### Features
 
-- **scripts:** let quality.json set the runs-on of generated workflows (#66)
+- **scripts:** let quality.json set the runs-on of generated workflows [#66](https://github.com/avi2d/checks/pull/66)
 
 ## 0.20.0
 
@@ -16,12 +34,12 @@ Released 2026-09-26.
 
 ### Features
 
-- **scripts:** pin node from .node-version in the generated CI workflow (#64)
-- **scripts:** add checks-subsumed-tests to report tests another test subsumes in a (#62)
+- **scripts:** pin node from .node-version in the generated CI workflow [#64](https://github.com/avi2d/checks/pull/64)
+- **scripts:** add checks-subsumed-tests to report tests another test subsumes in a [#62](https://github.com/avi2d/checks/pull/62)
 
 ### Fixes
 
-- **scripts:** lint a PR title that starts with # in the generated commitlint workflow (#63)
+- **scripts:** lint a PR title that starts with # in the generated commitlint workflow [#63](https://github.com/avi2d/checks/pull/63)
 
 ## 0.19.0
 
@@ -29,9 +47,9 @@ Released 2026-09-26.
 
 ### Features
 
-- **scripts:** judge checks-mutation-compare mutant by mutant instead of by score (#58)
-- **scripts:** fail a test left in tests/quarantine past 30 days (#59)
-- **scripts:** pin shared read-only library clones with checks-vendor (#57)
+- **scripts:** judge checks-mutation-compare mutant by mutant instead of by score [#58](https://github.com/avi2d/checks/pull/58)
+- **scripts:** fail a test left in tests/quarantine past 30 days [#59](https://github.com/avi2d/checks/pull/59)
+- **scripts:** pin shared read-only library clones with checks-vendor [#57](https://github.com/avi2d/checks/pull/57)
 
 ## 0.18.0
 
@@ -39,11 +57,11 @@ Released 2026-09-26.
 
 ### Features
 
-- **scripts:** generate commitlint and CI workflows with checks-quality (#54)
+- **scripts:** generate commitlint and CI workflows with checks-quality [#54](https://github.com/avi2d/checks/pull/54)
 
 ### Fixes
 
-- **scripts:** make checks-quality refuse a config that drops the kit's extends (#55)
+- **scripts:** make checks-quality refuse a config that drops the kit's extends [#55](https://github.com/avi2d/checks/pull/55)
 
 ## 0.17.0
 
@@ -51,9 +69,9 @@ Released 2026-09-25.
 
 ### Features
 
-- **effect-channel:** add a cognitive complexity rule and make it the size budget's (#50)
-- **scripts:** export the refused directive names from comment-matchers (#49)
-- refuse undeclared package imports and deprecated symbol use (#48)
+- **effect-channel:** add a cognitive complexity rule and make it the size budget's [#50](https://github.com/avi2d/checks/pull/50)
+- **scripts:** export the refused directive names from comment-matchers [#49](https://github.com/avi2d/checks/pull/49)
+- refuse undeclared package imports and deprecated symbol use [#48](https://github.com/avi2d/checks/pull/48)
 
 ## 0.16.0
 
@@ -61,8 +79,8 @@ Released 2026-09-25.
 
 ### Features
 
-- **scripts:** add checks-repetition to hold new repetition in production code (#46)
-- **scripts:** add the recommended size limits, a tests budget and an overrun ratchet (#45)
+- **scripts:** add checks-repetition to hold new repetition in production code [#46](https://github.com/avi2d/checks/pull/46)
+- **scripts:** add the recommended size limits, a tests budget and an overrun ratchet [#45](https://github.com/avi2d/checks/pull/45)
 
 ## 0.15.0
 
@@ -70,7 +88,7 @@ Released 2026-09-25.
 
 ### Features
 
-- **scripts:** hold living docs to prose rules and resolvable references in checks-docs (#42)
+- **scripts:** hold living docs to prose rules and resolvable references in checks-docs [#42](https://github.com/avi2d/checks/pull/42)
 
 ## 0.14.0
 
@@ -78,8 +96,8 @@ Released 2026-09-25.
 
 ### Features
 
-- **scripts:** generate README blocks, check CONTRIBUTING.md, and give each bin a page (#39)
-- **scripts:** generate CHANGELOG.md from conventional commits and ship it in the package (#40)
+- **scripts:** generate README blocks, check CONTRIBUTING.md, and give each bin a page [#39](https://github.com/avi2d/checks/pull/39)
+- **scripts:** generate CHANGELOG.md from conventional commits and ship it in the package [#40](https://github.com/avi2d/checks/pull/40)
 
 ## 0.13.0
 
@@ -87,7 +105,7 @@ Released 2026-09-25.
 
 ### Features
 
-- **scripts:** add checks-docs gate holding doc files to shared templates (#37)
+- **scripts:** add checks-docs gate holding doc files to shared templates [#37](https://github.com/avi2d/checks/pull/37)
 
 ## 0.12.0
 
@@ -95,11 +113,11 @@ Released 2026-09-24.
 
 ### Features
 
-- **scripts:** add size budget, feature-owner rules and change-signal gates (#35)
+- **scripts:** add size budget, feature-owner rules and change-signal gates [#35](https://github.com/avi2d/checks/pull/35)
 
 ### Fixes
 
-- release 0.12.0 and read local exports in checks-feature-owners (#36)
+- release 0.12.0 and read local exports in checks-feature-owners [#36](https://github.com/avi2d/checks/pull/36)
 
 ## 0.11.0
 
@@ -107,7 +125,7 @@ Released 2026-09-24.
 
 ### Features
 
-- **scripts:** add quality.json with schema, loader and checks-quality fragment generator (#33)
+- **scripts:** add quality.json with schema, loader and checks-quality fragment generator [#33](https://github.com/avi2d/checks/pull/33)
 
 ## 0.10.0
 
@@ -115,7 +133,7 @@ Released 2026-09-24.
 
 ### Features
 
-- **scripts:** add checks-test skip gate and checks-flake seed recorder (#31)
+- **scripts:** add checks-test skip gate and checks-flake seed recorder [#31](https://github.com/avi2d/checks/pull/31)
 
 ## 0.9.0
 
@@ -123,14 +141,14 @@ Released 2026-09-24.
 
 ### Features
 
-- **scripts:** let ciWiring.lintGates select the gates checks-lint runs (#29)
-- **oxlintrc:** turn on no-unsafe-type-assertion and no-non-null-assertion (#26)
+- **scripts:** let ciWiring.lintGates select the gates checks-lint runs [#29](https://github.com/avi2d/checks/pull/29)
+- **oxlintrc:** turn on no-unsafe-type-assertion and no-non-null-assertion [#26](https://github.com/avi2d/checks/pull/26)
 
 ### Fixes
 
-- **scripts:** split Effect-free comment matchers out for hosts without node_modules (#30)
-- **scripts:** judge a repository's first commit against the empty tree in the range gates (#28)
-- **lint:** cruise the whole repo; lint-coverage counts skips and exits 2 on a failed walk (#27)
+- **scripts:** split Effect-free comment matchers out for hosts without node_modules [#30](https://github.com/avi2d/checks/pull/30)
+- **scripts:** judge a repository's first commit against the empty tree in the range gates [#28](https://github.com/avi2d/checks/pull/28)
+- **lint:** cruise the whole repo; lint-coverage counts skips and exits 2 on a failed walk [#27](https://github.com/avi2d/checks/pull/27)
 
 ## 0.8.0
 
@@ -138,8 +156,8 @@ Released 2026-09-24.
 
 ### Features
 
-- **scripts:** add checks-lint to run every kit lint gate over one resolved range (#25)
-- **scripts:** run the bins on Effect and hold scripts/ to Effect-native IO (#22)
+- **scripts:** add checks-lint to run every kit lint gate over one resolved range [#25](https://github.com/avi2d/checks/pull/25)
+- **scripts:** run the bins on Effect and hold scripts/ to Effect-native IO [#22](https://github.com/avi2d/checks/pull/22)
 
 ## 0.6.0
 
@@ -147,7 +165,7 @@ Released 2026-09-24.
 
 ### Features
 
-- add checks-suppressions-ratchet to refuse a raised oxlint suppression count (#21)
+- add checks-suppressions-ratchet to refuse a raised oxlint suppression count [#21](https://github.com/avi2d/checks/pull/21)
 
 ## 0.5.0
 
@@ -155,7 +173,7 @@ Released 2026-09-24.
 
 ### Features
 
-- **effect-channel:** add opt-in no-throw and no-try-catch rules (#20)
+- **effect-channel:** add opt-in no-throw and no-try-catch rules [#20](https://github.com/avi2d/checks/pull/20)
 
 ## 0.4.0
 
@@ -163,11 +181,11 @@ Released 2026-09-24.
 
 ### Features
 
-- add checks-ci-wiring to confirm CI runs each declared gate on pull requests (#19)
+- add checks-ci-wiring to confirm CI runs each declared gate on pull requests [#19](https://github.com/avi2d/checks/pull/19)
 
 ### Fixes
 
-- pin the quarantine pathIgnorePatterns in the test-layout bunfig check (#18)
+- pin the quarantine pathIgnorePatterns in the test-layout bunfig check [#18](https://github.com/avi2d/checks/pull/18)
 
 ## 0.3.0
 
@@ -175,8 +193,8 @@ Released 2026-09-23.
 
 ### Features
 
-- add checks-mutation-compare no-regression gate for Stryker reports (#17)
-- ship a shared Stryker mutation-testing preset (#16)
+- add checks-mutation-compare no-regression gate for Stryker reports [#17](https://github.com/avi2d/checks/pull/17)
+- ship a shared Stryker mutation-testing preset [#16](https://github.com/avi2d/checks/pull/16)
 
 ## 0.2.0
 
@@ -184,11 +202,11 @@ Released 2026-09-23.
 
 ### Features
 
-- expose runnable scripts as checks- bins for consumer package scripts (#15)
-- rename npm package from @avi2d/checks to @avi2dg/checks (#14)
-- add a shared comment gate and backtest command (#12)
-- publish @avi2d/checks to the public npm registry (#11)
+- expose runnable scripts as checks- bins for consumer package scripts [#15](https://github.com/avi2d/checks/pull/15)
+- rename npm package from @avi2d/checks to @avi2dg/checks [#14](https://github.com/avi2d/checks/pull/14)
+- add a shared comment gate and backtest command [#12](https://github.com/avi2d/checks/pull/12)
+- publish @avi2d/checks to the public npm registry [#11](https://github.com/avi2d/checks/pull/11)
 
 ### Fixes
 
-- count violation lines from file top, drop dead moduleStart (#10)
+- count violation lines from file top, drop dead moduleStart [#10](https://github.com/avi2d/checks/pull/10)

package/CONTRIBUTING.md

@@ -16,7 +16,9 @@ To check a change the way CI does:
 1. Run `bun run typecheck`.
 1. Run `bun run test`, which runs the suite through `scripts/test.ts`.
 
-CI runs the commands `gates.ci` lists in `quality.json`, which include `git diff --exit-code` over the whole tree after the build and the commit lint on the pull request title.
+Declare each skip with `skipReason(reason, name)` beside the native Bun test call, as [checks-test](docs/gates/checks-test.md) says.
+
+CI runs the commands in `.github/workflows/ci.yml` and lints the pull request title in `.github/workflows/commitlint.yml`.
 
 ## Regenerate what is committed
 
@@ -24,9 +26,8 @@ Each generated file is committed, and lint, the suite or CI's diff after the bui
 
 To regenerate after an edit:
 
-1. After editing `sources.effect` in `quality.json` or a file in `presets/`, run `bun scripts/quality.ts generate`, which rewrites `oxlintrc.quality.json` and `tsconfig.quality.json`.
-1. After editing `effect-channel/`, `scripts/feature-rules.ts`, the schema in `scripts/quality-file.ts` or the templates in `scripts/doc-templates.ts`, run `bun run build`.
-   It rewrites `dist/index.js`, `dist/feature-rules.js`, `quality.schema.json` and `templates/`.
+1. After editing `effect-channel/` or the templates in `scripts/doc-templates.ts`, run `bun run build`.
+   It rewrites `dist/index.js` and `templates/`.
 1. After editing anything a generated block names as its source in its opening marker, run `bun run build`, which rewrites every generated block.
 1. Commit what the command rewrote in the same commit as the edit.
 
@@ -49,7 +50,9 @@ To release a version:
    ```
 
 1. Watch the `release` workflow.
-   It refuses a tag off `main` or one that disagrees with `package.json`, and reruns the build, the check that the build changed no committed file, lint, typecheck and the suite before it publishes.
+   It refuses a tag off `main` or one that disagrees with `package.json`.
+   It reruns the build, the check that the build changed no committed file, lint, typecheck and the suite before it publishes to npm.
+   After npm publish succeeds, the workflow creates or updates the GitHub release with the matching `CHANGELOG.md` section.
 
 `publishConfig.access` in `package.json` is what makes the scoped package public.
 npm attaches a trusted publisher only to a package that already exists, so a package's first version goes out by hand.
@@ -66,15 +69,15 @@ To place a change:
    | --- | --- |
    | `scripts/` | every bin, and the modules they share |
    | `effect-channel/` | the oxlint plugin with the Effect error-channel and cognitive complexity rules |
-   | `dist/` | the committed bundles of the plugin and of `featureRules` |
-   | `presets/` | the Effect presets `checks-quality` builds its fragments from |
+   | `dist/` | the committed oxlint plugin bundle |
+   | `presets/` | the Effect rule blocks consumers copy into native configs |
    | `templates/` | one template per kind of doc file, which `bun run build` renders |
    | `CHANGELOG.md` | every release, which `bun run build` writes from the conventional commits |
    | `tests/` | the suite, with the tests that spawn a process under `tests/e2e/` |
    | `docs/gates/` | one reference page per bin |
    | `docs/configs/` | one reference page per shipped config a bin does not own |
    | `docs/design.md` | why the kit is shaped the way it is |
-   | the root configs | `oxlintrc.json`, `tsconfig.effect.json`, `bunfig.toml`, `commitlint.config.js`, `dependency-cruiser.config.js`, `stryker.preset.js` and `quality.schema.json`, which a consuming repository extends or copies |
+   | the root configs | `oxlintrc.json`, `tsconfig.effect.json`, `bunfig.toml`, `commitlint.config.js`, `dependency-cruiser.config.js`, `stryker.preset.js`, which a consuming repository extends or copies |
 
 1. Change the page under `docs/` that describes the behaviour in the same commit as the behaviour.
    A new bin gets its page under `docs/gates/`, and the suite fails until it has one.

package/README.md

@@ -2,7 +2,7 @@
 
 `@avi2dg/checks` is the kit of deterministic checks a TypeScript repository installs to hold its code, tests, commits, CI wiring and docs to one shared standard.
 It ships the lint gates `checks-lint` runs over each pull request, the test runners, and the configs a repository extends for oxlint, tsc, dependency-cruiser, commitlint, bun and Stryker.
-A repository declares what it opts into once, in `quality.json`, and each check decides its constraint the same way on every run.
+Each repository owns its workflows and native tool configs, as [Native settings](docs/configs/native-settings.md) maps.
 
 ## Before you begin
 
@@ -59,30 +59,22 @@ To consume the kit from a repository:
    }
    ```
 
-1. Declare the commands CI runs in `quality.json` at the repository root:
-
-   ```json
-   {
-     "$schema": "./node_modules/@avi2dg/checks/quality.schema.json",
-     "gates": { "ci": ["bun run lint", "bun run typecheck", "bun run test"] }
-   }
-   ```
-
 1. Copy the bunfig preset:
 
    ```sh
    cp node_modules/@avi2dg/checks/bunfig.toml bunfig.toml
    ```
 
-1. Add three scripts to `package.json`:
+1. Add scripts to `package.json`, replacing the build entry with the repository's own build command:
 
    ```json
+   "build": "bun build src/index.ts --outdir dist --target node",
    "lint": "oxlint --type-aware && checks-lint",
    "typecheck": "tsc --noEmit && effect-tsgo diagnostics --project tsconfig.json --format text --strict",
    "test": "checks-test"
    ```
 
-1. Run the three on every pull request in `.github/workflows/ci.yml`, fetching the whole history the range needs:
+1. Run the scripts on every pull request in `.github/workflows/ci.yml`, fetching the whole history the range needs:
 
    ```yaml
    on:
@@ -96,17 +88,20 @@ To consume the kit from a repository:
              fetch-depth: 0
          - uses: oven-sh/setup-bun@v2
          - run: bun install --frozen-lockfile
+         - run: bun run build
+         - run: git diff --exit-code
          - run: bun run lint
          - run: bun run typecheck
          - run: bun run test
    ```
 
+Add a pull request title lint step in another workflow using `./node_modules/.bin/commitlint`.
 `bun run lint` then ends with `checks-lint: <count> gate(s) pass`.
 
 ## What runs
 
 `checks-lint` runs these gates in this order, each over the working tree or over the range it resolves, and names every one that fails.
-A repository leaves out a gate that does not apply to it through `gates.lint`, as [Gate selection](docs/gates/checks-lint.md#gate-selection) says.
+`checks-lint` runs every applicable gate, including the TypeScript gates once the repository tracks TypeScript.
 
 <!-- generated gates: bun run build writes it from KIT_GATES in scripts/gates.ts and scripts/doc-blocks.ts -->
 
@@ -119,22 +114,19 @@ A repository leaves out a gate that does not apply to it through `gates.lint`, a
 | [`checks-suppressions-ratchet`](docs/gates/checks-suppressions-ratchet.md) | the range | every repository |
 | [`checks-ci-wiring`](docs/gates/checks-ci-wiring.md) | the working tree | every repository |
 | [`checks-docs`](docs/gates/checks-docs.md) | the range | every repository |
-| [`checks-quality`](docs/gates/checks-quality.md) | the working tree | a repository tracking `quality.json` |
-| [`checks-size-budget`](docs/gates/checks-size-budget.md) | the range | a repository tracking `*.ts` or `*.tsx` |
 | [`checks-repetition`](docs/gates/checks-repetition.md) | the range | a repository tracking `*.ts` or `*.tsx` |
-| [`checks-feature-owners`](docs/gates/checks-feature-owners.md) | the range | a repository tracking `*.ts` or `*.tsx` |
 | [`checks-quarantine-clock`](docs/gates/checks-quarantine-clock.md) | the range | every repository |
 
 <!-- end generated gates -->
 
 These bins run on their own:
 
-- [`checks-test`](docs/gates/checks-test.md) runs the suite as `scripts.test` and refuses a skip the repository has not declared.
+- [`checks-test`](docs/gates/checks-test.md) runs the suite as `scripts.test` and refuses a skip without a reason at its test site.
 - [`checks-flake`](docs/gates/checks-flake.md) runs the suite on a schedule and records the seeds a flaky test fails with.
 - [`checks-mutation-compare`](docs/gates/checks-mutation-compare.md) holds every mutant in a pull request to no regression.
 - [`checks-subsumed-tests`](docs/gates/checks-subsumed-tests.md) lists each test another test subsumes in a mutation run.
 - [`checks-backtest`](docs/gates/checks-backtest.md) reports what the comment check would have refused in recent history.
-- [`checks-vendor`](docs/gates/checks-vendor.md) pins each library `quality.json` declares to a shared read-only clone and links it under `repos/`.
+- [`checks-vendor`](docs/gates/checks-vendor.md) pins each library its `prepare` arguments name to a shared read-only clone and links it under `repos/`.
 
 `checks-lint` has [its own page](docs/gates/checks-lint.md), which says which range it resolves.
 The oxlint base, the dependency-cruiser base and the commitlint config run through their own tools, as the pages under Related topics say.
@@ -144,13 +136,13 @@ The oxlint base, the dependency-cruiser base and the commitlint config run throu
 To move a repository to a newer release of the kit:
 
 1. Run the install line again, which moves the kit to its newest release and the peers to the versions it pins.
-1. Run `bun run checks-quality generate` when `quality.json` declares `sources.effect`, since a release that changes a preset reaches the fragments only through it.
+1. Review the Effect overrides in `.oxlintrc.json` and `tsconfig.json` when a release changes their presets.
 1. Copy `node_modules/@avi2dg/checks/bunfig.toml` over `bunfig.toml` again, since `checks-test-layout` compares the copy with the installed preset.
 1. Run `bun run lint`, `bun run typecheck` and `bun run test`.
 
 The repository's lockfile pins the kit, so a repository moves only when it runs these steps.
 [CHANGELOG.md](CHANGELOG.md), shipped in the package, lists what each release changed.
-A repository that still declares `ciWiring` or `commitIdentity` in `package.json` moves them into `quality.json`, as [Keys moved from package.json](docs/configs/quality-file.md#keys-moved-from-packagejson) maps.
+A repository that tracks `quality.json` moves its settings as [Native settings](docs/configs/native-settings.md#consumer-migration) maps.
 
 ## Where things are
 
@@ -168,18 +160,17 @@ Every path is relative to the installed package, `node_modules/@avi2dg/checks/`.
 | `dependency-cruiser.config.js` | the shared dependency-cruiser base |
 | `scripts/` | every bin, which a package script calls by its `checks-` name |
 | `templates/` | one template per kind of doc file, which a new doc file starts from |
-| `presets/` | the Effect rule blocks `checks-quality generate` writes into the fragments |
-| `quality.schema.json` | the schema of `quality.json`, which its `$schema` line names |
+| `presets/` | the Effect rule blocks a repository copies into its native config |
 | `oxlintrc.json` | the oxlint base config `.oxlintrc.json` extends |
 | `stryker.preset.js` | the Stryker mutation-testing preset |
 | `tsconfig.effect.json` | the tsconfig fragment with the Effect language-service block |
-| `dist/` | the compiled oxlint plugin with the Effect error-channel and cognitive complexity rules, and `featureRules` |
+| `dist/` | the compiled oxlint plugin with the Effect error-channel and cognitive complexity rules |
 
 <!-- end generated shipped -->
 
 ## Related topics
 
-- [The quality file](docs/configs/quality-file.md)
+- [Native settings](docs/configs/native-settings.md)
 - [The Effect rules](docs/configs/effect-rules.md)
 - [The TypeScript rules](docs/configs/typescript-rules.md)
 - [The dependency rules](docs/configs/dependency-rules.md)

package/bunfig.toml

@@ -1,2 +1,2 @@
 [test]
-pathIgnorePatterns = ["**/tests/quarantine/**", "repos/**"]
+pathIgnorePatterns = ["**/tests/quarantine/**", "**/tests/live/**", "**/tests/pixel/**", "repos/**"]

package/docs/configs/commit-messages.md

@@ -1,3 +1,7 @@
+---
+kind: reference
+audience: consumers
+---
 # The commit message lint
 
 The shared commitlint config holds each pull request title to conventional commits, and a reader looks it up to wire the lint into a repository's CI.
@@ -10,7 +14,7 @@ It arrives with the kit, since `@commitlint/cli` and `@commitlint/config-convent
 ## Workflow
 
 The lint runs in CI on pull requests, because `jj` never fires a git hook.
-`checks-quality generate` writes the workflow whole into `.github/workflows/commitlint.yml`, as [checks-quality](../gates/checks-quality.md) says.
+Each repository owns `.github/workflows/commitlint.yml` and runs the installed `commitlint` binary in a pull request step.
 The workflow lints with the installed kit's `commitlint.config.js`, so every repository holds titles to the same rules.
 
 ## What it lints

package/docs/configs/dependency-rules.md

@@ -1,3 +1,7 @@
+---
+kind: reference
+audience: consumers
+---
 # The dependency rules
 
 The shared dependency-cruiser base holds a repository's imports to a set of rules every repository shares, and a reader looks it up to add a boundary of its own.
@@ -35,7 +39,7 @@ module.exports = {
 
 A rule that restates a base name overrides it field by field.
 That is how an entry point stops being an orphan: redeclare `no-orphans` with the entry added to its `pathNot`.
-A repository that declares feature owners spreads the rules `quality.json` compiles to into the same `forbidden`, as [checks-feature-owners](../gates/checks-feature-owners.md#import-boundary) says.
+A repository with an import boundary writes its rule directly under `forbidden`.
 
 ## Running it
 
@@ -59,5 +63,4 @@ jobs:
 
 ## Related topics
 
-- [checks-feature-owners](../gates/checks-feature-owners.md)
 - [Why it is shaped this way](../design.md)

package/docs/configs/effect-rules.md

@@ -1,49 +1,48 @@
+---
+kind: reference
+audience: consumers
+---
 # The Effect rules
 
-The oxlint base config and the tsconfig fragment hold a repository's Effect code to its error channel and to Effect-native IO, and a reader looks them up to learn what each rule refuses and how a path opts in.
+The oxlint base and Effect language service check paths a repository writes with Effect.
 
-## Base config
+## Oxlint override
 
-The base config, `oxlintrc.json`, loads the `effect-channel` plugin and turns on `effect-channel/no-error-channel-escape`.
-That rule refuses `Effect.ignore`, `Effect.ignoreCause`, the `Effect.catchCause` family, and an `Effect.catch` whose handler takes no error or names it `_`.
-
-Two more rules ship off, because a repository writes only some of its paths in Effect, and code a host loads without `node_modules`, such as a hook bundle or this oxlint plugin, cannot import it:
-
-- `effect-channel/no-throw` refuses a `throw` statement.
-- `effect-channel/no-try-catch` refuses a `try` statement with a `catch` clause, and `try`/`finally` stays allowed.
-
-Each refusal says what to write instead: a `Schema.TaggedError` failed through `Effect.fail`, a throwing call wrapped in `Effect.try` or `Effect.tryPromise`, and recovery by tag with `Effect.catchTag`.
-
-## Effect paths
-
-A repository turns the rules on for the paths it writes in Effect by declaring those paths in `quality.json` and extending the fragments [checks-quality](../gates/checks-quality.md) generates:
+The shared `oxlintrc.json` loads `effect-channel/no-error-channel-escape` across the tree.
+The repo's `.oxlintrc.json` owns its Effect paths and exemptions in an override:
 
 ```json
-"sources": {
-  "effect": { "paths": ["src/**/*.ts"], "exempt": ["src/host/*.ts"] }
+{
+  "extends": ["./node_modules/@avi2dg/checks/oxlintrc.json"],
+  "plugins": ["typescript", "oxc", "eslint", "import"],
+  "overrides": [{
+    "files": ["src/**/*.ts"],
+    "excludeFiles": ["src/host/*.ts"],
+    "plugins": ["typescript", "oxc", "eslint", "import", "node", "promise", "unicorn"],
+    "rules": {
+      "node/no-sync": "error",
+      "oxc/no-async-await": "error",
+      "promise/avoid-new": "error",
+      "unicorn/no-process-exit": "error",
+      "effect-channel/no-throw": "error",
+      "effect-channel/no-try-catch": "error"
+    }
+  }]
 }
 ```
 
-The fragment's override carries the kit's Effect rule block, `presets/effect.oxlint.json`.
-It holds the two rules above, plus `node/no-sync`, `oxc/no-async-await`, `promise/avoid-new` and `unicorn/no-process-exit`.
-Files under `exempt` answer to none of them.
-
-oxlint resolves `files` against the directory of the config that holds the override, so a config passed with `-c` from outside the repository matches nothing and reports nothing.
-
-`unicorn/no-process-exit` passes over any file that opens with a shebang.
-A repository whose bins open with one bans `process.exit` itself with `no-restricted-properties` in its own `.oxlintrc.json`, as the kit's own repository does.
-The preset leaves that rule out because a repository's own `no-restricted-properties` list for the same files would replace it, or be replaced by it.
-Sites standing when the declaration lands go in oxlint's own baseline, `oxlint --suppress-all`, so their count can only fall, as [checks-suppressions-ratchet](../gates/checks-suppressions-ratchet.md) holds.
+The kit ships the rule block in `presets/effect.oxlint.json` for copying into the override.
+Each config in an oxlint `extends` chain sets `plugins` explicitly, because an omitted list enables defaults across the chain.
+`unicorn/no-process-exit` does not check a shebang script, so a bin can use `eslint/no-restricted-properties` for `process.exit`.
 
 ## Language service
 
-The language service holds the same paths to Effect-native IO through the tsconfig fragment's override, whose severities are `presets/effect.language-service.json`.
-`nodeBuiltinImport`, `asyncFunction`, `newPromise` and `extendsNativeError` are all errors.
-effect-tsgo keeps the severities `tsconfig.effect.json` sets when a later config in `extends` restates the plugin with only its overrides.
+The repository's `tsconfig.json` holds its Effect override under `compilerOptions.plugins`.
+The override includes the same source paths and excludes the same exempt paths as oxlint.
+The kit ships severity values in `presets/effect.language-service.json` for the override's `options`.
+The kit's `tsconfig.effect.json` keeps the shared language service diagnostics.
 
 ## Related topics
 
 - [The TypeScript rules](typescript-rules.md)
-- [checks-quality](../gates/checks-quality.md)
-- [The quality file](quality-file.md)
-- [Why it is shaped this way](../design.md)
+- [Native settings](native-settings.md)

package/docs/configs/native-settings.md

@@ -0,0 +1,74 @@
+---
+kind: reference
+audience: consumers
+---
+# Native settings
+
+A consuming repository puts each setting in the file its tool reads.
+
+## Settings by file
+
+| File | Setting | Reader |
+| --- | --- | --- |
+| `.github/workflows/*.yml` | Pull request commands, scheduled commands, runner labels | GitHub Actions and `checks-ci-wiring` |
+| `.oxlintrc.json` | Effect paths, exemptions, file size, function size, statements, cognitive complexity and depth | oxlint |
+| `oxlint-suppressions.json` | The existing violations oxlint suppresses, per file and rule | oxlint and `checks-suppressions-ratchet` |
+| `.jscpd.json` | The `path` and `ignore` globs of the files repetition is measured in | jscpd and `checks-repetition` |
+| `tsconfig.json` | Effect language service scope and severity | TypeScript and Effect language service |
+| `package.json` | `scripts` with the `checks-vendor` arguments in `prepare`, `author` and `contributors` | Bun, `checks-commit-identity` and `checks-vendor` |
+| `bunfig.toml` | Test discovery and quarantine exclusion | Bun and `checks-test-layout` |
+| `.dependency-cruiser.cjs` | Import rules | dependency-cruiser |
+| `stryker.conf.mjs` | Mutation settings | Stryker |
+| Each page under `docs/` | Diátaxis mode in `kind` front matter, and `audience: consumers` on a page that speaks to a consuming repository | `checks-docs` |
+
+Every page under `docs/` names its mode in `kind` front matter, whatever directory holds it.
+A page whose front matter sets `audience: consumers` names commands a consuming repository runs, so `checks-docs` does not hold them to this `package.json`.
+Every other living doc names commands this repository runs, and `checks-docs` holds each one to its `package.json`.
+
+## Consumer migration
+
+The following table maps the former fields to their owners.
+
+| Former field | New owner |
+| --- | --- |
+| `defaultBranch` | Git's `refs/remotes/origin/HEAD`, or the pull request base or event repository in CI |
+| `runsOn`, `gates.ci`, `gates.scheduled` | `runs-on` and `run` steps in `.github/workflows/*.yml` |
+| `gates.lint` | `checks-lint` runs every kit gate |
+| `commitIdentity.authors` | `author` and `contributors` in `package.json` |
+| `sources.production` | `path` and `ignore` in `.jscpd.json` |
+| `size.production`, `size.tests` | File overrides and native size rules in `.oxlintrc.json` |
+| `sources.effect.paths`, `sources.effect.exempt` | Overrides in `.oxlintrc.json` and `tsconfig.json` |
+| `sources.libraries` | `checks-vendor` arguments in the `prepare` script of `package.json` |
+| `docs.pages` | `kind` front matter on each page |
+| `docs.forConsumers` | `audience: consumers` front matter on each page |
+| `features`, `changeSignal`, `agentRules` | No active declarations used these fields |
+
+The kit has no general configuration manifest or generated workflow.
+`checks-ci-wiring` requires title lint on opened and synchronized pull requests.
+It also requires lint, build, typecheck and test for each of those scripts that `package.json` defines, and a clean git diff after a build.
+`checks-repetition` runs jscpd with the repository's own `.jscpd.json`, so its `path` and `ignore` globs decide which files are measured.
+
+## Size limits
+
+The size rules are plain oxlint rules at `error` in `.oxlintrc.json`, and `bun run lint` enforces them on the whole tree.
+A repository records its existing violations with `oxlint --suppress-all`, which writes them to `oxlint-suppressions.json`.
+`checks-suppressions-ratchet` refuses any count in that file that rises, so the recorded debt only falls.
+The kit's own `.oxlintrc.json` sets these limits for each size override, and a repository may copy them:
+
+<!-- generated size-limits: bun run build writes it from .oxlintrc.json, SIZE_RULES in scripts/size-rules.ts and scripts/doc-blocks.ts -->
+
+| Limits | oxlint rule | `effect-channel/**/*.ts`, `scripts/**/*.ts` | `tests/**/*.ts` |
+| --- | --- | --- | --- |
+| The most lines a file may hold, blank and comment lines counted | `max-lines` | 400 | 600 |
+| The most lines a function may span, blank and comment lines counted | `max-lines-per-function` | 100 | off |
+| The most statements a function may hold | `max-statements` | 30 | 50 |
+| The highest cognitive complexity a function may reach, a switch counted once | `effect-channel/cognitive-complexity` | 15 | 15 |
+| The deepest a block may nest inside a function | `max-depth` | 4 | 4 |
+
+<!-- end generated size-limits -->
+
+## Related topics
+
+- [The Effect rules](effect-rules.md)
+- [The CI wiring check](../gates/checks-ci-wiring.md)
+- [The suppressions ratchet](../gates/checks-suppressions-ratchet.md)

package/docs/configs/typescript-rules.md

@@ -1,3 +1,7 @@
+---
+kind: reference
+audience: consumers
+---
 # The TypeScript rules
 
 The oxlint base config holds a repository's TypeScript to a set of rules, and a reader looks it up to learn what each rule refuses and which rules need type information.