eslint-config-webpack 4.1.4 → 4.2.1

package/configs/browser.js

@@ -1,5 +1,5 @@
-import globals from "globals";
 import importPlugin from "eslint-plugin-import";
+import globals from "globals";
 
 const recommendedBrowserConfig = {
 	languageOptions: {
@@ -11,6 +11,20 @@ const recommendedBrowserConfig = {
 		import: importPlugin,
 	},
 	rules: {
+		"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-modern-dom-apis": "error",
+
+		"unicorn/prefer-keyboard-event-key": "error",
+
+		"unicorn/prefer-query-selector": "error",
+
 		"import/extensions": ["error", "always", { ignorePackages: true }],
 	},
 };

package/configs/index.js

@@ -3,6 +3,7 @@ import javascriptConfig from "./javascript.js";
 import jestConfig from "./jest.js";
 import markdownConfig from "./markdown.js";
 import nodeConfig from "./node.js";
+import packageJSON from "./package-json.js";
 import stylisticConfig from "./stylistic.js";
 import typescriptConfig from "./typescript.js";
 
@@ -14,6 +15,7 @@ const configs = {
 	...nodeConfig,
 	...stylisticConfig,
 	...typescriptConfig,
+	...packageJSON,
 };
 
 export default configs;

package/configs/javascript.js

@@ -1,7 +1,7 @@
-import globals from "globals";
 import javascriptConfig from "@eslint/js";
-import unicornPlugin from "eslint-plugin-unicorn";
 import importPlugin from "eslint-plugin-import";
+import unicornPlugin from "eslint-plugin-unicorn";
+import globals from "globals";
 import { allExtensions } from "./utils/extensions.js";
 
 const possibleProblems = {
@@ -885,13 +885,17 @@ const unicornRules = {
 
 	"unicorn/prefer-default-parameters": "error",
 
-	"unicorn/prefer-dom-node-append": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-dom-node-append": "error",
 
-	"unicorn/prefer-dom-node-dataset": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-dom-node-dataset": "error",
 
-	"unicorn/prefer-dom-node-remove": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-dom-node-remove": "error",
 
-	"unicorn/prefer-dom-node-text-content": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-dom-node-text-content": "error",
 
 	"unicorn/prefer-event-target": "error",
 
@@ -907,7 +911,8 @@ const unicornRules = {
 	// No need
 	// "unicorn/prefer-json-parse-buffer": "off",
 
-	"unicorn/prefer-keyboard-event-key": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-keyboard-event-key": "error",
 
 	"unicorn/prefer-logical-operator-over-ternary": "error",
 
@@ -918,7 +923,8 @@ const unicornRules = {
 	// `| 0` is faster
 	// "unicorn/prefer-math-trunc": "off",
 
-	"unicorn/prefer-modern-dom-apis": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-modern-dom-apis": "error",
 
 	"unicorn/prefer-modern-math-apis": "error",
 
@@ -941,7 +947,8 @@ const unicornRules = {
 
 	"unicorn/prefer-prototype-methods": "error",
 
-	"unicorn/prefer-query-selector": "error",
+	// Not here, define only for `browsers`
+	// "unicorn/prefer-query-selector": "error",
 
 	// No need
 	// "unicorn/prefer-reflect-apply": "off",
@@ -1141,21 +1148,20 @@ const importRules = {
 	// No need
 	// "import/no-unassigned-import": "off",
 
-	// No need
-	// TODO consider this in the future
-	// "import/order": [
-	//   "warn",
-	//   {
-	//     groups: [
-	//       "builtin",
-	//       "external",
-	//       "internal",
-	//       "parent",
-	//       "sibling",
-	//       "index",
-	//     ]
-	//   },
-	// ],
+	"import/order": [
+		"error",
+		{
+			named: {
+				enabled: true,
+				import: true,
+				export: true,
+				require: true,
+				cjsExports: true,
+				types: "mixed",
+			},
+			alphabetize: { order: "asc" },
+		},
+	],
 
 	// No need
 	// "import/prefer-default-export": "off",
@@ -1195,6 +1201,7 @@ function getConfig(esVersion) {
 		},
 		linterOptions: {
 			reportUnusedDisableDirectives: true,
+			reportUnusedInlineConfigs: "error",
 		},
 		rules: {
 			...javascriptConfig.configs.recommended.rules,

package/configs/jest.js

@@ -206,6 +206,21 @@ async function getJestRecommendedConfig() {
 			// Allow to output information in tests
 			"no-console": "off",
 
+			// Allow to use `eval` for tests
+			"no-eval": "off",
+
+			// Allow to have any regexps in tests, useful to clean up/etc
+			"no-control-regex": "off",
+
+			// Allow to use any builtins, syntax and node API in tests
+			"n/no-unsupported-features/es-builtins": "off",
+			"n/no-unsupported-features/es-syntax": "off",
+			"n/no-unsupported-features/node-builtins": "off",
+
+			// Allow to `require` and `import` any things in tests
+			"n/no-unpublished-require": "off",
+			"n/no-unpublished-import": "off",
+
 			// Doesn't require jsdoc for tests, they are either redundant or we have a separate task for checking types of tests
 			"jsdoc/require-jsdoc": "off",
 		},

package/configs/markdown.js

@@ -60,6 +60,10 @@ async function getMarkdownRecommendedConfig() {
 
 				"n/no-unpublished-import": "off",
 
+				"n/no-missing-import": "off",
+
+				"n/no-missing-require": "off",
+
 				"import/no-unresolved": "off",
 
 				"import/no-extraneous-dependencies": "off",

package/configs/node.js

@@ -1,5 +1,5 @@
-import globals from "globals";
 import importPlugin from "eslint-plugin-import";
+import globals from "globals";
 
 const commonRules = {
 	// No need
@@ -38,11 +38,11 @@ const commonRules = {
 	// Deprecated
 	// "n/no-hide-core-modules": "error",
 
-	// From recommended
-	// "n/no-missing-import": "error",
+	// We have `import/no-unresolved` rule
+	"n/no-missing-import": "off",
 
-	// From recommended
-	// "n/no-missing-require": "error",
+	// We have `import/no-unresolved` rule
+	"n/no-missing-require": "off",
 
 	// No need
 	// "n/no-mixed-requires": "error",
@@ -144,6 +144,7 @@ async function getCommonJSConfig() {
 			import: importPlugin,
 		},
 		rules: {
+			...nodeConfig.rules,
 			...commonRules,
 			"n/exports-style": "error",
 			"n/no-path-concat": "error",
@@ -200,6 +201,7 @@ async function getModuleConfig() {
 			import: importPlugin,
 		},
 		rules: {
+			...nodeConfig.rules,
 			...commonRules,
 			"import/extensions": [
 				"error",

package/configs/package-json.js

@@ -0,0 +1,9 @@
+import { configs } from "../plugins/package-json/index.js";
+
+const recommendedBrowserConfig = {
+	...configs.recommended,
+};
+
+export default {
+	"package-json/recommended": recommendedBrowserConfig,
+};

package/configs/stylistic.js

@@ -1,6 +1,6 @@
+import stylisticPlugin from "@stylistic/eslint-plugin";
 import prettierPlugin from "eslint-plugin-prettier";
 import prettierConfig from "eslint-plugin-prettier/recommended";
-import stylisticPlugin from "@stylistic/eslint-plugin";
 
 const recommendedConfig = {
 	...prettierConfig,

package/configs/utils/extensions.js

@@ -2,4 +2,4 @@ const javascriptExtensions = [".js", ".cjs", ".mjs", ".jsx"];
 const typescriptExtensions = [".ts", ".cts", ".mts", ".tsx"];
 const allExtensions = [...javascriptExtensions, ...typescriptExtensions];
 
-export { javascriptExtensions, typescriptExtensions, allExtensions };
+export { allExtensions, javascriptExtensions, typescriptExtensions };

package/configs.js

@@ -3,8 +3,8 @@ import path from "node:path";
 import { globalIgnores } from "eslint/config";
 import semver from "semver";
 import configs from "./configs/index.js";
-import ignorePaths from "./ignore-paths.js";
 import { typescriptExtensions } from "./configs/utils/extensions.js";
+import ignorePaths from "./ignore-paths.js";
 
 const SKIP_TIME = 5000;
 
@@ -295,6 +295,7 @@ configs.recommended = [
 	jestConfig,
 	configs["markdown/recommended"],
 	configs["stylistic/recommended"],
+	configs["package-json/recommended"],
 ];
 
 configs["recommended-module"] = [
@@ -306,6 +307,7 @@ configs["recommended-module"] = [
 	jestConfig,
 	configs["markdown/recommended"],
 	configs["stylistic/recommended"],
+	configs["package-json/recommended"],
 ];
 
 configs["recommended-commonjs"] = [
@@ -317,6 +319,7 @@ configs["recommended-commonjs"] = [
 	jestConfig,
 	configs["markdown/recommended"],
 	configs["stylistic/recommended"],
+	configs["package-json/recommended"],
 ];
 
 configs["recommended-dirty"] = [
@@ -328,6 +331,7 @@ configs["recommended-dirty"] = [
 	jestConfig,
 	configs["markdown/recommended"],
 	configs["stylistic/recommended"],
+	configs["package-json/recommended"],
 ];
 
 export { default } from "./configs/index.js";

package/ignore-paths.js

@@ -1,9 +1,69 @@
 export default [
-	"types/**/*",
+	// OS
+	".DS_Store",
+	"Thumbs.db",
+
+	// IDE
+	".idea",
+	"*.iml",
+	".vscode",
+	".vscode-test",
+	"*.sublime-project",
+	"*.sublime-workspace",
+
+	// Logs
+	"logs/**/*",
+	"*.log",
+	"npm-debug.log*",
+	"yarn-debug.log*",
+	"yarn-error.log*",
+	"lerna-debug.log*",
+
+	// Diagnostic reports (https://nodejs.org/api/report.html)
+	"report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json",
+
+	// Runtime data
+	"pids",
+	"*.pid",
+	"*.seed",
+	"*.pid.lock",
+
+	// Directory for instrumented libs generated by jscoverage/JSCover
+	"lib-cov/**/*",
+
+	// Coverage directory used by tools like istanbul
+	"coverage/**/*",
+	"*.lcov",
+
+	// nyc test coverage
+	".nyc_output",
+
+	// Compiled binary addons (https://nodejs.org/api/addons.html)
+	"build/Release/**/*",
+
+	// Dependencies
 	"node_modules/**/*",
+
+	// Optional REPL history
+	".node_repl_history",
+
+	// Generated code
 	"dist/**/*",
-	"coverage/**/*",
+
+	// Test
 	"test/fixtures/**/*",
 	"test/outputs/**/*",
-	"build/Release/**/*",
+
+	// Generated types
+	"types/**/*",
+
+	// Reports
+	"reports/**/*",
+
+	// Caches
+	".cache/**/*",
+	".eslintcache",
+	".stylelintcache",
+	".cspellcache",
+	"*.tsbuildinfo",
 ];

package/package.json

@@ -1,13 +1,30 @@
 {
   "name": "eslint-config-webpack",
-  "version": "4.1.4",
-  "author": "Joshua Wiens (https://twitter.com/@d3viant0ne)",
-  "license": "MIT",
+  "version": "4.2.1",
   "description": "Provides Webpack's eslint rules as an extensible shared config",
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "config",
+    "webpack",
+    "javascript",
+    "typescript"
+  ],
+  "homepage": "https://github.com/webpack/eslint-config-webpack#readme",
+  "bugs": {
+    "url": "https://github.com/webpack/eslint-config-webpack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/webpack/eslint-config-webpack.git"
+  },
+  "license": "MIT",
+  "author": "Joshua Wiens (https://twitter.com/@d3viant0ne)",
   "type": "module",
   "main": "index.js",
   "files": [
     "index.js",
+    "plugins",
     "prettier-config.js",
     "prettier-config-es5.js",
     "configs.js",
@@ -16,11 +33,14 @@
   ],
   "scripts": {
     "lint": "npm run lint:code",
-    "lint:code": "node node_modules/eslint/bin/eslint.js --cache .",
+    "lint:code": "eslint --cache .",
     "release": "standard-version"
   },
   "dependencies": {
-    "semver": "^7.7.2"
+    "detect-indent": "^7.0.1",
+    "jsonc-eslint-parser": "^2.4.0",
+    "semver": "^7.7.2",
+    "sort-package-json": "^3.3.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.29.0",
@@ -80,20 +100,5 @@
   },
   "engines": {
     "node": ">= 18.20.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/webpack/eslint-config-webpack.git"
-  },
-  "keywords": [
-    "eslint",
-    "eslintconfig",
-    "config",
-    "webpack",
-    "javascirpt"
-  ],
-  "bugs": {
-    "url": "https://github.com/webpack/eslint-config-webpack/issues"
-  },
-  "homepage": "https://github.com/webpack/eslint-config-webpack#readme"
+  }
 }

package/plugins/package-json/index.js

@@ -0,0 +1,48 @@
+import { createRequire } from "node:module";
+import * as parserJsonc from "jsonc-eslint-parser";
+import { rule as orderProperties } from "./rules/order-properties.js";
+
+const require = createRequire(import.meta.url);
+
+const { version } = require("../../package.json");
+
+const rules = {
+	"order-properties": orderProperties,
+};
+
+const recommendedRules = {
+	...Object.fromEntries(
+		Object.entries(rules)
+			.filter(([, rule]) => rule.meta.docs?.recommended)
+			.map(([name]) => [`package-json/${name}`, "error"]),
+	),
+};
+
+const configs = {
+	recommended: {
+		name: "package-json/recommended",
+		files: ["**/package.json"],
+		languageOptions: {
+			parser: parserJsonc,
+		},
+		plugins: {
+			get "package-json"() {
+				// eslint-disable-next-line no-use-before-define
+				return plugin;
+			},
+		},
+		rules: recommendedRules,
+	},
+};
+
+const plugin = {
+	configs,
+	meta: {
+		version,
+	},
+	rules,
+};
+
+export { configs, rules };
+
+export default plugin;

package/plugins/package-json/rules/order-properties.js

@@ -0,0 +1,187 @@
+import detectIndent from "detect-indent";
+import { sortOrder } from "sort-package-json";
+
+/**
+ * @param {string} string string
+ * @returns {"\r\n" | "\n"} detected newline
+ */
+function detectNewline(string) {
+	if (typeof string !== "string") {
+		throw new TypeError("Expected a string");
+	}
+
+	const newlines = string.match(/(?:\r?\n)/g) || [];
+
+	if (newlines.length === 0) {
+		return;
+	}
+
+	const crlf = newlines.filter((newline) => newline === "\r\n").length;
+	const lf = newlines.length - crlf;
+
+	return crlf > lf ? "\r\n" : "\n";
+}
+
+/**
+ * @param {string} string string
+ * @returns {string} result
+ */
+function detectNewlineGraceful(string) {
+	return detectNewline(string) || "\n";
+}
+
+// eslint-disable-next-line jsdoc/no-restricted-syntax
+/** @typedef {Record<string, any>} ObjectToSort */
+
+/**
+ * @param {ObjectToSort} object object to sort
+ * @param {(a: number, b: number) => number} sortWith function to sort
+ * @returns {ObjectToSort} object with sorted properties
+ */
+function sortObjectKeys(object, sortWith) {
+	let keys;
+	let sortFn;
+
+	if (typeof sortWith === "function") {
+		sortFn = sortWith;
+	} else {
+		keys = sortWith;
+	}
+
+	const objectKeys = Object.keys(object);
+
+	return (keys || [...objectKeys.sort(sortFn)]).reduce((total, key) => {
+		if (Object.hasOwn(object, key)) {
+			total[key] = object[key];
+		}
+
+		return total;
+	}, Object.create(null));
+}
+
+/**
+ * @param {string} filePath file path
+ * @returns {boolean} result
+ */
+export const isPackageJson = (filePath) =>
+	/(?:^|[/\\])package.json$/.test(filePath);
+
+// eslint-disable-next-line jsdoc/no-restricted-syntax
+/**
+ * @typedef {import("eslint").AST.Program} PackageJsonAst
+ * @property {[any]} body body
+ */
+
+/**
+ * @typedef {import("eslint").SourceCode} PackageJsonSourceCode
+ * @property {PackageJsonAst} ast ast
+ */
+
+/**
+ * @template {unknown[]} [Options=unknown[]]
+ * @typedef {import("eslint").RuleContext} PackageJsonRuleContext
+ * @property {Options} options options
+ * @property {PackageJsonSourceCode} sourceCode source code
+ */
+
+/**
+ * @template {unknown[]} Options
+ * @typedef {object} PackageJsonRuleModule
+ * @property {import("eslint").Rule.RuleMetaData} meta meta
+ * @property {(context: PackageJsonRuleContext<Options>) => import("eslint").RuleListener} create function to create
+ */
+
+/**
+ * @type {import("eslint").Rule} rule
+ */
+export const rule = {
+	create(context) {
+		if (!isPackageJson(context.filename)) {
+			return {};
+		}
+
+		return {
+			"Program:exit"() {
+				const { ast, text } = context.sourceCode;
+
+				const options = {
+					order: "sort-package-json",
+					...context.options[0],
+				};
+
+				const requiredOrder =
+					options.order === "sort-package-json" ? sortOrder : options.order;
+
+				const json = JSON.parse(text);
+				const orderedSource = sortObjectKeys(json, [
+					...requiredOrder,
+					...Object.keys(json),
+				]);
+				const orderedKeys = Object.keys(orderedSource);
+
+				const { properties } = ast.body[0].expression;
+
+				for (let i = 0; i < properties.length; i += 1) {
+					const property = properties[i].key;
+					const { value } = property;
+
+					if (value === orderedKeys[i]) {
+						continue;
+					}
+
+					context.report({
+						data: {
+							property: value,
+						},
+						fix(fixer) {
+							const { indent, type } = detectIndent(text);
+							const endCharacters = text.endsWith("\n") ? "\n" : "";
+							const newline = detectNewlineGraceful(text);
+							let result =
+								JSON.stringify(
+									orderedSource,
+									null,
+									type === "tab" ? "\t" : indent,
+								) + endCharacters;
+							if (newline === "\r\n") {
+								result = result.replaceAll("\n", newline);
+							}
+
+							return fixer.replaceText(context.sourceCode.ast, result);
+						},
+						loc: properties[i].loc,
+						messageId: "incorrectOrder",
+					});
+				}
+			},
+		};
+	},
+	meta: {
+		docs: {
+			category: "Best Practices",
+			description: "Package properties must be declared in standard order",
+			recommended: true,
+		},
+		fixable: "code",
+		messages: {
+			incorrectOrder:
+				'Package top-level property "{{property}}" is not ordered in the npm standard way. Run the ESLint auto-fixer to correct.',
+		},
+		schema: [
+			{
+				properties: {
+					order: {
+						anyOf: [
+							{
+								enum: ["sort-package-json"],
+								type: ["string"],
+							},
+						],
+					},
+				},
+				type: "object",
+			},
+		],
+		type: "layout",
+	},
+};