@noctcore/eslint-plugin-contracts 0.7.0 → 0.7.1

package/README.md

@@ -1,36 +1,73 @@
 # @noctcore/eslint-plugin-contracts
 
-Rules for shared **contract** conventions — zod schema naming, wire-message discriminants, error
-stringification, direct `process.env` access, and money precision. Flat-config only, ESLint 9+.
+Rules for shared **contract** conventions: zod schema naming, wire-message discriminants, error
+stringification, direct `process.env` access and money precision, where drift between producer and
+consumer breaks at runtime.
+
+**Docs:** [noctcore.github.io/eslint-plugins/packages/contracts](https://noctcore.github.io/eslint-plugins/packages/contracts/)
+
+Not a good fit for a codebase that does not use zod, or whose error handling is intentionally
+untyped.
+
+## Requirements
+
+- ESLint 9 or newer, flat config (`eslint.config.js`) only.
+- `configs.recommended` registers the plugin and sets rule severities, nothing else. It sets no
+  `files` and no parser, so it applies to whatever files the rest of your config lints. To lint
+  TypeScript, add a `files` pattern and `@typescript-eslint/parser`, as in the quick start.
 
 ## Install
 
 ```sh
-bun add -D @noctcore/eslint-plugin-contracts   # or npm i -D / pnpm add -D
+bun add -D @noctcore/eslint-plugin-contracts @typescript-eslint/parser   # or npm i -D / pnpm add -D
 ```
 
-## Use
+## Quick start
 
 ```js
 // eslint.config.js
+import tsParser from '@typescript-eslint/parser';
 import contracts from '@noctcore/eslint-plugin-contracts';
 
 export default [
-  contracts.configs.recommended,
+  {
+    ...contracts.configs.recommended,
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: { parser: tsParser },
+  },
+  // Optional: tune a preset rule's options.
+  {
+    files: ['**/*.{ts,tsx}'],
+    rules: {
+      'noctcore-contracts/zod-schema-naming': ['error', { roleSuffixes: ['Event', 'Command', 'Query'] }],
+      'noctcore-contracts/no-direct-process-env': ['error', { configModule: '@acme/config' }],
+    },
+  },
 ];
 ```
 
-Or wire rules individually:
+## Opt-in rules
 
-```js
-import contracts from '@noctcore/eslint-plugin-contracts';
+Four rules ship `off`: `require-registered-keys`, `env-var-schema-parity` and
+`translation-key-exists` do nothing until their `sinks` / `schema` / `catalogs` options are set, and
+`require-schema-parse-at-boundary` is a conservative syntactic slice of a type-aware concern.
 
+```js
+// eslint.config.js
 export default [
+  // ...the quick start's entries, then:
   {
-    plugins: { 'noctcore-contracts': contracts },
+    files: ['**/*.{ts,tsx}'],
+    languageOptions: { parser: tsParser },
     rules: {
-      'noctcore-contracts/zod-schema-naming': ['error', { roleSuffixes: ['Event', 'Command', 'Query'] }],
-      'noctcore-contracts/no-direct-process-env': ['error', { configModule: '@acme/config' }],
+      'noctcore-contracts/require-registered-keys': ['error', {
+        sinks: [{ callee: 'localStorage.getItem', argIndex: 0 }],
+      }],
+      'noctcore-contracts/env-var-schema-parity': ['error', { schema: '.env.example' }],
+      'noctcore-contracts/translation-key-exists': ['error', {
+        catalogs: [{ file: 'locales/en/common.json', namespace: 'common' }],
+      }],
+      'noctcore-contracts/require-schema-parse-at-boundary': 'error',
     },
   },
 ];
@@ -38,24 +75,29 @@ export default [
 
 ## Rules
 
-Legend: 🔧 = autofixable · 💤 = ships inert / `off` in `recommended` (enable + configure explicitly).
-
-| Rule | Description | 🔧 | 💤 |
-| --- | --- | --- | --- |
-| [`zod-schema-naming`](./docs/rules/zod-schema-naming.md) | Exported zod schema must be a PascalCase `*Schema` const with a sibling `z.infer` type. | | |
-| [`wire-message-naming`](./docs/rules/wire-message-naming.md) | A role-suffixed schema's `type: z.literal(...)` must be kebab-case of its name minus the suffix. | 🔧 | |
-| [`no-error-stringify`](./docs/rules/no-error-stringify.md) | Ban `${error}` / `error.toString()` / `error + ""` — they drop the cause chain. | | |
-| [`no-direct-process-env`](./docs/rules/no-direct-process-env.md) | Ban direct `process.env`; require a typed config accessor. | | |
-| [`money-must-be-decimal`](./docs/rules/money-must-be-decimal.md) | Money-named fields typed `: number` are banned; require a Decimal money type. | | |
-| [`require-error-cause`](./docs/rules/require-error-cause.md) | Re-throwing a new error inside `catch` must forward the caught error as `{ cause }`. | 🔧 | |
-| [`restrict-throw-to-taxonomy`](./docs/rules/restrict-throw-to-taxonomy.md) | `throw` only allowlisted error classes; ban throwing non-Error values. | | |
-| [`require-registered-keys`](./docs/rules/require-registered-keys.md) | Key/name argument of a configured sink API must be an imported constant, not a raw string. | | 💤 |
-| [`env-var-schema-parity`](./docs/rules/env-var-schema-parity.md) | `process.env.FOO` / `import.meta.env.FOO` keys must be declared in a schema file. | | 💤 |
-| [`require-schema-parse-at-boundary`](./docs/rules/require-schema-parse-at-boundary.md) | Ban `as T` on boundary reads (`JSON.parse`, `res.json()`, web storage, search params, message events, LLM tool input), directly or through a `const`; parse at runtime. | | 💤 |
-| [`schema-enum-field-consistency`](./docs/rules/schema-enum-field-consistency.md) | A field that is an enum in one zod object schema must not be `z.string()` in another schema of the same module. | | |
-| [`fetch-must-check-ok`](./docs/rules/fetch-must-check-ok.md) | A fetch response must be checked with `.ok` or a status comparison before `.json()` parses its body. | | |
-| [`translation-key-exists`](./docs/rules/translation-key-exists.md) | A static i18next / react-i18next key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) must exist in the catalog of the namespace in scope. | | 💤 |
-
-The 💤 rules ship `off` in `recommended`: `require-registered-keys`, `env-var-schema-parity` and
-`translation-key-exists` do nothing until their `sinks` / `schema` / `catalogs` options are set, and `require-schema-parse-at-boundary` is a
-conservative syntactic slice of a type-aware concern. Turn them on explicitly once configured.
+<!-- begin generated rules -->
+<!-- Generated by `bun run docs:readmes` from each rule's meta. Do not edit by hand. -->
+
+✅ in `recommended` (error) · ⚙️ needs options · 🔧 `--fix` · 💡 suggestions · 💭 needs type info · ❌ deprecated
+
+| Rule | Description | ✅ | ⚙️ | 🔧 | 💡 | 💭 |
+| --- | --- | :-: | :-: | :-: | :-: | :-: |
+| [`env-var-schema-parity`](https://noctcore.github.io/eslint-plugins/rules/contracts/env-var-schema-parity/) | Require every `process.env.FOO` / `import.meta.env.FOO` key to be declared in a schema file (`.env.example` or a zod-env module), so config access and config declaration cannot drift apart. |  | ⚙️ |  |  |  |
+| [`fetch-must-check-ok`](https://noctcore.github.io/eslint-plugins/rules/contracts/fetch-must-check-ok/) | Require a fetch response to be checked with `.ok` or a status comparison before `.json()` parses its body. | ✅ |  |  |  |  |
+| [`money-must-be-decimal`](https://noctcore.github.io/eslint-plugins/rules/contracts/money-must-be-decimal/) | Disallow monetary values typed as the JS primitive `number`. Money-named fields explicitly typed `: number` lose precision to float rounding; use a Decimal money type instead. | ✅ |  |  |  |  |
+| [`no-direct-process-env`](https://noctcore.github.io/eslint-plugins/rules/contracts/no-direct-process-env/) | Disallow direct `process.env` access. Force every consumer through a typed, validated config accessor so a missing variable fails at boot, not at use. | ✅ |  |  |  |  |
+| [`no-error-stringify`](https://noctcore.github.io/eslint-plugins/rules/contracts/no-error-stringify/) | Disallow stringifying an error with bare `${error}` interpolation, `error.toString()`, or `error + ""`. These drop the cause chain. Use `error instanceof Error ? error.message : String(error)` instead. | ✅ |  |  |  |  |
+| [`require-error-cause`](https://noctcore.github.io/eslint-plugins/rules/contracts/require-error-cause/) | Require re-thrown errors inside a `catch` to forward the caught error as `{ cause }`. A `throw new SomeError(...)` that omits the cause severs the chain to the original failure. | ✅ |  | 🔧 |  |  |
+| [`require-registered-keys`](https://noctcore.github.io/eslint-plugins/rules/contracts/require-registered-keys/) | Require the key/name argument of configured sink APIs (storage, event channels, cache keys) to be an imported constant from a registry module, not a raw string literal. |  | ⚙️ |  |  |  |
+| [`require-schema-parse-at-boundary`](https://noctcore.github.io/eslint-plugins/rules/contracts/require-schema-parse-at-boundary/) | Disallow asserting external boundary data with `as T` instead of parsing it at runtime. Flags casts of `JSON.parse`, `res.json()`, web storage, URL search params, message-event data and LLM tool input, directly or through a `const`; use a zod/valibot parse. |  |  |  |  |  |
+| [`restrict-throw-to-taxonomy`](https://noctcore.github.io/eslint-plugins/rules/contracts/restrict-throw-to-taxonomy/) | Restrict `throw` to an approved error taxonomy. Flags throwing a non-allowlisted error class and throwing a non-Error value (string, object, number, ...). | ✅ |  |  |  |  |
+| [`schema-enum-field-consistency`](https://noctcore.github.io/eslint-plugins/rules/contracts/schema-enum-field-consistency/) | Disallow a zod field that is an enum in one object schema of a module from being `z.string()` in another, which widens the wire type every consumer then narrows by hand. | ✅ |  |  |  |  |
+| [`translation-key-exists`](https://noctcore.github.io/eslint-plugins/rules/contracts/translation-key-exists/) | Require every static i18next / react-i18next translation key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) to exist in the catalog of the namespace in scope. |  | ⚙️ |  |  |  |
+| [`wire-message-naming`](https://noctcore.github.io/eslint-plugins/rules/contracts/wire-message-naming/) | A message-schema const ending in a role suffix (default Event/Command/Query) whose zod object declares `type: z.literal(...)` must set that literal to kebab-case(const name minus its role suffix). | ✅ |  | 🔧 |  |  |
+| [`zod-schema-naming`](https://noctcore.github.io/eslint-plugins/rules/contracts/zod-schema-naming/) | Every exported zod schema is a PascalCase const suffixed `Schema`, paired with a same-named inferred type (`export type Foo = z.infer<typeof FooSchema>`). | ✅ |  |  |  |  |
+<!-- end generated rules -->
+
+## Severity policy
+
+Every rule is `error` or `off`, never `warn`: a warning is a rule nobody obeys. See the
+[severity policy](https://noctcore.github.io/eslint-plugins/getting-started/#severity-policy).

package/dist/index.cjs

@@ -120,7 +120,8 @@ var envVarSchemaParityRule = createRule({
   meta: {
     type: "suggestion",
     docs: {
-      description: "Require every `process.env.FOO` / `import.meta.env.FOO` key to be declared in a schema file (`.env.example` or a zod-env module), so config access and config declaration cannot drift apart."
+      description: "Require every `process.env.FOO` / `import.meta.env.FOO` key to be declared in a schema file (`.env.example` or a zod-env module), so config access and config declaration cannot drift apart.",
+      requiresOptions: true
     },
     schema: [optionSchema],
     messages: {
@@ -1087,7 +1088,8 @@ var requireRegisteredKeysRule = createRule({
   meta: {
     type: "suggestion",
     docs: {
-      description: "Require the key/name argument of configured sink APIs (storage, event channels, cache keys) to be an imported constant from a registry module, not a raw string literal."
+      description: "Require the key/name argument of configured sink APIs (storage, event channels, cache keys) to be an imported constant from a registry module, not a raw string literal.",
+      requiresOptions: true
     },
     schema: [optionSchema6],
     messages: {
@@ -2312,7 +2314,8 @@ var translationKeyExistsRule = createRule({
   meta: {
     type: "problem",
     docs: {
-      description: "Require every static i18next / react-i18next translation key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) to exist in the catalog of the namespace in scope."
+      description: "Require every static i18next / react-i18next translation key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) to exist in the catalog of the namespace in scope.",
+      requiresOptions: true
     },
     schema: [optionSchema10],
     messages: {
@@ -2599,7 +2602,7 @@ var rules = {
 
 // src/index.ts
 var NAMESPACE = "noctcore-contracts";
-var VERSION = "0.7.0";
+var VERSION = "0.7.1";
 var plugin = {
   meta: { name: "@noctcore/eslint-plugin-contracts", version: VERSION },
   rules,

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
+import * as _noctcore_eslint_utils from '@noctcore/eslint-utils';
 import { TSESTree, TSESLint } from '@typescript-eslint/utils';
 
 interface FetchMustCheckOkOptions {
@@ -256,43 +257,43 @@ declare function translationSettingsOf(options: TranslationKeyExistsOptions): Tr
 
 /** Every rule this plugin exposes, keyed by its (unprefixed) rule id. */
 declare const rules: {
-    'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
 };
@@ -303,43 +304,43 @@ declare const plugin: {
         version: string;
     };
     rules: {
-        'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
     };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as _typescript_eslint_utils_ts_eslint from '@typescript-eslint/utils/ts-eslint';
+import * as _noctcore_eslint_utils from '@noctcore/eslint-utils';
 import { TSESTree, TSESLint } from '@typescript-eslint/utils';
 
 interface FetchMustCheckOkOptions {
@@ -256,43 +257,43 @@ declare function translationSettingsOf(options: TranslationKeyExistsOptions): Tr
 
 /** Every rule this plugin exposes, keyed by its (unprefixed) rule id. */
 declare const rules: {
-    'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
-    'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+    'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
         name: string;
     };
 };
@@ -303,43 +304,43 @@ declare const plugin: {
         version: string;
     };
     rules: {
-        'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'zod-schema-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"schemaNaming" | "missingType", [ZodSchemaNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'wire-message-naming': _typescript_eslint_utils_ts_eslint.RuleModule<"typeMismatch", [WireMessageNamingOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'no-error-stringify': _typescript_eslint_utils_ts_eslint.RuleModule<"noErrorStringify", [NoErrorStringifyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'no-direct-process-env': _typescript_eslint_utils_ts_eslint.RuleModule<"directProcessEnv", [NoDirectProcessEnvOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'money-must-be-decimal': _typescript_eslint_utils_ts_eslint.RuleModule<"moneyMustBeDecimal", [MoneyMustBeDecimalOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-error-cause': _typescript_eslint_utils_ts_eslint.RuleModule<"missingCause", [], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'restrict-throw-to-taxonomy': _typescript_eslint_utils_ts_eslint.RuleModule<"disallowedErrorClass" | "nonErrorThrow", [RestrictThrowToTaxonomyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-registered-keys': _typescript_eslint_utils_ts_eslint.RuleModule<"unregisteredKey", [RequireRegisteredKeysOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'env-var-schema-parity': _typescript_eslint_utils_ts_eslint.RuleModule<"undeclaredEnvVar", [EnvVarSchemaParityOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'require-schema-parse-at-boundary': _typescript_eslint_utils_ts_eslint.RuleModule<"castedBoundaryData", [RequireSchemaParseAtBoundaryOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'schema-enum-field-consistency': _typescript_eslint_utils_ts_eslint.RuleModule<"widenedEnumField", [SchemaEnumFieldConsistencyOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'fetch-must-check-ok': _typescript_eslint_utils_ts_eslint.RuleModule<"missingOkCheck", [FetchMustCheckOkOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
-        'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], unknown, _typescript_eslint_utils_ts_eslint.RuleListener> & {
+        'translation-key-exists': _typescript_eslint_utils_ts_eslint.RuleModule<"missingKey" | "missingKeyPrefix" | "unknownNamespace" | "catalogUnreadable", [TranslationKeyExistsOptions], _noctcore_eslint_utils.NoctcoreRuleDocs, _typescript_eslint_utils_ts_eslint.RuleListener> & {
             name: string;
         };
     };

package/dist/index.js

@@ -76,7 +76,8 @@ var envVarSchemaParityRule = createRule({
   meta: {
     type: "suggestion",
     docs: {
-      description: "Require every `process.env.FOO` / `import.meta.env.FOO` key to be declared in a schema file (`.env.example` or a zod-env module), so config access and config declaration cannot drift apart."
+      description: "Require every `process.env.FOO` / `import.meta.env.FOO` key to be declared in a schema file (`.env.example` or a zod-env module), so config access and config declaration cannot drift apart.",
+      requiresOptions: true
     },
     schema: [optionSchema],
     messages: {
@@ -1043,7 +1044,8 @@ var requireRegisteredKeysRule = createRule({
   meta: {
     type: "suggestion",
     docs: {
-      description: "Require the key/name argument of configured sink APIs (storage, event channels, cache keys) to be an imported constant from a registry module, not a raw string literal."
+      description: "Require the key/name argument of configured sink APIs (storage, event channels, cache keys) to be an imported constant from a registry module, not a raw string literal.",
+      requiresOptions: true
     },
     schema: [optionSchema6],
     messages: {
@@ -2268,7 +2270,8 @@ var translationKeyExistsRule = createRule({
   meta: {
     type: "problem",
     docs: {
-      description: "Require every static i18next / react-i18next translation key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) to exist in the catalog of the namespace in scope."
+      description: "Require every static i18next / react-i18next translation key (`t(...)`, `i18n.t(...)`, `<Trans i18nKey>`) to exist in the catalog of the namespace in scope.",
+      requiresOptions: true
     },
     schema: [optionSchema10],
     messages: {
@@ -2555,7 +2558,7 @@ var rules = {
 
 // src/index.ts
 var NAMESPACE = "noctcore-contracts";
-var VERSION = "0.7.0";
+var VERSION = "0.7.1";
 var plugin = {
   meta: { name: "@noctcore/eslint-plugin-contracts", version: VERSION },
   rules,

package/docs/rules/env-var-schema-parity.md

@@ -2,6 +2,10 @@
 
 > Every `process.env.FOO` / `import.meta.env.FOO` key must be declared in a schema file.
 
+<!-- begin generated rule header -->
+⚙️ Opt-in: `off` in `recommended`; needs options (see Options) · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 An env var that is read in code but declared nowhere is config drift waiting to fail in production:
@@ -27,8 +31,12 @@ const url = process.env.DATABASE_URL;
 const port = import.meta.env.PORT;
 ```
 
-Only static accesses are policed. Computed (`process.env[dynamic]`) and destructured reads are left
-alone.
+## What it does not flag
+
+- Computed reads such as `process.env[dynamicKey]`: only static `.FOO` accesses are policed.
+- Destructured reads (`const { FOO } = process.env`).
+- Anything at all when `schema` is unset, or when the schema file cannot be read: the rule goes inert
+  rather than flagging every access.
 
 ## Options
 

package/docs/rules/fetch-must-check-ok.md

@@ -2,7 +2,9 @@
 
 > A fetch response must be checked with `.ok` or a status comparison before `.json()` parses its body.
 
-Ported from tsforge's `typescript-core/fetch-must-check-ok` (MIT).
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
 
 ## Why
 
@@ -85,6 +87,13 @@ Three response shapes are tracked: `const res = await fetch(...)` then `res.json
 Aliases work (`const ok = res.ok; if (!ok) throw ...`). A bare `if (res.status)` or
 `typeof res.status === 'number'` is not a check: both are true for a 500.
 
+## What it does not flag
+
+Purely syntactic, no type information. A response assigned later (`let res; res = await fetch(...)`),
+passed to another function, or returned from a wrapper that is not in `fetchFunctions` is not tracked.
+A nested function that reuses the response's name is treated as the same binding. Clients whose
+`.json()` already throws on a bad status (ky, for example) do not belong in `fetchFunctions`.
+
 ## Options
 
 | Option | Type | Default | Meaning |
@@ -99,9 +108,12 @@ List every name you want tracked, including `fetch` itself:
 }]
 ```
 
-## Limits
+## When not to use it
 
-Purely syntactic, no type information. A response assigned later (`let res; res = await fetch(...)`),
-passed to another function, or returned from a wrapper that is not in `fetchFunctions` is not tracked.
-A nested function that reuses the response's name is treated as the same binding. Clients whose
-`.json()` already throws on a bad status (ky, for example) do not belong in `fetchFunctions`.
+Leave it off if your code never reads a raw `Response`, for example when every request goes through a
+client whose `.json()` already throws on a bad status.
+
+## Credits
+
+Based on the `typescript-core/fetch-must-check-ok` rule from
+[tsforge](https://github.com/boringstack-xyz/tsforge) (MIT).

package/docs/rules/money-must-be-decimal.md

@@ -2,6 +2,10 @@
 
 > Monetary fields typed as the JS `number` primitive lose precision to float rounding — use a Decimal money type.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 Money stored as a JS `number` accumulates IEEE-754 rounding errors (`0.1 + 0.2 !== 0.3`), which is
@@ -16,10 +20,6 @@ positions that carry real precision risk:
 - class properties — `class Invoice { total: number }`
 - annotated variable declarators — `const amount: number = …`
 
-Conservative on purpose. Untyped declarations and numeric-literal initializers (`let total = 0`) are
-**not** flagged — those are usually counters/accumulators. Interface and type-literal members
-(`{ amount: number }`) are **out of scope** so non-money type members do not regress.
-
 ```ts bad reports=2
 class Invoice { total: number; }
 const amount: number = 5;
@@ -31,6 +31,15 @@ const count: number = 3;          // not a money name
 interface Payment { amount: number; }   // type member, out of scope
 ```
 
+## What it does not flag
+
+Conservative on purpose. Untyped declarations and numeric-literal initializers (`let total = 0`) are
+**not** flagged — those are usually counters/accumulators. Interface and type-literal members
+(`{ amount: number }`) are **out of scope** so non-money type members do not regress.
+
+- Object-literal properties (`const x = { total: 5 }`).
+- Fields matching `minorUnitPatterns`, and every field in a file listed in `allowedFiles`.
+
 ## Options
 
 | Option | Type | Default | Meaning |
@@ -47,7 +56,7 @@ interface Payment { amount: number; }   // type member, out of scope
 }]
 ```
 
-## Talking to a payment API
+### Talking to a payment API
 
 Stripe and most payment APIs deal in integer minor units: `amount` is a number of cents, and that
 is correct at that boundary. Without `minorUnitPatterns` this rule flags every one of those

package/docs/rules/no-direct-process-env.md

@@ -2,6 +2,10 @@
 
 > Read environment variables through a typed, validated config accessor — never `process.env` directly.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 `process.env.X` is `string | undefined`, unvalidated, and reachable from anywhere. A typo or a missing
@@ -27,8 +31,12 @@ import { config } from '@/config';
 const isProd = config.isProduction;
 ```
 
-Files matched by the `allowedFiles` glob allowlist are skipped entirely, so bootstrap entrypoints,
-config files, and tests may still read `process.env` directly.
+## What it does not flag
+
+- Files matched by the `allowedFiles` glob allowlist are skipped entirely, so bootstrap entrypoints,
+  config files, and tests may still read `process.env` directly.
+- `import.meta.env` reads and other `process` properties (`process.environment`, `process.argv`):
+  only `process.env` itself is policed.
 
 ```ts good filename=vite.config.ts relocation
 const isProd = process.env.NODE_ENV === 'production';

package/docs/rules/no-error-stringify.md

@@ -2,6 +2,10 @@
 
 > Stringifying an error with `${error}`, `error.toString()`, or `error + ""` drops its cause chain.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 `` `${error}` ``, `error.toString()`, and `error + ""` all coerce an `Error` to its `message` alone,
@@ -31,6 +35,12 @@ const msg = error instanceof Error ? error.message : String(error);
 const m = `${error.message}`;
 ```
 
+## What it does not flag
+
+- Bare `String(error)`, which the guarded extractor idiom relies on.
+- Member reads such as `` `${error.message}` `` or `error.stack`.
+- `x + ""` where `x` is not one of `errorIdentifierNames` (`count + ""`).
+
 ## Options
 
 | Option | Type | Default | Meaning |

package/docs/rules/require-error-cause.md

@@ -2,6 +2,10 @@
 
 > Re-throwing inside a `catch` without `{ cause }` severs the chain to the original error. 🔧
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 🔧 Fixable with `--fix` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 When you catch an error and throw a new one, the new error is what reaches your logger. If you do not
@@ -20,16 +24,6 @@ try {
 ## What it flags
 
 A `throw new SomeError(...)` inside a `catch` block when **no** argument carries a `cause` property.
-Deliberately conservative:
-
-- Only constructors whose simple name ends in `Error` or `Exception` are treated as errors
-  (`Error`, `TypeError`, `ValidationError`, `HttpException`). Throwing `new Response(...)` for
-  control flow is not policed.
-- Fires only when the enclosing catch binds a plain identifier (`catch (err)`). A parameterless
-  `catch {}` or a destructured binding (`catch ({ message })`) has no single name to attach, so the
-  throw is left alone.
-- Any `cause` property (whatever its value), and any spread the rule cannot see through, counts as
-  "has a cause" and suppresses the report — a hand-written cause is never second-guessed.
 
 A `throw` nested in a closure declared inside the catch is still flagged: the binding is genuinely in
 scope there. Nested `try/catch` uses the nearest binding.
@@ -47,7 +41,7 @@ try { work(); } catch (err) { throw new Error('failed', { cause: err }); }
 try { work(); } catch (err) { throw err; }
 ```
 
-## Fix
+### Fix
 
 Autofix attaches `{ cause: <binding> }`:
 
@@ -58,9 +52,19 @@ Autofix attaches `{ cause: <binding> }`:
 A zero-argument `new SomeError()` is **reported but not autofixed** — inserting an options object as
 the first argument could clobber a positional message the rule cannot see.
 
-## Options
+## What it does not flag
 
-None.
+Deliberately conservative:
+
+- Only constructors whose simple name ends in `Error` or `Exception` are treated as errors
+  (`Error`, `TypeError`, `ValidationError`, `HttpException`). Throwing `new Response(...)` for
+  control flow is not policed.
+- Fires only when the enclosing catch binds a plain identifier (`catch (err)`). A parameterless
+  `catch {}` or a destructured binding (`catch ({ message })`) has no single name to attach, so the
+  throw is left alone.
+- Any `cause` property (whatever its value), and any spread the rule cannot see through, counts as
+  "has a cause" and suppresses the report — a hand-written cause is never second-guessed.
+- A bare re-throw of the caught error (`throw err`).
 
 ## When not to use it
 

package/docs/rules/require-registered-keys.md

@@ -2,6 +2,10 @@
 
 > The key/name argument of a configured sink API must be an imported constant, not a raw string.
 
+<!-- begin generated rule header -->
+⚙️ Opt-in: `off` in `recommended`; needs options (see Options) · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 String keys threaded into sink APIs — storage slots, event channels, feature flags, query-cache keys
@@ -26,9 +30,18 @@ localStorage.getItem(USER_PROFILE_KEY);
 emitter.on(TASK_DONE, handler);
 ```
 
+## What it does not flag
+
 Only string literals are flagged. An already-imported identifier, a template literal, or any computed
 expression is left alone — those are not the raw-string smell.
 
+`callee` is matched against the call's dotted identifier path (`localStorage.getItem`, `emitter.on`).
+A callee that is computed or not a plain identifier chain (`this.emitter.on`, `obj[k].on`, `a().b`)
+cannot be matched and is skipped.
+
+Calls to callees not listed in `sinks` (`sessionStorage.getItem` when only `localStorage.getItem` is
+configured) are not policed.
+
 ## Options
 
 | Option | Type | Default | Meaning |
@@ -51,10 +64,6 @@ key sinks to hard-code, so you declare which callees matter for your project.
 }]
 ```
 
-`callee` is matched against the call's dotted identifier path (`localStorage.getItem`, `emitter.on`).
-A callee that is computed or not a plain identifier chain (`this.emitter.on`, `obj[k].on`, `a().b`)
-cannot be matched and is skipped.
-
 ## When not to use it
 
 If your keys are already constants, or you have no registry module to import from, leave `sinks` empty

package/docs/rules/require-schema-parse-at-boundary.md

@@ -2,6 +2,10 @@
 
 > Parse external boundary data at runtime — don't assert its shape with `as T`.
 
+<!-- begin generated rule header -->
+Opt-in: `off` in `recommended` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 External data — a fetch body, a `JSON.parse` result, a message-event payload — has whatever shape the
@@ -98,7 +102,7 @@ async function loadUser(res: Response) {
 }
 ```
 
-### What it leaves alone
+## What it does not flag
 
 - Casts to `unknown`, `any`, `const` or a primitive keyword (`as string | null`): the safe or
   neutral forms.
@@ -111,12 +115,15 @@ async function loadUser(res: Response) {
 
 ## Options
 
+| Option | Type | Default | Meaning |
+| --- | --- | --- | --- |
+| `boundaries` | `string[]` | `[]` | Extra callees whose result is boundary data: a bare name or a dotted path. |
+
 ```js
-{
-  // Extra callees whose result is boundary data: a bare name or a dotted path.
+'noctcore-contracts/require-schema-parse-at-boundary': ['error', {
   // `readBody(event) as T` and `(await readBody(event)) as T` are then flagged.
-  boundaries: ['readBody', 'ipcRenderer.invoke'], // default []
-}
+  boundaries: ['readBody', 'ipcRenderer.invoke'],
+}]
 ```
 
 ```ts bad options={"boundaries":["readBody"]}

package/docs/rules/restrict-throw-to-taxonomy.md

@@ -2,6 +2,10 @@
 
 > `throw` only members of your error taxonomy — never an ad hoc built-in nor a bare value.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 A codebase that throws a curated set of error types can handle them exhaustively at the boundary:
@@ -15,10 +19,6 @@ breaks that: a non-Error carries no stack and no cause, and an unclassified erro
 - `throw new SomethingError(...)` whose constructor is **not** in the `allow` list.
 - `throw <non-Error value>` — a string, number, boolean, template literal, object, or array literal.
 
-Conservative on the ambiguous forms. A bare identifier (`throw err` — the re-throw), a member
-(`throw ctx.error`), and a call (`throw makeError()`) are all left alone: a syntactic rule cannot know
-whether they resolve to an Error, and re-throwing a caught error is the most common `throw` there is.
-
 ```ts bad reports=3
 // built-in not in the taxonomy
 throw new TypeError('bad');
@@ -34,6 +34,12 @@ throw new Error('boom');
 try { work(); } catch (err) { throw err; }
 ```
 
+## What it does not flag
+
+Conservative on the ambiguous forms. A bare identifier (`throw err` — the re-throw), a member
+(`throw ctx.error`), and a call (`throw makeError()`) are all left alone: a syntactic rule cannot know
+whether they resolve to an Error, and re-throwing a caught error is the most common `throw` there is.
+
 ## Options
 
 | Option | Type | Default | Meaning |

package/docs/rules/schema-enum-field-consistency.md

@@ -3,6 +3,10 @@
 > A field that is an enum in one zod object schema must not be `z.string()` in another schema of the
 > same module.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 When schemas double as wire types (tRPC procedures, a shared contract package), the output schema is
@@ -50,6 +54,16 @@ export const ticketOutput = z.object({
 });
 ```
 
+## What it does not flag
+
+- `z.union([z.string(), z.null()])` and any `z.string()` chain with `.pipe()` or `.transform()`:
+  neither is a plain string.
+- A single `z.literal('X')`: a constant, not an enum.
+- An imported identifier, unless its name matches `enumIdentifierPattern` (see Options).
+- An enum in another file: the scope is one module.
+- Keys in `ignoreFields`, computed keys, and schemas built from a namespace not listed in
+  `zodIdentifiers`.
+
 ## Options
 
 | Option | Type | Default | Meaning |

package/docs/rules/translation-key-exists.md

@@ -2,6 +2,10 @@
 
 > Every static translation key must exist in the catalog of the namespace in scope.
 
+<!-- begin generated rule header -->
+⚙️ Opt-in: `off` in `recommended`; needs options (see Options) · 💭 Type information: used when available
+<!-- end generated rule header -->
+
 ## Why
 
 i18next does not fail on a missing key. It renders the key itself (`admin.portalAccounts.revokeTitle`)
@@ -56,7 +60,7 @@ Plural forms (`key_one`, `key_few`, `key_ordinal_other`) answer for `key` only w
 `count`, and context variants (`key_male`) only when it passes `context`, because without them
 i18next looks up the bare key and misses. A subtree or array answers only with `returnObjects`.
 
-### What it never reports
+## What it does not flag
 
 Anything it cannot resolve statically: a variable key (`t(someKey)`), a template key
 (`` t(`status.${s}`) ``), a key computed by a helper, a namespace held in an identifier it cannot
@@ -64,6 +68,15 @@ resolve (an import not listed in `namespaceIdentifiers`), an options bag it cann
 (`t('k', opts)`, `{ ...opts }`, `{ ns: someNs }`), and a `t` parameter with no `TFunction` type. The
 rule stays silent on those rather than guessing.
 
+### Dead keys are out of scope
+
+The reverse check, "a catalog key nothing uses", is not something a per-file ESLint rule can do
+soundly: it needs every source file at once, and ESLint may lint one file (editor), a subset
+(`--cache`, lint-staged), or shard files across workers. Worse, keys routinely flow as data
+(navigation tables, key-builder helpers, `` `errors:${code}` ``), which no call-site analysis
+sees. Run it as a whole-tree check instead, one that unions static keys, template-key prefixes
+and string literals that equal a key.
+
 ## Options
 
 | Option | Type | Default | Meaning |
@@ -140,15 +153,6 @@ found one real bug (`t('common.cancel')` in the default namespace, which renders
 namespace registered at runtime only inside a test (`registerFeatureNamespace('late-arrival', ...)`)
 is reported as unknown; exclude test files or add a catalog entry for it.
 
-## Dead keys are out of scope
-
-The reverse check, "a catalog key nothing uses", is not something a per-file ESLint rule can do
-soundly: it needs every source file at once, and ESLint may lint one file (editor), a subset
-(`--cache`, lint-staged), or shard files across workers. Worse, keys routinely flow as data
-(navigation tables, key-builder helpers, `` `errors:${code}` ``), which no call-site analysis
-sees. Run it as a whole-tree check instead, one that unions static keys, template-key prefixes
-and string literals that equal a key.
-
 ## When not to use it
 
 If your keys are mostly computed, or your catalogs are not JSON files on disk (fetched from a TMS at

package/docs/rules/wire-message-naming.md

@@ -2,6 +2,10 @@
 
 > A message-schema's `type` discriminant must be the kebab-case of its const name minus its role suffix. 🔧
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 🔧 Fixable with `--fix` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 When wire messages are modelled as zod objects with a `type: z.literal('…')` discriminant, the const
@@ -29,7 +33,11 @@ export const TaskCompletedEvent = z.object({ type: z.literal('task-completed') }
 export const RunTaskCommand = z.object({ type: z.literal('run-task') });
 ```
 
-Consts without a role suffix, and role-suffixed consts without a `type` literal, are ignored.
+## What it does not flag
+
+- Consts without a role suffix (`TaskSchema`), whatever their `type` literal says.
+- Role-suffixed consts without a `type: z.literal(...)` property.
+- Consts that are not exported: only `export const` declarations are checked.
 
 ## Options
 

package/docs/rules/zod-schema-naming.md

@@ -2,6 +2,10 @@
 
 > Every exported zod schema is a PascalCase const suffixed `Schema`, paired with a same-named inferred type.
 
+<!-- begin generated rule header -->
+✅ In `recommended` at `error` · 💭 Type information: not needed
+<!-- end generated rule header -->
+
 ## Why
 
 A contracts package is a shared spine. A uniform `FooSchema` + `Foo` pairing keeps the schema and
@@ -30,6 +34,12 @@ export const TaskSchema = z.object({ id: z.string() });
 export type Task = z.infer<typeof TaskSchema>;
 ```
 
+## What it does not flag
+
+- Exported consts whose initializer is not rooted at `z` (`export const MAX = 10`).
+- Zod schemas that are not exported.
+- Consts ending in one of the configured `roleSuffixes` (see Options).
+
 ## Options
 
 | Option | Type | Default | Meaning |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noctcore/eslint-plugin-contracts",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "ESLint rules for shared contract, config, error-handling, and money-precision conventions (zod schema naming, wire discriminants, no-direct-process-env, decimal money).",
   "license": "MIT",
   "type": "module",
@@ -38,7 +38,7 @@
     "url": "git+https://github.com/noctcore/eslint-plugins.git",
     "directory": "packages/eslint-plugin-contracts"
   },
-  "homepage": "https://github.com/noctcore/eslint-plugins/tree/main/packages/eslint-plugin-contracts",
+  "homepage": "https://noctcore.github.io/eslint-plugins/packages/contracts/",
   "bugs": "https://github.com/noctcore/eslint-plugins/issues",
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts --clean",
@@ -46,7 +46,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@noctcore/eslint-utils": "^0.1.1",
+    "@noctcore/eslint-utils": "^0.1.2",
     "@typescript-eslint/utils": "^8.61.1"
   },
   "peerDependencies": {
@@ -55,11 +55,11 @@
   },
   "devDependencies": {
     "@noctcore/eslint-test-utils": "workspace:*",
-    "@types/node": "^22.0.0",
-    "@typescript-eslint/parser": "^8.61.1",
-    "@typescript-eslint/rule-tester": "^8.61.1",
+    "@types/node": "^22.20.3",
+    "@typescript-eslint/parser": "^8.70.0",
+    "@typescript-eslint/rule-tester": "^8.70.0",
     "tsup": "^8.5.1",
     "typescript": "^5.6.0",
-    "vitest": "^4"
+    "vitest": "^5"
   }
 }