Support ESLint's new config system (#1886)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com> Co-authored-by: fisker <lionkay@gmail.com>
sindresorhus · Dec 20, 2023 · 65711f9 · 65711f9
1 parent c91c6ad
commit 65711f9
Show file tree

Hide file tree

Showing 10 changed files with 364 additions and 156 deletions.
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -2,7 +2,7 @@
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */
 const config = {
-  ignoreConfig: ['all'],
+  ignoreConfig: ['all', 'flat/all', 'flat/recommended'],
   ignoreDeprecatedRules: true,
   ruleDocTitleFormat: 'desc',
   ruleListColumns: [

diff --git a/configs/all.js b/configs/all.js
@@ -1,9 +1,6 @@
 'use strict';
-const {rules, ...baseConfigs} = require('./recommended.js');
+const recommended = require('./recommended.js');
 
-module.exports = {
-	...baseConfigs,
-	rules: Object.fromEntries(Object.entries(rules).map(
-		([ruleId, severity]) => [ruleId, ruleId.startsWith('unicorn/') ? 'error' : severity],
-	)),
-};
+module.exports = Object.fromEntries(Object.entries(recommended).map(
+	([ruleId, severity]) => [ruleId, ruleId.startsWith('unicorn/') ? 'error' : severity],
+));
diff --git a/configs/flat-config-base.js b/configs/flat-config-base.js
@@ -0,0 +1,20 @@
+'use strict';
+const eslintrc = require('@eslint/eslintrc');
+const legacyConfigBase = require('./legacy-config-base.js');
+
+const {
+	parserOptions: {
+		ecmaVersion,
+		sourceType,
+	},
+} = legacyConfigBase;
+
+const {globals} = eslintrc.Legacy.environments.get('es2024');
+
+module.exports = {
+	languageOptions: {
+		ecmaVersion,
+		sourceType,
+		globals,
+	},
+};
diff --git a/configs/legacy-config-base.js b/configs/legacy-config-base.js
@@ -0,0 +1,10 @@
+'use strict';
+module.exports = {
+	env: {
+		es2024: true,
+	},
+	parserOptions: {
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+};
diff --git a/configs/recommended.js b/configs/recommended.js
@@ -1,129 +1,117 @@
 'use strict';
 module.exports = {
-	env: {
-		es2024: true,
-	},
-	parserOptions: {
-		ecmaVersion: 'latest',
-		sourceType: 'module',
-	},
-	plugins: [
-		'unicorn',
-	],
-	rules: {
-		'unicorn/better-regex': 'error',
-		'unicorn/catch-error-name': 'error',
-		'unicorn/consistent-destructuring': 'error',
-		'unicorn/consistent-function-scoping': 'error',
-		'unicorn/custom-error-definition': 'off',
-		'unicorn/empty-brace-spaces': 'error',
-		'unicorn/error-message': 'error',
-		'unicorn/escape-case': 'error',
-		'unicorn/expiring-todo-comments': 'error',
-		'unicorn/explicit-length-check': 'error',
-		'unicorn/filename-case': 'error',
-		'unicorn/import-style': 'error',
-		'unicorn/new-for-builtins': 'error',
-		'unicorn/no-abusive-eslint-disable': 'error',
-		'unicorn/no-array-callback-reference': 'error',
-		'unicorn/no-array-for-each': 'error',
-		'unicorn/no-array-method-this-argument': 'error',
-		'unicorn/no-array-push-push': 'error',
-		'unicorn/no-array-reduce': 'error',
-		'unicorn/no-await-expression-member': 'error',
-		'unicorn/no-console-spaces': 'error',
-		'unicorn/no-document-cookie': 'error',
-		'unicorn/no-empty-file': 'error',
-		'unicorn/no-for-loop': 'error',
-		'unicorn/no-hex-escape': 'error',
-		'unicorn/no-instanceof-array': 'error',
-		'unicorn/no-invalid-remove-event-listener': 'error',
-		'unicorn/no-keyword-prefix': 'off',
-		'unicorn/no-lonely-if': 'error',
-		'no-negated-condition': 'off',
-		'unicorn/no-negated-condition': 'error',
-		'no-nested-ternary': 'off',
-		'unicorn/no-nested-ternary': 'error',
-		'unicorn/no-new-array': 'error',
-		'unicorn/no-new-buffer': 'error',
-		'unicorn/no-null': 'error',
-		'unicorn/no-object-as-default-parameter': 'error',
-		'unicorn/no-process-exit': 'error',
-		'unicorn/no-static-only-class': 'error',
-		'unicorn/no-thenable': 'error',
-		'unicorn/no-this-assignment': 'error',
-		'unicorn/no-typeof-undefined': 'error',
-		'unicorn/no-unnecessary-await': 'error',
-		'unicorn/no-unnecessary-polyfills': 'error',
-		'unicorn/no-unreadable-array-destructuring': 'error',
-		'unicorn/no-unreadable-iife': 'error',
-		'unicorn/no-unused-properties': 'off',
-		'unicorn/no-useless-fallback-in-spread': 'error',
-		'unicorn/no-useless-length-check': 'error',
-		'unicorn/no-useless-promise-resolve-reject': 'error',
-		'unicorn/no-useless-spread': 'error',
-		'unicorn/no-useless-switch-case': 'error',
-		'unicorn/no-useless-undefined': 'error',
-		'unicorn/no-zero-fractions': 'error',
-		'unicorn/number-literal-case': 'error',
-		'unicorn/numeric-separators-style': 'error',
-		'unicorn/prefer-add-event-listener': 'error',
-		'unicorn/prefer-array-find': 'error',
-		'unicorn/prefer-array-flat': 'error',
-		'unicorn/prefer-array-flat-map': 'error',
-		'unicorn/prefer-array-index-of': 'error',
-		'unicorn/prefer-array-some': 'error',
-		'unicorn/prefer-at': 'error',
-		'unicorn/prefer-blob-reading-methods': 'error',
-		'unicorn/prefer-code-point': 'error',
-		'unicorn/prefer-date-now': 'error',
-		'unicorn/prefer-default-parameters': 'error',
-		'unicorn/prefer-dom-node-append': 'error',
-		'unicorn/prefer-dom-node-dataset': 'error',
-		'unicorn/prefer-dom-node-remove': 'error',
-		'unicorn/prefer-dom-node-text-content': 'error',
-		'unicorn/prefer-event-target': 'error',
-		'unicorn/prefer-export-from': 'error',
-		'unicorn/prefer-includes': 'error',
-		'unicorn/prefer-json-parse-buffer': 'off',
-		'unicorn/prefer-keyboard-event-key': 'error',
-		'unicorn/prefer-logical-operator-over-ternary': 'error',
-		'unicorn/prefer-math-trunc': 'error',
-		'unicorn/prefer-modern-dom-apis': 'error',
-		'unicorn/prefer-modern-math-apis': 'error',
-		'unicorn/prefer-module': 'error',
-		'unicorn/prefer-native-coercion-functions': 'error',
-		'unicorn/prefer-negative-index': 'error',
-		'unicorn/prefer-node-protocol': 'error',
-		'unicorn/prefer-number-properties': 'error',
-		'unicorn/prefer-object-from-entries': 'error',
-		'unicorn/prefer-optional-catch-binding': 'error',
-		'unicorn/prefer-prototype-methods': 'error',
-		'unicorn/prefer-query-selector': 'error',
-		'unicorn/prefer-reflect-apply': 'error',
-		'unicorn/prefer-regexp-test': 'error',
-		'unicorn/prefer-set-has': 'error',
-		'unicorn/prefer-set-size': 'error',
-		'unicorn/prefer-spread': 'error',
-		'unicorn/prefer-string-replace-all': 'error',
-		'unicorn/prefer-string-slice': 'error',
-		'unicorn/prefer-string-starts-ends-with': 'error',
-		'unicorn/prefer-string-trim-start-end': 'error',
-		'unicorn/prefer-switch': 'error',
-		'unicorn/prefer-ternary': 'error',
-		'unicorn/prefer-top-level-await': 'error',
-		'unicorn/prefer-type-error': 'error',
-		'unicorn/prevent-abbreviations': 'error',
-		'unicorn/relative-url-style': 'error',
-		'unicorn/require-array-join-separator': 'error',
-		'unicorn/require-number-to-fixed-digits-argument': 'error',
-		// Turned off because we can't distinguish `widow.postMessage` and `{Worker,MessagePort,Client,BroadcastChannel}#postMessage()`
-		// See #1396
-		'unicorn/require-post-message-target-origin': 'off',
-		'unicorn/string-content': 'off',
-		'unicorn/switch-case-braces': 'error',
-		'unicorn/template-indent': 'error',
-		'unicorn/text-encoding-identifier-case': 'error',
-		'unicorn/throw-new-error': 'error',
-	},
+	'unicorn/better-regex': 'error',
+	'unicorn/catch-error-name': 'error',
+	'unicorn/consistent-destructuring': 'error',
+	'unicorn/consistent-function-scoping': 'error',
+	'unicorn/custom-error-definition': 'off',
+	'unicorn/empty-brace-spaces': 'error',
+	'unicorn/error-message': 'error',
+	'unicorn/escape-case': 'error',
+	'unicorn/expiring-todo-comments': 'error',
+	'unicorn/explicit-length-check': 'error',
+	'unicorn/filename-case': 'error',
+	'unicorn/import-style': 'error',
+	'unicorn/new-for-builtins': 'error',
+	'unicorn/no-abusive-eslint-disable': 'error',
+	'unicorn/no-array-callback-reference': 'error',
+	'unicorn/no-array-for-each': 'error',
+	'unicorn/no-array-method-this-argument': 'error',
+	'unicorn/no-array-push-push': 'error',
+	'unicorn/no-array-reduce': 'error',
+	'unicorn/no-await-expression-member': 'error',
+	'unicorn/no-console-spaces': 'error',
+	'unicorn/no-document-cookie': 'error',
+	'unicorn/no-empty-file': 'error',
+	'unicorn/no-for-loop': 'error',
+	'unicorn/no-hex-escape': 'error',
+	'unicorn/no-instanceof-array': 'error',
+	'unicorn/no-invalid-remove-event-listener': 'error',
+	'unicorn/no-keyword-prefix': 'off',
+	'unicorn/no-lonely-if': 'error',
+	'no-negated-condition': 'off',
+	'unicorn/no-negated-condition': 'error',
+	'no-nested-ternary': 'off',
+	'unicorn/no-nested-ternary': 'error',
+	'unicorn/no-new-array': 'error',
+	'unicorn/no-new-buffer': 'error',
+	'unicorn/no-null': 'error',
+	'unicorn/no-object-as-default-parameter': 'error',
+	'unicorn/no-process-exit': 'error',
+	'unicorn/no-static-only-class': 'error',
+	'unicorn/no-thenable': 'error',
+	'unicorn/no-this-assignment': 'error',
+	'unicorn/no-typeof-undefined': 'error',
+	'unicorn/no-unnecessary-await': 'error',
+	'unicorn/no-unnecessary-polyfills': 'error',
+	'unicorn/no-unreadable-array-destructuring': 'error',
+	'unicorn/no-unreadable-iife': 'error',
+	'unicorn/no-unused-properties': 'off',
+	'unicorn/no-useless-fallback-in-spread': 'error',
+	'unicorn/no-useless-length-check': 'error',
+	'unicorn/no-useless-promise-resolve-reject': 'error',
+	'unicorn/no-useless-spread': 'error',
+	'unicorn/no-useless-switch-case': 'error',
+	'unicorn/no-useless-undefined': 'error',
+	'unicorn/no-zero-fractions': 'error',
+	'unicorn/number-literal-case': 'error',
+	'unicorn/numeric-separators-style': 'error',
+	'unicorn/prefer-add-event-listener': 'error',
+	'unicorn/prefer-array-find': 'error',
+	'unicorn/prefer-array-flat': 'error',
+	'unicorn/prefer-array-flat-map': 'error',
+	'unicorn/prefer-array-index-of': 'error',
+	'unicorn/prefer-array-some': 'error',
+	'unicorn/prefer-at': 'error',
+	'unicorn/prefer-blob-reading-methods': 'error',
+	'unicorn/prefer-code-point': 'error',
+	'unicorn/prefer-date-now': 'error',
+	'unicorn/prefer-default-parameters': 'error',
+	'unicorn/prefer-dom-node-append': 'error',
+	'unicorn/prefer-dom-node-dataset': 'error',
+	'unicorn/prefer-dom-node-remove': 'error',
+	'unicorn/prefer-dom-node-text-content': 'error',
+	'unicorn/prefer-event-target': 'error',
+	'unicorn/prefer-export-from': 'error',
+	'unicorn/prefer-includes': 'error',
+	'unicorn/prefer-json-parse-buffer': 'off',
+	'unicorn/prefer-keyboard-event-key': 'error',
+	'unicorn/prefer-logical-operator-over-ternary': 'error',
+	'unicorn/prefer-math-trunc': 'error',
+	'unicorn/prefer-modern-dom-apis': 'error',
+	'unicorn/prefer-modern-math-apis': 'error',
+	'unicorn/prefer-module': 'error',
+	'unicorn/prefer-native-coercion-functions': 'error',
+	'unicorn/prefer-negative-index': 'error',
+	'unicorn/prefer-node-protocol': 'error',
+	'unicorn/prefer-number-properties': 'error',
+	'unicorn/prefer-object-from-entries': 'error',
+	'unicorn/prefer-optional-catch-binding': 'error',
+	'unicorn/prefer-prototype-methods': 'error',
+	'unicorn/prefer-query-selector': 'error',
+	'unicorn/prefer-reflect-apply': 'error',
+	'unicorn/prefer-regexp-test': 'error',
+	'unicorn/prefer-set-has': 'error',
+	'unicorn/prefer-set-size': 'error',
+	'unicorn/prefer-spread': 'error',
+	'unicorn/prefer-string-replace-all': 'error',
+	'unicorn/prefer-string-slice': 'error',
+	'unicorn/prefer-string-starts-ends-with': 'error',
+	'unicorn/prefer-string-trim-start-end': 'error',
+	'unicorn/prefer-switch': 'error',
+	'unicorn/prefer-ternary': 'error',
+	'unicorn/prefer-top-level-await': 'error',
+	'unicorn/prefer-type-error': 'error',
+	'unicorn/prevent-abbreviations': 'error',
+	'unicorn/relative-url-style': 'error',
+	'unicorn/require-array-join-separator': 'error',
+	'unicorn/require-number-to-fixed-digits-argument': 'error',
+	// Turned off because we can't distinguish `widow.postMessage` and `{Worker,MessagePort,Client,BroadcastChannel}#postMessage()`
+	// See #1396
+	'unicorn/require-post-message-target-origin': 'off',
+	'unicorn/string-content': 'off',
+	'unicorn/switch-case-braces': 'error',
+	'unicorn/template-indent': 'error',
+	'unicorn/text-encoding-identifier-case': 'error',
+	'unicorn/throw-new-error': 'error',
 };
diff --git a/index.js b/index.js
@@ -1,8 +1,10 @@
 'use strict';
 const createDeprecatedRules = require('./rules/utils/create-deprecated-rules.js');
 const {loadRules} = require('./rules/utils/rule.js');
-const recommendedConfig = require('./configs/recommended.js');
-const allRulesEnabledConfig = require('./configs/all.js');
+const legacyConfigBase = require('./configs/legacy-config-base.js');
+const flatConfigBase = require('./configs/flat-config-base.js');
+const recommendedRules = require('./configs/recommended.js');
+const allRules = require('./configs/all.js');
 const {name, version} = require('./package.json');
 
 const deprecatedRules = createDeprecatedRules({
@@ -26,7 +28,13 @@ const deprecatedRules = createDeprecatedRules({
 	'regex-shorthand': 'unicorn/better-regex',
 });
 
-module.exports = {
+const createConfig = (rules, isLegacyConfig = false) => ({
+	...(isLegacyConfig ? legacyConfigBase : flatConfigBase),
+	plugins: isLegacyConfig ? ['unicorn'] : {unicorn},
+	rules,
+});
+
+const unicorn = {
 	meta: {
 		name,
 		version,
@@ -35,8 +43,13 @@ module.exports = {
 		...loadRules(),
 		...deprecatedRules,
 	},
-	configs: {
-		recommended: recommendedConfig,
-		all: allRulesEnabledConfig,
-	},
 };
+
+const configs = {
+	recommended: createConfig(recommendedRules, /* isLegacyConfig */ true),
+	all: createConfig(allRules, /* isLegacyConfig */ true),
+	'flat/recommended': createConfig(recommendedRules),
+	'flat/all': createConfig(allRules),
+};
+
+module.exports = {...unicorn, configs};
diff --git a/package.json b/package.json
@@ -10,6 +10,7 @@
 		"email": "sindresorhus@gmail.com",
 		"url": "https://sindresorhus.com"
 	},
+	"main": "index.js",
 	"engines": {
 		"node": ">=16"
 	},
@@ -18,12 +19,12 @@
 		"fix": "run-p --continue-on-error fix:*",
 		"fix:eslint-docs": "eslint-doc-generator",
 		"fix:js": "npm run lint:js -- --fix",
-		"fix:md": "npm run lint:md -- --fix",
+		"fix:markdown": "npm run lint:markdown -- --fix",
 		"integration": "node ./test/integration/test.mjs",
 		"lint": "run-p --continue-on-error lint:*",
 		"lint:eslint-docs": "npm run fix:eslint-docs -- --check",
 		"lint:js": "xo",
-		"lint:md": "markdownlint \"**/*.md\"",
+		"lint:markdown": "markdownlint \"**/*.md\"",
 		"lint:package-json": "npmPkgJsonLint .",
 		"run-rules-on-codebase": "node ./test/run-rules-on-codebase/lint.mjs",
 		"bundle-lodash": "echo \"export {defaultsDeep, camelCase, kebabCase, snakeCase, upperFirst, lowerFirst} from 'lodash-es';\" | npx esbuild --bundle --outfile=rules/utils/lodash.js --format=cjs",
@@ -49,6 +50,7 @@
 	"dependencies": {
 		"@babel/helper-validator-identifier": "^7.22.20",
 		"@eslint-community/eslint-utils": "^4.4.0",
+		"@eslint/eslintrc": "^2.1.4",
 		"ci-info": "^4.0.0",
 		"clean-regexp": "^1.0.0",
 		"core-js-compat": "^3.34.0",