@sarj/eslint-plugin 15.26.8 → 15.28.0

package/dist/index.d.cts

@@ -1,4 +1,6 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { D as DocumentedRule } from './_docs-XCw_6XV9.cjs';
+export { p as publicDocumentation } from './_docs-XCw_6XV9.cjs';
+import '@typescript-eslint/utils';
 
 /** @fileoverview _retired — burned rule names and their migration action. */
 /** Why a name was withdrawn, and in which release. */
@@ -10,91 +12,6 @@ interface RetiredRule {
 }
 declare const RETIRED_RULES: Readonly<Record<string, RetiredRule>>;
 
-/**
- * @fileoverview _docs — typed source-owned rule documentation and executable examples.
- *
- */
-
-type RuleCategory = "architecture" | "correctness" | "maintainability" | "performance" | "security" | "style" | "testing";
-type AutofixPolicy = "none" | "safe" | "suggestion";
-type DefaultLevel = "error" | "warning";
-type ExampleOutcome = "match" | "no-match";
-interface ExampleFile {
-    readonly path: string;
-    readonly source: string;
-}
-/** A reviewed example. It remains private unless `public: true` is explicit. */
-interface RuleExample {
-    readonly id: string;
-    readonly scenarioId?: string;
-    readonly title: string;
-    readonly outcome: ExampleOutcome;
-    readonly files: readonly ExampleFile[];
-    readonly focusPath: string;
-    readonly expectedCount: number;
-    readonly public?: boolean;
-    readonly fixedFiles?: readonly ExampleFile[];
-}
-/** Human-authored fields that cannot be derived from the ESLint rule module. */
-interface RuleDocumentation {
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    readonly defaultLevel?: DefaultLevel;
-    readonly languages?: readonly "typescript"[];
-    readonly autofix?: AutofixPolicy;
-    readonly aliases?: readonly string[];
-    readonly limitations?: readonly string[];
-    readonly filePatterns?: readonly string[];
-    readonly references?: readonly string[];
-    readonly since?: string;
-    readonly examples?: readonly RuleExample[];
-}
-/** Complete native record exposed to catalog generation without changing ESLint metadata. */
-interface NativeRuleSpec extends Required<Omit<RuleDocumentation, "since">> {
-    readonly engine: "eslint";
-    readonly ruleId: string;
-    readonly code: null;
-    readonly messageIds: readonly string[];
-    readonly optionsSchema: object | null;
-    readonly since: string | null;
-    readonly key: string;
-    readonly publicExamples: readonly RuleExample[];
-}
-/** The explicit allowlist projection consumed by generated public documentation. */
-interface PublicRuleSpec {
-    readonly engine: "eslint";
-    readonly ruleId: string;
-    readonly code: null;
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    readonly defaultLevel: DefaultLevel;
-    readonly languages: readonly "typescript"[];
-    readonly autofix: AutofixPolicy;
-    readonly aliases: readonly string[];
-    readonly limitations: readonly string[];
-    readonly filePatterns: readonly string[];
-    readonly references: readonly string[];
-    readonly since: string | null;
-    readonly messageIds: readonly string[];
-    readonly optionsSchema: object | null;
-    readonly examples: readonly RuleExample[];
-}
-declare const eslintCreateRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener> & {
-    name: string;
-};
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof eslintCreateRule<Options, MessageIds>> & {
-    /** Non-enumerable so the public ESLint rule shape remains unchanged. */
-    readonly documentation?: NativeRuleSpec;
-};
-/** Serialize only reviewed fields; test-only examples never cross this boundary. */
-declare function publicDocumentation(rules: Readonly<Record<string, {
-    readonly documentation?: NativeRuleSpec;
-}>>): readonly PublicRuleSpec[];
-
 interface RuleOptions$5 {
     readonly basePath?: string;
 }
@@ -327,6 +244,7 @@ declare const RULES: {
         zodMajorVersion?: 4;
     }], "useMultiValueLiteral">;
     readonly "prefer-named-callback-domain": DocumentedRule<[], "nameCallbackDomain">;
