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

package/README.md

@@ -104,7 +104,10 @@ export default zjutjh({
   },
   ignores: [
     "**/build"
-  ]
+  ],
+  // 默认关闭。设为 true 自动读取项目根目录下的 .gitignore（不存在则跳过）
+  // 也可传入 string 指定其他 gitignore 文件路径
+  // gitignore: true
 })
 ```
 

package/dist/index.d.mts

@@ -17,6 +17,7 @@ interface OptionsConfig extends OptionsComponentExts {
   react?: boolean;
   oxfmt?: boolean | OptionsOxfmt;
   ignores?: string[];
+  gitignore?: boolean | string;
   overrides?: OverridesConfigs;
 }
 interface OptionsComponentExts {

package/dist/index.mjs

@@ -1,4 +1,7 @@
 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";
@@ -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
@@ -435,9 +446,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 = false } = options;
 	const configs = [];
-	configs.push(ignores({ userIgnores }), javascript(), imports(), stylistic({ overrides: getOverrides(options, "stylistic") }), misc());
+	configs.push(ignores({
+		userIgnores,
+		gitignore: enableGitignore
+	}), javascript(), imports(), stylistic({ overrides: getOverrides(options, "stylistic") }), misc());
 	if (enableVue) componentExts.push("vue");
 	const typescriptOptions = resolveSubOptions(options, "ts");
 	if (enableTs) configs.push(await typescript({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zjutjh/eslint-config",
   "type": "module",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.1",
   "license": "ISC",
   "author": "zjutjh",
   "description": "ESLint config used by zjutjh",
@@ -71,6 +71,7 @@
   "dependencies": {
     "@antfu/install-pkg": "^1.1.0",
     "@clack/prompts": "^1.2.0",
+    "@eslint/compat": "^2.0.5",
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
     "eslint-plugin-import-x": "^4.16.2",