@cuiqg/eslint-config 2.8.1 → 2.8.2

package/dist/index.mjs

@@ -1,7 +1,8 @@
 import { FlatConfigComposer } from "eslint-flat-config-utils";
+import { fileURLToPath } from "node:url";
+import { isPackageExists } from "local-pkg";
 import globals from "globals";
 import process from "node:process";
-import { isPackageExists } from "local-pkg";
 
 //#region src/globs.js
 const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
@@ -26,6 +27,8 @@ 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",
@@ -69,6 +72,26 @@ 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;
@@ -77,6 +100,9 @@ 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];
@@ -190,6 +216,13 @@ async function prettier() {
 
 //#endregion
 //#region src/configs/stylistic.js
+const stylisticConfigDefaults = {
+	indent: 2,
+	jsx: true,
+	quotes: "single",
+	semi: false,
+	commaDangle: "never"
+};
 async function stylistic() {
 	const pluginStylistic = await interopDefault(import("@stylistic/eslint-plugin"));
 	const config = pluginStylistic.configs.customize({
@@ -197,7 +230,8 @@ async function stylistic() {
 		indent: 2,
 		pluginName: "style",
 		quotes: "single",
-		semi: false
+		semi: false,
+		...stylisticConfigDefaults
 	});
 	return [{
 		name: "cuiqg/stylistic",
@@ -374,6 +408,116 @@ async function tailwindcss() {
 	}];
 }
 
+//#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 }
+	}];
+	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
 //#region src/env.js
 const isInGitHookOrLintStaged = () => {
@@ -403,17 +547,23 @@ const defaultPluginRenaming = {
 /**
 *
 * @param {object} options - 设置选项
-* @param {...any} userConfigs - 用户配置
-* @returns {Promise<any[]>} 合并后的配置
+* @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 {...Object} userConfigs - 用户配置
+* @returns {Promise<Object[]>} 合并后的配置
 */
 function cuiqg(options = {}, ...userConfigs) {
-	const { prettier: enablePrettier = false, unocss: enableUnocss = hasUnocss(), tailwindcss: enableTailwindcss = hasTailwindcss(), vue: enableVue = hasVue() } = options;
+	const { prettier: enablePrettier = false, unocss: enableUnocss = hasUnocss(), tailwindcss: enableTailwindcss = hasTailwindcss(), vue: enableVue = hasVue(), formatter: enableFormatter = true } = options;
 	const configs = [];
 	configs.push(ignores(), javascript(), jsdoc(), stylistic(), packageJson());
 	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;
@@ -424,4 +574,4 @@ function cuiqg(options = {}, ...userConfigs) {
 var src_default = cuiqg;
 
 //#endregion
-export { GLOB_CSS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, 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, isInEditor, isInGitHookOrLintStaged, javascript, jsdoc, macros, packageJson, prettier, stylistic, 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, formatters, 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.1",
+  "version": "2.8.2",
   "description": "Eslint config for @cuiqg",
   "keywords": [
     "eslint-config"
@@ -42,6 +42,7 @@
     "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-jsdoc": "^61.4.1",
     "eslint-plugin-package-json": "^0.85.0",
     "eslint-plugin-prettier": "^5.5.4",