@moccu/eslint-config 0.6.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

@@ -3,7 +3,7 @@
 [![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,3 +1,5 @@
+'use strict';
+
 const
 	{List} = require('../helper')
 ;

package/helper/index.js

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

package/index.js

@@ -1,139 +1,137 @@
+'use strict';
+
 const
 	{CLASS_MEMBER_GROUPS, CLASS_MEMBER_ORDER} = require('./defaults/sort-class-members'),
-	_package = require('./package.json'),
 	js = require('@eslint/js'),
+	globals = require('globals'),
 	sortClassMembers = require('eslint-plugin-sort-class-members'),
-	plugin = {
-		meta: {
-			name: _package.name,
-   			version: _package.version
-		},
-		configs: {},
-		rules: {
-			'accessor-pairs': 'error',
-			'array-callback-return': 'error',
-			'block-scoped-var': 'error',
-			'complexity': 'error',
-			'consistent-this': [
-				2, 'self'
-			],
-			'curly': 'error',
-			'dot-notation': 'error',
-			'eqeqeq': 'error',
-			'func-name-matching': 'error',
-			'func-names': [
-				'error', 'never'
-			],
-			'func-style': [
-				'error',
-				'declaration', {
-					'allowArrowFunctions': true
-				}
-			],
-			'guard-for-in': 'error',
-			'id-match': 'error',
-			'max-depth': 'error',
-			'max-lines': [
-				'error', {
-					'max': 350,
-					'skipBlankLines': true
-				}
-			],
-			'max-nested-callbacks': 'error',
-			'no-alert': 'error',
-			'no-array-constructor': 'error',
-			'no-await-in-loop': 'error',
-			'no-bitwise': 'error',
-			'no-caller': 'error',
-			'no-continue': 'error',
-			'no-div-regex': 'error',
-			'no-duplicate-imports': 'error',
-			'no-empty-function': 'error',
-			'no-eq-null': 'error',
-			'no-eval': 'error',
-			'no-extend-native': 'error',
-			'no-extra-bind': 'error',
-			'no-extra-label': 'error',
-			'no-implicit-coercion': [
-				'error', {
-					'boolean': false,
-					'number': false,
-					'string': false
-				}
-			],
-			'no-implicit-globals': 'error',
-			'no-implied-eval': 'error',
-			'no-inner-declarations': [
-				'error', 'functions'
-			],
-			'no-iterator': 'error',
-			'no-label-var': 'error',
-			'no-labels': 'error',
-			'no-lone-blocks': 'error',
-			'no-lonely-if': 'error',
-			'no-loop-func': 'error',
-			'no-multi-str': 'error',
-			'no-nested-ternary': 'error',
-			'no-new-func': 'error',
-			'no-new-wrappers': 'error',
-			'no-octal-escape': 'error',
-			'no-proto': 'error',
-			'no-prototype-builtins': 'error',
-			'no-restricted-globals': 'error',
-			'no-restricted-imports': 'error',
-			'no-restricted-properties': 'error',
-			'no-restricted-syntax': 'error',
-			'no-script-url': 'error',
-			'no-self-compare': 'error',
-			'no-shadow-restricted-names': 'error',
-			'no-template-curly-in-string': 'error',
-			'no-throw-literal': 'error',
-			'no-undef-init': 'error',
-			'no-unmodified-loop-condition': 'error',
-			'no-unneeded-ternary': 'error',
-			'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-void': 'error',
-			'no-warning-comments': 'error',
-			'no-with': 'error',
-			'one-var': 'error',
-			'prefer-const': 'error',
-			'prefer-numeric-literals': 'error',
-			'prefer-promise-reject-errors': 'error',
-			'radix': [
-				'error', 'always'
-			],
-			'require-await': 'error',
-			'strict': 'error',
-			'symbol-description': 'error',
-			'unicode-bom': [
-				'error', 'never'
-			],
-			'sort-class-members/sort-class-members': [2, {
-				order: CLASS_MEMBER_ORDER,
-				groups: CLASS_MEMBER_GROUPS
-			}]
-		}
-	}
-;
-
-plugin.configs = {
-	recommended: {
-		extends: ['eslint:recommended'],
-		plugins: ['sort-class-members'],
-		rules: plugin.rules
+	rules = {
+		'accessor-pairs': 'error',
+		'array-callback-return': 'error',
+		'block-scoped-var': 'error',
+		'complexity': 'error',
+		'consistent-this': [
+			2, 'self'
+		],
+		'curly': 'error',
+		'dot-notation': 'error',
+		'eqeqeq': 'error',
+		'func-name-matching': 'error',
+		'func-names': [
+			'error', 'never'
+		],
+		'func-style': [
+			'error',
+			'declaration', {
+				'allowArrowFunctions': true
+			}
+		],
+		'guard-for-in': 'error',
+		'id-match': 'error',
+		'max-depth': 'error',
+		'max-lines': [
+			'error', {
+				'max': 350,
+				'skipBlankLines': true
+			}
+		],
+		'max-nested-callbacks': 'error',
+		'no-alert': 'error',
+		'no-array-constructor': 'error',
+		'no-await-in-loop': 'error',
+		'no-bitwise': 'error',
+		'no-caller': 'error',
+		'no-continue': 'error',
+		'no-div-regex': 'error',
+		'no-duplicate-imports': 'error',
+		'no-empty-function': 'error',
+		'no-eq-null': 'error',
+		'no-eval': 'error',
+		'no-extend-native': 'error',
+		'no-extra-bind': 'error',
+		'no-extra-label': 'error',
+		'no-implicit-coercion': [
+			'error', {
+				'boolean': false,
+				'number': false,
+				'string': false
+			}
+		],
+		'no-implicit-globals': 'error',
+		'no-implied-eval': 'error',
+		'no-inner-declarations': [
+			'error', 'functions'
+		],
+		'no-iterator': 'error',
+		'no-label-var': 'error',
+		'no-labels': 'error',
+		'no-lone-blocks': 'error',
+		'no-lonely-if': 'error',
+		'no-loop-func': 'error',
+		'no-multi-str': 'error',
+		'no-nested-ternary': 'error',
+		'no-new-func': 'error',
+		'no-new-wrappers': 'error',
+		'no-octal-escape': 'error',
+		'no-proto': 'error',
+		'no-prototype-builtins': 'error',
+		'no-restricted-globals': 'error',
+		'no-restricted-imports': 'error',
+		'no-restricted-properties': 'error',
+		'no-restricted-syntax': 'error',
+		'no-script-url': 'error',
+		'no-self-compare': 'error',
+		'no-shadow-restricted-names': 'error',
+		'no-template-curly-in-string': 'error',
+		'no-throw-literal': 'error',
+		'no-undef-init': 'error',
+		'no-unmodified-loop-condition': 'error',
+		'no-unneeded-ternary': 'error',
+		'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-void': 'error',
+		'no-warning-comments': 'error',
+		'no-with': 'error',
+		'one-var': 'error',
+		'prefer-const': 'error',
+		'prefer-numeric-literals': 'error',
+		'prefer-promise-reject-errors': 'error',
+		'radix': [
+			'error', 'always'
+		],
+		'require-await': 'error',
+		'strict': 'error',
+		'symbol-description': 'error',
+		'unicode-bom': [
+			'error', 'never'
+		],
+		'sort-class-members/sort-class-members': [2, {
+			order: CLASS_MEMBER_ORDER,
+			groups: CLASS_MEMBER_GROUPS
+		}]
 	},
-	'flat/recommended': {
+	recommended = {
 		...js.configs.recommended,
+		languageOptions: {
+			...js.configs.recommended.languageOptions,
+			sourceType: 'commonjs',
+			globals: {
+				...globals.node
+			}
+		},
 		plugins: {
 			'sort-class-members': sortClassMembers
 		},
-		rules: plugin.rules
+		rules: {
+			...js.configs.recommended.rules,
+			...rules
+		}
 	}
-};
+;
 
-module.exports = plugin;
+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.6.0",
+  "version": "0.8.0",
   "author": "Moccu GmbH & Co. KG",
   "license": "MIT",
   "repository": "moccu/eslint-config-moccu",
@@ -30,12 +30,14 @@
     "hint"
   ],
   "devDependencies": {
-    "eslint": "^9.8.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

@@ -1,9 +1,10 @@
+'use strict';
+
 (async function() {
 	const
 		assert = require('assert'),
 		{ESLint} = require('eslint'),
 		files = ['**/*.js'],
-		// configs = ['index', 'react', 'react-proptypes']
 		configs = ['index']
 	;
 
@@ -17,7 +18,7 @@
 				plugin = require(`../${name}.js`),
 				eslint = new ESLint({
 					overrideConfigFile: true,
-					overrideConfig: plugin.configs['flat/recommended']
+					overrideConfig: plugin.configs.recommended
 				}),
 				results = await eslint.lintFiles(files)
 			;

package/test/helper.js

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

package/test/index.js

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

package/react-proptypes.js

@@ -1,19 +0,0 @@
-// @TODO: Add flat config
-
-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,79 +0,0 @@
-// @TODO: Add flat config
-
-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'}
-				]
-			})
-		}]
-	}
-};