@foray1010/eslint-config 10.4.3 → 10.5.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.5.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.4.3...@foray1010/eslint-config@10.5.0) (2023-04-15)
+
+### Features
+
+- **eslint-config:** enable functional/prefer-immutable-types and type-declaration-immutability ([9dc211e](https://github.com/foray1010/common-presets/commit/9dc211e550df72c4538a5526285ad635b1a491d5))
+
+### Bug Fixes
+
+- **eslint-config:** remove warning message when uses with typescript v5 ([c3b1a82](https://github.com/foray1010/common-presets/commit/c3b1a822f6e598db6571a467bbb32d083acacdbb))
+
 ## [10.4.3](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@10.4.2...@foray1010/eslint-config@10.4.3) (2023-03-31)
 
 ### Bug Fixes

package/README.md

@@ -20,7 +20,7 @@ Z for looser rules
 
 1. `yarn add -DE @foray1010/eslint-config eslint prettier`
 
-1. Create an `eslint.config.mjs` in the project root (It is not a standard config path, but we opts for `.mjs` extension to make it compatible with commonjs projects)
+2. Create an `eslint.config.js` in the project root
 
    - For general purpose or Node.js project (support TypeScript)
 
@@ -87,7 +87,15 @@ Z for looser rules
      export default config
      ```
 
-1. Add npm script
+3. If the project support ES Modules, you can directly use `eslint` command with the following setting in `package.json`.
+
+   ```json
+   {
+     "type": "module"
+   }
+   ```
+
+4. If the project does not support ES Modules, you have to put the config in `eslint.config.mjs` instead, and use the following npm script in `package.json`. Note that your editor may not support custom eslint config path and may not work properly.
 
    ```json
    {

package/bases/base.mjs

@@ -154,9 +154,6 @@ async function generateTypeScriptConfig() {
             typedefs: false,
           },
         ],
-        // use with functional/prefer-readonly-type
-        // mark class variables as readonly if it is not mutated
-        '@typescript-eslint/prefer-readonly': 'error',
         // make sure functions which return a promise will just return a rejected promise instead of throwing an error
         '@typescript-eslint/promise-function-async': 'error',
         // allow primitive value in template string
@@ -176,20 +173,47 @@ async function generateTypeScriptConfig() {
         '@typescript-eslint/unbound-method': ['error', { ignoreStatic: true }],
         // do not allow usage of deprecated code
         'deprecation/deprecation': 'error',
-        // use with @typescript-eslint/prefer-readonly
-        'functional/prefer-readonly-type': [
+        // use with functional/type-declaration-immutability
+        'functional/prefer-immutable-types': [
           'error',
           {
-            // sometimes it is easier to mutate, it should be fine to mutate within local scope
-            allowLocalMutation: true,
-            // don't force library consumer to use readonly type
-            allowMutableReturnType: true,
-            // allow mutating class variables
-            ignoreClass: 'fieldsOnly',
+            // as there is no native way to achieve `ReadonlyDeep` in TypeScript
+            enforcement: 'ReadonlyShallow',
+            // reduce the difficult to use this rule
+            ignoreInferredTypes: true,
+            // escape hatch without using eslint-disable
+            ignoreNamePattern: 'Mutable$',
+            ignoreTypePattern: [
+              '^React.', // Some React types does not work with `Readonly`
+            ],
           },
         ],
         // forbid unnecessary callback wrapper
         'functional/prefer-tacit': 'error',
+        // use with functional/prefer-immutable-types
+        'functional/type-declaration-immutability': [
+          'error',
+          {
+            rules: [
+              {
+                identifiers: '.+',
+                immutability: 'ReadonlyShallow',
+                comparator: 'AtLeast',
+                // modified from https://github.com/eslint-functional/eslint-plugin-functional/blob/main/docs/rules/type-declaration-immutability.md#preset-overrides
+                fixer: [
+                  {
+                    pattern: '^(Array|Map|Set)<(.+)>$',
+                    replace: 'Readonly$1<$2>',
+                  },
+                  {
+                    pattern: '^(.+)$',
+                    replace: 'Readonly<$1>',
+                  },
+                ],
+              },
+            ],
+          },
+        ],
         'no-restricted-syntax': [
           'error',
           {

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "10.4.3",
+  "version": "10.5.0",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -29,8 +29,8 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-compat": "^4.1.2",
-    "eslint-plugin-deprecation": "^1.3.2",
-    "eslint-plugin-functional": "^5.0.0",
+    "eslint-plugin-deprecation": "^1.4.0",
+    "eslint-plugin-functional": "^5.0.8",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^27.1.3",
     "eslint-plugin-jest-dom": "^4.0.0",
@@ -46,7 +46,7 @@
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "1.0.0",
-    "@types/eslint": "8.21.3"
+    "@types/eslint": "8.37.0"
   },
   "peerDependencies": {
     "eslint": "^8.36.0",
@@ -64,5 +64,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2827bd9ef34bdd2e0ee9a91397d20b0547461d7d"
+  "gitHead": "944fe72ee061b3626ffae018135f391a2fdd2013"
 }