Add an experimental flat config support

herp-inc · Sep 24, 2024 · 500a008 · 500a008
1 parent 63a6921
commit 500a008
Show file tree

Hide file tree

Showing 12 changed files with 227 additions and 1 deletion.
diff --git a/base/README.md b/base/README.md
@@ -40,3 +40,27 @@ Add `@herp-inc` to the `extends` section of your [ESLint configuration](http://e
   }
 }
 ```
+
+## [Flat config](https://eslint.org/docs/latest/use/configure/configuration-files) support (experimental)
+
+> [!WARNING]
+> This feature is still experimental, and thus may encounter breaking changes even in a minor version.
+
+Make sure that the following packages are installed as peer dependencies.
+
+| Package                                                                          | Version          |
+| -------------------------------------------------------------------------------- | ---------------- |
+| [`@eslint/js`](https://www.npmjs.com/package/@eslint/js)                         | `^8.56.0 \|\| 9` |
+| [`eslint`](https://www.npmjs.com/package/eslint)                                 | `^8.56.0 \|\| 9` |
+| [`eslint-config-prettier`](https://www.npmjs.com/package/eslint-config-prettier) | `9`              |
+| [`eslint-plugin-import`](https://www.npmjs.com/package/eslint-plugin-import)     | `^2.30.0`        |
+| [`typescript-eslint`](https://www.npmjs.com/package/typescript-eslint)           | `7 \|\| 8`       |
+
+```eslint.config.js
+import config from '@herp-inc/eslint-config/flat';
+
+export default [
+  ...config,
+  // Add your additional configurations here
+];
+```
diff --git a/base/flat.mjs b/base/flat.mjs
@@ -0,0 +1,53 @@
+import eslint from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import tseslint from 'typescript-eslint';
+
+import config from './index.js';
+
+export default [
+  eslint.configs.recommended,
+  ...tseslint
+    .config(
+      ...tseslint.configs.recommendedTypeChecked,
+      ...tseslint.configs.stylisticTypeChecked,
+      eslintConfigPrettier,
+      importPlugin.flatConfigs.recommended,
+      {
+        languageOptions: {
+          parserOptions: {
+            projectService: true,
+          },
+        },
+        settings: {
+          'import/parsers': {
+            '@typescript-eslint/parser': [
+              '.cjs',
+              '.cts',
+              '.ctsx',
+              '.js',
+              '.jsx',
+              '.mjs',
+              '.mts',
+              '.mtsx',
+              '.ts',
+              '.tsx',
+            ],
+          },
+        },
+      },
+      {
+        rules: config.rules,
+      },
+    )
+    .map((config) => ({
+      ...config,
+      files: ['**/*.{cts,ctsx,mts,mtsx,ts,tsx}'],
+    })),
+  {
+    files: ['**/*.d.ts', '**/*.d.*.ts'],
+    rules: {
+      'import/no-default-export': 'off',
+    },
+  },
+];
diff --git a/base/package.json b/base/package.json
@@ -3,6 +3,14 @@
   "version": "202409.0.0",
   "description": "ESLint shareable config for TypeScript environments",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js"
+    },
+    "./flat": {
+      "import": "./flat.mjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/herp-inc/eslint-config"
@@ -19,10 +27,20 @@
   },
   "homepage": "https://github.com/herp-inc/eslint-config",
   "peerDependencies": {
+    "@eslint/js": "^8.56.0 || 9",
     "@typescript-eslint/eslint-plugin": "7 || 8",
     "@typescript-eslint/parser": "7 || 8",
     "eslint": "^8.56.0 || 9",
     "eslint-config-prettier": "*",
-    "eslint-plugin-import": "^2.30.0"
+    "eslint-plugin-import": "^2.30.0",
+    "typescript-eslint":  "7 || 8"
+  },
+  "peerDependenciesMeta": {
+    "@eslint/js": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    }
   }
 }
diff --git a/jest/README.md b/jest/README.md
@@ -40,3 +40,26 @@ Add `@herp-inc/eslint-config-jest` to the `extends` section of your [ESLint conf
   ]
 }
 ```