+    readonly "prefer-nominal-id-types": DocumentedRule<[], "preferNominalIds">;
     readonly "prefer-named-complex-return-type": DocumentedRule<[], "nameComplexReturnType">;
     readonly "prefer-native-random-uuid": DocumentedRule<readonly [], "preferNative" | "replaceWithNative">;
     readonly "prefer-node-crypto-hash": DocumentedRule<readonly [], "preferNodeCryptoHash">;
@@ -367,7 +285,7 @@ declare const RULES: {
 /** @deprecated All repositories use one policy; retained for import compatibility. */
 declare const APPLICATION_ONLY_RULES: readonly [];
 /** Rules staged as non-blocking warnings while corpus adoption evidence accumulates. */
-declare const ADVISORY_RULES: readonly ["@sarj/excessive-commentary", "@sarj/no-bespoke-api-case-conversion", "@sarj/no-json-stringify-object-equality", "@sarj/no-restated-comment", "@sarj/no-restated-jsdoc", "@sarj/prefer-millisecond-control-duration-schema", "@sarj/prefer-module-level-refined-schema", "@sarj/prefer-multi-value-zod-literal", "@sarj/prefer-named-complex-return-type", "@sarj/prefer-node-crypto-hash", "@sarj/prefer-node-fs-promises", "@sarj/prefer-shared-zod-enum", "@sarj/prefer-switch-for-repeated-equality", "@sarj/prefer-whole-object-assertion", "@sarj/require-camelcase-properties", "@sarj/require-interface-for-exported-class", "@sarj/require-sql-access-class", "@sarj/sole-export-matches-filename"];
+declare const ADVISORY_RULES: readonly ["@sarj/excessive-commentary", "@sarj/no-bespoke-api-case-conversion", "@sarj/no-json-stringify-object-equality", "@sarj/no-restated-comment", "@sarj/no-restated-jsdoc", "@sarj/prefer-millisecond-control-duration-schema", "@sarj/prefer-module-level-refined-schema", "@sarj/prefer-multi-value-zod-literal", "@sarj/prefer-named-complex-return-type", "@sarj/prefer-node-crypto-hash", "@sarj/prefer-node-fs-promises", "@sarj/prefer-nominal-id-types", "@sarj/prefer-shared-zod-enum", "@sarj/prefer-switch-for-repeated-equality", "@sarj/prefer-whole-object-assertion", "@sarj/require-camelcase-properties", "@sarj/require-interface-for-exported-class", "@sarj/require-sql-access-class", "@sarj/sole-export-matches-filename"];
 declare const RECOMMENDED_RULES: {
     readonly "@sarj/no-conditional-empty-object-spread": "error";
     readonly "@sarj/prefer-typed-reflection": "error";
@@ -643,6 +561,7 @@ declare const RECOMMENDED_RULES: {
         readonly zodMajorVersion: 4;
     }];
     readonly "@sarj/prefer-named-callback-domain": "error";
+    readonly "@sarj/prefer-nominal-id-types": "warn";
     readonly "@sarj/prefer-named-complex-return-type": "warn";
     readonly "@sarj/prefer-node-crypto-hash": "warn";
     readonly "@sarj/prefer-node-fs-promises": "warn";
@@ -955,6 +874,7 @@ declare const STRICT_RULES: {
         readonly zodMajorVersion: 4;
     }];
     readonly "@sarj/prefer-named-callback-domain": "error";
+    readonly "@sarj/prefer-nominal-id-types": "warn";
     readonly "@sarj/prefer-named-complex-return-type": "warn";
     readonly "@sarj/prefer-node-crypto-hash": "warn";
     readonly "@sarj/prefer-node-fs-promises": "warn";
