@zjutjh/eslint-config 2.0.0-beta.0 → 2.0.0-beta.2

package/README.md

@@ -97,14 +97,14 @@ export default zjutjh({
   overrides: {
     vue: {
       "vue/multi-word-component-names": ["off"]
-    },
-    stylistic: {
-      "stylistic/quotes": ["error", "single"]
     }
   },
   ignores: [
     "**/build"
-  ]
+  ],
+  // 默认关闭。设为 true 自动读取项目根目录下的 .gitignore（不存在则跳过）
+  // 也可传入 string 指定其他 gitignore 文件路径
+  // gitignore: true
 })
 ```
 
@@ -114,11 +114,6 @@ export default zjutjh({
 export default zjutjh(
   // 第一个参数是 zjutjh 专用的配置
   {
-    overrides: {
-      stylistic: {
-        "stylistic/quotes": ["error", "single"]
-      }
-    },
     ignores: [
       "**/build"
     ]
@@ -148,16 +143,15 @@ export default zjutjh(
 
 ## 代码格式化
 
-很多人在意代码的格式化，这里单独拿出一章讲。
+内置 [oxfmt](https://oxc.rs/docs/guide/usage/formatter) 作为格式化工具，**默认开启**，覆盖 js(x)/ts(x)、
+vue、css/scss/less、html、json/jsonc/json5 等文件。
 
-内置两种格式化工具。`@stylistic/eslint-plugin` (lint 工具对格式的检查) 和传统的 formatter 工具
-([oxfmt](https://oxc.rs/docs/guide/usage/formatter))。stylistic 默认开启，如果要使用 oxfmt，需要手动开启。
+如果不希望由 ESLint 进行格式化（例如团队另有格式化方案），可以关闭：
 
 ```ts
-// 启用 oxfmt
 export default zjutjh({
-  oxfmt: true
-}),
+  oxfmt: false
+})
 ```
 
 支持自定义 oxfmt 格式化选项，以及关闭对部分文件的格式化（默认对支持的文件全部开启）
@@ -176,8 +170,7 @@ export default zjutjh({
 })
 ```
 
