@cuiqg/eslint-config 2.8.2 → 2.8.4

package/dist/index.mjs

@@ -73,25 +73,6 @@ const GLOB_EXCLUDE = [
 //#endregion
 //#region src/utils.js
 const scopeUrl = fileURLToPath(new URL(".", import.meta.url));
-const parserPlain = {
-	meta: { name: "parser-plain" },
-	parseForESLint: (code) => ({
-		ast: {
-			body: [],
-			comments: [],
-			loc: {
-				end: code.length,
-				start: 0
-			},
-			range: [0, code.length],
-			tokens: [],
-			type: "Program"
-		},
-		scopeManager: null,
-		services: { isPlain: true },
-		visitorKeys: { Program: [] }
-	})
-};
 async function interopDefault(module) {
 	try {
 		let resolved = await module;
@@ -100,9 +81,6 @@ async function interopDefault(module) {
 		throw new Error(`Cannot import module: ${String(error)}`);
 	}
 }
-function isPackageInScope(name) {
-	return isPackageExists(name, { paths: [scopeUrl] });
-}
 function renameRules(rules, map) {
 	return Object.fromEntries(Object.entries(rules).map(([key, value]) => {
 		for (const [from, to] of Object.entries(map)) if (key.startsWith(`${from}/`)) return [to + key.slice(from.length), value];
@@ -145,7 +123,15 @@ async function javascript() {
 		linterOptions: { reportUnusedDisableDirectives: true },
 		name: "cuiqg/javascript",
 		plugins: { js: pluginJs },
-		rules: { ...pluginJs.configs.recommended.rules }
+		rules: {
+			...pluginJs.configs.recommended.rules,
+			"no-unused-vars": ["error", {
+				argsIgnorePattern: "^_",
+				caughtErrorsIgnorePattern: "^_",
+				ignoreRestSiblings: true,
+				varsIgnorePattern: "^_"
+			}]
+		}
 	}];
 }
 
@@ -217,25 +203,21 @@ async function prettier() {
 //#endregion
 //#region src/configs/stylistic.js
 const stylisticConfigDefaults = {
+	experimental: false,
 	indent: 2,
 	jsx: true,
 	quotes: "single",
-	semi: false,
-	commaDangle: "never"
+	semi: false
 };
 async function stylistic() {
 	const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
 	const config = pluginStylistic.configs.customize({
-		commaDangle: "never",
-		indent: 2,
-		pluginName: "style",
-		quotes: "single",
-		semi: false,
-		...stylisticConfigDefaults
+		...stylisticConfigDefaults,
+		commaDangle: "never"
 	});
 	return [{
 		name: "cuiqg/stylistic",
-		plugins: { style: pluginStylistic },
+		plugins: { "@stylistic": pluginStylistic },
 		rules: { ...config.rules }
 	}];
 }
@@ -263,6 +245,7 @@ async function vue() {
 				computed: "readonly",
 				defineEmits: "readonly",
 				defineExpose: "readonly",
+				definePage: "readonly",
 				defineModel: "readonly",
 				defineOptions: "readonly",
 				defineProps: "readonly",
@@ -404,118 +387,28 @@ async function tailwindcss() {
 		name: "cuiqg/tailwindcss",
 		plugins: { tailwindcss: pluginTailwindcss },
 		languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
-		rules: { ...pluginTailwindcss.configs["flat/recommended"][1].rules }
+		rules: { ...pluginTailwindcss.configs.recommended.rules },
+		settings: {}
 	}];
 }
 
 //#endregion
-//#region src/configs/formatters.js
-function mergePrettierOptions(options, overrides = {}) {
-	return {
-		...options,
-		...overrides,
-		plugins: [...overrides.plugins || [], ...options.plugins || []]
-	};
-}
-async function formatters(options = {}) {
-	const isPrettierPluginXmlScope = isPackageInScope("@prettier/plugin-xml");
-	const isPrettierPluginPhpScope = isPackageInScope("@prettier/plugin-php");
-	const { config = {}, css = true, html = true, graphql = true, svg = isPrettierPluginXmlScope, xml = isPrettierPluginXmlScope, php = isPrettierPluginPhpScope } = options;
-	const pluginFormat = await interopDefault(import("eslint-plugin-format"));
-	const { indent, quotes, semi } = { ...stylisticConfigDefaults };
-	const prettierOptions = Object.assign({
-		endOfLine: "auto",
-		printWidth: 120,
-		semi,
-		singleQuote: quotes === "single",
-		tabWidth: typeof indent === "number" ? indent : 2,
-		trailingComma: "all",
-		useTabs: indent === "tab"
-	}, config || {});
-	const prettierXmlOptions = {
-		bracketSameLine: true,
-		singleAttributePerLine: false,
-		tabWidth: 80,
-		xmlQuoteAttributes: "double",
-		xmlSelfClosingSpace: true,
-		xmlSortAttributesByKey: false,
-		xmlWhitespaceSensitivity: "ignore"
-	};
-	const prettierPhpOptions = {
-		phpVersion: "auto",
-		printWidth: 80,
-		tabWidth: 4,
-		useTabs: false,
-		singleQuote: false,
-		trailingCommaPHP: true,
-		braceStyle: "per-cs",
-		requirePragma: false,
-		insertPragma: false
-	};
-	const configs = [{
-		name: "cuiqg/formatter/setup",
-		plugins: { format: pluginFormat }
+//#region src/configs/imports.js
+async function imports() {
+	const pluginImportX = await interopDefault(import("eslint-plugin-import-x"));
+	return [{
+		name: "cuiqg/imports",
+		plugins: { "import-x": pluginImportX },
+		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"] }
 	}];
-	if (css) configs.push({
-		name: "cuiqg/formatter/css",
-		files: [GLOB_CSS, GLOB_POSTCSS],
-		plugins: { format: parserPlain },
-		rules: { "format/prettier": ["error", mergePrettierOptions(prettierOptions, { parser: "css" })] }
-	}, {
-		files: [GLOB_SCSS],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/scss",
-		rules: { "format/prettier": ["error", mergePrettierOptions(prettierOptions, { parser: "scss" })] }
-	});
-	if (html) configs.push({
-		files: [GLOB_HTML],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/html",
-		rules: { "format/prettier": ["error", mergePrettierOptions(prettierOptions, { parser: "html" })] }
-	});
-	if (xml) configs.push({
-		files: [GLOB_XML],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/xml",
-		rules: { "format/prettier": ["error", mergePrettierOptions({
-			...prettierXmlOptions,
-			...prettierOptions
-		}, {
-			parser: "xml",
-			plugins: ["@prettier/plugin-xml"]
-		})] }
-	});
-	if (svg) configs.push({
-		files: [GLOB_SVG],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/svg",
-		rules: { "format/prettier": ["error", mergePrettierOptions({
-			...prettierXmlOptions,
-			...prettierOptions
-		}, {
-			parser: "xml",
-			plugins: ["@prettier/plugin-xml"]
-		})] }
-	});
-	if (graphql) configs.push({
-		files: [GLOB_GRAPHQL],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/graphql",
-		rules: { "format/prettier": ["error", mergePrettierOptions(prettierOptions, { parser: "graphql" })] }
-	});
-	if (php) configs.push({
-		files: [GLOB_PHP],
-		languageOptions: { parser: parserPlain },
-		name: "cuiqg/formatter/php",
-		rules: { "format/prettier": ["error", mergePrettierOptions({
-			...prettierPhpOptions,
-			...prettierOptions
-		}, {
-			parser: "php",
-			plugins: ["@prettier/plugin-php"]
-		})] }
-	});
-	return configs;
 }
 
 //#endregion
@@ -537,33 +430,34 @@ const hasVue = () => [
 const hasTypeScript = () => isPackageExists("typescript");
 const hasUnocss = () => isPackageExists("unocss");
 const hasTailwindcss = () => isPackageExists("tailwindcss");
+const hasPrettier = () => isPackageExists("prettier");
 
 //#endregion
 //#region src/presets.js
-const defaultPluginRenaming = {
-	"@stylistic": "style",
-	"@typescript-eslint": "ts"
-};
+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(), formatter: enableFormatter = 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());
 	if (enableTailwindcss) configs.push(tailwindcss());
 	if (enablePrettier) configs.push(prettier());
-	if (enableFormatter) configs.push(formatters(typeof enableFormatter === "object" ? enableFormatter : {}));
 	let composer = new FlatConfigComposer();
 	composer = composer.append(...configs, ...userConfigs).renamePlugins(defaultPluginRenaming);
 	return composer;
@@ -574,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, formatters, hasTailwindcss, hasTypeScript, hasUnocss, hasVue, ignores, 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.2",
+  "version": "2.8.4",
   "description": "Eslint config for @cuiqg",
   "keywords": [
     "eslint-config"
@@ -23,8 +23,16 @@
   "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",
@@ -43,6 +51,7 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-flat-config-utils": "^2.1.4",
     "eslint-plugin-format": "^1.0.2",
+    "eslint-plugin-import-x": "^4.16.1",
     "eslint-plugin-jsdoc": "^61.4.1",
     "eslint-plugin-package-json": "^0.85.0",
     "eslint-plugin-prettier": "^5.5.4",
@@ -52,14 +61,5 @@
     "jsonc-eslint-parser": "^2.4.1",
     "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"
   }
-}
+}