@madgex/eslint-config-madgex 2.2.0 → 2.3.0

package/README.md

@@ -10,28 +10,36 @@ npm install eslint@9 @madgex/eslint-config-madgex -save-dev
 
 ## VSCode extension
 
-Use VSCode Extension v3.0.5+ (you might need to switch to pre-release version)
+Use the official VSCode [ESLint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) v3.0.5+ (you might need to switch to pre-release version)
 
 ## Usage
 
 > ⚠️ Recomended to use only 1 type of source file in your repo, either `commonjs` or `module` (esm). `eslint` & `eslint-plugin-n` (this config depends on) has difficulty supporting both at the same time in a monorepo.
 
-```json
+`eslint-plugin-n` which is a part of our config, reads the package.json for node version, and what `type` of JS files you use (ESM or commonjs).
+
+```json5
 // package.json
-// ESM import/export modules, set to commonjs if you are using `require/module.exports`, you cant use both
-"type": "module",
 {
-  "engines": {
-    "node": ">=18"
-  }
+  ...
+  "type": "module", // "module" (ESM), or "commonjs" - you cant use both
+  {
+    "engines": {
+      "node": ">=18"
+    }
+  },
+  ...
 }
 ```
 
+`eslint-plugin-n` also recognises `.npmignore` files which will silence warnings of missing dependancies when they are installed as `devDependancies`.
+
 ### Node/Browser
 
 ```js
 // eslint.config.js
 import configMadgex from '@madgex/eslint-config-madgex';
+
 export default [...configMadgex];
 ```
 
@@ -43,6 +51,23 @@ config order matters.
 // eslint.config.js
 import configMadgex from '@madgex/eslint-config-madgex';
 import pluginVue from 'eslint-plugin-vue';
+// pluginVue.configs['flat/recommended'] has prettier conflicts
 
-export default [...configMadgex, ...pluginVue.configs['flat/recommended']];
+export default [...configMadgex, ...pluginVue.configs['flat/essential']];
 ```
+
+### Rules
+
+Notes regarding specific rules enforced in this config:
+
+- [`no-param-reassign`](https://eslint.org/docs/latest/rules/no-param-reassign) - Disallow reassigning function parameters, except for **`accu`** which is the accumulator in a `.reduce()` e.g.
+
+  ```js
+  Array.reduce((accu, key) => {
+    accu[key] = getVal(key);
+
+    return accu;
+  }, {});
+  ```
+
+- [`no-unused-vars`](https://eslint.org/docs/latest/rules/no-unused-vars) - Disallow unused variables, except for `request` and `h` as found on hapi.js route handlers.

package/index.js

@@ -37,7 +37,6 @@ module.exports = [
       // https://eslint.org/docs/latest/rules/
       'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
       'no-console': process.env.NODE_ENV === 'production' ? 2 : 0,
-      'no-param-reassign': ['error', { props: true }],
       eqeqeq: ['error', 'always', { null: 'ignore' }],
       'no-shadow': 'error',
       'no-lonely-if': 'error',
@@ -46,6 +45,14 @@ module.exports = [
       'default-case': 'error',
       'consistent-return': 'error',
       'func-names': 'warn',
+      'no-param-reassign': [
+        'error',
+        {
+          props: true,
+          ignorePropertyModificationsFor: ['accu'],
+        },
+      ],
+      'no-unused-vars': ['error', { argsIgnorePattern: 'request|h' }],
     },
   },
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/eslint-config-madgex",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "type": "commonjs",
   "description": "Madgex ESLint config - based on eslint-config-airbnb",
   "main": "index.js",