@moccu/eslint-config 0.5.0 → 0.8.0

package/.github/workflows/build.yml

@@ -4,14 +4,18 @@ on: push
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
         with:
           persist-credentials: false
 
       - name: Setup 🔌
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version-file: '.nvmrc'
           registry-url: https://registry.npmjs.org/
@@ -25,8 +29,6 @@ jobs:
       - name: Publish 🚀
         if: startsWith(github.ref, 'refs/tags/')
         run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
 
       - name: Publish to GitHub 🚀
         if: startsWith(github.ref, 'refs/tags/')

package/.nvmrc

@@ -1 +1 @@
-20.15.0
+lts/*

package/README.md

@@ -1,9 +1,9 @@
 # eslint-config-moccu
 
-![Build](https://github.com/moccu/eslint-config-moccu/workflows/Build/badge.svg)
+[![Build](https://github.com/moccu/eslint-config-moccu/actions/workflows/build.yml/badge.svg)](https://github.com/moccu/eslint-config-moccu/actions)
 
 
-The eslint config we use at moccu
+The eslint config we use at Moccu
 
 ## Installation
 
@@ -13,49 +13,21 @@ $ npm install --save-dev @moccu/eslint-config
 
 ## Usage
 
-### Base
-
-This is a customized ruleset based on the [eslint recommended](https://eslint.org/docs/rules/)
-rules.
-
-```js
-{
-	"extends": [
-		"@moccu/eslint-config"
-	],
-	"rules": {
-		// Additional rules...
-	}
-}
-```
-
-### React
-
-This is a customized ruleset based on the [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)
-rules.
-Separately there is a ruleset for proptypes-validation in `@moccu/eslint-config/react-proptypes`.
-
 ```js
-{
-	"extends": [
-		"@moccu/eslint-config",
-		"@moccu/eslint-config/react",
-		"@moccu/eslint-config/react-proptypes"
-	],
-	"rules": {
-		// Additional rules...
+// eslint.config.js
+const {defineConfig} = require('eslint/config');
+const moccu = require('@moccu/eslint-config');
+
+module.exports = defineConfig([
+	moccu.configs['recommended'],
+	{
+		rules: {
+			semi: ['warn', 'always']
+		}
 	}
-}
+]);
 ```
 
-## Contribute
-
-* Add / Edit rules after agreements with developers at Moccu
-* Run tests using  `npm test`
-* Set new version in [package.json](https://github.com/moccu/eslint-config-moccu/blob/master/package.json)
-* Publish new version on npm using `npm publish --access=public`
-* Add github release and tag including release notes
-
 ## License
 
 [MIT](./LICENSE)

package/defaults/sort-class-members.js

@@ -1,11 +1,9 @@
 'use strict';
 
-
 const
 	{List} = require('../helper')
 ;
 
-
 module.exports.CLASS_MEMBER_ORDER = new List(
 	'[static-properties]',
 	'[static-methods]',

package/helper/index.js

@@ -1,6 +1,5 @@
 'use strict';
 
-
 module.exports.List = class extends Array {
 
 	insert(value) {

package/index.js

@@ -1,74 +1,21 @@
 'use strict';
 
-
 const
-	{CLASS_MEMBER_GROUPS, CLASS_MEMBER_ORDER} = require('./defaults/sort-class-members')
-;
-
-
-module.exports = {
-	extends: [
-		'eslint:recommended'
-	],
-	plugins: [
-		'sort-class-members'
-	],
-	rules: {
+	{CLASS_MEMBER_GROUPS, CLASS_MEMBER_ORDER} = require('./defaults/sort-class-members'),
+	js = require('@eslint/js'),
+	globals = require('globals'),
+	sortClassMembers = require('eslint-plugin-sort-class-members'),
+	rules = {
 		'accessor-pairs': 'error',
-		// 'array-bracket-newline': 'off',
-		'array-bracket-spacing': 'error',
 		'array-callback-return': 'error',
-		// 'array-element-newline': 'off',
-		// 'arrow-body-style': 'off',
-		// 'arrow-parens': 'off',
-		'arrow-spacing': [
-			'error', {
-				'after': true,
-				'before': true
-			}
-		],
 		'block-scoped-var': 'error',
-		'block-spacing': [
-			'error', 'never'
-		],
-		'brace-style': [
-			'error',
-			'1tbs', {
-				'allowSingleLine': true
-			}
-		],
-		'callback-return': 'error',
-		// 'camelcase': 'off',
-		// 'capitalized-comments': 'off',
-		// 'class-methods-use-this': 'off',
-		// 'comma-dangle': 'off',
-		'comma-spacing': [
-			'error', {
-				'after': true,
-				'before': false
-			}
-		],
-		'comma-style': [
-			'error', 'last'
-		],
 		'complexity': 'error',
-		'computed-property-spacing': [
-			'error', 'never'
-		],
-		// 'consistent-return': 'off',
 		'consistent-this': [
 			2, 'self'
 		],
 		'curly': 'error',
-		// 'default-case': 'off',
-		'dot-location': [
-			'error', 'property'
-		],
 		'dot-notation': 'error',
-		'eol-last': 'error',
 		'eqeqeq': 'error',
-		// 'for-direction': 'error',
-		// 'func-call-spacing': 'off',
 		'func-name-matching': 'error',
 		'func-names': [
 			'error', 'never'
@@ -79,35 +26,9 @@ module.exports = {
 				'allowArrowFunctions': true
 			}
 		],
-		// 'function-paren-newline': 'off',
-		'generator-star-spacing': 'error',
-		// 'getter-return': 'error',
-		// 'global-require': 'off',
 		'guard-for-in': 'error',
-		'handle-callback-err': 'error',
-		'id-blacklist': 'error',
-		// 'id-length': 'off',
 		'id-match': 'error',
-		// 'implicit-arrow-linebreak': 'off',
-		// 'indent': 'off',
-		// 'indent-legacy': 'off',
-		// 'init-declarations': 'off',
-		'jsx-quotes': 'error',
-		'key-spacing': 'error',
-		'keyword-spacing': [
-			2, {}
-		],
-		// 'line-comment-position': 'off',
-		'linebreak-style': [
-			'error', 'unix'
-		],
-		'lines-around-comment': 'error',
-		'lines-around-directive': 'error',
-		'lines-between-class-members': [
-			'error', 'always'
-		],
 		'max-depth': 'error',
-		// 'max-len': 'off',
 		'max-lines': [
 			'error', {
 				'max': 350,
@@ -115,37 +36,20 @@ module.exports = {
 			}
 		],
 		'max-nested-callbacks': 'error',
-		// 'max-params': 'off',
-		// 'max-statements': 'off',
-		'max-statements-per-line': 'error',
-		'multiline-comment-style': [
-			'error', 'separate-lines'
-		],
-		// 'multiline-ternary': 'off',
-		// 'new-parens': 'error',
-		// 'newline-after-var': 'off',
-		// 'newline-before-return': 'off',
-		// 'newline-per-chained-call': 'off',
 		'no-alert': 'error',
 		'no-array-constructor': 'error',
 		'no-await-in-loop': 'error',
 		'no-bitwise': 'error',
-		'no-buffer-constructor': 'error',
 		'no-caller': 'error',
-		// 'no-catch-shadow': 'error',
-		'no-confusing-arrow': 'error',
 		'no-continue': 'error',
 		'no-div-regex': 'error',
 		'no-duplicate-imports': 'error',
-		// 'no-else-return': 'off',
 		'no-empty-function': 'error',
 		'no-eq-null': 'error',
 		'no-eval': 'error',
 		'no-extend-native': 'error',
 		'no-extra-bind': 'error',
 		'no-extra-label': 'error',
-		// 'no-extra-parens': 'off',
-		'no-floating-decimal': 'error',
 		'no-implicit-coercion': [
 			'error', {
 				'boolean': false,
@@ -155,154 +59,79 @@ module.exports = {
 		],
 		'no-implicit-globals': 'error',
 		'no-implied-eval': 'error',
-		// 'no-inline-comments': 'off',
 		'no-inner-declarations': [
 			'error', 'functions'
 		],
-		// 'no-invalid-this': 'off',
 		'no-iterator': 'error',
 		'no-label-var': 'error',
 		'no-labels': 'error',
 		'no-lone-blocks': 'error',
 		'no-lonely-if': 'error',
 		'no-loop-func': 'error',
-		// 'no-magic-numbers': 'off',
-		// 'no-mixed-operators': 'off',
-		// 'no-mixed-requires': 'off',
-		// 'no-multi-assign': 'off',
-		// 'no-multi-spaces': 'off',
 		'no-multi-str': 'error',
-		'no-multiple-empty-lines': 'error',
-		'no-native-reassign': 'error',
-		// 'no-negated-condition': 'off',
-		'no-negated-in-lhs': 'error',
 		'no-nested-ternary': 'error',
-		// 'no-new': 'off',
 		'no-new-func': 'error',
-		'no-new-object': 'error',
-		'no-new-require': 'error',
 		'no-new-wrappers': 'error',
 		'no-octal-escape': 'error',
-		// 'no-param-reassign': 'off',
-		'no-path-concat': 'error',
-		// 'no-plusplus': 'off',
-		// 'no-process-env': 'off',
-		'no-process-exit': 'error',
 		'no-proto': 'error',
 		'no-prototype-builtins': 'error',
 		'no-restricted-globals': 'error',
 		'no-restricted-imports': 'error',
-		'no-restricted-modules': 'error',
 		'no-restricted-properties': 'error',
 		'no-restricted-syntax': 'error',
-		// 'no-return-assign': 'off',
-		'no-return-await': 'error',
 		'no-script-url': 'error',
 		'no-self-compare': 'error',
-		// 'no-sequences': 'off',
-		// 'no-shadow': 'off',
 		'no-shadow-restricted-names': 'error',
-		// 'no-spaced-func': 'off',
-		'no-sync': 'error',
-		// 'no-tabs': 'off',
 		'no-template-curly-in-string': 'error',
-		// 'no-ternary': 'off',
 		'no-throw-literal': 'error',
-		'no-trailing-spaces': 'error',
 		'no-undef-init': 'error',
-		// 'no-undefined': 'off',
-		// 'no-underscore-dangle': 'off',
 		'no-unmodified-loop-condition': 'error',
 		'no-unneeded-ternary': 'error',
-		// 'no-unused-expressions': 'off',
-		// 'no-use-before-define': 'off',
 		'no-useless-call': 'error',
 		'no-useless-computed-key': 'error',
 		'no-useless-concat': 'error',
 		'no-useless-constructor': 'error',
 		'no-useless-rename': 'error',
 		'no-useless-return': 'error',
-		// 'no-var': 'off',
 		'no-void': 'error',
 		'no-warning-comments': 'error',
-		'no-whitespace-before-property': 'error',
 		'no-with': 'error',
-		'nonblock-statement-body-position': 'error',
-		// 'object-curly-newline': 'off',
-		'object-curly-spacing': [
-			'error', 'never'
-		],
-		'object-property-newline': [
-			'error', {
-				'allowMultiplePropertiesPerLine': true
-			}
-		],
-		// 'object-shorthand': 'off',
 		'one-var': 'error',
-		'one-var-declaration-per-line': [
-			'error', 'initializations'
-		],
-		// 'operator-assignment': 'off',
-		'operator-linebreak': [
-			'error', 'after'
-		],
-		// 'padded-blocks': 'off',
-		'padding-line-between-statements': 'error',
-		// 'prefer-arrow-callback': 'off',
 		'prefer-const': 'error',
-		// 'prefer-destructuring': 'off',
 		'prefer-numeric-literals': 'error',
 		'prefer-promise-reject-errors': 'error',
-		// 'prefer-reflect': 'off',
-		// 'prefer-rest-params': 'off',
-		// 'prefer-spread': 'off',
-		// 'prefer-template': 'off',
-		// 'quote-props': 'off',
-		'quotes': [
-			'error',
-			'single', {
-				'allowTemplateLiterals': true
-			}
-		],
 		'radix': [
 			'error', 'always'
 		],
 		'require-await': 'error',
-		// 'require-jsdoc': 'off',
-		'rest-spread-spacing': 'error',
-		'semi': 'error',
-		'semi-spacing': 'error',
-		// 'semi-style': 'off',
-		// 'sort-imports': 'off',
-		// 'sort-keys': 'off',
-		// 'sort-vars': 'off',
-		// 'space-before-blocks': 'off',
-		// 'space-before-function-paren': 'off',
-		'space-in-parens': [
-			'error', 'never'
-		],
-		// 'space-infix-ops': 'off',
-		'space-unary-ops': [
-			'error', {
-				'nonwords': false,
-				'words': false
-			}
-		],
-		// 'spaced-comment': 'off',
 		'strict': 'error',
-		'switch-colon-spacing': 'error',
 		'symbol-description': 'error',
-		'template-curly-spacing': 'error',
-		'template-tag-spacing': 'error',
 		'unicode-bom': [
 			'error', 'never'
 		],
-		// 'vars-on-top': 'off',
-		'wrap-regex': 'error',
-		'yield-star-spacing': 'error',
 		'sort-class-members/sort-class-members': [2, {
 			order: CLASS_MEMBER_ORDER,
 			groups: CLASS_MEMBER_GROUPS
 		}]
+	},
+	recommended = {
+		...js.configs.recommended,
+		languageOptions: {
+			...js.configs.recommended.languageOptions,
+			sourceType: 'commonjs',
+			globals: {
+				...globals.node
+			}
+		},
+		plugins: {
+			'sort-class-members': sortClassMembers
+		},
+		rules: {
+			...js.configs.recommended.rules,
+			...rules
+		}
 	}
-};
+;
+
+module.exports.configs = { recommended };
+module.exports.rules = rules;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moccu/eslint-config",
   "description": "The eslint config we use at moccu",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "author": "Moccu GmbH & Co. KG",
   "license": "MIT",
   "repository": "moccu/eslint-config-moccu",
@@ -30,12 +30,14 @@
     "hint"
   ],
   "devDependencies": {
-    "eslint": "^8.35.0",
-    "eslint-plugin-react": "^7.32.2",
-    "eslint-plugin-sort-class-members": "^1.20.0"
+    "eslint": "^10.6.0"
+  },
+  "dependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint-plugin-sort-class-members": "^1.22.1",
+    "globals": "^17.7.0"
   },
   "peerDependencies": {
-    "eslint": ">=8.0.0",
-    "eslint-plugin-sort-class-members": "^1.20.0"
+    "eslint": ">=10.0.0"
   }
 }

package/test/core.js

@@ -5,7 +5,7 @@
 		assert = require('assert'),
 		{ESLint} = require('eslint'),
 		files = ['**/*.js'],
