Merge pull request #1032 from eslint-functional/define-config

Author: RebeccaStevens

GETTING_STARTED.md

@@ -36,27 +36,40 @@ In your `eslint.config.js` file, import `typescript-eslint` and `eslint-plugin-f
 
 ```js
 // eslint.config.js
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
 import functional from "eslint-plugin-functional";
 import tseslint from "typescript-eslint";
 
-export default tseslint.config({
-  files: ["**/*.ts"],
-  extends: [
-    functional.configs.externalTypeScriptRecommended,
-    functional.configs.recommended,
-    functional.configs.stylistic,
-    // your other plugin configs here
-  ],
-  languageOptions: {
-    parser: tseslint.parser,
-    parserOptions: {
-      projectService: true,
+export default defineConfig(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  functional.configs.externalTypeScriptRecommended,
+  functional.configs.recommended,
+  functional.configs.stylistic,
+  // any other plugin configs here
+  {
+    rules: {
+      // any rule configs here
     },
   },
-  rules: {
-    // any rule configs here
+  {
+    // enable types for type-aware linting
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+  {
+    // disable type-aware linting on JS files
+    files: ['**/*.js'],
+    extends: [
+      tseslint.configs.disableTypeChecked,
+      functional.configs.disableTypeChecked,
+    ],
   },
-});
+);
 ```
 
 ### Without TypeScript
@@ -68,18 +81,21 @@ disable rules that require TypeScript.
 
 ```js
 // eslint.config.js
+import eslint from '@eslint/js';
+import { defineConfig } from 'eslint/config';
 import functional from "eslint-plugin-functional";
 
-export default [
+export default defineConfig(
+  eslint.configs.recommended,
   functional.configs.externalVanillaRecommended,
   functional.configs.recommended,
   functional.configs.stylistic,
   functional.configs.disableTypeChecked,
-  // your other plugin configs here
+  // any other plugin configs here
   {
     rules: {
       // any rule configs here
     },
   },
-];
+);
 ```

src/index.ts

@@ -1,4 +1,4 @@
-import type { FlatConfig } from "@typescript-eslint/utils/ts-eslint";
+import type { ESLint, Linter } from "eslint";
 
 import all from "#/configs/all";
 import currying from "#/configs/currying";
@@ -22,28 +22,28 @@ const meta = {
   version: __VERSION__ as string,
 } as const;
 
-const functional = {
+const functional: ESLint.Plugin = {
   meta,
   rules,
-} satisfies FlatConfig.Plugin;
+} as unknown as ESLint.Plugin;
 
 const plugins = { functional } as const;
 
 const configs: Readonly<{
-  all: FlatConfig.Config;
-  lite: FlatConfig.Config;
-  recommended: FlatConfig.Config;
-  strict: FlatConfig.Config;
-  off: FlatConfig.Config;
-  disableTypeChecked: FlatConfig.Config;
-  externalVanillaRecommended: FlatConfig.Config;
-  externalTypeScriptRecommended: FlatConfig.Config;
-  currying: FlatConfig.Config;
-  noExceptions: FlatConfig.Config;
-  noMutations: FlatConfig.Config;
-  noOtherParadigms: FlatConfig.Config;
-  noStatements: FlatConfig.Config;
-  stylistic: FlatConfig.Config;
+  all: Linter.Config;
+  lite: Linter.Config;
+  recommended: Linter.Config;
+  strict: Linter.Config;
+  off: Linter.Config;
+  disableTypeChecked: Linter.Config;
+  externalVanillaRecommended: Linter.Config;
+  externalTypeScriptRecommended: Linter.Config;
+  currying: Linter.Config;
+  noExceptions: Linter.Config;
+  noMutations: Linter.Config;
+  noOtherParadigms: Linter.Config;
+  noStatements: Linter.Config;
+  stylistic: Linter.Config;
 }> = {
   all: { plugins, rules: all },
   lite: { plugins, rules: lite },
@@ -71,9 +71,16 @@ const configs: Readonly<{
   },
   noStatements: { plugins, rules: noStatements },
   stylistic: { plugins, rules: stylistic },
-} satisfies Record<string, FlatConfig.Config>;
+} satisfies Record<
+  string,
+  Linter.Config & {
+    extends?: Array<string | Linter.Config | InfiniteArray<Linter.Config>>;
+  }
+>;
 
-type EslintPluginFunctional = FlatConfig.Plugin & {
+type InfiniteArray<T> = T | Array<InfiniteArray<T>>;
+
+type EslintPluginFunctional = typeof functional & {
   meta: typeof meta;
   rules: typeof rules;
   configs: typeof configs;

src/utils/rule.ts

@@ -3,6 +3,7 @@ import assert from "node:assert/strict";
 import type { TSESTree } from "@typescript-eslint/utils";
 import { type NamedCreateRuleMeta, RuleCreator, getParserServices } from "@typescript-eslint/utils/eslint-utils";
 import type { ReportDescriptor, RuleContext, RuleListener, RuleModule } from "@typescript-eslint/utils/ts-eslint";
+import type { Rule as EslintRule } from "eslint";
 import { Immutability, type ImmutabilityOverrides, getTypeImmutability } from "is-immutable-type";
 import { isIntrinsicErrorType } from "ts-api-utils";
 import type { Node as TSNode, Type, TypeNode } from "typescript";
@@ -40,13 +41,10 @@ export type NamedCreateRuleCustomMeta<T extends string, Options extends Readonly
 /**
  * The definition of a rule.
  */
-export type Rule<MessageIds extends string, Options extends ReadonlyArray<unknown>> = RuleModule<
-  MessageIds,
-  Options,
-  Docs
-> & {
-  meta: NamedCreateRuleCustomMeta<MessageIds, Options>;
-};
+export type Rule<MessageIds extends string, Options extends ReadonlyArray<unknown>> = EslintRule.RuleModule &
+  RuleModule<MessageIds, Options, Docs> & {
+    meta: NamedCreateRuleCustomMeta<MessageIds, Options>;
+  };
 
 /**
  * All options must extends this type.