@madgex/eslint-config-madgex 1.3.1 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.0.0](https://github.com/wiley/madgex-eslint-config-madgex/compare/@madgex/eslint-config-madgex@1.4.1...@madgex/eslint-config-madgex@2.0.0) (2024-04-18)
+
+-fix!: eslint 9, using modern eslint-plugin-n setup
+
 ## <small>1.3.1 (2020-10-15)</small>
 
 - feat: init monorepo ([244a52a](https://thegits/scm/int/eslint-config-madgex/commits/244a52a))

package/README.md

@@ -5,15 +5,44 @@
 ## Install
 
 ```bash
-npm install @madgex/eslint-config-madgex -save-dev
+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)
+
 ## Usage
 
-Extend `@madgex/eslint-config-madgex` in your [.eslintrc.json](https://eslint.org/docs/user-guide/configuring):
+> ⚠️ 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
+// package.json
+// ESM import/export modules, set to commonjs if you are using `require/module.exports`, you cant use both
+"type": "module",
 {
-  "extends": "@madgex/eslint-config-madgex"
+  "engines": {
+    "node": ">=18"
+  }
 }
 ```
+
+### Node/Browser
+
+```js
+// eslint.config.js
+import configMadgex from '@madgex/eslint-config-madgex';
+export default [...configMadgex];
+```
+
+### Vue
+
+config order matters.
+
+```js
+// eslint.config.js
+import configMadgex from '@madgex/eslint-config-madgex';
+import pluginVue from 'eslint-plugin-vue';
+
+export default [...configMadgex, ...pluginVue.configs['flat/recommended']];
+```

package/index.js

@@ -1,66 +1,25 @@
-module.exports = {
-  env: {
-    browser: true,
-    es6: true,
-    node: true,
-    jest: true,
-  },
-  // http://eslint.org/docs/user-guide/configuring#extending-configuration-files
-  extends: ['airbnb-base', 'plugin:promise/recommended', 'plugin:prettier/recommended'],
-  plugins: ['prettier'],
-  rules: {
-    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
-    'no-console': process.env.NODE_ENV === 'production' ? 2 : 0,
-    'no-plusplus': 0,
-    'linebreak-style': 0,
-    'max-len': [
-      'error',
-      120,
-      2,
-      {
-        ignoreUrls: true,
-        ignoreComments: false,
-        ignoreRegExpLiterals: true,
-        ignoreStrings: true,
-        ignoreTemplateLiterals: true,
-      },
-    ],
-    // disallow reassignment of function parameters
-    // disallow parameter object manipulation except for specific exclusions
-    // rule: http://eslint.org/docs/rules/no-param-reassign.html
-    'no-param-reassign': [
-      'error',
-      {
-        props: true,
-        ignorePropertyModificationsFor: [
-          'acc', // for reduce accumulators
-          'e', // for e.returnvalue
-          'ctx', // for Koa routing
-          'req', // for Express requests
-          'request', // for Express requests
-          'res', // for Express responses
-          'response', // for Express responses
-          '$scope', // for Angular 1 scopes
-          'state', // for Vuex mutations
-        ],
+const globals = require('globals');
+const js = require('@eslint/js');
+const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+const nodePlugin = require('eslint-plugin-n');
+
+module.exports = [
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.browser,
       },
-    ],
-    // loosely based on Hapi's style guide, extended to break after const|let|var blocks
-    // https://github.com/hapijs/eslint-config-hapi/blob/master/lib/index.js#L101
-    'padding-line-between-statements': [
-      'error',
-      { blankLine: 'always', prev: 'directive', next: '*' },
-      { blankLine: 'any', prev: 'directive', next: 'directive' },
-      { blankLine: 'always', prev: 'cjs-import', next: '*' },
-      { blankLine: 'any', prev: 'cjs-import', next: 'cjs-import' },
-      { blankLine: 'always', prev: '*', next: 'cjs-export' },
-      { blankLine: 'any', prev: 'cjs-export', next: '*' },
-      { blankLine: 'always', prev: 'multiline-block-like', next: '*' },
-      { blankLine: 'always', prev: 'class', next: '*' },
-      { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
-      { blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] },
-      { blankLine: 'always', prev: ['case', 'default'], next: '*' },
-    ],
-    'prettier/prettier': 'error',
+    },
+  },
+  js.configs.recommended,
+  nodePlugin.configs['flat/recommended'],
+  eslintPluginPrettierRecommended,
+  {
+    rules: {
+      'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
+      'no-console': process.env.NODE_ENV === 'production' ? 2 : 0,
+      'prettier/prettier': 'error',
+    },
   },
-};
+];

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@madgex/eslint-config-madgex",
-  "version": "1.3.1",
+  "version": "2.0.0",
+  "type": "commonjs",
   "description": "Madgex ESLint config - based on eslint-config-airbnb",
   "main": "index.js",
   "scripts": {
@@ -12,16 +13,16 @@
   "author": "James Wragg <james.wragg@madgex.com> (https://madgex.com/)",
   "license": "MIT",
   "peerDependencies": {
-    "eslint": "^7.11.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-config-prettier": "^6.12.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.1.4",
-    "eslint-plugin-promise": "^4.2.1",
-    "prettier": "^2.1.2"
+    "@eslint/js": ">=9",
+    "eslint": ">=9",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-n": "^17.2.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "globals": ">=15",
+    "prettier": ">=3"
   },
   "engines": {
-    "node": ">= 10"
+    "node": ">=18"
   },
-  "gitHead": "833f1f0d6bcc09b325ea2ea090543fc3f8617105"
+  "gitHead": "2bbdb8be7d056e210ce28579c116e05d2f9362c8"
 }