@cuiqg/eslint-config 2.8.4 → 2.8.6

package/README.md

@@ -13,17 +13,26 @@ npm i -D eslint @cuiqg/eslint-config
 + "type": "module",
   "scripts": {
 +   "lint": "eslint .",
-+   "lint:fix": "eslint . --fix"
++   "lint:fix": "eslint . --fix",
++   "lint:inspect": "eslint . --inspect-config"
   }
 }
 ```
 
-创建 `eslint.config.js` 文件
+创建 `eslint.config.mjs` 文件
 
 ```js
+import fs from 'node:fs'
 import cuiqg from '@cuiqg/eslint-config'
+import { FlatCompat } from '@eslint/eslintrc'
 
-export default cuiqg()
+const compat = new FlatCompat()
+
+export default cuiqg({}, 
+  fs.existsSync('.eslintrc-auto-import.json')
+    ? compat.extend('./.eslintrc-auto-import.json')
+    : []
+)
 ```
 
 ## 插件配置
@@ -36,7 +45,9 @@ export default cuiqg()
 {
   "prettier.enable": false,
   "editor.formatOnSave": false,
+
   "eslint.useFlatConfig": true,
+
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit",
     "source.organizeImports": "never"

package/dist/index.mjs

@@ -17,18 +17,7 @@ const GLOB_SCSS = "**/*.scss";
 const GLOB_LESS = "**/*.less";
 const GLOB_STYLUS = "**/*.styl";
 const GLOB_POSTCSS = "**/*.{p,post}css";
-const GLOB_JSON = "**/*.json";
-const GLOB_JSON5 = "**/*.json5";
-const GLOB_JSONC = "**/*.jsonc";
-const GLOB_MARKDOWN = "**/*.md";
 const GLOB_VUE = "**/*.vue";
-const GLOB_YAML = "**/*.y?(a)ml";
-const GLOB_TOML = "**/*.toml";
-const GLOB_XML = "**/*.xml";
-const GLOB_SVG = "**/*.svg";
-const GLOB_HTML = "**/*.htm?(l)";
-const GLOB_GRAPHQL = "**/*.{g,graph}ql";
-const GLOB_PHP = "**/*.php";
 const GLOB_EXCLUDE = [
 	"**/node_modules",
 	"**/dist",
@@ -101,11 +90,36 @@ async function ignores() {
 	})];
 }
 
+//#endregion
+//#region src/env.js
+const isInGitHookOrLintStaged = () => {
+	return !!(process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged"));
+};
+const isInEditor = () => {
+	if (process.env.CI) return false;
+	if (isInGitHookOrLintStaged()) return false;
+	return !!(process.env.VSCODE_PID || process.env.VSCODE_CWD || process.env.JETBRAINS_IDE || process.env.VIM || process.env.NVIM);
+};
+const hasVue = () => [
+	"vue",
+	"nuxt",
+	"vitepress",
+	"@slidev/cli"
+].some((i) => isPackageExists(i));
+const hasTypeScript = () => isPackageExists("typescript");
+const hasUnocss = () => isPackageExists("unocss");
+const hasTailwindcss = () => isPackageExists("tailwindcss");
+const hasPrettier = () => isPackageExists("prettier");
+
 //#endregion
 //#region src/configs/javascript.js
 async function javascript() {
-	const [pluginJs] = await Promise.all([interopDefault(import("@eslint/js"))]);
+	const files = [GLOB_SRC];
+	const pluginUnusedImports = await interopDefault(import("eslint-plugin-unused-imports"));
 	return [{
+		files,
+		name: "cuiqg/javascript",
+		plugins: { "unused-imports": pluginUnusedImports },
 		languageOptions: {
 			ecmaVersion: "latest",
 			globals: {
@@ -121,16 +135,195 @@ async function javascript() {
 			sourceType: "module"
 		},
 		linterOptions: { reportUnusedDisableDirectives: true },
-		name: "cuiqg/javascript",
-		plugins: { js: pluginJs },
 		rules: {
-			...pluginJs.configs.recommended.rules,
+			"accessor-pairs": ["error", {
+				enforceForClassMembers: true,
+				setWithoutGet: true
+			}],
+			"array-callback-return": "error",
+			"block-scoped-var": "error",
+			"constructor-super": "error",
+			"default-case-last": "error",
+			"dot-notation": ["error", { allowKeywords: true }],
+			"eqeqeq": ["error", "smart"],
+			"new-cap": ["error", {
+				capIsNew: false,
+				newIsCap: true,
+				properties: true
+			}],
+			"no-alert": "error",
+			"no-array-constructor": "error",
+			"no-async-promise-executor": "error",
+			"no-caller": "error",
+			"no-case-declarations": "error",
+			"no-class-assign": "error",
+			"no-compare-neg-zero": "error",
+			"no-cond-assign": ["error", "always"],
+			"no-console": ["error", { allow: ["warn", "error"] }],
+			"no-const-assign": "error",
+			"no-control-regex": "error",
+			"no-debugger": "error",
+			"no-delete-var": "error",
+			"no-dupe-args": "error",
+			"no-dupe-class-members": "error",
+			"no-dupe-keys": "error",
+			"no-duplicate-case": "error",
+			"no-empty": ["error", { allowEmptyCatch: true }],
+			"no-empty-character-class": "error",
+			"no-empty-pattern": "error",
+			"no-eval": "error",
+			"no-ex-assign": "error",
+			"no-extend-native": "error",
+			"no-extra-bind": "error",
+			"no-extra-boolean-cast": "error",
+			"no-fallthrough": "error",
+			"no-func-assign": "error",
+			"no-global-assign": "error",
+			"no-implied-eval": "error",
+			"no-import-assign": "error",
+			"no-invalid-regexp": "error",
+			"no-irregular-whitespace": "error",
+			"no-iterator": "error",
+			"no-labels": ["error", {
+				allowLoop: false,
+				allowSwitch: false
+			}],
+			"no-lone-blocks": "error",
+			"no-loss-of-precision": "error",
+			"no-misleading-character-class": "error",
+			"no-multi-str": "error",
+			"no-new": "error",
+			"no-new-func": "error",
+			"no-new-native-nonconstructor": "error",
+			"no-new-wrappers": "error",
+			"no-obj-calls": "error",
+			"no-octal": "error",
+			"no-octal-escape": "error",
+			"no-proto": "error",
+			"no-prototype-builtins": "error",
+			"no-redeclare": ["error", { builtinGlobals: false }],
+			"no-regex-spaces": "error",
+			"no-restricted-globals": [
+				"error",
+				{
+					message: "Use `globalThis` instead.",
+					name: "global"
+				},
+				{
+					message: "Use `globalThis` instead.",
+					name: "self"
+				}
+			],
+			"no-restricted-properties": [
+				"error",
+				{
+					message: "Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.",
+					property: "__proto__"
+				},
+				{
+					message: "Use `Object.defineProperty` instead.",
+					property: "__defineGetter__"
+				},
+				{
+					message: "Use `Object.defineProperty` instead.",
+					property: "__defineSetter__"
+				},
+				{
+					message: "Use `Object.getOwnPropertyDescriptor` instead.",
+					property: "__lookupGetter__"
+				},
+				{
+					message: "Use `Object.getOwnPropertyDescriptor` instead.",
+					property: "__lookupSetter__"
+				}
+			],
+			"no-restricted-syntax": [
+				"error",
+				"TSEnumDeclaration[const=true]",
+				"TSExportAssignment"
+			],
+			"no-self-assign": ["error", { props: true }],
+			"no-self-compare": "error",
+			"no-sequences": "error",
+			"no-shadow-restricted-names": "error",
+			"no-sparse-arrays": "error",
+			"no-template-curly-in-string": "error",
+			"no-this-before-super": "error",
+			"no-throw-literal": "error",
+			"no-undef": "error",
+			"no-undef-init": "error",
+			"no-unexpected-multiline": "error",
+			"no-unmodified-loop-condition": "error",
+			"no-unneeded-ternary": ["error", { defaultAssignment: false }],
+			"no-unreachable": "error",
+			"no-unreachable-loop": "error",
+			"no-unsafe-finally": "error",
+			"no-unsafe-negation": "error",
+			"no-unused-expressions": ["error", {
+				allowShortCircuit: true,
+				allowTaggedTemplates: true,
+				allowTernary: true
+			}],
 			"no-unused-vars": ["error", {
+				args: "none",
+				caughtErrors: "none",
+				ignoreRestSiblings: true,
+				vars: "all"
+			}],
+			"no-use-before-define": ["error", {
+				classes: false,
+				functions: false,
+				variables: true
+			}],
+			"no-useless-backreference": "error",
+			"no-useless-call": "error",
+			"no-useless-catch": "error",
+			"no-useless-computed-key": "error",
+			"no-useless-constructor": "error",
+			"no-useless-rename": "error",
+			"no-useless-return": "error",
+			"no-var": "error",
+			"no-with": "error",
+			"object-shorthand": [
+				"error",
+				"always",
+				{
+					avoidQuotes: true,
+					ignoreConstructors: false
+				}
+			],
+			"one-var": ["error", { initialized: "never" }],
+			"prefer-arrow-callback": ["error", {
+				allowNamedFunctions: false,
+				allowUnboundThis: true
+			}],
+			"prefer-const": [isInEditor ? "warn" : "error", {
+				destructuring: "all",
+				ignoreReadBeforeAssign: true
+			}],
+			"prefer-exponentiation-operator": "error",
+			"prefer-promise-reject-errors": "error",
+			"prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
+			"prefer-rest-params": "error",
+			"prefer-spread": "error",
+			"prefer-template": "error",
+			"symbol-description": "error",
+			"unicode-bom": ["error", "never"],
+			"unused-imports/no-unused-imports": isInEditor ? "warn" : "error",
+			"unused-imports/no-unused-vars": ["error", {
+				args: "after-used",
 				argsIgnorePattern: "^_",
-				caughtErrorsIgnorePattern: "^_",
 				ignoreRestSiblings: true,
+				vars: "all",
 				varsIgnorePattern: "^_"
-			}]
+			}],
+			"use-isnan": ["error", {
+				enforceForIndexOf: true,
+				enforceForSwitchCase: true
+			}],
+			"valid-typeof": ["error", { requireStringLiterals: true }],
+			"vars-on-top": "error",
+			"yoda": ["error", "never"]
 		}
 	}];
 }
@@ -175,14 +368,52 @@ async function macros() {
 //#endregion
 //#region src/configs/package-json.js
 async function packageJson() {
-	const pluginPackageJson = await interopDefault(import("eslint-plugin-package-json"));
+	const [pluginPackageJson, pluginDepend, parserJsonc] = await Promise.all([
+		interopDefault(import("eslint-plugin-package-json")),
+		interopDefault(import("eslint-plugin-depend")),
+		interopDefault(import("jsonc-eslint-parser"))
+	]);
 	return [{
-		...pluginPackageJson.configs.recommended,
-		rules: {
-			...pluginPackageJson.configs.recommended.rules,
-			...pluginPackageJson.configs.stylistic.rules
+		name: "cuiqg/package-json",
+		files: ["**/package.json"],
+		plugins: {
+			"package-json": pluginPackageJson,
+			"depend": pluginDepend
 		},
-		name: "cuiqg/package-json"
+		languageOptions: { parser: parserJsonc },
+		rules: {
+			"depend/ban-dependencies": "error",
+			"package-json/bin-name-casing": "error",
+			"package-json/exports-subpaths-style": ["error", { prefer: "explicit" }],
+			"package-json/no-empty-fields": "error",
+			"package-json/no-redundant-files": "error",
+			"package-json/no-redundant-publishConfig": "error",
+			"package-json/order-properties": ["error", { order: "sort-package-json" }],
+			"package-json/repository-shorthand": ["error", { form: "shorthand" }],
+			"package-json/require-author": "error",
+			"package-json/require-description": "error",
+			"package-json/require-engines": "error",
+			"package-json/require-keywords": "error",
+			"package-json/require-name": "error",
+			"package-json/require-type": "error",
+			"package-json/require-version": "error",
+			"package-json/scripts-name-casing": "error",
+			"package-json/sort-collections": "error",
+			"package-json/specify-peers-locally": "error",
+			"package-json/unique-dependencies": "error",
+			"package-json/valid-author": "error",
+			"package-json/valid-bin": "error",
+			"package-json/valid-dependencies": "error",
+			"package-json/valid-description": "error",
+			"package-json/valid-directories": "error",
+			"package-json/valid-files": "error",
+			"package-json/valid-homepage": "error",
+			"package-json/valid-keywords": "error",
+			"package-json/valid-license": "error",
+			"package-json/valid-name": "error",
+			"package-json/valid-scripts": "error",
+			"package-json/valid-version": "error"
+		}
 	}];
 }
 
@@ -393,45 +624,21 @@ async function tailwindcss() {
 }
 
 //#endregion
-//#region src/configs/imports.js
-async function imports() {
-	const pluginImportX = await interopDefault(import("eslint-plugin-import-x"));
+//#region src/configs/comments.js
+async function comments() {
+	const pluginComments = await interopDefault(import("@eslint-community/eslint-plugin-eslint-comments"));
 	return [{
-		name: "cuiqg/imports",
-		plugins: { "import-x": pluginImportX },
+		name: "cuiqg/eslint-comments",
+		plugins: { "@eslint-community/eslint-comments": pluginComments },
 		rules: {
-			"import-x/consistent-type-specifier-style": ["error", "prefer-top-level"],
-			"import-x/first": "error",
-			"import-x/no-duplicates": "error",
-			"import-x/no-mutable-exports": "error",
-			"import-x/no-named-default": "error",
-			"import-x/newline-after-import": ["error", { "count": 1 }]
-		},
-		settings: { "import-x/core-modules": ["electron", "vue-router/auto-routes"] }
+			"@eslint-community/eslint-comments/no-aggregating-enable": "error",
+			"@eslint-community/eslint-comments/no-duplicate-disable": "error",
+			"@eslint-community/eslint-comments/no-unlimited-disable": "error",
+			"@eslint-community/eslint-comments/no-unused-enable": "error"
+		}
 	}];
 }
 
-//#endregion
-//#region src/env.js
-const isInGitHookOrLintStaged = () => {
-	return !!(process.env.GIT_PARAMS || process.env.VSCODE_GIT_COMMAND || process.env.npm_lifecycle_script?.startsWith("lint-staged"));
-};
-const isInEditor = () => {
-	if (process.env.CI) return false;
-	if (isInGitHookOrLintStaged()) return false;
-	return !!(process.env.VSCODE_PID || process.env.VSCODE_CWD || process.env.JETBRAINS_IDE || process.env.VIM || process.env.NVIM);
-};
-const hasVue = () => [
-	"vue",
-	"nuxt",
-	"vitepress",
-	"@slidev/cli"
-].some((i) => isPackageExists(i));
-const hasTypeScript = () => isPackageExists("typescript");
-const hasUnocss = () => isPackageExists("unocss");
-const hasTailwindcss = () => isPackageExists("tailwindcss");
-const hasPrettier = () => isPackageExists("prettier");
-
 //#endregion
 //#region src/presets.js
 const defaultPluginRenaming = {};
@@ -442,18 +649,16 @@ const defaultPluginRenaming = {};
 * @param {boolean} [options.unocss] - 是否启用 Unocss 格式化
 * @param {boolean} [options.tailwindcss] - 是否启用 Tailwindcss 格式化
 * @param {boolean} [options.vue] - 是否启用 VUE 格式化
-* @param {boolean} [options.imports=true] - 是否启用 Import-X
 * @param {boolean} [options.jsdoc=true] - 是否启用 JSDoc 格式化
 * @param {...Object} userConfigs - 用户配置
 *
 * @returns {Promise<Object[]>} 合并后的配置
 */
 function cuiqg(options = {}, ...userConfigs) {
-	const { jsdoc: enableJsdoc = true, prettier: enablePrettier = hasPrettier(), unocss: enableUnocss = hasUnocss(), tailwindcss: enableTailwindcss = hasTailwindcss(), vue: enableVue = hasVue(), imports: enableImports = true } = options;
+	const { jsdoc: enableJsdoc = true, prettier: enablePrettier = hasPrettier(), unocss: enableUnocss = hasUnocss(), tailwindcss: enableTailwindcss = hasTailwindcss(), vue: enableVue = hasVue() } = options;
 	const configs = [];
-	configs.push(ignores(), javascript(), stylistic(), packageJson());
+	configs.push(ignores(), comments(), javascript(), stylistic(), packageJson());
 	if (enableJsdoc) configs.push(jsdoc());
-	if (enableImports) configs.push(imports());
 	if (enableVue) configs.push(vue(), macros());
 	if (enableUnocss) configs.push(unocss());
 	if (enableTailwindcss) configs.push(tailwindcss());
@@ -468,4 +673,4 @@ function cuiqg(options = {}, ...userConfigs) {
 var src_default = cuiqg;
 
 //#endregion
-export { GLOB_CSS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_PHP, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_STYLUS, GLOB_SVG, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_XML, GLOB_YAML, cuiqg, src_default as default, defaultPluginRenaming, hasPrettier, hasTailwindcss, hasTypeScript, hasUnocss, hasVue, ignores, imports, isInEditor, isInGitHookOrLintStaged, javascript, jsdoc, macros, packageJson, prettier, stylistic, stylisticConfigDefaults, tailwindcss, unocss, vue };
+export { GLOB_CSS, GLOB_EXCLUDE, GLOB_JS, GLOB_JSX, GLOB_LESS, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_STYLUS, GLOB_TS, GLOB_TSX, GLOB_VUE, comments, cuiqg, src_default as default, defaultPluginRenaming, hasPrettier, hasTailwindcss, hasTypeScript, hasUnocss, hasVue, ignores, isInEditor, isInGitHookOrLintStaged, javascript, jsdoc, macros, packageJson, prettier, stylistic, stylisticConfigDefaults, tailwindcss, unocss, vue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuiqg/eslint-config",
-  "version": "2.8.4",
+  "version": "2.8.6",
   "description": "Eslint config for @cuiqg",
   "keywords": [
     "eslint-config"
@@ -36,29 +36,30 @@
     "@eslint/config-inspector": "^1.4.2",
     "@eslint/eslintrc": "^3.3.3",
     "bumpp": "^10.3.2",
-    "eslint": "^9.39.1",
-    "tsdown": "^0.16.8"
+    "eslint": "^9.39.2",
+    "tsdown": "^0.18.2"
   },
   "peerDependencies": {
     "eslint": ">=9.28.0"
   },
   "dependencies": {
-    "@eslint/js": "^9.39.1",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
     "@stylistic/eslint-plugin": "^5.6.1",
-    "@unocss/eslint-plugin": "^66.5.9",
+    "@unocss/eslint-plugin": "^66.5.10",
     "@vue-macros/eslint-config": "3.0.0-beta.21",
     "eslint-config-flat-gitignore": "^2.1.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-flat-config-utils": "^2.1.4",
-    "eslint-plugin-format": "^1.0.2",
+    "eslint-plugin-depend": "^1.4.0",
     "eslint-plugin-import-x": "^4.16.1",
-    "eslint-plugin-jsdoc": "^61.4.1",
+    "eslint-plugin-jsdoc": "^61.5.0",
     "eslint-plugin-package-json": "^0.85.0",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-tailwindcss": "4.0.0-beta.0",
+    "eslint-plugin-unused-imports": "^4.3.0",
     "eslint-plugin-vue": "^10.6.2",
     "globals": "^16.5.0",
-    "jsonc-eslint-parser": "^2.4.1",
+    "jsonc-eslint-parser": "^2.4.2",
     "local-pkg": "^1.1.2",
     "vue-eslint-parser": "^10.2.0"
   }