@pplancq/eslint-config 3.0.1 → 4.0.1

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## @pplancq/eslint-config [4.0.1](https://github.com/pplancq/dev-tools/compare/@pplancq/eslint-config@4.0.0...@pplancq/eslint-config@4.0.1) (2024-11-11)
+
+### Bug Fixes
+
+* **deps:** update dependency eslint-plugin-jest to ^28.9.0 ([db2bb8d](https://github.com/pplancq/dev-tools/commit/db2bb8d283207659cf3db7f8636f70aef5dcfd0c))
+
+## @pplancq/eslint-config [4.0.0](https://github.com/pplancq/dev-tools/compare/@pplancq/eslint-config@3.0.1...@pplancq/eslint-config@4.0.0) (2024-11-08)
+
+### ⚠ BREAKING CHANGES
+
+* **eslint-config:** this version support only eslint v9 with new flat configuration.\ Please refer to the Migration Guide for detailed instructions: [Migration Guide](./MIGRATION.md#migration-guide-pplancqeslint-config-v3-to-v4)
+
+### Features
+
+* **eslint-config:** make factory for define eslint flat config ([4f5e261](https://github.com/pplancq/dev-tools/commit/4f5e26169d3258b2b0f0de982ae664e69317a6ee))
+* **eslint-config:** migrate rule to flat config ([40fc36e](https://github.com/pplancq/dev-tools/commit/40fc36e6aac55baa634a55c4dd499c7ce4058dc1))
+* **eslint-config:** update eslint v8 to v9 ([5cf5721](https://github.com/pplancq/dev-tools/commit/5cf57215c74172fd0f611c8425522d927752026e))
+* **eslint-config:** update script to set default config ([16215da](https://github.com/pplancq/dev-tools/commit/16215da3e7c9cebc078f31cf5cc1b2006ee65634))
+
+### Bug Fixes
+
+* **deps:** update dependency eslint-plugin-jsx-a11y to ^6.10.1 ([69f02a2](https://github.com/pplancq/dev-tools/commit/69f02a2f3cbf00ee75168b48345458c9effbeaf1))
+* **deps:** update dependency eslint-plugin-jsx-a11y to ^6.10.2 ([cd2bf08](https://github.com/pplancq/dev-tools/commit/cd2bf08034f8bca2d62d6a1d5d366a9d424e9ab9))
+* **deps:** update dependency eslint-plugin-react to ^7.37.2 ([c57c4a6](https://github.com/pplancq/dev-tools/commit/c57c4a6cc78bd0d8fa627f015acc6bc92dea59d1))
+* **deps:** update dependency eslint-plugin-testing-library to ^6.4.0 ([94274e0](https://github.com/pplancq/dev-tools/commit/94274e08effe5bbf59f37f4213b21cb0bb293690))
+
 ## @pplancq/eslint-config [3.0.1](https://github.com/pplancq/dev-tools/compare/@pplancq/eslint-config@3.0.0...@pplancq/eslint-config@3.0.1) (2024-10-15)
 
 ### Bug Fixes

package/MIGRATION.md

@@ -0,0 +1,52 @@
+# Migration Guide v3 to v4
+
+This guide will help you migrate from version 3 to version 4 of the `@pplancq/eslint-config` package, which now supports ESLint 9 and the new flat configuration.
+
+## Steps to Migrate
+
+### 1. Update ESLint and Install the New Configuration
+
+First, update ESLint to version 9 and install the new version of the configuration package:
+
+```shell
+npm install --save-dev eslint@9 @pplancq/eslint-config@4
+```
+
+### 2. Remove Legacy Configuration
+
+Remove the legacy ESLint configuration from your `package.json` or `.eslintrc` file. For example, if you have the following in your `package.json`:
+
+```json
+{
+  "eslintConfig": {
+    "extends": ["@pplancq/eslint-config/react"]
+  }
+}
+```
+
+Remove this section entirely.
+
+### 3. Create New Configuration File
+
+Create a new `eslint.config.mjs` file in the root of your project:
+
+```javascript
+// eslint.config.mjs
+import { defineConfig } from '@pplancq/eslint-config';
+
+export default defineConfig({
+  enableReact: true,
+});
+```
+
+### 4. Adjust Configuration Options
+
+Review and adjust the configuration options as needed. For detailed information on all available options, please refer to the [README](./README.md).
+
+### Configuration Equivalents
+
+- `@pplancq/eslint-config/node` is equivalent to `defineConfig()`.
+- To use `@pplancq/eslint-config/react`, set the `enableReact` option to `true`.
+- To use `@pplancq/eslint-config/vitest`, set the `enableVitest` option to `true`.
+- To use `@pplancq/eslint-config/jest`, set the `enableJest` option to `true`.
+- To use `@pplancq/eslint-config/prettier`, set the `enablePrettier` option to `'on'`.

package/README.md

@@ -1,6 +1,6 @@
 # @pplancq/eslint-config
 
-This package has been designed to provide a simplified and customizable ESLint configuration for your React/Node.js applications. Whether you are a beginner or an experienced developer, this package will help you configure ESLint with strict rules to ensure better code structure. Based on Airbnb’s ESLint configuration, this package includes additional rules for TypeScript files and test files.
+This package provides a simplified and customizable ESLint configuration for your React/Node.js applications. Whether you are a beginner or an experienced developer, this package helps you configure ESLint with strict rules to ensure better code structure. Based on Airbnb’s ESLint configuration, it includes additional rules for TypeScript files and test files.
 
 ## Getting Started
 
@@ -11,79 +11,55 @@ This package has been designed to provide a simplified and customizable ESLint c
 ### Installation
 
 ```shell
-npm install --save-dev eslint@8 @pplancq/eslint-config
+npm install --save-dev eslint@9 @pplancq/eslint-config
 ```
 
-## ESLint Configuration
+## Usage
 
-Use the following command to enable the default configuration:
+### Automatic Configuration
+
+To enable the default configuration automatically, use the following command:
 
 ```shell
 npx init-eslint-config
 ```
 
-### @pplancq/eslint-config/react
-
-To use, add the following to your `package.json`:
-
-```json
-{
-  "eslintConfig": { "extends": ["@pplancq/eslint-config/react"] }
-}
-```
-
-This configuration enables the rules for base, TypeScript, React, and Testing Library files.
+### Manual Configuration
 
-### @pplancq/eslint-config/node
+Alternatively, you can create an `eslint.config.mjs` file in the root of your project:
 
-To use, add the following to your `package.json`:
+```javascript
+// eslint.config.mjs
+import { defineConfig } from '@pplancq/eslint-config';
 
-```json
-{
-  "eslintConfig": { "extends": ["@pplancq/eslint-config/node"] }
-}
+export default defineConfig({
+  enableReact: true,
+  enableVitest: true,
+});
 ```
 
-This configuration enables the rules for base and TypeScript files.
+### Options
 
-### @pplancq/eslint-config/vitest
+The following options can be passed to the `defineConfig` function. All options are optional. By default, this configuration includes rules for base, import, and TypeScript files.
 
-To use, add the following to your `package.json`:
+| Option         | Default                                    | Description                                                                                                                                                                                            |
+| -------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| tsFiles        | ['**/*.ts?(x)']                            | Patterns for TypeScript files                                                                                                                                                                          |
+| unitTestFiles  | ['**/*.{test,spec,steps}.{js,jsx,ts,tsx}'] | Patterns for unit test files                                                                                                                                                                           |
+| enableReact    | false                                      | Enables rules for React and Testing Library files                                                                                                                                                      |
+| enableVitest   | false                                      | Enables rules for Vitest files                                                                                                                                                                         |
+| enableJest     | false                                      | Enables rules for Jest files                                                                                                                                                                           |
+| enablePrettier | 'off'                                      | 'off' disables Prettier rules<br/>'on' enables Prettier rules<br/>'disableStyleOnly' enables Prettier rules but disables the 'prettier/prettier' rule, not using Prettier CLI for formatting your code |
+| extendConfig   | []                                         | Extends the ESLint configuration                                                                                                                                                                       |
 
-```json
-{
-  "eslintConfig": { "extends": ["@pplancq/eslint-config/vitest"] }
-}
-```
-
-This configuration enables the rules for Vitest files.
-
-### @pplancq/eslint-config/jest
+### Prettier Configuration
 
-To use, add the following to your `package.json`:
-
-```json
-{
-  "eslintConfig": { "extends": ["@pplancq/eslint-config/jest"] }
-}
-```
-
-This configuration enables the rules for Jest files.
-
-### @pplancq/eslint-config/prettier
-
-To use, add the following to your `package.json`:
-
-```json
-{
-  "eslintConfig": { "extends": ["@pplancq/eslint-config/prettier"] }
-}
-```
-
-This configuration enables the rules for Prettier files.
-
-You will need to install the following packages:
+If you set `enablePrettier: 'on'`, you will need to install the following packages:
 
 ```shell
 npm install --save-dev prettier eslint-plugin-prettier
 ```
+
+## Migration
+
+If you are upgrading from version 3 to version 4 of `@pplancq/eslint-config`, please refer to the [Migration Guide](./MIGRATION.md#migration-guide-pplancqeslint-config-v3-to-v4) for detailed instructions.

package/bin/init.js

@@ -1,11 +1,16 @@
 #!/usr/bin/env node
 const { writeFileSync } = require('fs');
 
-console.info('Add eslint config in .eslintrc.js');
+console.info('Add eslint config in eslint.config.mjs');
 
 writeFileSync(
-  '.eslintrc.js',
-  "module.exports = { extends: ['@pplancq/eslint-config/react', '@pplancq/eslint-config/vitest'] };\n",
+  'eslint.config.mjs',
+  "import { defineConfig } from '@pplancq/eslint-config';\n" +
+    '\n' +
+    'export default defineConfig({\n' +
+    '  enableReact: true,\n' +
+    '  enableVitest: true,\n' +
+    '});\n',
   {
     encoding: 'utf-8',
   },

package/main.js

@@ -0,0 +1,67 @@
+const { baseRules } = require('./rules/base');
+const { importRules } = require('./rules/import');
+const { reactJsxA11yRules } = require('./rules/react-jsx-a11y');
+const { reactRules, reactTypescriptRules, reactTestRules } = require('./rules/react');
+const { typescriptRules } = require('./rules/typescript');
+const { prettierRules } = require('./rules/prettier');
+const { vitestRules } = require('./rules/vitest');
+const { jestRules } = require('./rules/jest');
+
+/**
+ * define eslint flat config.
+ *
+ * @param {Object} options
+ * @param {string[]} [options.tsFiles=['**\/*.ts?(x)']]
+ * @param {string[]} [options.unitTestFiles=['**\/*.{test,spec,steps}.{js,jsx,ts,tsx}']]
+ * @param {boolean} [options.enableReact=false]
+ * @param {boolean} [options.enableVitest=false]
+ * @param {boolean} [options.enableJest=false]
+ * @param {'off' | 'on' | 'disableStyleOnly'} [options.enablePrettier='on']
+ * @param {Array<import('eslint').Linter.Config>} [options.extendConfig=[]]
+ *
+ * @returns {import('eslint').Linter.Config}
+ */
+const defineConfig = ({
+  tsFiles = ['**/*.ts?(x)'],
+  unitTestFiles = ['**/*.{test,spec,steps}.{js,jsx,ts,tsx}'],
+  enableReact = false,
+  enableVitest = false,
+  enableJest = false,
+  enablePrettier = 'off',
+  extendConfig = [],
+} = {}) => {
+  typescriptRules.files = tsFiles;
+  reactTypescriptRules.files = tsFiles;
+  reactTestRules.files = unitTestFiles;
+  vitestRules.files = unitTestFiles;
+  jestRules.files = unitTestFiles;
+
+  if (enablePrettier === 'disableStyleOnly') {
+    prettierRules.rules['prettier/prettier'] = 'off';
+  }
+
+  return [
+    importRules,
+    baseRules,
+    enableReact && reactJsxA11yRules,
+    typescriptRules,
+    enableReact && reactRules,
+    enableReact && reactTypescriptRules,
+    enableReact && reactTestRules,
+    enablePrettier !== 'off' && prettierRules,
+    enableVitest && vitestRules,
+    enableJest && jestRules,
+    {
+      files: ['eslint.config.*'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+        'import/no-default-export': 'off',
+      },
+    },
+    ...extendConfig,
+  ].filter(Boolean);
+};
+
+module.exports = {
+  defineConfig,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pplancq/eslint-config",
-  "version": "3.0.1",
+  "version": "4.0.1",
   "license": "MIT",
   "description": "pplancq eslint config",
   "author": "pplancq <paul.plancq@outlook.fr>",
@@ -12,13 +12,7 @@
   "bugs": {
     "url": "https://github.com/pplancq/dev-tools/issues"
   },
-  "exports": {
-    "./node": "./node.js",
-    "./react": "./react.js",
-    "./jest": "./jest.js",
-    "./vitest": "./vitest.js",
-    "./prettier": "./prettier.js"
-  },
+  "main": "main.js",
   "bin": {
     "init-eslint-config": "./bin/init.js"
   },
@@ -27,21 +21,22 @@
     "config"
   ],
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.8.1",
-    "@typescript-eslint/parser": "^8.8.1",
+    "@typescript-eslint/eslint-plugin": "^8.13.0",
+    "@typescript-eslint/parser": "^8.13.0",
     "@vitest/eslint-plugin": "^1.1.7",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jest": "^28.8.3",
+    "eslint-plugin-jest": "^28.9.0",
     "eslint-plugin-jest-dom": "^5.4.0",
     "eslint-plugin-jest-extended": "^2.4.0",
-    "eslint-plugin-jsx-a11y": "^6.10.0",
-    "eslint-plugin-react": "^7.37.1",
-    "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-testing-library": "^6.3.0"
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-testing-library": "^6.4.0",
+    "globals": "^15.12.0"
   },
   "peerDependencies": {
-    "eslint": "^8.57.0",
+    "eslint": "^9.14.0",
     "eslint-plugin-prettier": "^5.0.1",
     "prettier": "^3.2.5"
   },

package/rules/base.js

@@ -1,17 +1,20 @@
-module.exports = {
-  extends: ['./import.js'],
-  parserOptions: {
+const globals = require('globals');
+
+const baseRules = {
+  languageOptions: {
     ecmaVersion: 'latest',
     sourceType: 'module',
-    ecmaFeatures: {
-      generators: false,
-      objectLiteralDuplicateProperties: false,
+    parserOptions: {
+      ecmaFeatures: {
+        generators: false,
+        objectLiteralDuplicateProperties: false,
+      },
+    },
+    globals: {
+      ...globals.browser,
+      ...globals.node,
+      ...globals.es2025,
     },
-  },
-  env: {
-    browser: true,
-    node: true,
-    es6: true,
   },
   rules: {
     // eslint https://eslint.org
@@ -1453,3 +1456,7 @@ module.exports = {
     'yield-star-spacing': ['error', 'after'],
   },
 };
+
+module.exports = {
+  baseRules,
+};

package/rules/import.js

@@ -1,11 +1,15 @@
-module.exports = {
-  plugins: ['import'],
-  parserOptions: {
+const importPlugin = require('eslint-plugin-import');
+
+const importRules = {
+  plugins: {
+    import: importPlugin,
+  },
+  languageOptions: {
     ecmaVersion: 'latest',
     sourceType: 'module',
-  },
-  env: {
-    es6: true,
+    globals: {
+      es6: true,
+    },
   },
   rules: {
     // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
@@ -272,3 +276,7 @@ module.exports = {
     },
   },
 };
+
+module.exports = {
+  importRules,
+};