-		configs = ['index', 'react', 'react-proptypes']
+		configs = ['index']
 	;
 
 	let
@@ -14,23 +14,14 @@
 	;
 
 	await Promise.all(configs.map(async (name) => {
-		const
-			config = require(`../${name}`),
-			eslint = new ESLint({
-				useEslintrc: false,
-				overrideConfig: {
-					env: {
-						'es6': true,
-						'node': true
-					},
-					parserOptions: {
-						'ecmaVersion': 'latest'
-					},
-					...config
-				}
-			}),
-			results = await eslint.lintFiles(files)
-		;
+			const
+				plugin = require(`../${name}.js`),
+				eslint = new ESLint({
+					overrideConfigFile: true,
+					overrideConfig: plugin.configs.recommended
+				}),
+				results = await eslint.lintFiles(files)
+			;
 
 		// Show error report
 		ESLint.getErrorResults(results).forEach((error) => {

package/test/helper.js

@@ -1,6 +1,5 @@
 'use strict';
 
-
 const
 	assert = require('assert'),
 

package/test/index.js

@@ -1,5 +1,4 @@
 'use strict';
 
-
 require('./core');
 require('./helper');

package/react-proptypes.js

@@ -1,20 +0,0 @@
-'use strict';
-
-
-module.exports = {
-	plugins: [
-		'react'
-	],
-	rules: {
-		'react/boolean-prop-naming': [2, {'rule': '^(is|has|can)[A-Z]([A-Za-z0-9]?)+'}],
-		'react/no-unused-prop-types': [2],
-		'react/require-default-props': [2],
-		'react/sort-prop-types': [2, {
-			'callbacksLast': true,
-			'ignoreCase': true,
-			'requiredFirst': true,
-			'sortShapeProp': true,
-			'noSortAlphabetically': false
-		}]
-	}
-};

package/react.js

@@ -1,81 +0,0 @@
-'use strict';
-
-
-const
-	{CLASS_MEMBER_GROUPS, CLASS_MEMBER_ORDER} = require('./defaults/sort-class-members')
-;
-
-
-module.exports = {
-	extends: [
-		'plugin:react/recommended'
-	],
-	plugins: [
-		'react',
-		'sort-class-members'
-	],
-	rules: {
-		'react/button-has-type': [2],
-		'react/display-name': 'off',
-		'react/no-access-state-in-setstate': [2],
-		'react/no-unused-state': [2],
-		'react/require-render-return': [2],
-		'react/jsx-curly-spacing': [2, {'when': 'never', 'allowMultiline': true}],
-		'react/jsx-equals-spacing': [2, 'never'],
-		'react/jsx-no-bind': [2],
-		'react/jsx-curly-brace-presence': [2],
-		'react/jsx-fragments': [2, 'element'],
-		'react/jsx-pascal-case': [2],
-		'react/jsx-props-no-multi-spaces': [2],
-		'react/jsx-sort-props': [2, {
-			'callbacksLast': true,
-			'ignoreCase': true,
-			'noSortAlphabetically': false,
-			'reservedFirst': true
-		}],
-		'react/jsx-tag-spacing': [2, {
-			'closingSlash': 'never',
-			'beforeSelfClosing': 'always',
-			'afterOpening': 'never',
-			'beforeClosing': 'never'
-		}],
-		'react/jsx-wrap-multilines': [2, {
-			'declaration': 'parens',
-			'assignment': 'parens',
-			'return': 'parens',
-			'arrow': 'parens',
-			'condition': 'parens',
-			'logical': 'parens',
-			'prop': 'parens'
-		}],
-		'sort-class-members/sort-class-members': [2, {
-			order: CLASS_MEMBER_ORDER
-				.insert('[framework-static-properties]').after('[static-properties]')
-				.insert('[framework-static-methods]').after('[static-methods]')
-				.insert('[framework-lifecycle-methods]').before('render'),
-			groups: Object.assign({}, CLASS_MEMBER_GROUPS, {
-				'framework-static-properties': [
-					{'name': 'propTypes', 'type': 'property', 'static': true},
-					{'name': 'defaultProps', 'type': 'property', 'static': true}
-				],
-				'framework-static-methods': [
-					{'name': 'getDerivedStateFromProps', 'type': 'method', 'static': true}
-				],
-				'framework-lifecycle-methods': [
-					{'name': 'componentWillMount', 'type': 'method'},
-					{'name': 'UNSAFE_componentWillMount', 'type': 'method'},
-					{'name': 'componentDidMount', 'type': 'method'},
-					{'name': 'componentWillReceiveProps', 'type': 'method'},
-					{'name': 'UNSAFE_componentWillReceiveProps', 'type': 'method'},
-					{'name': 'shouldComponentUpdate', 'type': 'method'},
-					{'name': 'componentWillUpdate', 'type': 'method'},
-					{'name': 'UNSAFE_componentWillUpdate', 'type': 'method'},
-					{'name': 'getSnapshotBeforeUpdate', 'type': 'method'},
-					{'name': 'componentDidUpdate', 'type': 'method'},
-					{'name': 'componentDidCatch', 'type': 'method'},
-					{'name': 'componentWillUnmount', 'type': 'method'}
-				]
-			})
-		}]
-	}
-};