feat: add @rightcapital/eslint-config that supports ESLint v9

resolves #128

README.md

@@ -22,7 +22,68 @@ Following tools are covered:
 
 ## ESLint
 
-This repo provides the following ESLint config packages:
+### Prerequisite
+
+- `eslint`(>=9)
+- `typescript`(optional, for TypeScript support)
+
+### Usage
+
+Install `@rightcapital/eslint-config` to your project.
+
+```sh
+pnpm add -D @rightcapital/eslint-config
+```
+
+In your `eslint.config.mjs`([or equivalent](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-formats)):
+
+```js
+import eslintConfigRightcapital from '@rightcapital/eslint-config';
+
+const { config } = eslintConfigRightcapital.utils;
+
+export default config(
+  ...eslintConfigRightcapital.configs.recommended,
+
+  // add more configs for specific files or packages if needed
+  {
+    files: ['scripts/**/*.{js,cjs,mjs}'],
+    extends: [
+      ...eslintConfigRightcapital.configs.node,
+      ...eslintConfigRightcapital.configs.script,
+    ],
+  },
+);
+```
+
+### Exported configs and utils
+
+**`configs`**
+
+- `recommended`: the all-in-one config, contains multiple rules configs for different files.
+
+> [!NOTE]  
+> The following configs are designed to be used with `extends` option. They do have a preset [`files` option](https://eslint.org/docs/latest/use/configure/configuration-files#:~:text=files%20%2D%20An%20array%20of%20glob%20patterns%20indicating%20the%20files%20that%20the%20configuration%20object%20should%20apply%20to.%20If%20not%20specified%2C%20the%20configuration%20object%20applies%20to%20all%20files%20matched%20by%20any%20other%20configuration%20object.).
+
+- `js`: JavaScript specific config.
+- `ts`: TypeScript specific config.
+- `react`: React specific config.
+- `node`: Node.js specific config.
+- `script`: Script oriented config, with less strict rules.
+
+**`utils`**
+
+- `config`: reexported util from `typescript-eslint` for easier compositing ESLint config. (docs: https://typescript-eslint.io/packages/typescript-eslint#config)
+- `globals`: reexported util from [globals](https://github.com/sindresorhus/globals), useful for configuring [`languageOptions.globals`](https://eslint.org/docs/latest/use/configure/language-options#specifying-globals).
+
+---
+
+<details>
+<summary>
+<b>[Deprecated]</b> Usage for Legacy ESLint versions(&lt;9)
+</summary>
+
+There are following config packages for legacy ESLint versions(<9):
 
 - `@rightcapital/eslint-config-javascript`: for JavaScript files
 - `@rightcapital/eslint-config-typescript`: for TypeScript files
@@ -31,13 +92,6 @@ This repo provides the following ESLint config packages:
 
 They can be used independently or combined together according to your project's needs.
 
-### Usage
-
-> [!NOTE]  
-> make sure `eslint` is installed in your project.
->
-> And install `typescript` to your project if you want to use the config supporting TypeScript(`@rightcapital/eslint-config-typescript*`).
-
 Install the config package(s) you need:
 
 ```sh
@@ -133,15 +187,16 @@ module.exports = {
 };
 ```
 
+</details>
 </details>
 
 ## Prettier
 
-### Usage
+### Prerequisite
 
-> Note: Prettier is a peer dependency of the config package. You need to install it in the root of your project.
->
-> See: https://prettier.io/docs/en/install.html
+- `prettier`
+
+### Usage
 
 Install config package to your project:
 

change/@rightcapital-eslint-config-base-389da89d-18b6-4255-9590-31cd93841d81.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "feat: add `@rightcapital/eslint-config` that supports ESLint v9",
+  "packageName": "@rightcapital/eslint-config-base",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@rightcapital-eslint-config-cd2767f8-32a2-475c-8110-9b14a87a3512.json

@@ -0,0 +1,7 @@
+{
+  "type": "major",
+  "comment": "feat: add `@rightcapital/eslint-config` that supports ESLint v9",
+  "packageName": "@rightcapital/eslint-config",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change/@rightcapital-eslint-config-javascript-6511ef06-f36b-4d0e-8fcb-f2f72c4211b1.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "feat: add `@rightcapital/eslint-config` that supports ESLint v9",
+  "packageName": "@rightcapital/eslint-config-javascript",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@rightcapital-eslint-config-typescript-78196c26-03c1-4058-9b64-fc290b95add3.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "feat: add `@rightcapital/eslint-config` that supports ESLint v9",
+  "packageName": "@rightcapital/eslint-config-typescript",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

change/@rightcapital-eslint-config-typescript-react-1ed7f4c8-2328-47ef-b72a-f6f254cc2605.json

@@ -0,0 +1,7 @@
+{
+  "type": "none",
+  "comment": "feat: add `@rightcapital/eslint-config` that supports ESLint v9",
+  "packageName": "@rightcapital/eslint-config-typescript-react",
+  "email": "[email protected]",
+  "dependentChangeType": "none"
+}

eslint.config.mjs

@@ -0,0 +1,61 @@
+import eslintConfigRightcapital from '@rightcapital/eslint-config';
+import eslintPluginEslintPlugin from 'eslint-plugin-eslint-plugin';
+
+const { config } = eslintConfigRightcapital.utils;
+
+export default config(
+  {
+    /**
+     * NOTE:
+     * DO NOT put any other keys other than `ignores` in this object.
+     * see: https://eslint.org/docs/latest/use/configure/configuration-files#globally-ignoring-files-with-ignores
+     */
+    ignores: [
+      // build output
+      'packages/*/lib',
+      '.github/actions/*/dist',
+
+      // E2E tests, they contains individual lint config and specific ESLint dependencies
+      'specs',
+    ],
+  },
+  ...eslintConfigRightcapital.configs.recommended,
+
+  // scripts
+  {
+    files: [
+      'packages/*/*.{js,cjs,mjs,ts,cts,mts}', // each package's top-level directory files
+      'scripts/**/*.{js,cjs,mjs}',
+      '.github/actions/**/*.{js,cjs,mjs}',
+    ],
+    extends: [
+      ...eslintConfigRightcapital.configs.script,
+      ...eslintConfigRightcapital.configs.node,
+    ],
+  },
+
+  // -----------------------
+  // package specific rules
+  // -----------------------
+
+  // @rightcapital/eslint-plugin
+  {
+    files: ['packages/eslint-plugin/**/*.ts'],
+    extends: [eslintPluginEslintPlugin.configs['flat/recommended']],
+  },
+  {
+    files: ['packages/eslint-plugin/src/helpers/test/*.ts'],
+    rules: {
+      'import-x/no-extraneous-dependencies': [
+        'error',
+        { devDependencies: true },
+      ],
+    },
+  },
+
+  // @rightcapital/lint-eslint-config-rules
+  {
+    files: ['packages/lint-eslint-config-rules/**/*.ts'],
+    extends: [...eslintConfigRightcapital.configs.script],
+  },
+);

package.json

@@ -35,15 +35,14 @@
     "@commitlint/cli": "19.5.0",
     "@commitlint/config-conventional": "19.5.0",
     "@commitlint/cz-commitlint": "19.5.0",
-    "@rightcapital/eslint-config-javascript": "workspace:*",
-    "@rightcapital/eslint-config-typescript": "workspace:*",
+    "@rightcapital/eslint-config": "workspace:*",
     "@rightcapital/prettier-config": "workspace:*",
     "@rightcapital/scripts": "workspace:*",
     "@types/node": "20.16.5",
     "beachball": "2.47.1",
     "commitizen": "4.3.0",
     "concurrently": "9.0.1",
-    "eslint": "8.57.1",
+    "eslint": "9.12.0",
     "eslint-plugin-eslint-plugin": "6.2.0",
     "execa": "9.4.0",
     "husky": "9.1.6",

packages/eslint-config-base/package.json

@@ -35,10 +35,12 @@
   "devDependencies": {
     "@rightcapital/tsconfig": "workspace:*",
     "@types/confusing-browser-globals": "1.0.3",
-    "@types/semver": "7.5.8"
+    "@types/eslint": "8.56.10",
+    "@types/semver": "7.5.8",
+    "eslint": "8.57.1"
   },
   "peerDependencies": {
-    "eslint": "^8.23.1 || ^9.0.0"
+    "eslint": "^8.23.1"
   },
   "packageManager": "[email protected]",
   "engines": {

packages/eslint-config-javascript/package.json

@@ -26,7 +26,9 @@
     "@rushstack/eslint-patch": "1.10.4"
   },
   "devDependencies": {
-    "@rightcapital/tsconfig": "workspace:*"
+    "@rightcapital/tsconfig": "workspace:*",
+    "@types/eslint": "8.56.10",
+    "eslint": "8.57.1"
   },
   "peerDependencies": {
     "eslint": "^8.23.1"

packages/eslint-config-typescript-react/package.json

@@ -33,7 +33,9 @@
     "eslint-plugin-react-hooks": "4.6.2"
   },
   "devDependencies": {
-    "@rightcapital/tsconfig": "workspace:*"
+    "@rightcapital/tsconfig": "workspace:*",
+    "@types/eslint": "8.56.10",
+    "eslint": "8.57.1"
   },
   "peerDependencies": {
     "eslint": "^8.57.0",

packages/eslint-config-typescript/package.json

@@ -30,7 +30,9 @@
     "eslint-config-prettier": "9.1.0"
   },
   "devDependencies": {
-    "@rightcapital/tsconfig": "workspace:*"
+    "@rightcapital/tsconfig": "workspace:*",
+    "@types/eslint": "8.56.10",
+    "eslint": "8.57.1"
   },
   "peerDependencies": {
     "eslint": "^8.23.1",

packages/eslint-config/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@rightcapital/eslint-config",
+  "version": "36.3.0",
+  "description": "ESLint Config for RightCapital",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RightCapitalHQ/frontend-style-guide.git",
+    "directory": "packages/eslint-config"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "prebuild": "pnpm run clean",
+    "build": "tsc --build",
+    "clean": "tsc --build --clean",
+    "prepack": "pnpm run build"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "1.9.0",
+    "@rightcapital/eslint-plugin": "workspace:*",
+    "@stylistic/eslint-plugin": "2.9.0",
+    "@typescript-eslint/utils": "8.0.1",
+    "confusing-browser-globals": "1.0.11",
+    "eslint-import-resolver-typescript": "3.6.1",
+    "eslint-plugin-import-x": "4.3.1",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-lodash": "8.0.0",
+    "eslint-plugin-n": "17.10.2",
+    "eslint-plugin-react-hooks": "4.6.2",
+    "eslint-plugin-simple-import-sort": "12.1.1",
+    "eslint-plugin-unicorn": "55.0.0",
+    "globals": "15.10.0",
+    "typescript-eslint": "8.0.1"
+  },
+  "devDependencies": {
+    "@rightcapital/tsconfig": "workspace:*",
+    "@types/confusing-browser-globals": "1.0.3",
+    "@types/eslint-plugin-jsx-a11y": "6.9.0",
+    "@types/semver": "7.5.8"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "packageManager": "[email protected]",
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  }
+}