feat: eslint 9 migration

BREAKING CHANGE: eslint 9 is now require BREAKING CHANGE: typescript >= v4.7 is now required (when using typescript)
eslint-functional · Apr 15, 2024 · af3665c · af3665c
1 parent 780b960
commit af3665c
Show file tree

Hide file tree

Showing 71 changed files with 1,392 additions and 1,335 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/workflows/lint-prettier.yml b/.github/workflows/lint-prettier.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -28,8 +28,6 @@ jobs:
     uses: ./.github/workflows/lint-markdown.yml
   lint_packages:
     uses: ./.github/workflows/lint-packages.yml
-  lint_prettier:
-    uses: ./.github/workflows/lint-prettier.yml
   lint_spelling:
     uses: ./.github/workflows/lint-spelling.yml
   test:
@@ -46,7 +44,6 @@ jobs:
       - lint_markdown
       - lint_spelling
       - lint_packages
-      - lint_prettier
       - test
       - type_check
     runs-on: ubuntu-latest

diff --git a/.github/workflows/test-js.yml b/.github/workflows/test-js.yml
@@ -14,14 +14,13 @@ jobs:
         os:
           - "ubuntu-latest"
         node_version:
-          - "16"
-          - "18"
+          - "18.18"
           - "20"
           - "latest"
         ts_version:
           - "next"
           - "latest"
-          - "4.3.5"
+          - "4.7.4"
           # - "JS"
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.ts_version == 'next' }}

diff --git a/.lintstagedrc.yml b/.lintstagedrc.yml
@@ -1,15 +1,14 @@
 "*.{json,yml}":
-  - prettier --ignore-unknown --write
+  - eslint --fix
   - cspell lint --no-progress --show-suggestions --show-context --no-must-find-files --dot
 
 "*.ts":
-  - prettier --ignore-unknown --write
   - eslint --fix
   - cspell lint --no-progress --show-suggestions --show-context --no-must-find-files --dot
   - tsc-files -p tsconfig.build.json --noEmit
 
 "*.md":
-  - prettier --ignore-unknown --write
+  - eslint --fix
   - markdownlint --config=.markdownlint.json --ignore-path=.markdownlintignore
   - cspell lint --no-progress --show-suggestions --show-context --no-must-find-files --dot
 

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,15 +1,24 @@
 {
   "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit",
-    "source.fixAll.eslint": "explicit",
-    "source.formatDocument": "explicit",
-    "source.organizeImports": "explicit",
-    "source.sortImports": "explicit"
+    "source.fixAll.eslint": "explicit"
   },
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.formatOnSaveMode": "file",
   "editor.rulers": [80],
+  "eslint.probe": [
+    "html",
+    "javascript",
+    "javascriptreact",
+    "json",
+    "jsonc",
+    "markdown",
+    "toml",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "yaml"
+  ],
   "files.associations": {
     ".markdownlint.json": "jsonc",
     ".markdownlintignore": "ignore"
@@ -29,6 +38,6 @@
   },
   "typescript.tsdk": "./node_modules/typescript/lib",
   "[markdown]": {
-    "editor.rulers": [160]
+    "editor.rulers": [120]
   }
 }
diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md
@@ -19,97 +19,67 @@ pnpm add -D eslint eslint-plugin-functional
 
 ```sh
 # Install with npm
-npm install -D eslint @typescript-eslint/parser eslint-plugin-functional
+npm install -D eslint typescript-eslint eslint-plugin-functional
 
 # Install with yarn
-yarn add -D eslint @typescript-eslint/parser eslint-plugin-functional
+yarn add -D eslint typescript-eslint eslint-plugin-functional
 
 # Install with pnpm
-pnpm add -D eslint @typescript-eslint/parser eslint-plugin-functional
+pnpm add -D eslint typescript-eslint eslint-plugin-functional
 ```
 
 ## Usage
 
-### Flat Config
+### Without TypeScript
 
-If using the new [flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new),
-import from `eslint-plugin-functional/flat`.
+In your `eslint.config.js` file, import `eslint-plugin-functional` and configure it as you wish.
 
-```ts
-import functional from "eslint-plugin-functional/flat";
-```
-
-### Classic Config
+If you're not using TypeScript, be sure to include the `disableTypeChecked` config after the other configs to
+disable rules that require TypeScript.
 
-Add `functional` to the plugins section of your `.eslintrc` configuration file. Then configure the rules you want to use under the rules section.
+```js
+// eslint.config.js
+import functional from "eslint-plugin-functional";
 
-```jsonc
-{
-  "plugins": ["functional"],
-  "rules": {
-    "functional/rule-name": "error"
-  }
-}
-```
-
-There are several rulesets provided by this plugin.
-[See the README](./README.md#rulesets) for what they are and what rules are included in each.
-Enable rulesets via the "extends" property of your `.eslintrc` configuration file.
-
-Be sure to include the `"plugin:functional/disable-type-checked"` ruleset to disable rules that require TypeScript.
-
-```jsonc
-{
-  // ...
-  "extends": [
-    "plugin:functional/external-vanilla-recommended",
-    "plugin:functional/recommended",
-    "plugin:functional/stylistic",
-    "plugin:functional/disable-type-checked"
-  ]
-}
+export default [
+  ...functional.configs.externalVanillaRecommended,
+  ...functional.configs.recommended,
+  ...functional.configs.stylistic,
+  ...functional.configs.disableTypeChecked,
+  // your other plugin configs here
+  {
+    rules: {
+      // any rule configs here
+    },
+  },
+];
 ```
 
 ### With TypeScript
 
-Add `@typescript-eslint/parser` to the "parser" filed in your `.eslintrc` configuration file.
-To use type information, you will need to specify a path to your `tsconfig.json` file in the "project" property of "parserOptions".
-Alternatively, you can just set "project" to `true` to automatically use the nearest `tsconfig.json` files.
-
-```jsonc
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": true
-  }
-}
-```
-
-See [@typescript-eslint/parser's README.md](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/parser#readme) for more information on the available parser options.
+In your `eslint.config.js` file, import `typescript-eslint` and `eslint-plugin-functional` and configure them as you wish.
 
-### Example Config
+```js
+// eslint.config.js
+import functional from "eslint-plugin-functional";
+import tseslint from "typescript-eslint";
 
-```jsonc
-{
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": true
+export default tseslint.config({
+  files: ["**/*.ts"],
+  extends: [
+    functional.configs.externalVanillaRecommended,
+    functional.configs.recommended,
+    functional.configs.stylistic,
+    // your other plugin configs here
+  ],
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: {
+      project: true,
+    },
   },
-  "env": {
-    "es6": true
+  rules: {
+    // any rule configs here
   },
-  "plugins": [
-    "@typescript-eslint",
-    "functional"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "plugin:functional/external-typescript-recommended",
-    "plugin:functional/recommended",
-    "plugin:functional/stylistic"
-  ]
-}
+});
 ```