@alextheman/eslint-plugin 5.17.0 → 5.18.0

package/dist/index.cjs

@@ -30,6 +30,8 @@ let _typescript_eslint_utils = require("@typescript-eslint/utils");
 let zod = require("zod");
 zod = __toESM(zod, 1);
 let _alextheman_utility_v6 = require("@alextheman/utility/v6");
+let _eslint_community_eslint_plugin_eslint_comments_configs = require("@eslint-community/eslint-plugin-eslint-comments/configs");
+_eslint_community_eslint_plugin_eslint_comments_configs = __toESM(_eslint_community_eslint_plugin_eslint_comments_configs, 1);
 let _eslint_js = require("@eslint/js");
 _eslint_js = __toESM(_eslint_js, 1);
 let eslint_config_prettier = require("eslint-config-prettier");
@@ -44,8 +46,6 @@ let eslint_plugin_perfectionist = require("eslint-plugin-perfectionist");
 eslint_plugin_perfectionist = __toESM(eslint_plugin_perfectionist, 1);
 let eslint_plugin_prettier = require("eslint-plugin-prettier");
 eslint_plugin_prettier = __toESM(eslint_plugin_prettier, 1);
-let typescript_eslint = require("typescript-eslint");
-typescript_eslint = __toESM(typescript_eslint, 1);
 let _eslint_react_eslint_plugin = require("@eslint-react/eslint-plugin");
 _eslint_react_eslint_plugin = __toESM(_eslint_react_eslint_plugin, 1);
 let _stylistic_eslint_plugin = require("@stylistic/eslint-plugin");
@@ -58,6 +58,8 @@ let eslint_plugin_react_hooks = require("eslint-plugin-react-hooks");
 eslint_plugin_react_hooks = __toESM(eslint_plugin_react_hooks, 1);
 let eslint_plugin_package_json = require("eslint-plugin-package-json");
 eslint_plugin_package_json = __toESM(eslint_plugin_package_json, 1);
+let typescript_eslint = require("typescript-eslint");
+typescript_eslint = __toESM(typescript_eslint, 1);
 let eslint_plugin_jsdoc = require("eslint-plugin-jsdoc");
 eslint_plugin_jsdoc = __toESM(eslint_plugin_jsdoc, 1);
 let _alextheman_utility_node = require("@alextheman/utility/node");