+
+## [Flat config](https://eslint.org/docs/latest/use/configure/configuration-files) support (experimental)
+
+> [!WARNING]
+> This feature is still experimental, and thus may encounter breaking changes even in a minor version.
+
+Make sure that the following packages are installed as peer dependencies.
+
+| Package                                                                  | Version          |
+| ------------------------------------------------------------------------ | ---------------- |
+| [`eslint`](https://www.npmjs.com/package/eslint)                         | `^8.21.0 \|\| 9` |
+| [`eslint-plugin-jest`](https://www.npmjs.com/package/eslint-plugin-jest) | `^28.8.0`        |
+
+```eslint.config.js
+import config from '@herp-inc/eslint-config/flat';
+import configJest from '@herp-inc/eslint-config-jest/flat';
+
+export default [
+  ...config,
+  ...configJest,
+  // Add your additional configurations here
+];
+```
diff --git a/jest/flat.mjs b/jest/flat.mjs
@@ -0,0 +1,14 @@
+import jest from 'eslint-plugin-jest';
+
+import config from './index.js';
+
+export default [
+  {
+    files: ['**/*.test.*'],
+    ...jest.configs['flat/recommended'],
+    rules: {
+      ...jest.configs['flat/recommended'].rules,
+      ...config.rules,
+    },
+  },
+];
diff --git a/jest/package.json b/jest/package.json
@@ -3,6 +3,14 @@
   "version": "202409.0.0",
   "description": "ESLint shareable config for Jest environments",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js"
+    },
+    "./flat": {
+      "import": "./flat.mjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/herp-inc/eslint-config"

diff --git a/jsx/README.md b/jsx/README.md
@@ -41,3 +41,27 @@ Add `@herp-inc/eslint-config-jsx` to the `extends` section of your [ESLint confi
   ]
 }
 ```
+
+## [Flat config](https://eslint.org/docs/latest/use/configure/configuration-files) support (experimental)
+
+> [!WARNING]
+> This feature is still experimental, and thus may encounter breaking changes even in a minor version.
+
+Make sure that the following packages are installed as peer dependencies.
+
+| Package                                                                          | Version          |
+| -------------------------------------------------------------------------------- | ---------------- |
+| [`eslint`](https://www.npmjs.com/package/eslint)                                 | `^8.21.0 \|\| 9` |
+| [`eslint-plugin-jsx-a11y`](https://www.npmjs.com/package/eslint-plugin-jsx-a11y) | `^6.9.0`         |
+| [`eslint-plugin-react`](https://www.npmjs.com/package/eslint-plugin-react)       | `^7.35.0`        |
+
+```eslint.config.js
+import config from '@herp-inc/eslint-config/flat';
+import configJSX from '@herp-inc/eslint-config-jsx/flat';
+
+export default [
+  ...config,
+  ...configJSX,
+  // Add your additional configurations here
+];
+```
diff --git a/jsx/flat.mjs b/jsx/flat.mjs
@@ -0,0 +1,13 @@
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+
+import config from './index.js';
+
+export default [
+  jsxA11y.flatConfigs.recommended,
+  {
+    rules: config.rules,
+  },
+].map((config) => ({
+  ...config,
+  files: ['**/*.{ctsx,jsx,mtsx,tsx}'],
+}));
diff --git a/jsx/package.json b/jsx/package.json
@@ -3,6 +3,14 @@
   "version": "202409.0.0",
   "description": "ESLint shareable config for JSX environments",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js"
+    },
+    "./flat": {
+      "import": "./flat.mjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/herp-inc/eslint-config"

diff --git a/node/README.md b/node/README.md
@@ -34,3 +34,26 @@ Add `@herp-inc/eslint-config-node` to the `extends` section of your [ESLint conf
   "extends": ["@herp-inc", "@herp-inc/eslint-config-node"]
 }
 ```
+
+## [Flat config](https://eslint.org/docs/latest/use/configure/configuration-files) support (experimental)
+
+> [!WARNING]
+> This feature is still experimental, and thus may encounter breaking changes even in a minor version.
+
+Make sure that the following packages are installed as peer dependencies.
+
+| Package                                                            | Version          |
+| ------------------------------------------------------------------ | ---------------- |
+| [`eslint`](https://www.npmjs.com/package/eslint)                   | `^8.21.0 \|\| 9` |
+| [`eslint-plugin-n`](https://www.npmjs.com/package/eslint-plugin-n) | `^17.10.0`       |
+
+```eslint.config.js
+import config from '@herp-inc/eslint-config/flat';
+import configNode from '@herp-inc/eslint-config-node/flat';
+
+export default [
+  ...config,
+  ...configNode,
+  // Add your additional configurations here
+];
+```
diff --git a/node/flat.mjs b/node/flat.mjs
@@ -0,0 +1,10 @@
+import nodePlugin from 'eslint-plugin-n';
+
+import config from './index.js';
+
+export default [
+  nodePlugin.configs['flat/recommended'],
+  {
+    rules: config.rules,
+  },
+];
diff --git a/node/package.json b/node/package.json
@@ -3,6 +3,14 @@
   "version": "202409.0.0",
   "description": "ESLint shareable config for Node.js environments",
   "main": "index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js"
+    },
+    "./flat": {
+      "import": "./flat.mjs"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/herp-inc/eslint-config"