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

package/README.md

@@ -1,4 +1,8 @@
-# `@zjutjh/eslint-config` [![npm-version](https://img.shields.io/npm/v/%40zjutjh%2Feslint-config)](https://www.npmjs.com/package/@zjutjh/eslint-config)
+# `@zjutjh/eslint-config`
+
+[![Open on npmx.dev](https://npmx.dev/api/registry/badge/license/@zjutjh/eslint-config?labelColor=000000&color=000000)](https://npmx.dev/package/@zjutjh/eslint-config)
+[![Open on npmx.dev](https://npmx.dev/api/registry/badge/version/@zjutjh/eslint-config?labelColor=000000&color=000000)](https://npmx.dev/package/@zjutjh/eslint-config)
+[![Open on npmx.dev](https://npmx.dev/api/registry/badge/size/@zjutjh/eslint-config?labelColor=000000&color=000000)](https://npmx.dev/package/@zjutjh/eslint-config)
 
 zjutjh 的 ESLint 配置，适用于 JS, TS, Vue3 等项目。
 
@@ -100,7 +104,10 @@ export default zjutjh({
   },
   ignores: [
     "**/build"
-  ]
+  ],
+  // 默认关闭。设为 true 自动读取项目根目录下的 .gitignore（不存在则跳过）
+  // 也可传入 string 指定其他 gitignore 文件路径
+  // gitignore: true
 })
 ```
 
@@ -147,22 +154,23 @@ export default zjutjh(
 很多人在意代码的格式化，这里单独拿出一章讲。
 
 内置两种格式化工具。`@stylistic/eslint-plugin` (lint 工具对格式的检查) 和传统的 formatter 工具
-(Prettier) 。stylistic 默认开启，如果要使用 Prettier，需要手动开启。
+([oxfmt](https://oxc.rs/docs/guide/usage/formatter))。stylistic 默认开启，如果要使用 oxfmt，需要手动开启。
 
 ```ts
-// 启用 prettier
+// 启用 oxfmt
 export default zjutjh({
-  prettier: true
+  oxfmt: true
 }),
 ```
 
-支持自定义 prettier 格式化选项，以及关闭对部分文件的格式化（默认对支持的文件全部开启）
+支持自定义 oxfmt 格式化选项，以及关闭对部分文件的格式化（默认对支持的文件全部开启）
 
 ```ts
 export default zjutjh({
-  prettier: {
-    prettierSelfOptions: {
-      // 自定义 prettier 的格式化风格配置
+  oxfmt: {
+    oxfmtSelfOptions: {
+      // 自定义 oxfmt 的格式化风格配置
+      // 参考 https://oxc.rs/docs/guide/usage/formatter
     },
     lang: {
       html: false // 关闭对一些文件的格式化。默认对支持的文件全部开启
@@ -171,7 +179,7 @@ export default zjutjh({
 })
 ```
 
-stylistic 只对 js(x) 和 ts(x) 进行格式化，而 prettier 还对其他文件，如 css，html 等的格式化。
+stylistic 只对 js(x) 和 ts(x) 进行格式化，而 oxfmt 还对其他文件，如 vue，css，html，json 等的格式化。
 如果你要**在编辑器中**自动格式化这些文件，需要配置编辑器来允许 eslint 校验这些类型的文件。
 
 ```jsonc
@@ -188,8 +196,8 @@ stylistic 只对 js(x) 和 ts(x) 进行格式化，而 prettier 还对其他文
 ```
 
 > [!WARNING]
-> 我们使用 eslint 调用 prettier 可执行文件来进行代码格式化，所以你的编辑器不需要安装 prettier 插件，有
-> eslint 插件就行。prettier 的格式化配置声明在配置源码内部，如果启用了 prettier 插件，他读取不到内部的配置，
+> 我们通过 eslint 调用 oxfmt 来进行代码格式化，所以你的编辑器不需要安装额外的格式化插件，有
+> eslint 插件就行。格式化配置声明在配置源码内部，如果启用了 prettier 插件，他读取不到内部的配置，
 > 会按照默认的配置来格式化，这会导致代码风格不一致。
 
 ## 开发指南

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { Linter } from "eslint";
 import { ParserOptions } from "@typescript-eslint/parser";
-import { Options } from "prettier";
+import { FormatOptions } from "oxfmt";
 
 //#region src/types.d.ts
 interface OverridesConfigs {
@@ -15,8 +15,9 @@ interface OptionsConfig extends OptionsComponentExts {
   taro?: boolean;
   jsx?: boolean;
   react?: boolean;
-  prettier?: boolean | OptionsPrettier;
+  oxfmt?: boolean | OptionsOxfmt;
   ignores?: string[];
+  gitignore?: boolean | string;
   overrides?: OverridesConfigs;
 }
 interface OptionsComponentExts {
@@ -25,9 +26,10 @@ interface OptionsComponentExts {
 interface OptionsTypeScriptParserOptions {
   parserOptions?: Partial<ParserOptions>;
 }
-interface OptionsPrettier {
-  prettierSelfOptions?: Options;
-  /** 对哪些文件启用 prettier，默认全部启用 */
+interface OptionsOxfmt {
+  /** 传递给 oxfmt format() API 的选项，参考 https://oxc.rs/docs/guide/usage/formatter */
+  oxfmtSelfOptions?: FormatOptions;
+  /** 对哪些文件启用 oxfmt，默认全部启用 */
   lang?: {
     /** js, ts, vue 文件 */es: boolean; /** css, less, scss 文件 */
     css: boolean;

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
@@ -170,11 +181,11 @@ function getOverrides(options, key) {
 	return { ...options.overrides?.[key] };
 }
 //#endregion
-//#region src/configs/prettier.ts
+//#region src/configs/oxfmt.ts
 /**
-* @see https://prettier.io/docs/options
+* @see https://oxc.rs/docs/guide/usage/formatter
 */
-const prettierOptions = {
+const oxfmtOptions = {
 	printWidth: 100,
 	tabWidth: 2,
 	useTabs: false,
@@ -186,42 +197,23 @@ const prettierOptions = {
 	bracketSpacing: true,
 	bracketSameLine: false,
 	arrowParens: "always",
-	requirePragma: false,
-	insertPragma: false,
-	proseWrap: "preserve",
 	htmlWhitespaceSensitivity: "css",
 	vueIndentScriptAndStyle: false,
 	endOfLine: "lf",
 	embeddedLanguageFormatting: "auto",
 	singleAttributePerLine: false
 };
-async function prettier(options) {
-	await ensurePackages([
-		"eslint-plugin-format",
-		"eslint-plugin-prettier",
-		"eslint-config-prettier",
-		"prettier"
-	]);
-	const [configPrettier, pluginFormat] = await Promise.all([interopDefault(import("eslint-plugin-prettier/recommended")), interopDefault(import("eslint-plugin-format"))]);
+async function oxfmt(options) {
+	await ensurePackages(["eslint-plugin-format", "oxfmt"]);
+	const pluginFormat = await interopDefault(import("eslint-plugin-format"));
 	const { es: enableESFormat = true, html: enableHTMLFormat = true, css: enableCSSFormat = true, json: enableJSONFormat = true } = options?.lang ?? {};
-	const mergedPrettierOptions = {
-		...prettierOptions,
-		...options?.prettierSelfOptions
+	const mergedOptions = {
+		...oxfmtOptions,
+		...options?.oxfmtSelfOptions
 	};
 	return [
 		enableESFormat ? {
-			name: "zjutjh/prettier/setup",
-			files: [
-				GLOB_VUE,
-				GLOB_TS,
-				GLOB_JS,
-				GLOB_TSX,
-				GLOB_JSX
-			],
-			...configPrettier
-		} : {},
-		enableESFormat ? {
-			name: "zjutjh/prettier/es",
+			name: "zjutjh/oxfmt/es",
 			files: [
 				GLOB_VUE,
 				GLOB_TS,
@@ -229,10 +221,11 @@ async function prettier(options) {
 				GLOB_TSX,
 				GLOB_JSX
 			],
-			rules: { "prettier/prettier": ["error", mergedPrettierOptions] }
+			plugins: { format: pluginFormat },
+			rules: { "format/oxfmt": ["error", mergedOptions] }
 		} : {},
 		enableCSSFormat ? {
-			name: "zjutjh/prettier/css",
+			name: "zjutjh/oxfmt/css",
 			files: [
 				GLOB_CSS,
 				GLOB_LESS,
@@ -240,23 +233,17 @@ async function prettier(options) {
 			],
 			languageOptions: { parser: pluginFormat.parserPlain },
 			plugins: { format: pluginFormat },
-			rules: { "format/prettier": ["error", {
-				parser: "css",
-				mergedPrettierOptions
-			}] }
+			rules: { "format/oxfmt": ["error", mergedOptions] }
 		} : {},
 		enableHTMLFormat ? {
-			name: "zjutjh/prettier/html",
+			name: "zjutjh/oxfmt/html",
 			files: [GLOB_HTML],
 			languageOptions: { parser: pluginFormat.parserPlain },
 			plugins: { format: pluginFormat },
-			rules: { "format/prettier": ["error", {
-				parser: "html",
-				mergedPrettierOptions
-			}] }
+			rules: { "format/oxfmt": ["error", mergedOptions] }
 		} : {},
 		enableJSONFormat ? {
-			name: "zjutjh/prettier/json",
+			name: "zjutjh/oxfmt/json",
 			files: [
 				GLOB_JSON,
 				GLOB_JSON5,
@@ -264,10 +251,7 @@ async function prettier(options) {
 			],
 			languageOptions: { parser: pluginFormat.parserPlain },
 			plugins: { format: pluginFormat },
-			rules: { "format/prettier": ["error", {
-				parser: "json",
-				mergedPrettierOptions
-			}] }
+			rules: { "format/oxfmt": ["error", mergedOptions] }
 		} : {}
 	];
 }
@@ -462,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, prettier: enablePrettier = 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({
@@ -479,8 +466,8 @@ async function zjutjh(options = {}, ...userConfigs) {
 	}));
 	if (enableJSX) configs.push(jsx());
 	if (enableReact) configs.push(await react({ overrides: getOverrides(options, "react") }));
-	const codeStyleOptions = resolveSubOptions(options, "prettier");
-	if (enablePrettier) configs.push(await prettier(codeStyleOptions));
+	const oxfmtOptions = resolveSubOptions(options, "oxfmt");
+	if (enableOxfmt) configs.push(await oxfmt(oxfmtOptions));
 	return configs.flat(1).concat(userConfigs);
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zjutjh/eslint-config",
   "type": "module",
-  "version": "1.0.0",
+  "version": "2.0.0-beta.1",
   "license": "ISC",
   "author": "zjutjh",
   "description": "ESLint config used by zjutjh",
@@ -32,13 +32,11 @@
     "@typescript-eslint/eslint-plugin": "^8.58.2",
     "@typescript-eslint/parser": "^8.58.2",
     "eslint": "^10.2.1",
-    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-format": "^2.0.1",
-    "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-react-hooks": "^7.1.1",
     "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-vue": "^10.8.0",
-    "prettier": "^3.8.3",
+    "oxfmt": "^0.35.0",
     "vue-eslint-parser": "^10.4.0"
   },
   "peerDependenciesMeta": {
@@ -51,15 +49,9 @@
     "@typescript-eslint/parser": {
       "optional": true
     },
-    "eslint-config-prettier": {
-      "optional": true
-    },
     "eslint-plugin-format": {
       "optional": true
     },
-    "eslint-plugin-prettier": {
-      "optional": true
-    },
     "eslint-plugin-react-hooks": {
       "optional": true
     },
@@ -69,7 +61,7 @@
     "eslint-plugin-vue": {
       "optional": true
     },
-    "prettier": {
+    "oxfmt": {
       "optional": true
     },
     "vue-eslint-parser": {
@@ -79,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",
@@ -97,14 +90,12 @@
     "bumpp": "^11.0.1",
     "cspell": "^10.0.0",
     "eslint": "^10.2.1",
-    "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-format": "^2.0.1",
-    "eslint-plugin-prettier": "^5.5.5",
     "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",
-    "prettier": "^3.8.3",
+    "oxfmt": "^0.35.0",
     "simple-git-hooks": "^2.13.1",
     "tsdown": "^0.21.9",
     "typescript": "^6.0.3",