@@ -4423,6 +4425,7 @@ const unusedVarsIgnorePatterns = {
 const generalJavaScript = [
 	_eslint_js.default.configs.recommended,
 	eslint_config_prettier.default,
+	_eslint_community_eslint_plugin_eslint_comments_configs.default.recommended,
 	eslint_plugin_n.default.configs["flat/recommended"],
 	{
 		files: [
@@ -4439,6 +4442,7 @@ const generalJavaScript = [
 			n: eslint_plugin_n.default
 		},
 		rules: {
+			"@eslint-community/eslint-comments/require-description": "error",
 			eqeqeq: "error",
 			"import-x/no-duplicates": ["error", { "prefer-inline": false }],
 			"import-x/no-unresolved": "error",
@@ -4485,38 +4489,6 @@ const generalJavaScript = [
 //#region src/configs/external/prettierConfig.ts
 const prettierConfig = { printWidth: 100 };
 //#endregion
-//#region src/configs/helpers/reactLanguageOptions.ts
-const reactLanguageOptions = {
-	ecmaVersion: 2020,
-	globals: import_globals.default.browser,
-	parserOptions: { ecmaFeatures: { jsx: true } }
-};
-//#endregion
-//#region src/configs/helpers/typeScriptLanguageOptions.ts
-const typeScriptLanguageOptions = {
-	parser: typescript_eslint.default.parser,
-	parserOptions: {
-		ecmaVersion: "latest",
-		projectService: true,
-		sourceType: "module",
-		tsconfigRootDir: process.cwd()
-	}
-};
-//#endregion
-//#region src/configs/helpers/restrictedImports/personalRestrictedImports.ts
-const personalRestrictedImports = combineRestrictedImports(generalRestrictedImports, { paths: [...["fs", "node:fs"].map((name) => {
-	return {
-		message: "Please use node:fs/promises instead.",
-		name
-	};
-})] });
-//#endregion
-//#region src/configs/helpers/restrictedImports/reactRestrictedImports.ts
-const reactRestrictedImports = combineRestrictedImports(generalRestrictedImports, { patterns: [{
-	message: "Please use `import Component from \"@mui/[package]/Component\"` instead. See https://mui.com/material-ui/guides/minimizing-bundle-size/ for more information.",
-	regex: "^@mui/[^/]+$"
-}] });
-//#endregion
 //#region src/configs/helpers/sorting/sortClasses.ts
 const sortClasses = {
 	customGroups: [],
@@ -4616,6 +4588,14 @@ const sortObjects = {
 	useConfigurationIf: {}
 };
 //#endregion
+//#region src/configs/helpers/restrictedImports/personalRestrictedImports.ts
+const personalRestrictedImports = combineRestrictedImports(generalRestrictedImports, { paths: [...["fs", "node:fs"].map((name) => {
+	return {
+		message: "Please use node:fs/promises instead.",
+		name
+	};
+})] });
+//#endregion
 //#region src/configs/helpers/sorting/sortNamedImports.ts
 const sortNamedImports = {
 	fallbackSort: { type: "unsorted" },
@@ -4698,6 +4678,13 @@ const reactHooks = {
 	}
 };
 //#endregion
+//#region src/configs/helpers/reactLanguageOptions.ts
+const reactLanguageOptions = {
+	ecmaVersion: 2020,
+	globals: import_globals.default.browser,
+	parserOptions: { ecmaFeatures: { jsx: true } }
+};
+//#endregion
 //#region src/configs/general/react.ts
 const generalReact = [eslint_plugin_jsx_a11y_x.default.configs.recommended, {
 	languageOptions: reactLanguageOptions,
@@ -4727,6 +4714,12 @@ const generalReact = [eslint_plugin_jsx_a11y_x.default.configs.recommended, {
 	settings: { react: { version: "detect" } }
 }];
 //#endregion
+//#region src/configs/helpers/restrictedImports/reactRestrictedImports.ts
+const reactRestrictedImports = combineRestrictedImports(generalRestrictedImports, { patterns: [{
+	message: "Please use `import Component from \"@mui/[package]/Component\"` instead. See https://mui.com/material-ui/guides/minimizing-bundle-size/ for more information.",
+	regex: "^@mui/[^/]+$"
+}] });
+//#endregion
 //#region src/configs/internal/react.ts
 const internalReact = [{
 	languageOptions: reactLanguageOptions,
@@ -4765,6 +4758,17 @@ const generalPackageJson = [eslint_plugin_package_json.default.configs.recommend
 	rules: { "package-json/scripts-name-casing": "error" }
 }];
 //#endregion
+//#region src/configs/helpers/typeScriptLanguageOptions.ts
+const typeScriptLanguageOptions = {
+	parser: typescript_eslint.default.parser,
+	parserOptions: {
+		ecmaVersion: "latest",
+		projectService: true,
+		sourceType: "module",
+		tsconfigRootDir: process.cwd()
+	}
+};
+//#endregion
 //#region src/configs/general/typeScript.ts
 const generalTypeScript = [
 	...typescript_eslint.default.configs.recommended,
@@ -5012,15 +5016,6 @@ function internalEslintPluginRules(plugin) {
 	}];
 }
 //#endregion
-//#region src/configs/internal/eslintPlugin/utility.ts
-function internalEslintPluginUtility(plugin) {
-	return [...internalEslintPluginBase(plugin), {
-		files: ["**/*.ts"],
-		name: "@alextheman/internal/eslint-plugin-utility",
-		rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions] }
-	}];
-}
-//#endregion
 //#region src/configs/internal/utility/base.ts
 function internalUtilityBase(plugin) {
 	return [...combinedTypeScriptPackage(plugin), {
@@ -5078,6 +5073,15 @@ function combinedTypeScriptReact(plugin) {
 	];
 }
 //#endregion
+//#region src/configs/internal/eslintPlugin/utility.ts
+function internalEslintPluginUtility(plugin) {
+	return [...internalEslintPluginBase(plugin), {
+		files: ["**/*.ts"],
+		name: "@alextheman/internal/eslint-plugin-utility",
+		rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions] }
+	}];
+}
+//#endregion
 //#region src/configs/internal/packageJson.ts
 const internalPackageJson = [...generalPackageJson, {
 	files: ["**/package.json"],
@@ -5516,7 +5520,7 @@ function parseUseObjectShorthandOptions(data) {
 const alexPlugin = {
 	meta: {
 		name: "@alextheman/eslint-plugin",
-		version: "5.17.0",
+		version: "5.18.0",
 		namespace: "alextheman"
 	},
 	configs: {},

package/dist/index.js

@@ -2,6 +2,7 @@ import { az, camelToKebab, deepCopy, deepFreeze, normaliseIndents, omitPropertie
 import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
 import z from "zod";
 import { DataError } from "@alextheman/utility/v6";
+import comments from "@eslint-community/eslint-plugin-eslint-comments/configs";
 import js from "@eslint/js";
 import prettierConfig$1 from "eslint-config-prettier";
 import * as tsResolver from "eslint-import-resolver-typescript";
@@ -9,13 +10,13 @@ import importPlugin from "eslint-plugin-import-x";
 import nodePlugin from "eslint-plugin-n";
 import perfectionist from "eslint-plugin-perfectionist";
 import prettierPlugin from "eslint-plugin-prettier";
-import tseslint from "typescript-eslint";
 import reactPlugin from "@eslint-react/eslint-plugin";
 import stylistic from "@stylistic/eslint-plugin";
 import jsxA11y from "eslint-plugin-jsx-a11y-x";
 import reactRefresh from "eslint-plugin-react-refresh";
 import reactHooksPlugin from "eslint-plugin-react-hooks";
 import packageJson from "eslint-plugin-package-json";
+import tseslint from "typescript-eslint";
 import jsdoc from "eslint-plugin-jsdoc";
 import { normalizeImportPath } from "@alextheman/utility/node";
 //#region \0rolldown/runtime.js
@@ -4403,6 +4404,7 @@ const unusedVarsIgnorePatterns = {
 const generalJavaScript = [
 	js.configs.recommended,
 	prettierConfig$1,
+	comments.recommended,
 	nodePlugin.configs["flat/recommended"],
 	{
 		files: [
@@ -4419,6 +4421,7 @@ const generalJavaScript = [
 			n: nodePlugin
 		},
 		rules: {
+			"@eslint-community/eslint-comments/require-description": "error",
 			eqeqeq: "error",
 			"import-x/no-duplicates": ["error", { "prefer-inline": false }],
 			"import-x/no-unresolved": "error",
@@ -4465,38 +4468,6 @@ const generalJavaScript = [
 //#region src/configs/external/prettierConfig.ts
 const prettierConfig = { printWidth: 100 };
 //#endregion
-//#region src/configs/helpers/reactLanguageOptions.ts
-const reactLanguageOptions = {
-	ecmaVersion: 2020,
-	globals: import_globals.default.browser,
-	parserOptions: { ecmaFeatures: { jsx: true } }
-};
-//#endregion
-//#region src/configs/helpers/typeScriptLanguageOptions.ts
-const typeScriptLanguageOptions = {
-	parser: tseslint.parser,
-	parserOptions: {
-		ecmaVersion: "latest",
-		projectService: true,
-		sourceType: "module",
-		tsconfigRootDir: process.cwd()
-	}
-};
-//#endregion
-//#region src/configs/helpers/restrictedImports/personalRestrictedImports.ts
-const personalRestrictedImports = combineRestrictedImports(generalRestrictedImports, { paths: [...["fs", "node:fs"].map((name) => {
-	return {
-		message: "Please use node:fs/promises instead.",
-		name
-	};
-})] });
-//#endregion
-//#region src/configs/helpers/restrictedImports/reactRestrictedImports.ts
-const reactRestrictedImports = combineRestrictedImports(generalRestrictedImports, { patterns: [{
-	message: "Please use `import Component from \"@mui/[package]/Component\"` instead. See https://mui.com/material-ui/guides/minimizing-bundle-size/ for more information.",
-	regex: "^@mui/[^/]+$"
-}] });
-//#endregion
 //#region src/configs/helpers/sorting/sortClasses.ts
 const sortClasses = {
 	customGroups: [],
@@ -4596,6 +4567,14 @@ const sortObjects = {
 	useConfigurationIf: {}
 };
 //#endregion
+//#region src/configs/helpers/restrictedImports/personalRestrictedImports.ts
+const personalRestrictedImports = combineRestrictedImports(generalRestrictedImports, { paths: [...["fs", "node:fs"].map((name) => {
+	return {
+		message: "Please use node:fs/promises instead.",
+		name
+	};
+})] });
+//#endregion
 //#region src/configs/helpers/sorting/sortNamedImports.ts
 const sortNamedImports = {
 	fallbackSort: { type: "unsorted" },
@@ -4678,6 +4657,13 @@ const reactHooks = {
 	}
 };
 //#endregion
+//#region src/configs/helpers/reactLanguageOptions.ts
+const reactLanguageOptions = {
+	ecmaVersion: 2020,
+	globals: import_globals.default.browser,
+	parserOptions: { ecmaFeatures: { jsx: true } }
+};
+//#endregion
 //#region src/configs/general/react.ts
 const generalReact = [jsxA11y.configs.recommended, {
 	languageOptions: reactLanguageOptions,
@@ -4707,6 +4693,12 @@ const generalReact = [jsxA11y.configs.recommended, {
 	settings: { react: { version: "detect" } }
 }];
 //#endregion
+//#region src/configs/helpers/restrictedImports/reactRestrictedImports.ts
+const reactRestrictedImports = combineRestrictedImports(generalRestrictedImports, { patterns: [{
+	message: "Please use `import Component from \"@mui/[package]/Component\"` instead. See https://mui.com/material-ui/guides/minimizing-bundle-size/ for more information.",
+	regex: "^@mui/[^/]+$"
+}] });
+//#endregion
 //#region src/configs/internal/react.ts
 const internalReact = [{
 	languageOptions: reactLanguageOptions,
@@ -4745,6 +4737,17 @@ const generalPackageJson = [packageJson.configs.recommended, {
 	rules: { "package-json/scripts-name-casing": "error" }
 }];
 //#endregion
+//#region src/configs/helpers/typeScriptLanguageOptions.ts
+const typeScriptLanguageOptions = {
+	parser: tseslint.parser,
+	parserOptions: {
+		ecmaVersion: "latest",
+		projectService: true,
+		sourceType: "module",
+		tsconfigRootDir: process.cwd()
+	}
+};
+//#endregion
 //#region src/configs/general/typeScript.ts
 const generalTypeScript = [
 	...tseslint.configs.recommended,
@@ -4992,15 +4995,6 @@ function internalEslintPluginRules(plugin) {
 	}];
 }
 //#endregion
-//#region src/configs/internal/eslintPlugin/utility.ts
-function internalEslintPluginUtility(plugin) {
-	return [...internalEslintPluginBase(plugin), {
-		files: ["**/*.ts"],
-		name: "@alextheman/internal/eslint-plugin-utility",
-		rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions] }
-	}];
-}
-//#endregion
 //#region src/configs/internal/utility/base.ts
 function internalUtilityBase(plugin) {
 	return [...combinedTypeScriptPackage(plugin), {
@@ -5058,6 +5052,15 @@ function combinedTypeScriptReact(plugin) {
 	];
 }
 //#endregion
+//#region src/configs/internal/eslintPlugin/utility.ts
+function internalEslintPluginUtility(plugin) {
+	return [...internalEslintPluginBase(plugin), {
+		files: ["**/*.ts"],
+		name: "@alextheman/internal/eslint-plugin-utility",
+		rules: { "jsdoc/require-jsdoc": ["error", requireJsdocOptions] }
+	}];
+}
+//#endregion
 //#region src/configs/internal/packageJson.ts
 const internalPackageJson = [...generalPackageJson, {
 	files: ["**/package.json"],
@@ -5496,7 +5499,7 @@ function parseUseObjectShorthandOptions(data) {
 const alexPlugin = {
 	meta: {
 		name: "@alextheman/eslint-plugin",
-		version: "5.17.0",
+		version: "5.18.0",
 		namespace: "alextheman"
 	},
 	configs: {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "5.17.0",
+  "version": "5.18.0",
   "description": "A package to provide custom ESLint rules and configs.",
   "repository": {
     "type": "git",
@@ -37,37 +37,38 @@
     "node": ">=22.3.0"
   },
   "dependencies": {
-    "@alextheman/utility": "5.19.1",
+    "@alextheman/utility": "5.23.0",
     "@eslint/compat": "2.1.0",
-    "@typescript-eslint/types": "8.60.0",
-    "@typescript-eslint/utils": "8.60.0",
+    "@typescript-eslint/types": "8.61.1",
+    "@typescript-eslint/utils": "8.61.1",
     "common-tags": "1.8.2",
-    "prettier": "3.8.3",
+    "prettier": "3.8.4",
     "zod": "4.4.3"
   },
   "devDependencies": {
-    "@eslint-react/eslint-plugin": "5.8.6",
+    "@eslint-community/eslint-plugin-eslint-comments": "4.7.2",
+    "@eslint-react/eslint-plugin": "5.9.0",
     "@eslint/js": "10.0.1",
     "@stylistic/eslint-plugin": "5.10.0",
     "@types/common-tags": "1.8.4",
     "@types/eslint": "9.6.1",
     "@types/eslint-plugin-jsx-a11y": "6.10.1",
-    "@types/node": "25.9.1",
-    "@typescript-eslint/rule-tester": "8.60.0",
-    "alex-c-line": "2.8.1",
+    "@types/node": "25.9.3",
+    "@typescript-eslint/rule-tester": "8.61.1",
+    "alex-c-line": "2.10.3",
     "dotenv-cli": "11.0.0",
-    "eslint": "10.4.0",
+    "eslint": "10.5.0",
     "eslint-config-prettier": "10.1.8",
-    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-import-resolver-typescript": "4.4.5",
     "eslint-plugin-import-x": "4.16.2",
-    "eslint-plugin-jsdoc": "63.0.0",
+    "eslint-plugin-jsdoc": "63.0.6",
     "eslint-plugin-jsx-a11y-x": "0.2.0",
-    "eslint-plugin-n": "18.0.1",
-    "eslint-plugin-package-json": "1.1.0",
-    "eslint-plugin-perfectionist": "5.9.0",
+    "eslint-plugin-n": "18.1.0",
+    "eslint-plugin-package-json": "1.4.0",
+    "eslint-plugin-perfectionist": "5.9.1",
     "eslint-plugin-prettier": "5.5.6",
     "eslint-plugin-react-hooks": "7.1.1",
-    "eslint-plugin-react-refresh": "0.5.2",
+    "eslint-plugin-react-refresh": "0.5.3",
     "eslint-vitest-rule-tester": "3.1.0",
     "execa": "9.6.1",
     "globals": "17.6.0",
@@ -75,14 +76,15 @@
     "jsdom": "29.1.1",
     "markdownlint-cli2": "0.22.1",
     "tempy": "3.2.0",
-    "tsdown": "0.22.1",
-    "tsx": "4.22.3",
+    "tsdown": "0.22.3",
+    "tsx": "4.22.4",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.60.0",
-    "vite": "8.0.14",
-    "vitest": "4.1.7"
+    "typescript-eslint": "8.61.1",
+    "vite": "8.0.16",
+    "vitest": "4.1.9"
   },
   "peerDependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "4.7.2",
     "@eslint-react/eslint-plugin": ">=5.8.4",
     "@eslint/js": ">=9.0.0",
     "@stylistic/eslint-plugin": ">=5.10.0",