@shivaedev/quality 0.25.0 → 0.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shivaedev/quality",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "Repository quality gate with typed rules, a baseline of existing debt and a registry of reasoned exceptions",
   "homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/quality#readme",
   "bugs": {
@@ -32,6 +32,7 @@
     "./tsconfig/base.json": "./tsconfig/base.json",
     "./tsconfig/package.json": "./tsconfig/package.json",
     "./package.json": "./package.json",
+    "./domEnvironment.config.ts": null,
     "./imports/isTooling.ts": null,
     "./rules/imports/bundleInputs.ts": null
   },

package/src/cli/args.ts

@@ -1,6 +1,6 @@
 import { parseArgs } from "node:util";
 import { Result } from "effect";
-import { ADOPT_REMOVED, USAGE as COMMAND_USAGE } from "./messages.ts";
+import { USAGE as COMMAND_USAGE, SUBCOMMANDS } from "./messages.ts";
 
 export type Command =
 	| { readonly _tag: "Lint"; readonly config: string | undefined }
@@ -33,12 +33,6 @@ function usage(problem: string): Parsed {
 	return { _tag: "Usage", problem };
 }
 
-const SUBCOMMANDS: Readonly<Record<string, string>> = {
-	baseline: "baseline takes write, prune, tighten or migrate.",
-	exceptions: "exceptions takes migrate.",
-	hooks: "hooks takes install, uninstall or pre-commit.",
-};
-
 function parsed(command: Command): Parsed {
 	return { _tag: "Parsed", command };
 }
@@ -112,9 +106,6 @@ export function parseCommand(args: readonly string[]): Parsed {
 		return parsed({ _tag: "Help" });
 	}
 	const name = [command, ...rest].join(" ");
