@sarj/eslint-plugin 18.3.1 → 19.0.0

package/dist/_docs-d31-QA2S.d.cts

@@ -1,170 +0,0 @@
-import { ESLintUtils, JSONSchema, TSESLint, TSESTree } from '@typescript-eslint/utils';
-import { Linter, JSRuleDefinition } from 'eslint';
-import { RuleDefinition, RuleVisitor } from '@eslint/core';
-
-/** @fileoverview _eslint-rule — native TypeScript rule contexts and owned option metadata. */
-
-type NativeJavaScriptSource = Parameters<JSRuleDefinition["create"]>[0]["sourceCode"];
-type TypeScriptSourceCode = Pick<TSESLint.SourceCode, Exclude<Extract<keyof TSESLint.SourceCode, keyof NativeJavaScriptSource>, "visitorKeys">> & Pick<NativeJavaScriptSource, "visitorKeys"> & Pick<NativeJavaScriptSource, Exclude<keyof NativeJavaScriptSource, keyof TSESLint.SourceCode>>;
-type NativeRuleListener = {
-    [Selector in keyof TSESLint.RuleListener as string extends Selector ? never : number extends Selector ? never : Selector]: TSESLint.RuleListener[Selector];
-} & RuleVisitor;
-type Definition<Options extends readonly unknown[], MessageIds extends string> = RuleDefinition<{
-    LangOptions: Linter.LanguageOptions;
-    ExtRuleDocs: Record<string, unknown>;
-    RuleOptions: [...Options];
-    MessageIds: MessageIds;
-    Code: TypeScriptSourceCode;
-    Node: TSESTree.Node | TSESTree.Token;
-    Visitor: NativeRuleListener;
-}>;
-type EngineRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Parameters<Definition<Options, MessageIds>["create"]>[0];
-type OwnedMetadata<Options extends readonly unknown[], MessageIds extends string> = Omit<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>["meta"], "schema" | "defaultOptions" | "docs"> & {
-    docs: ESLintUtils.RuleWithMetaAndName<Options, MessageIds>["meta"]["docs"] & {
-        url: string;
-    };
-    schema: JSONSchema.JSONSchema4 | JSONSchema.JSONSchema4[];
-    defaultOptions?: [...Options];
-};
-interface NativeRule<Options extends readonly unknown[], MessageIds extends string> {
-    name: string;
-    defaultOptions: Readonly<Options> | undefined;
-    meta: OwnedMetadata<Options, MessageIds>;
-    create(context: EngineRuleContext<MessageIds, Options>): NativeRuleListener;
-}
-
-/**
- * @fileoverview _trackable-rule — observe rule prerequisites and completed native execution without altering diagnostics.
- */
-
-type RuleExecutionState = "ran" | "skipped" | "untracked" | "failed";
-interface RuleExecution {
-    readonly ruleId: string;
-    readonly filePath: string;
-    readonly execution: RuleExecutionState;
-    readonly requiresTypeInformation: boolean | null;
-    readonly reason?: string;
-}
-interface RuleExecutionTracker {
-    finish(): readonly RuleExecution[];
-}
-/** Tracking is opt-in and bound to the exact rule instance used by the engine. */
-declare function trackableRule<Options extends readonly unknown[], MessageIds extends string>(rule: NativeRule<Options, MessageIds>, requiresTypeInformation: boolean | null): NativeRule<Options, MessageIds> & {
-    trackExecution(): RuleExecutionTracker;
-};
-
-/**
- * @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;
-}
-interface ExamplePoint {
-    readonly line: number;
-    readonly column: number;
-}
-interface ExampleLocation extends ExamplePoint {
-    readonly end?: ExamplePoint;
-}
-interface SuggestionExpectation {
-    readonly messageId: string;
-    readonly output: string;
-}
-interface DiagnosticExpectation {
-    readonly messageId: string;
-    readonly message: string;
-    readonly location: ExampleLocation;
-    readonly automaticFix: boolean;
-    readonly suggestions: readonly SuggestionExpectation[];
-}
-/** A reviewed example. It remains private unless `public: true` is explicit. */
-interface RuleExample<Options extends readonly unknown[] = readonly unknown[]> {
-    readonly ruleOptions?: Readonly<Options>;
-    readonly installedDependencies?: readonly {
-        readonly module: string;
-        readonly version: string;
-    }[];
-    readonly id: string;
-    readonly scenarioId?: string;
-    readonly title: string;
-    readonly outcome: ExampleOutcome;
-    readonly files: readonly ExampleFile[];
-    readonly focusPath: string;
-    readonly expectedCount: number;
-    readonly expectedDiagnostics?: readonly DiagnosticExpectation[];
-    readonly public?: boolean;
-    readonly fixedFiles?: readonly ExampleFile[];
-}
-type PublicRuleExample = Omit<RuleExample, "expectedDiagnostics">;
-/** Human-authored fields that cannot be derived from the ESLint rule module. */
-interface RuleDocumentation<Options extends readonly unknown[] = readonly unknown[]> {
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    /** Omission/null preserves undeclared prerequisites rather than assuming a syntax-only detector. */
-    readonly requiresTypeInformation?: boolean | null;
-    /** Source package roots whose imported APIs establish provenance; these are not plugin dependencies. */
-    readonly runtimeImports?: readonly string[];
-    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<Options>[];
-}
-/** 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 requiresTypeInformation: boolean | null;
-    readonly runtimeImports: readonly string[];
-    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 PublicRuleExample[];
-}
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof trackableRule<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[];
-
-export { publicDocumentation as p };
-export type { DocumentedRule as D, ExampleFile as E, RuleExample as R };

package/dist/_docs-d31-QA2S.d.ts

@@ -1,170 +0,0 @@
-import { ESLintUtils, JSONSchema, TSESLint, TSESTree } from '@typescript-eslint/utils';
-import { Linter, JSRuleDefinition } from 'eslint';
-import { RuleDefinition, RuleVisitor } from '@eslint/core';
-
-/** @fileoverview _eslint-rule — native TypeScript rule contexts and owned option metadata. */
-
-type NativeJavaScriptSource = Parameters<JSRuleDefinition["create"]>[0]["sourceCode"];
-type TypeScriptSourceCode = Pick<TSESLint.SourceCode, Exclude<Extract<keyof TSESLint.SourceCode, keyof NativeJavaScriptSource>, "visitorKeys">> & Pick<NativeJavaScriptSource, "visitorKeys"> & Pick<NativeJavaScriptSource, Exclude<keyof NativeJavaScriptSource, keyof TSESLint.SourceCode>>;
-type NativeRuleListener = {
-    [Selector in keyof TSESLint.RuleListener as string extends Selector ? never : number extends Selector ? never : Selector]: TSESLint.RuleListener[Selector];
-} & RuleVisitor;
-type Definition<Options extends readonly unknown[], MessageIds extends string> = RuleDefinition<{
-    LangOptions: Linter.LanguageOptions;
-    ExtRuleDocs: Record<string, unknown>;
-    RuleOptions: [...Options];
-    MessageIds: MessageIds;
-    Code: TypeScriptSourceCode;
-    Node: TSESTree.Node | TSESTree.Token;
-    Visitor: NativeRuleListener;
-}>;
-type EngineRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Parameters<Definition<Options, MessageIds>["create"]>[0];
-type OwnedMetadata<Options extends readonly unknown[], MessageIds extends string> = Omit<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>["meta"], "schema" | "defaultOptions" | "docs"> & {
-    docs: ESLintUtils.RuleWithMetaAndName<Options, MessageIds>["meta"]["docs"] & {
-        url: string;
-    };
-    schema: JSONSchema.JSONSchema4 | JSONSchema.JSONSchema4[];
-    defaultOptions?: [...Options];
-};
-interface NativeRule<Options extends readonly unknown[], MessageIds extends string> {
-    name: string;
-    defaultOptions: Readonly<Options> | undefined;
-    meta: OwnedMetadata<Options, MessageIds>;
-    create(context: EngineRuleContext<MessageIds, Options>): NativeRuleListener;
-}
-
-/**
- * @fileoverview _trackable-rule — observe rule prerequisites and completed native execution without altering diagnostics.
- */
-
-type RuleExecutionState = "ran" | "skipped" | "untracked" | "failed";
-interface RuleExecution {
-    readonly ruleId: string;
-    readonly filePath: string;
-    readonly execution: RuleExecutionState;
-    readonly requiresTypeInformation: boolean | null;
-    readonly reason?: string;
-}
-interface RuleExecutionTracker {
-    finish(): readonly RuleExecution[];
-}
-/** Tracking is opt-in and bound to the exact rule instance used by the engine. */
-declare function trackableRule<Options extends readonly unknown[], MessageIds extends string>(rule: NativeRule<Options, MessageIds>, requiresTypeInformation: boolean | null): NativeRule<Options, MessageIds> & {
-    trackExecution(): RuleExecutionTracker;
-};
-
-/**
- * @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;
-}
-interface ExamplePoint {
-    readonly line: number;
-    readonly column: number;
-}
-interface ExampleLocation extends ExamplePoint {
-    readonly end?: ExamplePoint;
-}
-interface SuggestionExpectation {
-    readonly messageId: string;
-    readonly output: string;
-}
-interface DiagnosticExpectation {
-    readonly messageId: string;
-    readonly message: string;
-    readonly location: ExampleLocation;
-    readonly automaticFix: boolean;
-    readonly suggestions: readonly SuggestionExpectation[];
-}
-/** A reviewed example. It remains private unless `public: true` is explicit. */
-interface RuleExample<Options extends readonly unknown[] = readonly unknown[]> {
-    readonly ruleOptions?: Readonly<Options>;
-    readonly installedDependencies?: readonly {
-        readonly module: string;
-        readonly version: string;
-    }[];
-    readonly id: string;
-    readonly scenarioId?: string;
-    readonly title: string;
-    readonly outcome: ExampleOutcome;
-    readonly files: readonly ExampleFile[];
-    readonly focusPath: string;
-    readonly expectedCount: number;
-    readonly expectedDiagnostics?: readonly DiagnosticExpectation[];
-    readonly public?: boolean;
-    readonly fixedFiles?: readonly ExampleFile[];
-}
-type PublicRuleExample = Omit<RuleExample, "expectedDiagnostics">;
-/** Human-authored fields that cannot be derived from the ESLint rule module. */
-interface RuleDocumentation<Options extends readonly unknown[] = readonly unknown[]> {
-    readonly summary: string;
-    readonly rationale: string;
-    readonly remediation: string;
-    readonly category: RuleCategory;
-    /** Omission/null preserves undeclared prerequisites rather than assuming a syntax-only detector. */
-    readonly requiresTypeInformation?: boolean | null;
-    /** Source package roots whose imported APIs establish provenance; these are not plugin dependencies. */
-    readonly runtimeImports?: readonly string[];
-    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<Options>[];
-}
-/** 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 requiresTypeInformation: boolean | null;
-    readonly runtimeImports: readonly string[];
-    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 PublicRuleExample[];
-}
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof trackableRule<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[];
-
-export { publicDocumentation as p };
-export type { DocumentedRule as D, ExampleFile as E, RuleExample as R };