feat: move flat configs to new "flat" subpackage

Author: RebeccaStevens

.eslintrc.json

@@ -119,6 +119,7 @@
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/prefer-function-type": "off",
         "@typescript-eslint/consistent-generic-constructors": "off",
+        "import/extensions": "off",
         "import/no-unresolved": "off",
         "init-declarations": "off",
         "jsdoc/require-jsdoc": "off",

GETTING_STARTED.md

@@ -30,6 +30,17 @@ pnpm add -D eslint @typescript-eslint/parser eslint-plugin-functional
 
 ## Usage
 
+### Flat Config
+
+If using the new [flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new),
+import from `eslint-plugin-functional/flat`.
+
+```ts
+import functional from "eslint-plugin-functional/flat";
+```
+
+### Classic Config
+
 Add `functional` to the plugins section of your `.eslintrc` configuration file. Then configure the rules you want to use under the rules section.
 
 ```jsonc

README.md

@@ -35,9 +35,6 @@ Tidelift is working with the maintainers of `eslint-plugin-functional` and a gro
 
 The following rulesets are made available by this plugin.
 
-Note: if using a [flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) add a `flat/` prefix to the preset name
-(e.g. `functional.configs["flat/recommended"]`).
-
 Presets:
 
 - **Strict** (`plugin:functional/strict`)\

knip.jsonc

@@ -1,6 +1,11 @@
 {
   "$schema": "node_modules/knip/schema-jsonc.json",
-  "entry": ["src/index.ts!", "tests/**/*.test.ts", "cz-adapter/index.js"],
+  "entry": [
+    "src/flat.ts!",
+    "src/classic.ts!",
+    "tests/**/*.test.ts",
+    "cz-adapter/index.js",
+  ],
   "project": ["src/**/*.ts!", "tests/**/*.ts", "cz-adapter/**/*.{js,ts}"],
   "ignore": ["tests/fixture/file.ts"],
   "ignoreDependencies": ["@types/eslint", "@vitest/coverage-istanbul"],

package.json

@@ -34,15 +34,25 @@
     "Jonas Kello"
   ],
   "exports": {
-    "types": {
-      "import": "./lib/index.d.mts",
-      "require": "./lib/index.d.cts"
+    ".": {
+      "types": {
+        "import": "./lib/classic.d.mts",
+        "require": "./lib/classic.d.cts"
+      },
+      "import": "./lib/classic.mjs",
+      "require": "./lib/classic.cjs"
     },
-    "import": "./lib/index.mjs",
-    "require": "./lib/index.cjs"
+    "./flat": {
+      "types": {
+        "import": "./lib/flat.d.mts",
+        "require": "./lib/flat.d.cts"
+      },
+      "import": "./lib/flat.mjs",
+      "require": "./lib/flat.cjs"
+    }
   },
-  "main": "lib/index.cjs",
-  "types": "lib/index.d.cts",
+  "main": "lib/classic.cjs",
+  "types": "lib/classic.d.cts",
   "files": [
     "lib/",
     "package.json",

rollup.config.ts

@@ -12,17 +12,17 @@ const treeshake = {
   unknownGlobalSideEffects: false,
 } satisfies RollupOptions["treeshake"];
 
-const library = {
-  input: "src/index.ts",
+const classic = {
+  input: "src/classic.ts",
 
   output: [
     {
-      file: pkg.exports.import,
+      file: pkg.exports["."].import,
       format: "esm",
       sourcemap: false,
     },
     {
-      file: pkg.exports.require,
+      file: pkg.exports["."].require,
       format: "cjs",
       sourcemap: false,
     },
@@ -42,4 +42,34 @@ const library = {
   treeshake,
 } satisfies RollupOptions;
 
-export default [library];
+const flat = {
+  input: "src/flat.ts",
+
+  output: [
+    {
+      file: pkg.exports["./flat"].import,
+      format: "esm",
+      sourcemap: false,
+    },
+    {
+      file: pkg.exports["./flat"].require,
+      format: "cjs",
+      sourcemap: false,
+    },
+  ],
+
+  plugins: [
+    rollupPluginAutoExternal(),
+    rollupPluginTs({
+      transpileOnly: true,
+      tsconfig: "tsconfig.build.json",
+    }),
+    rollupPluginDeassert({
+      include: ["**/*.{js,ts}"],
+    }),
+  ],
+
+  treeshake,
+} satisfies RollupOptions;
+
+export default [classic, flat];

src/classic.ts

@@ -0,0 +1,47 @@
+import { type Linter } from "@typescript-eslint/utils/ts-eslint";
+
+import all from "#eslint-plugin-functional/configs/all";
+import currying from "#eslint-plugin-functional/configs/currying";
+import disableTypeChecked from "#eslint-plugin-functional/configs/disable-type-checked";
+import externalTypeScriptRecommended from "#eslint-plugin-functional/configs/external-typescript-recommended";
+import externalVanillaRecommended from "#eslint-plugin-functional/configs/external-vanilla-recommended";
+import lite from "#eslint-plugin-functional/configs/lite";
+import noExceptions from "#eslint-plugin-functional/configs/no-exceptions";
+import noMutations from "#eslint-plugin-functional/configs/no-mutations";
+import noOtherParadigms from "#eslint-plugin-functional/configs/no-other-paradigms";
+import noStatements from "#eslint-plugin-functional/configs/no-statements";
+import off from "#eslint-plugin-functional/configs/off";
+import recommended from "#eslint-plugin-functional/configs/recommended";
+import strict from "#eslint-plugin-functional/configs/strict";
+import stylistic from "#eslint-plugin-functional/configs/stylistic";
+import { rules } from "#eslint-plugin-functional/rules";
+import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
+
+export default {
+  rules,
+  configs: {
+    all: { plugins: [ruleNameScope], rules: all },
+    lite: { plugins: [ruleNameScope], rules: lite },
+    recommended: { plugins: [ruleNameScope], rules: recommended },
+    strict: { plugins: [ruleNameScope], rules: strict },
+    off: { plugins: [ruleNameScope], rules: off },
+    "disable-type-checked": {
+      plugins: [ruleNameScope],
+      rules: disableTypeChecked,
+    },
+    "external-vanilla-recommended": {
+      plugins: [ruleNameScope],
+      rules: externalVanillaRecommended,
+    },
+    "external-typescript-recommended": {
+      plugins: [ruleNameScope],
+      rules: externalTypeScriptRecommended,
+    },
+    currying: { plugins: [ruleNameScope], rules: currying },
+    "no-exceptions": { plugins: [ruleNameScope], rules: noExceptions },
+    "no-mutations": { plugins: [ruleNameScope], rules: noMutations },
+    "no-other-paradigms": { plugins: [ruleNameScope], rules: noOtherParadigms },
+    "no-statements": { plugins: [ruleNameScope], rules: noStatements },
+    stylistic: { plugins: [ruleNameScope], rules: stylistic },
+  },
+} as Linter.Plugin;

src/flat.ts

@@ -0,0 +1,60 @@
+import { type FlatConfig } from "@typescript-eslint/utils/ts-eslint";
+
+import all from "#eslint-plugin-functional/configs/all";
+import currying from "#eslint-plugin-functional/configs/currying";
+import disableTypeChecked from "#eslint-plugin-functional/configs/disable-type-checked";
+import externalTypeScriptRecommended from "#eslint-plugin-functional/configs/external-typescript-recommended";
+import externalVanillaRecommended from "#eslint-plugin-functional/configs/external-vanilla-recommended";
+import lite from "#eslint-plugin-functional/configs/lite";
+import noExceptions from "#eslint-plugin-functional/configs/no-exceptions";
+import noMutations from "#eslint-plugin-functional/configs/no-mutations";
+import noOtherParadigms from "#eslint-plugin-functional/configs/no-other-paradigms";
+import noStatements from "#eslint-plugin-functional/configs/no-statements";
+import off from "#eslint-plugin-functional/configs/off";
+import recommended from "#eslint-plugin-functional/configs/recommended";
+import strict from "#eslint-plugin-functional/configs/strict";
+import stylistic from "#eslint-plugin-functional/configs/stylistic";
+import { rules } from "#eslint-plugin-functional/rules";
+import { __VERSION__ } from "#eslint-plugin-functional/utils/constants";
+
+const functional = {
+  meta: {
+    name: "eslint-plugin-functional",
+    version: __VERSION__,
+  } as const,
+  rules,
+} satisfies Omit<FlatConfig.Plugin, "configs">;
+
+const configs = {
+  all: { plugins: { functional }, rules: all },
+  lite: { plugins: { functional }, rules: lite },
+  recommended: { plugins: { functional }, rules: recommended },
+  strict: { plugins: { functional }, rules: strict },
+  off: { plugins: { functional }, rules: off },
+  disableTypeChecked: {
+    plugins: { functional },
+    rules: disableTypeChecked,
+  },
+  externalVanillaRecommended: {
+    plugins: { functional },
+    rules: externalVanillaRecommended,
+  },
+  externalTypescriptRecommended: {
+    plugins: { functional },
+    rules: externalTypeScriptRecommended,
+  },
+  currying: { plugins: { functional }, rules: currying },
+  noExceptions: { plugins: { functional }, rules: noExceptions },
+  noMutations: { plugins: { functional }, rules: noMutations },
+  noOtherParadigms: {
+    plugins: { functional },
+    rules: noOtherParadigms,
+  },
+  noStatements: { plugins: { functional }, rules: noStatements },
+  stylistic: { plugins: { functional }, rules: stylistic },
+} satisfies Record<string, FlatConfig.Config>;
+
+export default {
+  ...functional,
+  configs,
+} as const;