@sarj/eslint-plugin 18.0.4 → 18.1.0

package/dist/{_docs-CzrWp3w7.d.cts → _docs-d31-QA2S.d.cts}

@@ -1,4 +1,4 @@
-import { ESLintUtils, TSESLint, TSESTree, JSONSchema } from '@typescript-eslint/utils';
+import { ESLintUtils, JSONSchema, TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { Linter, JSRuleDefinition } from 'eslint';
 import { RuleDefinition, RuleVisitor } from '@eslint/core';
 
@@ -19,18 +19,6 @@ type Definition<Options extends readonly unknown[], MessageIds extends string> =
     Visitor: NativeRuleListener;
 }>;
 type EngineRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Parameters<Definition<Options, MessageIds>["create"]>[0];
-type NativeRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Omit<EngineRuleContext<MessageIds, Options>, "options"> & {
-    readonly options: Readonly<Partial<Options>>;
-};
-type NativeRuleConfiguration<Options extends readonly unknown[], MessageIds extends string> = Omit<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>, "create"> & {
-    create(this: void, context: NativeRuleContext<MessageIds, Options>, options: Readonly<Options>): NativeRuleListener;
-} & (readonly [] extends Options ? unknown : {
-    readonly defaultOptions: Readonly<Options>;
-} | {
-    readonly meta: {
-        readonly defaultOptions: Readonly<Options>;
-    };
-});
 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;
@@ -44,7 +32,26 @@ interface NativeRule<Options extends readonly unknown[], MessageIds extends stri
     meta: OwnedMetadata<Options, MessageIds>;
     create(context: EngineRuleContext<MessageIds, Options>): NativeRuleListener;
 }
-declare function createNativeRule<Options extends readonly unknown[], MessageIds extends string>(config: NativeRuleConfiguration<Options, MessageIds>, url: (name: string) => string): NativeRule<Options, MessageIds>;
+
+/**
+ * @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.
@@ -102,6 +109,10 @@ interface RuleDocumentation<Options extends readonly unknown[] = readonly unknow
     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;
@@ -132,6 +143,8 @@ interface PublicRuleSpec {
     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;
@@ -144,7 +157,7 @@ interface PublicRuleSpec {
     readonly optionsSchema: object | null;
     readonly examples: readonly PublicRuleExample[];
 }
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof createNativeRule<Options, MessageIds>> & {
+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;
 };

package/dist/{_docs-CzrWp3w7.d.ts → _docs-d31-QA2S.d.ts}

@@ -1,4 +1,4 @@
-import { ESLintUtils, TSESLint, TSESTree, JSONSchema } from '@typescript-eslint/utils';
+import { ESLintUtils, JSONSchema, TSESLint, TSESTree } from '@typescript-eslint/utils';
 import { Linter, JSRuleDefinition } from 'eslint';
 import { RuleDefinition, RuleVisitor } from '@eslint/core';
 
@@ -19,18 +19,6 @@ type Definition<Options extends readonly unknown[], MessageIds extends string> =
     Visitor: NativeRuleListener;
 }>;
 type EngineRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Parameters<Definition<Options, MessageIds>["create"]>[0];
-type NativeRuleContext<MessageIds extends string, Options extends readonly unknown[]> = Omit<EngineRuleContext<MessageIds, Options>, "options"> & {
-    readonly options: Readonly<Partial<Options>>;
-};
-type NativeRuleConfiguration<Options extends readonly unknown[], MessageIds extends string> = Omit<ESLintUtils.RuleWithMetaAndName<Options, MessageIds>, "create"> & {
-    create(this: void, context: NativeRuleContext<MessageIds, Options>, options: Readonly<Options>): NativeRuleListener;
-} & (readonly [] extends Options ? unknown : {
-    readonly defaultOptions: Readonly<Options>;
-} | {
-    readonly meta: {
-        readonly defaultOptions: Readonly<Options>;
-    };
-});
 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;
@@ -44,7 +32,26 @@ interface NativeRule<Options extends readonly unknown[], MessageIds extends stri
     meta: OwnedMetadata<Options, MessageIds>;
     create(context: EngineRuleContext<MessageIds, Options>): NativeRuleListener;
 }
-declare function createNativeRule<Options extends readonly unknown[], MessageIds extends string>(config: NativeRuleConfiguration<Options, MessageIds>, url: (name: string) => string): NativeRule<Options, MessageIds>;
+
+/**
+ * @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.
@@ -102,6 +109,10 @@ interface RuleDocumentation<Options extends readonly unknown[] = readonly unknow
     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;
@@ -132,6 +143,8 @@ interface PublicRuleSpec {
     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;
@@ -144,7 +157,7 @@ interface PublicRuleSpec {
     readonly optionsSchema: object | null;
     readonly examples: readonly PublicRuleExample[];
 }
-type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof createNativeRule<Options, MessageIds>> & {
+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;
 };