@@ -996,7 +916,7 @@ type FlatPreset = {
 declare const PLUGIN: {
     readonly meta: {
         readonly name: "@sarj/eslint-plugin";
-        readonly version: "15.26.8";
+        readonly version: "15.28.0";
     };
     readonly rules: {
         readonly "no-conditional-empty-object-spread": DocumentedRule<[], "avoid">;
@@ -1117,6 +1037,7 @@ declare const PLUGIN: {
             zodMajorVersion?: 4;
         }], "useMultiValueLiteral">;
         readonly "prefer-named-callback-domain": DocumentedRule<[], "nameCallbackDomain">;
+        readonly "prefer-nominal-id-types": DocumentedRule<[], "preferNominalIds">;
         readonly "prefer-named-complex-return-type": DocumentedRule<[], "nameComplexReturnType">;
         readonly "prefer-native-random-uuid": DocumentedRule<readonly [], "preferNative" | "replaceWithNative">;
         readonly "prefer-node-crypto-hash": DocumentedRule<readonly [], "preferNodeCryptoHash">;
@@ -1161,4 +1082,4 @@ declare const PLUGIN: {
     };
 };
 
-export { ADVISORY_RULES, APPLICATION_ONLY_RULES, RECOMMENDED_RULES, RENAMED_RULES, RETIRED_RULES, RULES, type RetiredRule, STRICT_RULES, ADVISORY_RULES as advisoryRules, APPLICATION_ONLY_RULES as applicationOnlyRules, PLUGIN as default, publicDocumentation, RECOMMENDED_RULES as recommendedRules, RENAMED_RULES as renamedRules, RETIRED_RULES as retiredRules, RULES as rules, STRICT_RULES as strictRules };
+export { ADVISORY_RULES, APPLICATION_ONLY_RULES, RECOMMENDED_RULES, RENAMED_RULES, RETIRED_RULES, RULES, type RetiredRule, STRICT_RULES, ADVISORY_RULES as advisoryRules, APPLICATION_ONLY_RULES as applicationOnlyRules, PLUGIN as default, RECOMMENDED_RULES as recommendedRules, RENAMED_RULES as renamedRules, RETIRED_RULES as retiredRules, RULES as rules, STRICT_RULES as strictRules };

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { D as DocumentedRule } from './_docs-XCw_6XV9.js';
+export { p as publicDocumentation } from './_docs-XCw_6XV9.js';
+import '@typescript-eslint/utils';
 
 /** @fileoverview _retired — burned rule names and their migration action. */
 /** Why a name was withdrawn, and in which release. */
@@ -10,91 +12,6 @@ interface RetiredRule {
 }
 declare const RETIRED_RULES: Readonly<Record<string, RetiredRule>>;
 
-/**
- * @fileoverview _docs — typed source-owned rule documentation and executable examples.
- *
- */
-
-type RuleCategory = "architecture" | "correctness" | "maintainability" | "performance" | "security" | "style" | "testing";
-type AutofixPolicy = "none" | "safe" | "suggestion";
-type DefaultLevel = "error" | "warning";
-type ExampleOutcome = "match" | "no-match";
-interface ExampleFile {
-    readonly path: string;
-    readonly source: string;
-}
-/** A reviewed example. It remains private unless `public: true` is explicit. */
-interface RuleExample {
-    readonly id: string;
-    readonly scenarioId?: string;
-    readonly title: string;
-    readonly outcome: ExampleOutcome;
-    readonly files: readonly ExampleFile[];
-    readonly focusPath: string;
-    readonly expectedCount: number;
-    readonly public?: boolean;
-    readonly fixedFiles?: readonly ExampleFile[];
-}
-/** Human-authored fields that cannot be derived from the ESLint rule module. */
-interface RuleDocumentation {
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    readonly defaultLevel?: DefaultLevel;
-    readonly languages?: readonly "typescript"[];
-    readonly autofix?: AutofixPolicy;
-    readonly aliases?: readonly string[];
-    readonly limitations?: readonly string[];
-    readonly filePatterns?: readonly string[];
-    readonly references?: readonly string[];
-    readonly since?: string;
-    readonly examples?: readonly RuleExample[];
-}
-/** Complete native record exposed to catalog generation without changing ESLint metadata. */
-interface NativeRuleSpec extends Required<Omit<RuleDocumentation, "since">> {
-    readonly engine: "eslint";
-    readonly ruleId: string;
-    readonly code: null;
-    readonly messageIds: readonly string[];
-    readonly optionsSchema: object | null;
-    readonly since: string | null;
-    readonly key: string;
-    readonly publicExamples: readonly RuleExample[];
-}
-/** The explicit allowlist projection consumed by generated public documentation. */
-interface PublicRuleSpec {
-    readonly engine: "eslint";
-    readonly ruleId: string;
-    readonly code: null;
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    readonly defaultLevel: DefaultLevel;
-    readonly languages: readonly "typescript"[];
-    readonly autofix: AutofixPolicy;
-    readonly aliases: readonly string[];
-    readonly limitations: readonly string[];
-    readonly filePatterns: readonly string[];
-    readonly references: readonly string[];
-    readonly since: string | null;
-    readonly messageIds: readonly string[];
-    readonly optionsSchema: object | null;
-    readonly examples: readonly RuleExample[];
-}
-declare const eslintCreateRule: <Options extends readonly unknown[], MessageIds extends string>({ meta, name, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<Options, MessageIds, unknown>>) => ESLintUtils.RuleModule<MessageIds, Options, unknown, ESLintUtils.RuleListener> & {
-    name: string;
-};
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof eslintCreateRule<Options, MessageIds>> & {
-    /** Non-enumerable so the public ESLint rule shape remains unchanged. */
-    readonly documentation?: NativeRuleSpec;
-};
-/** Serialize only reviewed fields; test-only examples never cross this boundary. */
-declare function publicDocumentation(rules: Readonly<Record<string, {
-    readonly documentation?: NativeRuleSpec;
-}>>): readonly PublicRuleSpec[];
-
 interface RuleOptions$5 {
     readonly basePath?: string;
 }
@@ -327,6 +244,7 @@ declare const RULES: {
         zodMajorVersion?: 4;
     }], "useMultiValueLiteral">;
     readonly "prefer-named-callback-domain": DocumentedRule<[], "nameCallbackDomain">;
+    readonly "prefer-nominal-id-types": DocumentedRule<[], "preferNominalIds">;
     readonly "prefer-named-complex-return-type": DocumentedRule<[], "nameComplexReturnType">;
     readonly "prefer-native-random-uuid": DocumentedRule<readonly [], "preferNative" | "replaceWithNative">;
     readonly "prefer-node-crypto-hash": DocumentedRule<readonly [], "preferNodeCryptoHash">;
@@ -367,7 +285,7 @@ declare const RULES: {
 /** @deprecated All repositories use one policy; retained for import compatibility. */
 declare const APPLICATION_ONLY_RULES: readonly [];
 /** Rules staged as non-blocking warnings while corpus adoption evidence accumulates. */
-declare const ADVISORY_RULES: readonly ["@sarj/excessive-commentary", "@sarj/no-bespoke-api-case-conversion", "@sarj/no-json-stringify-object-equality", "@sarj/no-restated-comment", "@sarj/no-restated-jsdoc", "@sarj/prefer-millisecond-control-duration-schema", "@sarj/prefer-module-level-refined-schema", "@sarj/prefer-multi-value-zod-literal", "@sarj/prefer-named-complex-return-type", "@sarj/prefer-node-crypto-hash", "@sarj/prefer-node-fs-promises", "@sarj/prefer-shared-zod-enum", "@sarj/prefer-switch-for-repeated-equality", "@sarj/prefer-whole-object-assertion", "@sarj/require-camelcase-properties", "@sarj/require-interface-for-exported-class", "@sarj/require-sql-access-class", "@sarj/sole-export-matches-filename"];
+declare const ADVISORY_RULES: readonly ["@sarj/excessive-commentary", "@sarj/no-bespoke-api-case-conversion", "@sarj/no-json-stringify-object-equality", "@sarj/no-restated-comment", "@sarj/no-restated-jsdoc", "@sarj/prefer-millisecond-control-duration-schema", "@sarj/prefer-module-level-refined-schema", "@sarj/prefer-multi-value-zod-literal", "@sarj/prefer-named-complex-return-type", "@sarj/prefer-node-crypto-hash", "@sarj/prefer-node-fs-promises", "@sarj/prefer-nominal-id-types", "@sarj/prefer-shared-zod-enum", "@sarj/prefer-switch-for-repeated-equality", "@sarj/prefer-whole-object-assertion", "@sarj/require-camelcase-properties", "@sarj/require-interface-for-exported-class", "@sarj/require-sql-access-class", "@sarj/sole-export-matches-filename"];
 declare const RECOMMENDED_RULES: {
     readonly "@sarj/no-conditional-empty-object-spread": "error";
     readonly "@sarj/prefer-typed-reflection": "error";
@@ -643,6 +561,7 @@ declare const RECOMMENDED_RULES: {
         readonly zodMajorVersion: 4;
     }];
     readonly "@sarj/prefer-named-callback-domain": "error";
+    readonly "@sarj/prefer-nominal-id-types": "warn";
     readonly "@sarj/prefer-named-complex-return-type": "warn";
     readonly "@sarj/prefer-node-crypto-hash": "warn";
     readonly "@sarj/prefer-node-fs-promises": "warn";
@@ -955,6 +874,7 @@ declare const STRICT_RULES: {
         readonly zodMajorVersion: 4;
     }];
     readonly "@sarj/prefer-named-callback-domain": "error";
+    readonly "@sarj/prefer-nominal-id-types": "warn";
     readonly "@sarj/prefer-named-complex-return-type": "warn";
     readonly "@sarj/prefer-node-crypto-hash": "warn";
     readonly "@sarj/prefer-node-fs-promises": "warn";
@@ -996,7 +916,7 @@ type FlatPreset = {
 declare const PLUGIN: {
     readonly meta: {
         readonly name: "@sarj/eslint-plugin";
-        readonly version: "15.26.8";
+        readonly version: "15.28.0";
     };
     readonly rules: {
         readonly "no-conditional-empty-object-spread": DocumentedRule<[], "avoid">;
@@ -1117,6 +1037,7 @@ declare const PLUGIN: {
             zodMajorVersion?: 4;
         }], "useMultiValueLiteral">;
         readonly "prefer-named-callback-domain": DocumentedRule<[], "nameCallbackDomain">;
+        readonly "prefer-nominal-id-types": DocumentedRule<[], "preferNominalIds">;
         readonly "prefer-named-complex-return-type": DocumentedRule<[], "nameComplexReturnType">;
         readonly "prefer-native-random-uuid": DocumentedRule<readonly [], "preferNative" | "replaceWithNative">;
         readonly "prefer-node-crypto-hash": DocumentedRule<readonly [], "preferNodeCryptoHash">;
@@ -1161,4 +1082,4 @@ declare const PLUGIN: {
     };
 };
 
-export { ADVISORY_RULES, APPLICATION_ONLY_RULES, RECOMMENDED_RULES, RENAMED_RULES, RETIRED_RULES, RULES, type RetiredRule, STRICT_RULES, ADVISORY_RULES as advisoryRules, APPLICATION_ONLY_RULES as applicationOnlyRules, PLUGIN as default, publicDocumentation, RECOMMENDED_RULES as recommendedRules, RENAMED_RULES as renamedRules, RETIRED_RULES as retiredRules, RULES as rules, STRICT_RULES as strictRules };
+export { ADVISORY_RULES, APPLICATION_ONLY_RULES, RECOMMENDED_RULES, RENAMED_RULES, RETIRED_RULES, RULES, type RetiredRule, STRICT_RULES, ADVISORY_RULES as advisoryRules, APPLICATION_ONLY_RULES as applicationOnlyRules, PLUGIN as default, RECOMMENDED_RULES as recommendedRules, RENAMED_RULES as renamedRules, RETIRED_RULES as retiredRules, RULES as rules, STRICT_RULES as strictRules };