@foray1010/eslint-config 6.3.0 → 7.0.0

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.0.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@6.4.0...@foray1010/eslint-config@7.0.0) (2022-06-13)
+
+### ⚠ BREAKING CHANGES
+
+- drop support for typescript >=5
+- drop eslint 7
+- drop node 12 and 17
+
+### Bug Fixes
+
+- **deps:** update dependency eslint-plugin-jsdoc to v39 ([f868271](https://github.com/foray1010/common-presets/commit/f8682716ee922a6a517d5c0173390dec0bd2e346))
+- reenable import/named ([62fe238](https://github.com/foray1010/common-presets/commit/62fe2389b852749d63735b02e4898708a132b522))
+- reenable no-floating-promises for test files ([3a03ad8](https://github.com/foray1010/common-presets/commit/3a03ad8e13f2b2440babc96880cd290f4ea6b386))
+- replace eslint-plugin-node by eslint-plugin-n ([764320c](https://github.com/foray1010/common-presets/commit/764320cc26795c245008ce5bdbb87662e5dbae60))
+
+### Miscellaneous Chores
+
+- drop eslint 7 ([543fd6a](https://github.com/foray1010/common-presets/commit/543fd6a702596e5e447a0797a4713d2f08478ecb))
+- drop node 12 and 17 ([c43351e](https://github.com/foray1010/common-presets/commit/c43351e0da92209fc3100d9cb1bc129af320fdac))
+- remove peerDependencies versions that are not sure if supported ([2175adb](https://github.com/foray1010/common-presets/commit/2175adb62efe7d1762f6f66ce9bb0e7adb5f82e5))
+
+## [6.4.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@6.3.1...@foray1010/eslint-config@6.4.0) (2022-04-25)
+
+### Features
+
+- **eslint-config:** add more rules for jest ([9e7b466](https://github.com/foray1010/common-presets/commit/9e7b466c332d90d56e5d41d4a006147148c3ae32))
+
+### [6.3.1](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@6.3.0...@foray1010/eslint-config@6.3.1) (2022-04-25)
+
+### Bug Fixes
+
+- allow unnecessary fragment for single expression ([3208164](https://github.com/foray1010/common-presets/commit/320816415a3554c96a71275b0f36444bc9495259))
+
 ## [6.3.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@6.2.0...@foray1010/eslint-config@6.3.0) (2022-04-25)
 
 ### Features

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "6.3.0",
+  "version": "7.0.0",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -20,7 +20,7 @@
     "eslintignore"
   ],
   "dependencies": {
-    "@foray1010/common-presets-utils": "^4.0.0",
+    "@foray1010/common-presets-utils": "^5.0.0",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
     "confusing-browser-globals": "^1.0.10",
@@ -30,8 +30,8 @@
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-jest-dom": "^4.0.0",
-    "eslint-plugin-jsdoc": "^38.0.0",
-    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-jsdoc": "^39.0.0",
+    "eslint-plugin-n": "^15.2.2",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.23.2",
     "eslint-plugin-react-hooks": "^4.2.0",
@@ -39,14 +39,14 @@
     "eslint-plugin-testing-library": "^5.3.1"
   },
   "peerDependencies": {
-    "eslint": ">=7.28.0 <9",
-    "prettier": ">=2 <3"
+    "eslint": "^8.0.0",
+    "prettier": "^2.0.0"
   },
   "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.13.0"
+    "node": "^14.17.0 || >=16.13.0 || >=18.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7fe04c3ba7497afa72c5cd089519ccb107925882"
+  "gitHead": "6b2dbe64ac8e4677dfb6b72f70e185bcd607f17b"
 }

package/presets/base.js

@@ -16,8 +16,7 @@ module.exports = {
   extends: [
     'eslint:recommended',
     'plugin:eslint-comments/recommended',
-    'plugin:import/errors',
-    'plugin:import/warnings',
+    'plugin:import/recommended',
     'plugin:jsdoc/recommended',
     'plugin:prettier/recommended',
     'eslint-config-prettier',
@@ -47,8 +46,6 @@ module.exports = {
     'import/default': 'off',
     // make sure import statements above the others
     'import/first': 'error',
-    // doesn't work with redux-saga/effects
-    'import/named': 'off',
     // separate import statements from the others
     'import/newline-after-import': 'error',
     // avoid anonymous function or class for easier to debug via stack trace
@@ -124,8 +121,12 @@ module.exports = {
     },
     {
       files: testFileGlobs,
-      extends: ['plugin:jest/recommended'],
+      extends: ['plugin:jest/recommended', 'plugin:jest/style'],
       plugins: ['eslint-plugin-jest'],
+      rules: {
+        // make sure lifecycle hooks on the top for readability
+        'jest/prefer-hooks-on-top': 'error',
+      },
     },
     // typescript plugins are depended on `typescript` package
     ...(hasDep('typescript')
@@ -188,10 +189,18 @@ module.exports = {
               '@typescript-eslint/no-use-before-define': [
                 'error',
                 {
+                  /* options from eslint/no-use-before-define */
+                  // allow use function before defined as they could be hoisted
                   functions: false,
                   classes: true,
                   variables: true,
-                  typedefs: true,
+
+                  /* options from @typescript-eslint/no-use-before-define */
+                  enums: true,
+                  // confusing option, it will disable `typedefs`
+                  ignoreTypeReferences: false,
+                  // tsc allows types to be used before define
+                  typedefs: false,
                 },
               ],
               // fault alarms in 4.29.3
@@ -206,8 +215,6 @@ module.exports = {
               {
                 files: testFileGlobs,
                 rules: {
-                  // testing-library's `act` may or may not response promise, this rule produces false alarm
-                  '@typescript-eslint/no-floating-promises': 'off',
                   // doesn't work with jest.fn<void>()
                   '@typescript-eslint/no-invalid-void-type': 'off',
                 },

package/presets/node.js

@@ -1,22 +1,22 @@
 'use strict'
 
 module.exports = {
-  plugins: ['eslint-plugin-node'],
+  plugins: ['eslint-plugin-n'],
   env: {
     node: true,
   },
   rules: {
     // disallow deprecated node APIs
-    'node/no-deprecated-api': 'error',
+    'n/no-deprecated-api': 'error',
     // disallow the assignment to `exports`
-    'node/no-exports-assign': 'error',
+    'n/no-exports-assign': 'error',
     // disallow `bin` files that npm ignores
-    'node/no-unpublished-bin': 'error',
+    'n/no-unpublished-bin': 'error',
     // disallow unsupported Node.js built-in APIs on the specified version
-    'node/no-unsupported-features/node-builtins': 'error',
+    'n/no-unsupported-features/node-builtins': 'error',
     // make `process.exit()` expressions the same code path as `throw`
-    'node/process-exit-as-throw': 'error',
+    'n/process-exit-as-throw': 'error',
     // enforce shebang on the entry bin file
-    'node/shebang': 'error',
+    'n/shebang': 'error',
   },
 }

package/presets/react.js

@@ -6,6 +6,7 @@ module.exports = {
   extends: [
     'plugin:react/recommended',
     'plugin:react/jsx-runtime',
+    'plugin:react-hooks/recommended',
     'eslint-config-prettier',
   ],
   parserOptions: {
@@ -21,7 +22,13 @@ module.exports = {
     },
   },
   rules: {
-    'react/jsx-no-useless-fragment': 'error',
+    'react/jsx-no-useless-fragment': [
+      'error',
+      {
+        // allow unnecessary fragment for single expression to bypass some typescript errors (e.g. do not allow string and only allow react element)
+        allowExpressions: true,
+      },
+    ],
     'react/jsx-sort-props': [
       'error',
       {
@@ -36,7 +43,6 @@ module.exports = {
     ],
     // rely on typescript instead, and it does not work well with types that are imported from elsewhere
     'react/prop-types': 'off',
-    'react-hooks/rules-of-hooks': 'error',
     'react-hooks/exhaustive-deps': [
       'error',
       {