@cuiqg/eslint-config 2.8.3 → 2.8.5

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

@@ -211,7 +211,10 @@ const stylisticConfigDefaults = {
 };
 async function stylistic() {
 	const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
-	const config = pluginStylistic.configs.customize({ ...stylisticConfigDefaults });
+	const config = pluginStylistic.configs.customize({
+		...stylisticConfigDefaults,
+		commaDangle: "never"
+	});
 	return [{
 		name: "cuiqg/stylistic",
 		plugins: { "@stylistic": pluginStylistic },
@@ -396,7 +399,14 @@ async function imports() {
 	return [{
 		name: "cuiqg/imports",
 		plugins: { "import-x": pluginImportX },
-		rules: { ...pluginImportX.configs["flat/recommended"].rules },
+		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"] }
 	}];
 }
@@ -420,6 +430,7 @@ const hasVue = () => [
 const hasTypeScript = () => isPackageExists("typescript");
 const hasUnocss = () => isPackageExists("unocss");
 const hasTailwindcss = () => isPackageExists("tailwindcss");
+const hasPrettier = () => isPackageExists("prettier");
 
 //#endregion
 //#region src/presets.js
@@ -427,18 +438,21 @@ const defaultPluginRenaming = {};
 /**
 *
 * @param {object} options - 设置选项
-* @param {boolean} [options.prettier=false] - 是否启用 prettier 格式化
-* @param {boolean} [options.unocss] - 是否启用 unocss 格式化
-* @param {boolean} [options.tailwindcss] - 是否启用 tailwindcss 格式化
-* @param {boolean} [options.vue] - 是否启用 vue 格式化
-* @param {boolean|object} [options.formatter=true] - 是否启用格式化
+* @param {boolean} [options.prettier] - 是否启用 Prettier 格式化
+* @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 { prettier: enablePrettier = false, 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(), imports: enableImports = true } = options;
 	const configs = [];
-	configs.push(ignores(), javascript(), jsdoc(), stylistic(), packageJson());
+	configs.push(ignores(), javascript(), stylistic(), packageJson());
+	if (enableJsdoc) configs.push(jsdoc());
 	if (enableImports) configs.push(imports());
 	if (enableVue) configs.push(vue(), macros());
 	if (enableUnocss) configs.push(unocss());
@@ -454,4 +468,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, hasTailwindcss, hasTypeScript, hasUnocss, hasVue, ignores, imports, isInEditor, isInGitHookOrLintStaged, javascript, jsdoc, macros, packageJson, prettier, stylistic, stylisticConfigDefaults, tailwindcss, unocss, vue };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuiqg/eslint-config",
-  "version": "2.8.3",
+  "version": "2.8.5",
   "description": "Eslint config for @cuiqg",
   "keywords": [
     "eslint-config"
@@ -23,44 +23,43 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "build:inspect": "npx @eslint/config-inspector build --config eslint-inspector.config.js",
+    "lint": "eslint .",
+    "lint:inspect": "npx @eslint/config-inspector --open false --config eslint-inspector.config.js",
+    "prepublishOnly": "npm run build",
+    "release": "bumpp"
+  },
   "devDependencies": {
-    "@cuiqg/prettier-config": "latest",
     "@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/js": "^9.39.2",
     "@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-format": "^1.1.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-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"
-  },
-  "prettier": "@cuiqg/prettier-config",
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "build:inspect": "pnpx @eslint/config-inspector build --config eslint-inspector.config.js",
-    "lint": "eslint .",
-    "lint:inspect": "pnpx @eslint/config-inspector --open false --config eslint-inspector.config.js",
-    "release": "bumpp"
   }
-}
+}