@sarj/eslint-plugin 16.42.1 → 17.1.0

package/README.md

@@ -8,6 +8,8 @@ Custom ESLint rules for hypermodern TypeScript / React / Next.js projects
 npm install --save-dev @sarj/eslint-plugin
 ```
 
+Version 17 requires ESLint 10.13.0 or later. The plugin, rules and flat presets use ESLint's native TypeScript contracts and compose directly with `defineConfig` from `eslint/config`. Use `Linter.Config` and `ESLint.Options` from `eslint` for consumer annotations; legacy `TSESLint.Plugin` and `TSESLint.FlatConfig.Config` annotations are no longer supported. The exported rule names, preset severities and option settings are unchanged.
+
 Rules and configuration are documented in the generated rule directory.
 
 [Documentation](https://code-standards.sarj.ai/rules/eslint/) · [Source](https://github.com/sarj-ai/code-standards)

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

@@ -1,4 +1,50 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { ESLintUtils, TSESLint, TSESTree, JSONSchema } 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 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;
+    };
+    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;
+}
+declare function createNativeRule<Options extends readonly unknown[], MessageIds extends string>(config: NativeRuleConfiguration<Options, MessageIds>, url: (name: string) => string): NativeRule<Options, MessageIds>;
 
 /**
  * @fileoverview _docs — typed source-owned rule documentation and executable examples.
@@ -98,10 +144,7 @@ interface PublicRuleSpec {
     readonly optionsSchema: object | null;
     readonly examples: readonly PublicRuleExample[];
 }
-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>> & {
+type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof createNativeRule<Options, MessageIds>> & {
     /** Non-enumerable so the public ESLint rule shape remains unchanged. */
     readonly documentation?: NativeRuleSpec;
 };

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

@@ -1,4 +1,50 @@
-import { ESLintUtils } from '@typescript-eslint/utils';
+import { ESLintUtils, TSESLint, TSESTree, JSONSchema } 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 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;
+    };
+    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;
+}
+declare function createNativeRule<Options extends readonly unknown[], MessageIds extends string>(config: NativeRuleConfiguration<Options, MessageIds>, url: (name: string) => string): NativeRule<Options, MessageIds>;
 
 /**
  * @fileoverview _docs — typed source-owned rule documentation and executable examples.
@@ -98,10 +144,7 @@ interface PublicRuleSpec {
     readonly optionsSchema: object | null;
     readonly examples: readonly PublicRuleExample[];
 }
-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>> & {
+type DocumentedRule<Options extends readonly unknown[], MessageIds extends string> = ReturnType<typeof createNativeRule<Options, MessageIds>> & {
     /** Non-enumerable so the public ESLint rule shape remains unchanged. */
     readonly documentation?: NativeRuleSpec;
 };