@bitfactory/eslint-config 3.3.1 → 4.1.0

package/README.md

@@ -1,9 +1,11 @@
 # @bitfactory/eslint-config
 
-[![Release](https://img.shields.io/badge/Release-3.x.x-F0ec73)](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory)
+[![Release](https://img.shields.io/badge/Release-4.x.x-F0ec73)](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
-![ESLint](https://img.shields.io/badge/ESLint-^8.56|^9.0-4B3263?logo=eslint&logoColor=white)
+[![ESLint](https://img.shields.io/badge/ESLint-^8.56|^9.0-4B3263?logo=eslint&logoColor=white)](https://eslint.org/)
 [![NodeJS](https://img.shields.io/badge/Node.js-^18.18|^20.9|^22.11-6da55f?logo=node.js)](https://nodejs.org/)
+[![Node.js Package](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/bitfactory-nl/shared-npm-eslint-config-bitfactory/actions/workflows/npm-publish.yml)
+[![NPM package version](https://badgen.net/npm/v/@bitfactory/eslint-config)](https://npmjs.com/package/@bitfactory/eslint-config)
 
 This is a shareable config for [ESLint](https://eslint.org). All the rules and configurations are already set. Rules can be overridden if needed.
 
@@ -87,15 +89,10 @@ module.exports = {
 };
 ```
 
-> **_NOTE:_**  Vue3 needs some extra configuration
+#### Vue 3 extra configuration
 
-```shell
-make npm "i @vue/eslint-config-typescript --save-exact --save-dev"
-```
-
-```shell
-make pnpm "i @vue/eslint-config-typescript --save-exact --save-dev"
-```
+> [!IMPORTANT]  
+> For Vue 3 TypeScript is mandatory, so [install the TS packages](#typescript-projects) as described in the TypeScript section.
 
 And set the following extend in `.eslintrc.js`:
 
@@ -103,8 +100,7 @@ And set the following extend in `.eslintrc.js`:
 module.exports = {
     extends: [
         '@bitfactory/eslint-config/vue',
-        'plugin:vue/vue3-recommended', // <-- add this one
-        '@vue/typescript/recommended', // <-- and this one
+        'plugin:vue/vue3-recommended',
         '@bitfactory/eslint-config/typescript',
     ],
 };
@@ -112,14 +108,17 @@ module.exports = {
 
 ### TypeScript projects
 
-To use this config with a TypeScript project also install the following packages
+To use this config with a TypeScript project _also_ install the following packages
+
+> [!NOTE]  
+> Check and make sure a compatible TypeScript version is installed. Can be added with: `make [p]npm i typescript`.
 
 ```shell
-make npm "i @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import --save-dev --save-exact"
+make npm "i @typescript-eslint/eslint-plugin @typescript-eslint/parse --save-dev --save-exact"
 ```
 
 ```shell
-make pnpm "i @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import --save-dev --save-exact"
+make pnpm "i @typescript-eslint/eslint-plugin @typescript-eslint/parser --save-dev --save-exact"
 ```
 
 And set the following extend in `.eslintrc.js`:
@@ -132,15 +131,11 @@ module.exports = {
 
 ### Vue.js, TypeScript and regular JavaScript together
 
-To use this config with a Vue.js, TypeScript and regular JavaScript project also install the following packages
+To use this config with a Vue.js, TypeScript and regular JavaScript together in one project make sure to install the packages from all three sections:
 
-```shell
-make npm "i eslint-plugin-vue eslint-plugin-vuejs-accessibility @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import @vue/eslint-config-typescript --save-dev --save-exact"
-```
-
-```shell
-make pnpm "i eslint-plugin-vue eslint-plugin-vuejs-accessibility @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-import @vue/eslint-config-typescript --save-dev --save-exact"
-```
+- [:package: Installing](#package-installing)
+  - [Vue.js projects](#vuejs-projects)
+  - [TypeScript projects](#typescript-projects)
 
 And set the following extend in `.eslintrc.js`:
 
@@ -148,8 +143,7 @@ And set the following extend in `.eslintrc.js`:
 module.exports = {
     extends: [
         '@bitfactory/eslint-config/vue',
-        'plugin:vue/vue3-recommended',
-        '@vue/typescript/recommended',
+        // 'plugin:vue/vue3-recommended', // <-- add this only for Vue 3
         '@bitfactory/eslint-config/typescript',
     ],
 };
@@ -222,6 +216,7 @@ make pnpm run eslint:fix
 ## :pencil2: Editor / IDE integration
 
 For ESLint to work, you need to set up your editor / IDE.
+See also <https://eslint.style/guide/faq#how-to-auto-format-on-save>
 
 ### Visual Studio Code
 

package/index.js

@@ -8,6 +8,7 @@ module.exports = {
     },
     extends: [
         'eslint:recommended',
+        'plugin:@stylistic/recommended-extends',
         'plugin:jsdoc/recommended',
         'plugin:unicorn/recommended',
         './rules/errors',
@@ -15,6 +16,7 @@ module.exports = {
         './rules/jsdoc',
         './rules/practices',
         './rules/style',
+        './rules/stylistic',
         './rules/variables',
     ],
     ignorePatterns: [
@@ -35,6 +37,7 @@ module.exports = {
         sourceType: 'module',
     },
     plugins: [
+        '@stylistic',
         'jsdoc',
         'unicorn',
     ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitfactory/eslint-config",
-  "version": "3.3.1",
+  "version": "4.1.0",
   "description": "ESLint sharable config for Bitfactory projects",
   "keywords": [
     "eslint",
@@ -18,14 +18,15 @@
     "vue.js"
   ],
   "devDependencies": {
-    "eslint": "9.16.0",
-    "lint-staged": "15.2.10",
-    "npm-check-updates": "17.1.11",
+    "eslint": "9.19.0",
+    "lint-staged": "15.4.3",
+    "npm-check-updates": "17.1.14",
     "simple-git-hooks": "2.11.1"
   },
   "peerDependencies": {
     "@babel/core": "^7.24.5",
     "@babel/eslint-parser": "^7.24.5",
+    "@stylistic/eslint-plugin": ">=2.6.0",
     "eslint": "^8.56.0 || ^9.0.0",
     "eslint-plugin-import": ">=2.31.0",
     "eslint-plugin-jsdoc": ">=47.0.0",

package/rules/es6.js

@@ -6,11 +6,7 @@ module.exports = {
     ],
     rules: {
         'arrow-body-style': ['error', 'as-needed'],
-        'arrow-parens': ['error', 'as-needed'],
-        'arrow-spacing': 'error',
-        'generator-star-spacing': ['error', 'after'],
         'import/no-duplicates': ['error'],
-        'no-confusing-arrow': 'error',
         'no-duplicate-imports': [
             'error',
             {
@@ -41,9 +37,6 @@ module.exports = {
         'prefer-rest-params': 'error',
         'prefer-spread': 'error',
         'prefer-template': 'error',
-        'rest-spread-spacing': 'error',
         'symbol-description': 'error',
-        'template-curly-spacing': 'error',
-        'yield-star-spacing': ['error', 'after'],
     },
 };

package/rules/practices.js

@@ -20,7 +20,6 @@ module.exports = {
         'no-extend-native': 'error',
         'no-extra-bind': 'error',
         'no-extra-label': 'error',
-        'no-floating-decimal': 'error',
         'no-implicit-coercion': 'error',
         'no-implicit-globals': 'error',
         'no-implied-eval': 'error',
@@ -28,7 +27,6 @@ module.exports = {
         'no-labels': 'error',
         'no-lone-blocks': 'error',
         'no-loop-func': 'error',
-        'no-multi-spaces': 'error',
         'no-multi-str': 'error',
         'no-new-func': 'error',
         'no-new-wrappers': 'error',

package/rules/style.js

@@ -2,37 +2,12 @@
 
 module.exports = {
     rules: {
-        'array-bracket-newline': ['error', 'consistent'],
-        'array-bracket-spacing': 'error',
-        'array-element-newline': ['error', 'consistent'],
-        'block-spacing': 'error',
-        'brace-style': 'error',
         'camelcase': 'error',
-        'comma-dangle': ['error', 'always-multiline'],
-        'comma-spacing': 'error',
-        'comma-style': 'error',
-        'computed-property-spacing': 'error',
         'consistent-this': 'error',
-        'eol-last': 'error',
         'func-name-matching': 'error',
         'func-names': ['error', 'never'],
         'func-style': 'error',
-        'implicit-arrow-linebreak': 'error',
-        'indent': ['error', 4, {
-            SwitchCase: 1,
-        }],
-        'key-spacing': 'error',
-        'keyword-spacing': 'error',
-        'line-comment-position': 'error',
-        'linebreak-style': 'error',
-        'lines-between-class-members': 'error',
         'max-depth': 'error',
-        'max-len': [
-            'warn',
-            {
-                code: 120,
-            },
-        ],
         'max-lines': 'warn',
         'max-lines-per-function': [
             'warn',
@@ -43,21 +18,10 @@ module.exports = {
         ],
         'max-params': 'error',
         'max-statements': 'warn',
-        'max-statements-per-line': 'error',
-        'multiline-ternary': ['error', 'never'],
         'new-cap': 'error',
-        'new-parens': 'error',
-        'newline-per-chained-call': 'error',
         'no-array-constructor': 'error',
         'no-lonely-if': 'error',
-        'no-mixed-operators': 'error',
         'no-multi-assign': 'error',
-        'no-multiple-empty-lines': [
-            'error',
-            {
-                max: 1,
-            },
-        ],
         'no-negated-condition': 'error',
         'no-new-object': 'error',
         'no-plusplus': [
@@ -66,8 +30,6 @@ module.exports = {
                 allowForLoopAfterthoughts: true,
             },
         ],
-        'no-tabs': 'error',
-        'no-trailing-spaces': 'error',
         'no-underscore-dangle': [
             'error',
             {
@@ -80,69 +42,12 @@ module.exports = {
                 defaultAssignment: false,
             },
         ],
-        'no-whitespace-before-property': 'error',
-        'object-curly-newline': ['error', {
-            ExportDeclaration: {
-                minProperties: 2,
-                multiline: true,
-            },
-            ImportDeclaration: {
-                minProperties: 4,
-                multiline: true,
-            },
-            ObjectExpression: {
-                minProperties: 1,
-                multiline: true,
-            },
-            ObjectPattern: {
-                minProperties: 4,
-                multiline: true,
-            },
-        }],
-        'object-curly-spacing': ['error', 'always'],
-        'object-property-newline': 'error',
         'one-var': ['error', 'never'],
-        'one-var-declaration-per-line': ['error', 'always'],
         'operator-assignment': 'error',
-        'operator-linebreak': ['error', 'after'],
-        'padding-line-between-statements': [
-            'error',
-            {
-                blankLine: 'always',
-                next: 'return',
-                prev: '*',
-            },
-        ],
         'prefer-object-spread': 'error',
-        'quote-props': ['error', 'consistent-as-needed'],
-        'quotes': [
-            'error',
-            'single',
-            {
-                allowTemplateLiterals: false,
-                avoidEscape: true,
-            },
-        ],
-        'semi': 'error',
-        'semi-style': 'error',
         'sort-imports': ['error', {
             ignoreDeclarationSort: true,
         }],
         'sort-vars': 'error',
-        'space-before-blocks': 'error',
-        'space-before-function-paren': ['error', 'never'],
-        'space-in-parens': 'error',
-        'space-infix-ops': 'error',
-        'space-unary-ops': [
-            'error',
-            {
-                nonwords: false,
-                words: true,
-            },
-        ],
-        'spaced-comment': 'error',
-        'switch-colon-spacing': 'error',
-        'template-tag-spacing': 'error',
-        'wrap-regex': 'error',
     },
 };

package/rules/stylistic.js

@@ -0,0 +1,118 @@
+/* eslint-disable unicorn/prefer-module */
+
+module.exports = {
+    rules: {
+        '@stylistic/array-bracket-newline': ['error', 'consistent'],
+        '@stylistic/array-bracket-spacing': 'error',
+        '@stylistic/array-element-newline': ['error', 'consistent'],
+        '@stylistic/arrow-parens': ['error', 'as-needed'],
+        '@stylistic/arrow-spacing': 'error',
+        '@stylistic/block-spacing': 'error',
+        '@stylistic/brace-style': ['error', '1tbs'],
+        '@stylistic/comma-dangle': ['error', 'always-multiline'],
+        '@stylistic/comma-spacing': 'error',
+        '@stylistic/comma-style': 'error',
+        '@stylistic/computed-property-spacing': 'error',
+        '@stylistic/eol-last': 'error',
+        '@stylistic/generator-star-spacing': ['error', 'after'],
+        '@stylistic/implicit-arrow-linebreak': 'error',
+        '@stylistic/indent': ['error', 4, {
+            SwitchCase: 1,
+        }],
+        '@stylistic/indent-binary-ops': ['error', 4],
+        '@stylistic/key-spacing': 'error',
+        '@stylistic/keyword-spacing': 'error',
+        '@stylistic/line-comment-position': 'error',
+        '@stylistic/linebreak-style': 'error',
+        '@stylistic/lines-between-class-members': 'error',
+        '@stylistic/max-len': ['warn', {
+            code: 120,
+        }],
+        '@stylistic/max-statements-per-line': 'error',
+        '@stylistic/member-delimiter-style': ['error', {
+            multiline: {
+                delimiter: 'semi',
+                requireLast: true,
+            },
+            singleline: {
+                delimiter: 'semi',
+                requireLast: false,
+            },
+            multilineDetection: 'brackets',
+        }],
+        '@stylistic/multiline-comment-style': ['error', 'separate-lines'],
+        '@stylistic/multiline-ternary': ['error', 'never'],
+        '@stylistic/new-parens': 'error',
+        '@stylistic/newline-per-chained-call': 'error',
+        '@stylistic/no-confusing-arrow': 'error',
+        '@stylistic/no-extra-parens': ['error', 'functions'],
+        '@stylistic/no-floating-decimal': 'error',
+        '@stylistic/no-mixed-operators': 'error',
+        '@stylistic/no-multi-spaces': 'error',
+        '@stylistic/no-multiple-empty-lines': ['error', {
+            max: 1,
+        }],
+        '@stylistic/no-tabs': 'error',
+        '@stylistic/no-trailing-spaces': 'error',
+        '@stylistic/no-whitespace-before-property': 'error',
+        '@stylistic/object-curly-newline': ['error', {
+            ExportDeclaration: {
+                minProperties: 2,
+                multiline: true,
+            },
+            ImportDeclaration: {
+                minProperties: 4,
+                multiline: true,
+            },
+            ObjectExpression: {
+                minProperties: 1,
+                multiline: true,
+            },
+            ObjectPattern: {
+                minProperties: 4,
+                multiline: true,
+            },
+        }],
+        '@stylistic/object-curly-spacing': ['error', 'always'],
+        '@stylistic/object-property-newline': 'error',
+        '@stylistic/one-var-declaration-per-line': ['error', 'always'],
+        '@stylistic/operator-linebreak': ['error', 'after'],
+        '@stylistic/padding-line-between-statements': ['error', {
+            blankLine: 'always',
+            next: 'return',
+            prev: '*',
+        }],
+        '@stylistic/rest-spread-spacing': 'error',
+        '@stylistic/quote-props': ['error', 'consistent-as-needed'],
+        '@stylistic/quotes': ['error', 'single', {
+            allowTemplateLiterals: false,
+            avoidEscape: true,
+        }],
+        '@stylistic/semi': ['error', 'always'],
+        '@stylistic/semi-style': 'error',
+        '@stylistic/space-before-blocks': 'error',
+        '@stylistic/space-before-function-paren': ['error', 'never'],
+        '@stylistic/space-in-parens': 'error',
+        '@stylistic/space-infix-ops': 'error',
+        '@stylistic/space-unary-ops': ['error', {
+            nonwords: false,
+            words: true,
+        }],
+        '@stylistic/spaced-comment': 'error',
+        '@stylistic/switch-colon-spacing': 'error',
+        '@stylistic/template-curly-spacing': 'error',
+        '@stylistic/template-tag-spacing': 'error',
+        '@stylistic/type-annotation-spacing': ['error', {
+            before: false,
+            after: true,
+            overrides: {
+                arrow: {
+                    before: true,
+                    after: true,
+                },
+            },
+        }],
+        '@stylistic/wrap-regex': 'error',
+        '@stylistic/yield-star-spacing': ['error', 'after'],
+    },
+};

package/typescript.js

@@ -20,7 +20,6 @@ module.exports = {
                         prefer: 'type-imports',
                     },
                 ],
-                '@typescript-eslint/member-delimiter-style': 'error',
                 'no-duplicate-imports': 'off',
             },
         },