-	if (command === "adopt") {
-		return usage(ADOPT_REMOVED);
-	}
 	if (ACCEPTS[name] === undefined) {
 		const subcommands = SUBCOMMANDS[command];
 		return usage(subcommands !== undefined && rest.length < 2 ? subcommands : `unknown command: ${name}`);

package/src/cli/messages.ts

@@ -27,5 +27,8 @@ hooks pre-commit  What the hook runs: lint, then package.json scripts typecheck
 --against <ref>  The branch the work merges into, whose merge base prune follows moves from. Defaults to origin/HEAD, then origin/main, then origin/master.
 Exit codes: 0 passed, 1 failed the gate, 2 could not run.`;
 
-export const ADOPT_REMOVED =
-	"`quality adopt` was removed in 0.7.0. To record a rule's existing findings in the baseline, run `quality baseline write --rule <id>`; to apply the fixes Biome can make first, run `quality fix`.";
+export const SUBCOMMANDS: Readonly<Record<string, string>> = {
+	baseline: "baseline takes write, prune, tighten or migrate.",
+	exceptions: "exceptions takes migrate.",
+	hooks: "hooks takes install, uninstall or pre-commit.",
+};

package/src/config/decode.ts

@@ -22,22 +22,11 @@ const Setting = Schema.Union([Level, Schema.Struct({ level: Schema.optionalKey(L
 
 const LocalRule = Schema.declare(isRule, { expected: "a rule made with defineRule" });
 
-const AdoptRemoved = Schema.Never.annotate({
-	message: "removed in quality 0.7.0. Delete the key, and record a rule's existing findings with `quality baseline write --rule <id>`.",
-});
-
-const PreCommitRemoved = Schema.Never.annotate({
-	message:
-		"removed. Put repository checks in the package.json quality:commit script; the hook also runs typecheck when present. Use `quality baseline tighten --staged` explicitly to lower staged debt.",
-});
-
 const ConfigInput = Schema.Struct({
-	adopt: Schema.optionalKey(AdoptRemoved),
 	baseline: Schema.optionalKey(Schema.String),
 	exceptions: Schema.optionalKey(Schema.Array(ExceptionDeclaration)),
 	extensions: Schema.optionalKey(Schema.Array(Schema.String)),
 	local: Schema.optionalKey(Schema.Array(LocalRule)),
-	preCommit: Schema.optionalKey(PreCommitRemoved),
 	registry: Schema.optionalKey(Schema.String),
 	rules: Schema.optionalKey(Schema.Record(Schema.String, Setting)),
 	sources: Schema.optionalKey(Schema.Array(Schema.String)),

package/src/domEnvironment.config.ts

@@ -0,0 +1,13 @@
+import { createRequire } from "node:module";
+import { join } from "node:path";
+import process from "node:process";
+import { pathToFileURL } from "node:url";
+import type { Environment } from "vitest/runtime";
+
+// Resolve the DOM plugin from the consumer; depending on test-story would cycle through its Quality tooling.
+const consumer = createRequire(join(process.cwd(), "package.json"));
+const { default: environment }: { readonly default: Environment } = await import(
+	pathToFileURL(consumer.resolve("@shivaedev/test-story/domEnvironment.config.ts")).href
+);
+
+export default environment;

package/src/testProjects.ts

@@ -1,4 +1,6 @@
-import { defaultExclude, type TestUserConfig } from "vitest/config";
+import { fileURLToPath } from "node:url";
+import { Config, ConfigProvider, Effect } from "effect";
+import { coverageConfigDefaults, defaultExclude, type TestUserConfig } from "vitest/config";
 import type { Environment } from "#naming/testName.ts";
 
 const EXTENSION = "?(c|m)[jt]s?(x)";
@@ -13,17 +15,39 @@ function excluding(...patterns: readonly string[]): string[] {
 	return [...defaultExclude, named("typecheck"), TYPECHECK_ALONE, ...patterns];
 }
 
-export function testProjects(...options: readonly never[]): TestUserConfig {
-	if (options.length > 0) {
-		throw new Error("testProjects takes no options. Remove suite exclusions; every test belongs in its named project.");
-	}
+export interface TestProjectsOptions {
+	readonly coverage?: boolean | NonNullable<TestUserConfig["coverage"]>;
+}
+
+export function testProjects({ coverage = false }: TestProjectsOptions = {}): TestUserConfig {
+	const ci = Effect.runSync(Config.String("CI").pipe(Config.withDefault("")).parse(ConfigProvider.fromEnv()));
 	return {
+		...(coverage === false
+			? {}
+			: {
+					coverage: {
+						enabled: true,
+						exclude: [...coverageConfigDefaults.exclude, "**/*.d.ts", "**/*.test.*", "**/*.spec.*", "**/test-support/**"],
+						include: ["src/**/*.{ts,tsx}"],
+						provider: "v8",
+						...(coverage === true ? {} : coverage),
+					},
+				}),
 		project: ["unit", "dom"],
 		projects: [
 			{ extends: true, test: { environment: "node", exclude: excluding(named("dom"), named("slow")), include: [named()], name: "unit" } },
-			{ extends: true, test: { environment: "happy-dom", exclude: excluding(named("slow")), include: [named("dom")], name: "dom" } },
+			{
+				extends: true,
+				test: {
+					environment: fileURLToPath(import.meta.resolve("#domEnvironment.config.ts")),
+					exclude: excluding(named("slow")),
+					include: [named("dom")],
+					name: "dom",
+				},
+			},
 			{ extends: true, test: { environment: "node", exclude: excluding(), include: [named("slow")], name: "slow" } },
 		],
+		silent: ci ? false : "passed-only",
 		// Tests that start real servers, browsers or CLIs need seconds on a busy CI runner, and Vitest's 5s default fails them for load, not behavior.
 		testTimeout: 30_000,
 	};

package/docs/modules.md

@@ -1,275 +0,0 @@
-# Module reference
-
-The `./*.ts` export pattern maps each module below to its emitted JavaScript and declarations, with source selected under the `source` condition. Import a symbol from its defining module. The [README](../README.md#api) explains the config and extension APIs; this table also makes the implementation modules exposed by that pattern findable.
-
-A module link opens its source. Type and value declarations with the same name appear once. `cli.ts` is the executable entry and has no exported symbols.
-
-## Top-level modules
-
-| Module | Exported names |
-| --- | --- |
-| [cli.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli.ts) | None; executable entry. |
-| [config.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/config.ts) | `Level` (`"error"`), `RuleSetting`, `RuleSettings`, `BuiltInRules`, `QualityConfig`, `defineConfig` |
-| [decoded.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/decoded.ts) | `Decoded`, `decodeWith`, `validOrFail` |
-| [failure.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/failure.ts) | `SetupFailure`, `GateFailed` |
-| [rule.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rule.ts) | `Finding`, `Findings`, `SourceFile`, `RuleInputs`, `RuleContext`, `Configured`, `Rule`, `defineRule` |
-| [standardSchema.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/standardSchema.ts) | `StandardSchemaV1`, `StandardResult`, `StandardIssue`, `describeIssue` |
-| [testProjects.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/testProjects.ts) | `testProjects` |
-
-## baseline
-
-| Module | Exported names |
-| --- | --- |
-| [baseline/compare.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/baseline/compare.ts) | `Regression`, `StaleBaselineEntry`, `BaselineCheck`, `countOf`, `applyBaseline` |
-| [baseline/format.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/baseline/format.ts) | `BaselineEntry`, `byPathAndRule`, `linesOf`, `decodeBaseline`, `encodeEntry`, `encodeBaseline` |
-| [baseline/legacy.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/baseline/legacy.ts) | `LEGACY_BASELINE`, `LegacyEntry`, `decodeLegacyBaseline`, `convertLegacy` |
-| [baseline/rewrite.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/baseline/rewrite.ts) | `rewriteBaseline` |
-| [baseline/update.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/baseline/update.ts) | `Adoption`, `Pruned`, `adopt`, `Scope`, `prune` |
-
-## biome
-
-| Module | Exported names |
-| --- | --- |
-| [biome/exceptionConfig.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/exceptionConfig.ts) | `exceptionConfig`, `withExceptionConfig` |
-| [biome/nativeEffectCall.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/nativeEffectCall.ts) | `nativeEffectCall` |
-| [biome/recognizeDiagnostics.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/recognizeDiagnostics.ts) | `recognizeDiagnostics` |
-| [biome/recommendedRules.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/recommendedRules.ts) | `recommendedRules` |
-| [biome/report.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/report.ts) | `Diagnostic`, `Report`, `biomeReport` |
-| [biome/run.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/run.ts) | `BiomeRun`, `runBiome` |
-| [biome/syntax.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/biome/syntax.ts) | `Syntax`, `syntaxOf`, `offsetOf`, `nodeAt` |
-
-## cli
-
-| Module | Exported names |
-| --- | --- |
-| [cli/args.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/args.ts) | `Command`, `Parsed`, `USAGE`, `parseCommand` |
-| [cli/baseline.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/baseline.ts) | `writeBaseline`, `shrinkBaseline` |
-| [cli/fix.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/fix.ts) | `MAX_FIX_ROUNDS`, `snapshotOf`, `Pass`, `Settling`, `settle`, `fix` |
-| [cli/lint.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/lint.ts) | `lint` |
-| [cli/messages.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/messages.ts) | `USAGE`, `ADOPT_REMOVED` |
-| [cli/migrate.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/migrate.ts) | `migrateBaseline` |
-| [cli/migrateExceptions.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/migrateExceptions.ts) | `migrateExceptions` |
-| [cli/program.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/program.ts) | `Invocation`, `program` |
-| [cli/runMain.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/runMain.ts) | `exitCode`, `quietOnClosedPipe`, `services`, `explained`, `runMain` |
-| [cli/shrink.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/cli/shrink.ts) | `pruneBaseline`, `tightenBaseline` |
-
-## config
-
-| Module | Exported names |
-| --- | --- |
-| [config/decode.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/config/decode.ts) | `ConfigInput`, `decodeConfig` |
-| [config/file.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/config/file.ts) | `CONFIG_FILE` |
-| [config/load.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/config/load.ts) | `ResolvedConfig`, `loadConfig` |
-| [config/resolve.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/config/resolve.ts) | `ResolvedRules`, `resolveRules` |
-
-## engine
-
-| Module | Exported names |
-| --- | --- |
-| [engine/baselineFile.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/engine/baselineFile.ts) | `BaselineFile`, `readInput`, `readBaseline` |
-| [engine/evaluate.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/engine/evaluate.ts) | `Outcome`, `evaluate`, `passes` |
-| [engine/runRules.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/engine/runRules.ts) | `ActiveRule`, `runRules` |
-| [engine/session.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/engine/session.ts) | `Session`, `scan`, `openSession` |
-| [engine/violation.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/engine/violation.ts) | `ActiveLevel` (`"error"`), `Violation`, `keyOf`, `byLocation`, `groupBy`, `RuleIndex`, `covers`, `levelOf`, `registrable`, `unusedEntryProblem` |
-
-## exceptions
-
-| Module | Exported names |
-| --- | --- |
-| [exceptions/biomeFindings.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/biomeFindings.ts) | `missingBiomeFiles`, `biomeExceptionHint` |
-| [exceptions/declaration.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/declaration.ts) | `ExceptionDeclaration`, `decodeExceptions` |
-| [exceptions/migrateBiome.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/migrateBiome.ts) | `migrateBiome` |
-| [exceptions/migrateConfig.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/migrateConfig.ts) | `migrateConfig` |
-| [exceptions/registryEntries.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/registryEntries.ts) | `registryEntries` |
-| [exceptions/registry.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/exceptions/registry.ts) | `RegistryEntry`, `decodeRegistry`, `StaleRegistryEntry`, `RegistryCheck`, `applyRegistry` |
-
-## git
-
-| Module | Exported names |
-| --- | --- |
-| [git/base.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/git/base.ts) | `Base`, `resolveBase` |
-| [git/command.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/git/command.ts) | `GitResult`, `Git`, `git`, `gitOrFail` |
-| [git/history.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/git/history.ts) | `Changes`, `changesSince` |
-
-## hooks
-
-| Module | Exported names |
-| --- | --- |
-| [hooks/command.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/command.ts) | `Launch`, `HookCommand`, `hookCommand`, `commandWords`, `shellWords` |
-| [hooks/install.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/install.ts) | `HookInstall`, `installHook` |
-| [hooks/location.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/location.ts) | `HookLocation`, `hookLocation` |
-| [hooks/preCommit.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/preCommit.ts) | `preCommitHook` |
-| [hooks/shim.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/shim.ts) | `isHookShim`, `hookShim` |
-| [hooks/uninstall.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/hooks/uninstall.ts) | `uninstallHook` |
-
-## imports
-
-| Module | Exported names |
-| --- | --- |
-| [imports/ambient.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/ambient.ts) | `Ambient`, `ambientModules` |
-| [imports/browserGlobals.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/browserGlobals.ts) | `browserGlobals` |
-| [imports/browserNames.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/browserNames.ts) | `browserNames` |
-| [imports/components.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/components.ts) | `cyclicComponents` |
-| [imports/departures.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/departures.ts) | `Departure`, `departures` |
-| [imports/extract.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/extract.ts) | `ImportKind`, `ImportRequest`, `importsOf` |
-| [imports/generated.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/generated.ts) | `withoutGenerated` |
-| [imports/glob.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/glob.ts) | `globMatcher` |
-| [imports/graph.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/graph.ts) | `ImportEdge`, `UnresolvedImport`, `ImportGraph`, `importGraph` |
-| [imports/paths.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/paths.ts) | `shortestPath` |
-| [imports/pnpmWorkspacePatterns.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/pnpmWorkspacePatterns.ts) | `pnpmWorkspacePatterns` |
-| [imports/projects.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/projects.ts) | `Project`, `projectsFor` |
-| [imports/resolve.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/resolve.ts) | `Endpoint`, `builtinName`, `packageNameOf`, `isDeclarationFile`, `presumedTarget`, `resolveImport` |
-| [imports/runtime.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/runtime.ts) | `Runtime`, `runtimeOf` |
-| [imports/specifiers.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/specifiers.ts) | `SpecifierSite`, `specifierSites` |
-| [imports/workspace.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/workspace.ts) | `WorkspacePackage`, `workspacePackages`, `packageOf` |
-
-## imports/fences
-
-| Module | Exported names |
-| --- | --- |
-| [imports/fences/check.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/check.ts) | `checkFences` |
-| [imports/fences/declarations.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/declarations.ts) | `Declarations`, `decodeDeclarations` |
-| [imports/fences/discover.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/discover.ts) | `discoverFences` |
-| [imports/fences/dsl.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/dsl.ts) | `fence` |
-| [imports/fences/evaluate.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/evaluate.ts) | `FenceGraph`, `Evaluate`, `CompiledFence`, `compileFence` |
-| [imports/fences/match.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/match.ts) | `PolicyScope`, `Matcher`, `Compiler`, `trimmed`, `holdsFiles`, `packageNamed`, `compile` |
-| [imports/fences/model.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/model.ts) | `Selector`, `Target`, `External`, `ExampleStep`, `Chain`, `Examples`, `Prohibition`, `Fence` |
-| [imports/fences/policy.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/policy.ts) | `compilePolicy` |
-| [imports/fences/reach.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/reach.ts) | `Reached`, `labelOf`, `outgoing`, `reachedFrom` |
-| [imports/fences/selectors.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/selectors.ts) | `packages`, `folders`, `files`, `modules`, `scopes`, `anyOf`, `workspace`, `anything`, `external` |
-| [imports/fences/vocabulary.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/imports/fences/vocabulary.ts) | `Vocabulary`, `compileVocabulary` |
-
-## inventory
-
-| Module | Exported names |
-| --- | --- |
-| [inventory/collect.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/inventory/collect.ts) | `InventoryScope`, `Inventory`, `linesOf`, `collectInventory` |
-| [inventory/filesystem.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/inventory/filesystem.ts) | `FilesystemFailure`, `orWhenAbsent`, `readOptionalText`, `readRequiredText`, `writeText` |
-| [inventory/ignoreScope.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/inventory/ignoreScope.ts) | `Verdict`, `IgnoreScope`, `emptyScope`, `posix`, `withIgnoreFile`, `insideKept`, `verdictFor` |
-| [inventory/trackedPaths.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/inventory/trackedPaths.ts) | `trackedPaths`, `ignoredTrackedPaths` |
-| [inventory/walk.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/inventory/walk.ts) | `ignoreScopeAt`, `scopeAbove`, `walk` |
-
-## manifests
-
-| Module | Exported names |
-| --- | --- |
-| [manifests/sorted.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/manifests/sorted.ts) | `Sorting`, `manifestsIn`, `sortingOf`, `sortManifests` |
-
-## naming
-
-| Module | Exported names |
-| --- | --- |
-| [naming/exportFits.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/exportFits.ts) | `exportFits` |
-| [naming/mainExport.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/mainExport.ts) | `mainExport` |
-| [naming/ownExports.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/ownExports.ts) | `OwnExport`, `ownExports` |
-| [naming/packageLayout.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/packageLayout.ts) | `PackageLayout`, `packageLayout` |
-| [naming/testName.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/testName.ts) | `ENVIRONMENTS`, `Environment`, `TestName`, `testName`, `isTestSupport`, `isTestCode` |
-| [naming/words.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/naming/words.ts) | `KEBAB`, `CAMEL`, `PASCAL`, `wordsOf`, `singular`, `sameWord`, `isUpper` |
-
-## report
-
-| Module | Exported names |
-| --- | --- |
-| [report/plural.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/report/plural.ts) | `plural` |
-| [report/render.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/report/render.ts) | `ReportContext`, `render` |
-| [report/stale.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/report/stale.ts) | `staleSections` |
-
-## rules
-
-| Module | Exported names |
-| --- | --- |
-| [rules/biome.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/biome.ts) | `PRESET`, `rootConfig`, `biome` |
-| [rules/builtIn.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/builtIn.ts) | `builtInRules` |
-| [rules/manifestsSorted.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/manifestsSorted.ts) | `manifestsSorted` |
-| [rules/manifestsSourceFirst.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/manifestsSourceFirst.ts) | `manifestsSourceFirst` |
-| [rules/maxLines.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/maxLines.ts) | `maxLines` |
-| [rules/maxDepth.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/maxDepth.ts) | `maxDepth` |
-| [rules/noBarrel.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/noBarrel.ts) | `noBarrel` |
-| [rules/syntax.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/syntax.ts) | `parse` |
-
-## rules/comments
-
-| Module | Exported names |
-| --- | --- |
-| [rules/comments/kinds.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/kinds.ts) | `Pragmas`, `textOf`, `isJsdoc`, `isPragma`, `isDirective` |
-| [rules/comments/maxPerFile.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/maxPerFile.ts) | `maxPerFile` |
-| [rules/comments/noBanner.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noBanner.ts) | `noBanner` |
-| [rules/comments/noEnvironmentPragma.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noEnvironmentPragma.ts) | `noEnvironmentPragma` |
-| [rules/comments/noJsdoc.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noJsdoc.ts) | `noJsdoc` |
-| [rules/comments/noLineReference.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noLineReference.ts) | `noLineReference` |
-| [rules/comments/noPrReference.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noPrReference.ts) | `noPrReference` |
-| [rules/comments/noTodo.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/noTodo.ts) | `noTodo` |
-| [rules/comments/definePattern.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/definePattern.ts) | `definePatternRule` |
-| [rules/comments/scan.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/comments/scan.ts) | `SourceComment`, `bodyOf`, `scanComments`, `commentsOf` |
-
-## rules/files
-
-| Module | Exported names |
-| --- | --- |
-| [rules/files/distinctCase.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/distinctCase.ts) | `distinctCase` |
-| [rules/files/folderNames.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/folderNames.ts) | `folderNames` |
-| [rules/files/namedAfterExport.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/namedAfterExport.ts) | `namedAfterExport` |
-| [rules/files/otherNames.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/otherNames.ts) | `otherNames` |
-| [rules/files/packageImports.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/packageImports.ts) | `PackageImports`, `packageImports` |
-| [rules/files/stylesheetImporters.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/files/stylesheetImporters.ts) | `stylesheetImporters` |
-
-## rules/imports
-
-| Module | Exported names |
-| --- | --- |
-| [rules/imports/aliased.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/aliased.ts) | `importsAliased` |
-| [rules/imports/cycles.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/cycles.ts) | `importCycles` |
-| [rules/imports/fences.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/fences.ts) | `importFences` |
-| [rules/imports/manifest.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/manifest.ts) | `importsManifest` |
-| [rules/imports/noTestCode.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/noTestCode.ts) | `noTestCode` |
-| [rules/imports/resolvable.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/resolvable.ts) | `importsResolvable` |
-| [rules/imports/runtime.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/imports/runtime.ts) | `importsRuntime` |
-
-## rules/stories
-
-| Module | Exported names |
-| --- | --- |
-| [rules/stories/fixtureWrites.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/stories/fixtureWrites.ts) | `FixtureWrite`, `fixtureWrites` |
-| [rules/stories/setup.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/stories/setup.ts) | `storySetup` |
-
-## rules/suppressions
-
-| Module | Exported names |
-| --- | --- |
-| [rules/suppressions/biomeOverrides.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biomeOverrides.ts) | `biomeOverrides` |
-| [rules/suppressions/biomeRecommended.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biomeRecommended.ts) | `biomeRecommendedFrom`, `biomeRecommended` |
-| [rules/suppressions/directives.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/directives.ts) | `SUPPRESSIONS`, `suppressionIn` |
-| [rules/suppressions/noDoubleCast.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/noDoubleCast.ts) | `noDoubleCast` |
-| [rules/suppressions/noInline.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/noInline.ts) | `noInline` |
-| [rules/suppressions/noIgnoreDeprecations.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/noIgnoreDeprecations.ts) | `noIgnoreDeprecations` |
-| [rules/suppressions/stylesheetComments.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/stylesheetComments.ts) | `STYLESHEET`, `stylesheetComments` |
-
-## rules/suppressions/biome
-
-| Module | Exported names |
-| --- | --- |
-| [rules/suppressions/biome/ConsumerDeclaration.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/ConsumerDeclaration.ts) | `ConsumerDeclaration` |
-| [rules/suppressions/biome/configs.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/configs.ts) | `Preset`, `Layer`, `Chain`, `BiomeConfigs`, `biomeConfigs` |
-| [rules/suppressions/biome/declarations.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/declarations.ts) | `Declaration`, `PRESET_DECLARATIONS`, `decodeShipped`, `Scoped`, `matches`, `scoped`, `scopeText` |
-| [rules/suppressions/biome/json.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/json.ts) | `Json`, `Parsed`, `parseJsonc`, `member`, `entriesOf`, `itemsOf`, `textOf`, `isFalse` |
-| [rules/suppressions/biome/resolve.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/resolve.ts) | `resolvePackage` |
-| [rules/suppressions/biome/weakenings.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/suppressions/biome/weakenings.ts) | `Weakening`, `weakeningsOf` |
-
-## rules/test-names
-
-| Module | Exported names |
-| --- | --- |
-| [rules/test-names/colocated.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/test-names/colocated.ts) | `testsColocated` |
-| [rules/test-names/follow.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/test-names/follow.ts) | `testsFollow` |
-| [rules/test-names/usesDom.ts](https://github.com/ShivaeDev/platform/blob/main/packages/quality/src/rules/test-names/usesDom.ts) | `usesDom` |
-
-## Preset assets
-
-| Package path | File |
-| --- | --- |
-| `@shivaedev/quality/biome` | `biome/preset.json` |
-| `@shivaedev/quality/tsconfig/base.json` | `tsconfig/base.json` |
-| `@shivaedev/quality/tsconfig/package.json` | `tsconfig/package.json` |
-| `@shivaedev/quality/package.json` | Package metadata |
-
-The [shared tooling guide](./tooling.md) explains how to use the presets.

package/docs/naming.md

@@ -1,130 +0,0 @@
-# Naming and test layout
-
-A name says what a thing is. The rules below give identifiers, files, folders and tests a common shape, so a reader can find the defining module and recognize test code. For the gate's workflow, see the [README](../README.md).
-
-A name says what a thing is, and the same kind of thing is named the same way everywhere. Every naming rule is an error without an autofix: nothing renames code or adds a `_` prefix. The message says what is wrong and which shapes are valid, and the author picks the name. Unused variables and parameters stay TypeScript errors; remove them instead of prefixing them.
-
-### Identifiers
-
-| What | Valid shape | Checked by |
-| --- | --- | --- |
-| Variables, functions and parameters | camelCase: `itemCount`, `loadItem`. A component or a class is PascalCase. | `useNamingConvention` |
-| Acronyms | Spelled as a word: `HttpClient`, `userId`, `parseUrl`. Never `HTTPClient`, `userID` or `parseURL`. | `useNamingConvention` with `strictCase` |
-| Types, interfaces, classes and enums | PascalCase, without an `I` prefix: `Item`, not `IItem`. | `useNamingConvention` |
-| Type parameters | `T`, or `T` followed by a PascalCase name: `TItem`, `TResult`. Effect's positional `A`, `E` and `R` are valid as they are. | `useNamingConvention` |
-| Module-level constants | A string or number literal at module level is CONSTANT_CASE: `const MAX_ITEMS = 50`. A constant inside a function is camelCase. | `constant-names` plugin, `useNamingConvention` |
-| Object keys and type properties | camelCase or PascalCase, after any leading `_` or `$` (`_tag`, `$transaction`), also in a `Record`. A quoted key is a [foreign name](./naming.md#foreign-names) and is not checked. | `key-names` plugin |
-| Schemas | PascalCase and named like their type: `const Item = Schema.Struct(...)` with `type Item = typeof Item.Type`. | `schema-names` plugin |
-| `Schema.Struct` fields | camelCase, also when quoted. Outside data keeps its keys only at the edge: `Schema.Struct({ createdAt: Schema.String }).pipe(Schema.encodeKeys({ createdAt: "created_at" }))`. | `schema-struct-keys` plugin, `key-names` plugin |
-| `Effect.fn` spans | `"Owner.operation"`, where the owner is the service or module and the operation is the name the function is bound to: `const loadItem = Effect.fn("ItemStore.loadItem")`, and `loadItem: Effect.fn("ItemStore.loadItem")` in an object. | `effect-fn-spans` plugin |
-| `Effect.gen` functions | A top-level function whose whole body is `Effect.gen` is an `Effect.fn`: `const loadItem = Effect.fn("ItemStore.loadItem")(function* (id: string) { … })`, or `Effect.fnUntraced` when it needs no span. | `effect-fn-functions` plugin |
-| Effect test bodies | In test code, a test takes the generator itself: `it.effect("loads the item", function* () { … })`, never `() => Effect.gen(function* () { … })`. The test helper runs it with `Effect.gen`. | `effect-test-bodies` plugin |
-| Service Layers | A static `layer` on the service, read as `ItemStore.layer`. No exported `ItemStoreLive` or `ItemStoreLayer` constant. A Layer that wires an application together stays unexported. | `service-layers` plugin |
-| Private members | A `#field`. No `private`, `protected` or `public` modifier. | `useConsistentMemberAccessibility` |
-| React | A function passed to an `onX` prop is `handleX`, an `onX` prop forwarded as it is, or a state setter passed as it is: `onOpenChange={setOpen}`. A context is `ThemeContext`, a ref `inputRef`, an id `fieldId`. A module that exports a component exports only components; a test may define the components it renders. | `handler-names` plugin, `useReactNamingConvention`, `useComponentExportOnlyModules` |
-| Booleans | A question: `isOpen`, `hasSave`, `canRetry`, `shouldFlush`. A name the DOM or React gives, such as `open` or `disabled`, stays. This is a convention only; no rule checks it. | Review |
-
-### Foreign names
-
-Some names are not ours to choose: a query parameter an outside API reads, an environment variable, an operator a query builder takes. Write such a name as a quoted key, and the naming rules skip it:
-
-```ts
-const query = { "per_page": 50, "sort_by": "created" };
-const env = { "DATABASE_URL": url };
-const where = { "OR": [{ id }, { slug }] };
-```
-
-An unquoted key is our own name and is camelCase or PascalCase. The formatter keeps the quotes as written, so a quoted key stays quoted. A `Schema.Struct` field is the exception: the struct is our model of the data, so the `schema-struct-keys` plugin reports a snake_case field even when it is quoted, and points to `Schema.encodeKeys`, which maps camelCase fields to the outside names at the edge.
-
-### Re-exports
-
-No file re-exports, package entry files included: every module is imported from the file that defines it. `noBarrelFile` reports `export { … } from`, `noReExportAll` reports `export *`, the `type-re-exports` plugin reports `export type … from`, and `noExportedImports` reports an import that is exported again. Its message suggests `export … from`, which is a re-export as well: import the name where it is used instead.
-
-The plugins report under the one Biome category `plugin`, so their findings share the baseline rule `biome/plugin`.
-
-### Files
-
-`files/named-after-export` names a code file after its main export, and the folders above it are the prefix. The export takes the words of the file name, in order, and may add words of its folders around them, in any order and in singular or plural. Folders count from the package root, without a leading `src`; the package name does not count. The file's first letter follows the export's case.
-
-| File | Exports | Valid |
-| --- | --- | --- |
-| `routers/items/list.ts` | `listItems` or `itemList` | Yes |
-| `routers/items/Create.ts` | `CreateItemRouter` | Yes |
-| `item/Panel.tsx` or `ItemPanel.tsx` | `ItemPanel`, with `ItemPanelProps` beside it | Yes |
-| `Panel/Panel.tsx` | `Panel`: the main file of a module folder repeats the folder | Yes |
-| `limits.ts` | `MAX_ITEMS` and `MAX_DEPTH`: a topic file of several exports is camelCase | Yes |
-| `ItemPanel.tsx` | `export default memo(ItemPanel)`: a default export counts under the name it resolves to | Yes |
-| `setupTests.ts` | Nothing, so it is camelCase | Yes |
-| `script/build-docs.ts` | Run by a `package.json` script or `bin`, or starts with `#!`, so it is kebab-case | Yes |
-| `order.ts` | `type Order` | No: the file's case follows the export, so it is `Order.ts` |
-| `maxItems.ts` | `MAX_ITEMS` alone | No: constants live in a topic file with related constants |
-| `items/listItems.ts` | `listItems` | No: the folder is the prefix, so it is `items/list.ts` |
-
-Test files are left to the test rules. The `toolOwned` option lists `.gitignore` patterns of files whose names a tool fixes, `*.config.*`, declaration files and `.railway/railway.ts` (also `.py` and `.go`) by default. The Railway paths apply at any project root; other files in `.railway/` still follow the naming rules. The shared Biome preset also permits default exports in these config paths.
-
-### Folders
-
-`files/folder-names` checks every folder above a checked file.
-
-- A module folder takes the name of its main file, inside it or beside it: `Panel/` with `Panel/Panel.tsx`, or `Dialog/` beside `Dialog.tsx`. A PascalCase folder without that file is a finding.
-- A package folder is its package name without the scope, so `@acme/ui-kit` lives in `ui-kit/`.
-- A folder that only groups files is kebab-case: `test-support/`, `.github/`.
-- A folder the `content` option lists is snake_case: `forest_path/`.
-
-The `toolOwned` option lists folders a tool names, `migrations/` by default. Authored files under `generated/` follow the same naming checks as other source; ignored, untracked output stays outside discovery.
-
-### Other files
-
-`files/other-names` names the files that are not code.
-
-- Markdown, JSON, GritQL, images, fonts and SVG are kebab-case, with optional dotted parts: `release-notes.md`, `icons.sprite.svg`. Conventional upper-case names stay: `README.md`, `CHANGELOG.md`, `LICENSE`, `AGENTS.md`, `CLAUDE.md`, `CONTRIBUTING.md`, `SECURITY.md` and `SKILL.md`.
-- A stylesheet that one component imports is named after it: `ItemPanel.css` beside `ItemPanel.tsx`. A shared stylesheet is kebab-case: `form-controls.css`. An import is a static `import` in a code file, relative or through a `#` alias from the `imports` of its `package.json`, or an `@import` in a stylesheet; a stylesheet that another stylesheet imports is shared. A path in a string, such as a test that reads the file, is not an import.
-- A Prisma schema is camelCase: `schema.prisma`.
-- A file the `content` option lists is snake_case: `forest_path.json`. A double underscore separates the parts of an id: `forest_path__clearing.json`.
-
-The `toolOwned` option lists files a tool names: dotfiles, `package.json`, `tsconfig*.json`, `biome.json`, `*.config.*` and `migrations/` by default.
-
-### Case
-
-`files/distinct-case` keeps every path apart on a case-insensitive filesystem, such as macOS or Windows. Two files or folders in one folder must differ by more than case, and so must the files a build makes of them: `ReadingHistory.tsx` and `readingHistory.ts` both build to `readingHistory.js`, so they are a finding. A folder pair is one finding, not one per file inside it.
-
-### Tests
-
-A test sits beside the code it covers, and its name says what it covers and where it runs.
-
-| File | Covers | Valid |
-| --- | --- | --- |
-| `cart/cart.test.ts` | `cart/cart.ts` | Yes |
-| `cart/cart.typecheck.test.ts` | The types of `cart/cart.ts`, checked by the compiler | Yes |
-| `cart/Basket.dom.test.tsx` | `cart/Basket.tsx`, in a DOM | Yes |
-| `cart/checkoutFlow.spec.ts` | A behaviour of the `cart/` folder as a whole, such as a flow across several files | Yes |
-| `cart/checkoutFlow.dom.spec.tsx` | The same, in a DOM | Yes |
-| `cart/checkoutFlow.typecheck.spec.ts` | The types of that behaviour, checked by the compiler | Yes |
-| `cart/totals.test.ts` | No `cart/totals.ts` beside it | No: a `.test` follows a file, and a test of the folder is a `.spec` |
-| `cart/cart.spec.ts` | | No: a `.spec` names a behaviour, so it may not share a stem with a file beside it |
-| `cart/cart.hydration.test.ts` | | No: an aspect gets its own file in the module's folder, or a `.spec` |
-| `cart/cart.postgres.test.ts` | | No: a database or a running app comes from the app's test fixture, not a file name |
-| `test/cart.test.ts` | | No: a test folder mirrors the source tree; the test sits beside `cart.ts` |
-
-`tests/follow` checks the name: `<file>[.<environment>].test.ts` beside its file, or `<behaviour>[.<environment>].spec.ts` in camelCase in the folder it covers. The environment is at most one of `dom`, `slow` and `typecheck`; [Vitest projects](./tooling.md#vitest-projects) run the runtime tests, and the compiler checks `.typecheck` files. For runtime tests, the rule requires `.dom` when it sees a static `@testing-library/*` import or dotted `document`/`window` member access. It does not track aliases, destructuring or computed access.
-
-`tests/colocated` checks the place: a test in a `test`, `tests`, `__tests__` or `spec` folder is a finding.
-
-Both rules take a `suites` option, `.gitignore` patterns of folders that hold tests with their own layout, such as tests across several packages or a Playwright suite, whose `.spec.ts` files mean something else. The rules skip those folders.
-
-### Test code
-
-Test code is a test file (`*.test.ts` or `*.spec.ts`, with any environment), or any file under a folder named `test-support/`. `test-support/` is the folder for fixtures, harnesses and generated clients that tests share. `imports/fences` never holds test code, and `structure/max-lines` gives it the test limit. `imports/no-test-code` prevents production modules from importing test code; put code they share in a production module.
-
-Name shared helpers without a `.test` or `.spec` suffix. `tests/follow` and `tests/colocated` use those suffixes to identify test files; the folder name alone does not make them skip a test-named file. `tests/story-setup` skips every file under `test-support/`, including a test-named file there.
-
-### Story tests
-
-Keep recurring setup in a domain kit under `test-support/`; the [test-story README](https://github.com/ShivaeDev/platform/tree/main/packages/test-story#readme) explains traits, verbs and a kit's `it`. Quality checks the setup patterns below; it does not establish which engine a test runs.
-
-`tests/story-setup` reports, in a test file:
-
-- A top-level function whose name starts with the word `seed`, `make`, `build` or `setup`, declared as a function or a variable holding an arrow function or function expression. The prefix is a whole word, so `builder` and `settings` pass. Nested helpers and declarations without a body are outside this check.
-- A call that writes fixture files through Node's `fs` or `fs/promises`: `writeFile`, `appendFile`, `mkdir`, `mkdtemp`, `copyFile`, `cp` and `symlink`, including their sync forms. Named, renamed, namespace, default and `promises` imports are checked.
-
-Each finding names its line and uses the helper or called function as its subject. The message asks for setup as traits of the kit and links to the README's story-test guidance. The rule reports without rewriting a test. Record existing findings with `quality baseline write --rule tests/story-setup` when adopting it.