-stylistic 只对 js(x) 和 ts(x) 进行格式化，而 oxfmt 还对其他文件，如 vue，css，html，json 等的格式化。
-如果你要**在编辑器中**自动格式化这些文件，需要配置编辑器来允许 eslint 校验这些类型的文件。
+如果你要**在编辑器中**自动格式化非 js/ts 的文件，需要配置编辑器来允许 eslint 校验这些类型的文件。
 
 ```jsonc
 // @filename .vscode/settings.json

package/dist/index.d.mts

@@ -6,7 +6,6 @@ import { FormatOptions } from "oxfmt";
 interface OverridesConfigs {
   vue?: Linter.RulesRecord;
   ts?: Linter.RulesRecord;
-  stylistic?: Linter.RulesRecord;
   react?: Linter.RulesRecord;
 }
 interface OptionsConfig extends OptionsComponentExts {
@@ -17,6 +16,7 @@ interface OptionsConfig extends OptionsComponentExts {
   react?: boolean;
   oxfmt?: boolean | OptionsOxfmt;
   ignores?: string[];
+  gitignore?: boolean | string;
   overrides?: OverridesConfigs;
 }
 interface OptionsComponentExts {

package/dist/index.mjs

@@ -1,10 +1,13 @@
 import { isPackageExists } from "local-pkg";
+import { existsSync } from "node:fs";
+import { isAbsolute, resolve } from "node:path";
+import { includeIgnoreFile } from "@eslint/compat";
 import importXPlugin, { flatConfigs } from "eslint-plugin-import-x";
 import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
 import eslintJS from "@eslint/js";
 import globals from "globals";
 import uniconPlugin from "eslint-plugin-unicorn";
-import pluginStylistic from "@stylistic/eslint-plugin";
+import pluginFormat from "eslint-plugin-format";
 //#region src/globs.ts
 const GLOB_VUE = "**/*.vue";
 const GLOB_JS = "**/*.?([cm])js";
@@ -57,10 +60,18 @@ const GLOBS_EXCLUDES = [
 //#endregion
 //#region src/configs/ignores.ts
 function ignores(options) {
-	return [{
+	const { gitignore = false } = options ?? {};
+	const configs = [{
 		name: "zjutjh/ignores",
 		ignores: [...GLOBS_EXCLUDES, ...options?.userIgnores ?? []]
 	}];
+	if (gitignore !== false) {
+		const path = gitignore === true ? ".gitignore" : gitignore;
+		const absolute = isAbsolute(path) ? path : resolve(process.cwd(), path);
+		if (existsSync(absolute)) configs.push(includeIgnoreFile(absolute, "zjutjh/gitignore"));
+		else if (gitignore !== true) throw new Error(`gitignore file not found: ${absolute}`);
+	}
+	return configs;
 }
 //#endregion
 //#region src/configs/imports.ts
@@ -108,7 +119,7 @@ function javascript() {
 		name: "zjutjh/javascript/rules",
 		rules: {
 			...eslintJS.configs.recommended.rules,
-			"camelcase": "warn",
+			camelcase: "warn",
 			"no-warning-comments": "warn",
 			"no-console": ["warn", { allow: [
 				"warn",
@@ -120,7 +131,7 @@ function javascript() {
 			"prefer-const": "warn",
 			"arrow-body-style": "error",
 			"no-nested-ternary": "error",
-			"curly": "error",
+			curly: "error",
 			"no-else-return": "error",
 			"no-implicit-coercion": "error",
 			"no-useless-concat": "error",
@@ -145,31 +156,10 @@ function misc() {
 		plugins: { unicorn: uniconPlugin }
 	}, {
 		name: "zjutjh/misc/rules",
-		rules: { "unicorn/filename-case": ["error", { "case": "kebabCase" }] }
+		rules: { "unicorn/filename-case": ["error", { case: "kebabCase" }] }
 	}];
 }
 //#endregion
-//#region src/utils.ts
-async function interopDefault(m) {
-	const resolved = await m;
-	return resolved.default || resolved;
-}
-async function ensurePackages(packages) {
-	const nonExistingPackages = packages.filter((i) => i && !isPackageExists(i));
-	if (nonExistingPackages.length === 0) return;
-	if (await (await import("@clack/prompts")).confirm({ message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?` })) {
-		const { installPackage } = await import("@antfu/install-pkg");
-		await installPackage(nonExistingPackages, { dev: true });
-	}
-}
-function resolveSubOptions(options, key) {
-	if (typeof options[key] === "boolean") return {};
-	return options[key] || {};
-}
-function getOverrides(options, key) {
-	return { ...options.overrides?.[key] };
-}
-//#endregion
 //#region src/configs/oxfmt.ts
 /**
 * @see https://oxc.rs/docs/guide/usage/formatter
@@ -192,9 +182,7 @@ const oxfmtOptions = {
 	embeddedLanguageFormatting: "auto",
 	singleAttributePerLine: false
 };
-async function oxfmt(options) {
-	await ensurePackages(["eslint-plugin-format", "oxfmt"]);
-	const pluginFormat = await interopDefault(import("eslint-plugin-format"));
+function oxfmt(options) {
 	const { es: enableESFormat = true, html: enableHTMLFormat = true, css: enableCSSFormat = true, json: enableJSONFormat = true } = options?.lang ?? {};
 	const mergedOptions = {
 		...oxfmtOptions,
@@ -245,6 +233,27 @@ async function oxfmt(options) {
 	];
 }
 //#endregion
+//#region src/utils.ts
+async function interopDefault(m) {
+	const resolved = await m;
+	return resolved.default || resolved;
+}
+async function ensurePackages(packages) {
+	const nonExistingPackages = packages.filter((i) => i && !isPackageExists(i));
+	if (nonExistingPackages.length === 0) return;
+	if (await (await import("@clack/prompts")).confirm({ message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?` })) {
+		const { installPackage } = await import("@antfu/install-pkg");
+		await installPackage(nonExistingPackages, { dev: true });
+	}
+}
+function resolveSubOptions(options, key) {
+	if (typeof options[key] === "boolean") return {};
+	return options[key] || {};
+}
+function getOverrides(options, key) {
+	return { ...options.overrides?.[key] };
+}
+//#endregion
 //#region src/configs/react.ts
 async function react(options) {
 	await ensurePackages([
@@ -283,45 +292,6 @@ async function react(options) {
 	}];
 }
 //#endregion
-//#region src/configs/stylistic.ts
-function stylistic(options) {
-	return [{
-		name: "zjutjh/stylistic/rules",
-		plugins: { "@stylistic": pluginStylistic },
-		rules: {
-			"@stylistic/eol-last": ["error", "always"],
-			"@stylistic/indent": ["error", 2],
-			"@stylistic/keyword-spacing": "error",
-			"@stylistic/key-spacing": "error",
-			"@stylistic/no-trailing-spaces": "error",
-			"@stylistic/linebreak-style": ["error", "unix"],
-			"@stylistic/quotes": ["error", "double"],
-			"@stylistic/function-call-spacing": "error",
-			"@stylistic/semi": "error",
-			"@stylistic/no-multiple-empty-lines": ["warn", { max: 1 }],
-			"@stylistic/object-curly-spacing": ["error", "always"],
-			"@stylistic/arrow-spacing": "error",
-			"@stylistic/block-spacing": "error",
-			"@stylistic/brace-style": "error",
-			"@stylistic/comma-dangle": "error",
-			"@stylistic/no-multi-spaces": "error",
-			"@stylistic/comma-spacing": "error",
-			"@stylistic/switch-colon-spacing": "error",
-			"@stylistic/type-annotation-spacing": "error",
-			"@stylistic/space-before-blocks": "error",
-			"@stylistic/space-before-function-paren": ["error", {
-				"anonymous": "never",
-				"named": "never",
-				"asyncArrow": "always"
-			}],
-			"@stylistic/space-in-parens": "error",
-			"@stylistic/space-infix-ops": "error",
-			"@stylistic/spaced-comment": "error",
-			...options.overrides
-		}
-	}];
-}
-//#endregion
 //#region src/configs/typescript.ts
 async function typescript(options) {
 	const { componentExts = [], overrides, parserOptions } = options;
@@ -424,9 +394,9 @@ async function vue(options) {
 			"vue/component-name-in-template-casing": [
 				"error",
 				"kebab-case",
-				{ "registeredComponentsOnly": true }
+				{ registeredComponentsOnly: true }
 			],
-			"vue/max-attributes-per-line": ["error", { "singleline": { "max": 3 } }],
+			"vue/max-attributes-per-line": ["error", { singleline: { max: 3 } }],
 			"vue/prefer-true-attribute-shorthand": ["warn", options?.taro ? "never" : "always"],
 			...options?.overrides
 		}
@@ -435,9 +405,12 @@ async function vue(options) {
 //#endregion
 //#region src/factory.ts
 async function zjutjh(options = {}, ...userConfigs) {
-	const { componentExts = [], vue: enableVue = isPackageExists("vue"), ts: enableTs = isPackageExists("typescript"), taro: enableTaro = isPackageExists("@tarojs/taro"), jsx: enableJSX = isPackageExists("react"), react: enableReact = isPackageExists("react"), ignores: userIgnores, oxfmt: enableOxfmt = false } = options;
+	const { componentExts = [], vue: enableVue = isPackageExists("vue"), ts: enableTs = isPackageExists("typescript"), taro: enableTaro = isPackageExists("@tarojs/taro"), jsx: enableJSX = isPackageExists("react"), react: enableReact = isPackageExists("react"), ignores: userIgnores, gitignore: enableGitignore = false, oxfmt: enableOxfmt = true } = options;
 	const configs = [];
-	configs.push(ignores({ userIgnores }), javascript(), imports(), stylistic({ overrides: getOverrides(options, "stylistic") }), misc());
+	configs.push(ignores({
+		userIgnores,
+		gitignore: enableGitignore
+	}), javascript(), imports(), misc());
 	if (enableVue) componentExts.push("vue");
 	const typescriptOptions = resolveSubOptions(options, "ts");
 	if (enableTs) configs.push(await typescript({
@@ -453,7 +426,7 @@ async function zjutjh(options = {}, ...userConfigs) {
 	if (enableJSX) configs.push(jsx());
 	if (enableReact) configs.push(await react({ overrides: getOverrides(options, "react") }));
 	const oxfmtOptions = resolveSubOptions(options, "oxfmt");
-	if (enableOxfmt) configs.push(await oxfmt(oxfmtOptions));
+	if (enableOxfmt) configs.push(oxfmt(oxfmtOptions));
 	return configs.flat(1).concat(userConfigs);
 }
 //#endregion

package/package.json

@@ -1,42 +1,66 @@
 {
   "name": "@zjutjh/eslint-config",
-  "type": "module",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.2",
+  "description": "ESLint config used by zjutjh",
   "license": "ISC",
   "author": "zjutjh",
-  "description": "ESLint config used by zjutjh",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zjutjh/eslint-config.git"
+  },
   "files": [
     "dist"
   ],
+  "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.mts"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     }
   },
-  "engines": {
-    "node": ">=24"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/zjutjh/eslint-config.git"
-  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged"
+  "dependencies": {
+    "@antfu/install-pkg": "^1.1.0",
+    "@clack/prompts": "^1.2.0",
+    "@eslint/compat": "^2.0.5",
+    "@eslint/js": "^10.0.1",
+    "eslint-plugin-format": "^2.0.1",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-simple-import-sort": "^13.0.0",
+    "eslint-plugin-unicorn": "^64.0.0",
+    "globals": "^17.5.0",
+    "local-pkg": "^1.1.2",
+    "oxfmt": "^0.35.0"
+  },
+  "devDependencies": {
+    "@eslint-react/eslint-plugin": "^4.2.3",
+    "@eslint/config-inspector": "^2.0.0",
+    "@eslint/core": "^1.2.1",
+    "@types/node": "^25.6.0",
+    "@typescript-eslint/eslint-plugin": "^8.58.2",
+    "@typescript-eslint/parser": "^8.58.2",
+    "bumpp": "^11.0.1",
+    "cspell": "^10.0.0",
+    "eslint": "^10.2.1",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-refresh": "^0.5.2",
+    "eslint-plugin-vue": "^10.8.0",
+    "lint-staged": "^16.4.0",
+    "simple-git-hooks": "^2.13.1",
+    "tsdown": "^0.21.9",
+    "typescript": "^6.0.3",
+    "vue-eslint-parser": "^10.4.0"
   },
   "peerDependencies": {
     "@eslint-react/eslint-plugin": "^4.2.3",
     "@typescript-eslint/eslint-plugin": "^8.58.2",
     "@typescript-eslint/parser": "^8.58.2",
     "eslint": "^10.2.1",
-    "eslint-plugin-format": "^2.0.1",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-vue": "^10.8.0",
-    "oxfmt": "^0.35.0",
     "vue-eslint-parser": "^10.4.0"
   },
   "peerDependenciesMeta": {
@@ -49,9 +73,6 @@
     "@typescript-eslint/parser": {
       "optional": true
     },
-    "eslint-plugin-format": {
-      "optional": true
-    },
     "eslint-plugin-react-hooks": {
       "optional": true
     },
@@ -61,44 +82,15 @@
     "eslint-plugin-vue": {
       "optional": true
     },
-    "oxfmt": {
-      "optional": true
-    },
     "vue-eslint-parser": {
       "optional": true
     }
   },
-  "dependencies": {
-    "@antfu/install-pkg": "^1.1.0",
-    "@clack/prompts": "^1.2.0",
-    "@eslint/js": "^10.0.1",
-    "@stylistic/eslint-plugin": "^5.10.0",
-    "eslint-plugin-import-x": "^4.16.2",
-    "eslint-plugin-simple-import-sort": "^13.0.0",
-    "eslint-plugin-unicorn": "^64.0.0",
-    "globals": "^17.5.0",
-    "local-pkg": "^1.1.2"
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
   },
-  "devDependencies": {
-    "@eslint-react/eslint-plugin": "^4.2.3",
-    "@eslint/config-inspector": "^2.0.0",
-    "@eslint/core": "^1.2.1",
-    "@types/node": "^25.6.0",
-    "@typescript-eslint/eslint-plugin": "^8.58.2",
-    "@typescript-eslint/parser": "^8.58.2",
-    "bumpp": "^11.0.1",
-    "cspell": "^10.0.0",
-    "eslint": "^10.2.1",
-    "eslint-plugin-format": "^2.0.1",
-    "eslint-plugin-react-hooks": "^7.1.1",
-    "eslint-plugin-react-refresh": "^0.5.2",
-    "eslint-plugin-vue": "^10.8.0",
-    "lint-staged": "^16.4.0",
-    "oxfmt": "^0.35.0",
-    "simple-git-hooks": "^2.13.1",
-    "tsdown": "^0.21.9",
-    "typescript": "^6.0.3",
-    "vue-eslint-parser": "^10.4.0"
+  "engines": {
+    "node": ">=24"
   },
   "scripts": {
     "build": "tsdown",