README.md
README.md is a file in Codebase Testing. 100 lines of code and 0 definitions.
<!-- Auto-generated 2026-10-04T16:25Z v9 -->
# @codebase/testing
<!-- concern:overview -->
## Purpose
Every suite in the workspace lives here. Each test root mirrors one source root, as `testMirrors` in `.govlab/shared/configs/taxonomy.config.ts` declares: `test.web/` mirrors the application, `test.rules/` the governance host, and each folder under `test.govlab/` one suite member. A test sits at its subject's folder path and is named for its subject with `.test` before the extension, so `test.build/core/converters/site.converter.test.ts` pins `banes-lab.root/banes-lab.build.scripts/core/converters/site.converter.ts`. A fixture carries the `fixture` marker and sits in the concern folder of its main consumers. A suite imports its subject by the owning package specifier, such as `@govlab/quality/core/parsers/tool.knip.parser.ts`, not by a relative climb. `closure-no-cross-member-relative` enforces the specifier, and its codemod rewrites a relative climb. One `vitest.config.ts` roots at the repo and collects every test under this root, so the whole workspace is one run, one report and one exit code.
<!-- /concern:overview -->
<!-- concern:use -->
## When to use
- Adding any test for a workspace member. This root is the only place one may live.
- Adding a fixture shared across suites, placed in the concern folder of its main consumers.
- Testing a local lint rule's behavior against `RuleTester`, at the rule's mirrored path under `test.rules/rules/eslint/`.
## When NOT to use
- Placing a test beside its subject. `closure-tests-centralized` and the `Taxonomy` step both fail it.
- Asserting against a fixture that only exists in another repository. A suite runs from a fresh checkout of this one.
<!-- /concern:use -->
<!-- concern:charts -->
## Architecture charts
The structure, logical-flow and dependency diagrams derived from the source AST live in [_code.info.generated/mermaid-charts.generated.md](./_code.info.generated/mermaid-charts.generated.md).
<!-- /concern:charts -->
<!-- concern:install -->
## Install
A private workspace member resolved through the root `package.json` workspaces list. One `npm install` at the repo root is the whole setup, because `vitest` is hoisted there and this package declares only its workspace siblings. The gate runs it directly as `vitest run --config codebase.testing/vitest.config.ts`, never through an npm script name.
## Quick start
```sh EXAMPLE: Run everything, one file, or one test by name
npx vitest run --config codebase.testing/vitest.config.ts
npx vitest run --config codebase.testing/vitest.config.ts codebase.testing/test.build/core/converters/site.converter.test.ts
npx vitest run --config codebase.testing/vitest.config.ts -t "replaces rather than duplicates"
```
```ts EXAMPLE: A suite imports its subject by the package specifier of the member it covers
import { describe, expect, it } from "vitest";
import { createCapability, registerCapability, registeredCapabilities } from "@banes-lab/web";
describe("capability registry", () => {
it("replaces rather than duplicates on the same id", () => {
registerCapability(createCapability("telemetry"));
registerCapability(createCapability("telemetry"));
expect(registeredCapabilities().filter((c) => c.id === "telemetry")).toHaveLength(1);
});
});
```
<!-- /concern:install -->
<!-- concern:api -->
## API
The package exposes no public API.
<!-- /concern:api -->
<!-- concern:config -->
## Configuration
`vitest.config.ts` sets `root` to the repo, includes `codebase.testing/**/*.test.ts`, and runs with `globals: false`, so every `describe`, `it` and `expect` is imported explicitly. It declares three projects: `node` for most suites, `web` in jsdom for the application's suites with the stylesheet fixture as its setup file, and `stage` in jsdom for the social-share renderer and timer suites. `tsconfig.json` relaxes `noPropertyAccessFromIndexSignature`, because a test indexes into fixtures constantly. It declares `types: ["node", "vite/client", "@webgpu/types"]`, so `import.meta.env` and `import.meta.glob` resolve in suites that import web source.
<!-- /concern:config -->
<!-- concern:deps -->
## Dependencies
- `@banes-lab/build-scripts`
- `@banes-lab/content`
- `@banes-lab/deploy`
- `@banes-lab/social-share`
- `@banes-lab/web`
- `@govlab/argv`
- `@govlab/canonical-write`
- `@govlab/code-parse`
- `@govlab/constants`
- `@govlab/content-fingerprint`
- `@govlab/context`
- `@govlab/docs`
- `@govlab/patterns`
- `@govlab/pipeline`
- `@govlab/quality`
- `@govlab/stats`
- `@project/scripts`
- `@ssot/govlab`
- `@ssot/paths`
- `@ssot/secrets`
- `coordination-surface`
<!-- /concern:deps -->
<!-- concern:ai-context -->
## AI context
- The `Taxonomy` step holds the mirror: it fails a test outside a mirror, a test with no subject at its mirrored path, and a file in a mirror that is neither a test nor a fixture. A test moves in the same change as its subject.
- A fixture imported by a relative path breaks when either end moves. The relative-specifier codemod in the auto-fix stage repoints an import whose target moved to the one file in the member that carries its name, and fails on a name that matches none or several.
- Prefer a fixture that already exists in the workspace over a synthetic stub. A suite asserting against a package that only exists in some other repository passes nothing and fails on a fresh checkout.
- A slow test, such as a full TypeScript program plus a mermaid parse, needs an explicit timeout as its last argument. The 5s default is measured under full parallel load, so a suite that passes alone can still time out in the whole run.
<!-- /concern:ai-context -->
<!-- concern:domains -->
## Domains
This package serves these software domains, which `_manifest.json` declares in `domains` from the two-tier software-domain vocabulary (`meta → sub`):
- **developer-tooling** — testing
<!-- /concern:domains -->
<!-- concern:quality-governance -->
## Quality governance
The canonical quality catalog resolves the quality concepts that govern this package. `_manifest.json` declares them in `governedBy`, and a lint package derives them from the concepts its own rules enforce. Each maps to the custom lint rules that enforce it:
- **separation-of-concerns** — _complexity_
- **type-safety** — _correctness_
<!-- /concern:quality-governance -->
<!-- concern:disposal -->
## Disposal
- Remove the testing stage from the verify orchestrator, including the test floor step (`coverage.entrypoint.ts` in the standalone scripts) that reads its report.
- Delete `closure-tests-centralized` from `.govlab/rules/eslint/` and the `testMirrors` map from the taxonomy config.
- Remove `codebase.testing/` and its workspace entry, after relocating any suite worth keeping beside its subject.
<!-- /concern:disposal -->
<!-- concern:metrics -->
---
stable · 0 exports · 21 deps · 0 principles · 2 concepts
<!-- /concern:metrics -->