@wongxy/eslint-config 4.0.1 → 4.0.3

package/README.md

@@ -1,6 +1,6 @@
 # eslint-config
 
-Personal ESLint configuration, based on `@antfu/eslint-config`
+ESLint config based on [`@antfu/eslint-config`](https://github.com/antfu/eslint-config).
 
 ## Usage
 
@@ -8,11 +8,21 @@ Personal ESLint configuration, based on `@antfu/eslint-config`
 pnpm i -D eslint @wongxy/eslint-config
 ```
 
-And create `eslint.config.mjs` in your project root:
-
 ```js
 // eslint.config.mjs
 import wongxy from '@wongxy/eslint-config'
 
 export default wongxy()
 ```
+
+## Options
+
+Everything `@antfu/eslint-config` accepts is passed through. On top of that:
+
+| Option | Uses | Default |
+| --- | --- | --- |
+| `react` | `@eslint-react/eslint-plugin` | on when `react`, `react-dom`, `next` or `react-native` is installed |
+| `reactnative` | `ts/no-require-imports`, `ts/no-use-before-define` off | on when `react-native` is installed |
+| `tailwindcss` | `eslint-plugin-better-tailwindcss` | on when `tailwindcss` is installed |
+
+`options.rules` and the per-integration `overrides` win over the defaults this config adds. Those defaults live in named `wongxy/*` configs.

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { OptionsOverrides, antfu } from "@antfu/eslint-config";
+import { Awaitable, OptionsConfig, OptionsOverrides, TypedFlatConfigItem, antfu } from "@antfu/eslint-config";
 import { Linter } from "eslint";
 //#region src/typegen.d.ts
 interface RuleOptions {
@@ -3033,7 +3033,7 @@ type TwNoUnnecessaryWhitespace = [] | [{
 }];
 //#endregion
 //#region src/types.d.ts
-type Options = Parameters<typeof antfu>[0] & {
+type Options = OptionsConfig & Omit<TypedFlatConfigItem, 'files' | 'ignores'> & {
   /**
    * Enable Tailwind rules.
    *
@@ -3047,7 +3047,7 @@ type Options = Parameters<typeof antfu>[0] & {
    *
    * @default auto-detect based on the dependencies
    */
-  reactnative?: boolean;
+  reactnative?: boolean | OptionsOverrides;
   /**
    * Enable react rules.
    *
@@ -3055,7 +3055,7 @@ type Options = Parameters<typeof antfu>[0] & {
    */
   react?: boolean | OptionsOverrides;
 };
-type UserConfig = Parameters<typeof antfu>[1] & {
+type UserConfig = Awaitable<TypedFlatConfigItem | TypedFlatConfigItem[]> & {
   rules?: RuleOptions;
 };
 type OptionsReturn = ReturnType<typeof antfu>;
@@ -3074,6 +3074,6 @@ interface OptionsTailwindCSS {
 }
 //#endregion
 //#region src/index.d.ts
-declare function wongxy(options?: Options, ...userConfigs: UserConfig[]): OptionsReturn;
+export default function wongxy(options?: Options, ...userConfigs: UserConfig[]): OptionsReturn;
 //#endregion
-export { wongxy as default };
+export type { Options, OptionsReturn, OptionsTailwindCSS, PickKeysByPrefix, RuleOptionsTailwindCSS, UserConfig };

package/dist/index.mjs

@@ -39,87 +39,92 @@ const ReactPackages = [
 	"react-dom",
 	"next"
 ];
-function resolveRules(overrides, rules) {
-	return Object.fromEntries(Object.entries(rules).filter(([k]) => !overrides[k]));
+const commonRules = {
+	"no-console": "off",
+	"no-alert": "off",
+	"no-multiple-empty-lines": "warn",
+	"antfu/top-level-function": "off",
+	"antfu/if-newline": "off",
+	"style/brace-style": [
+		"error",
+		"1tbs",
+		{ allowSingleLine: true }
+	],
+	"perfectionist/sort-jsx-props": ["warn", {
+		order: "asc",
+		type: "natural",
+		groups: [
+			"reserved-first",
+			"reserved-second",
+			"unknown",
+			"reserved-last"
+		],
+		customGroups: [
+			{
+				groupName: "reserved-first",
+				elementNamePattern: ["key", "ref"]
+			},
+			{
+				groupName: "reserved-second",
+				elementNamePattern: ["id", "name"]
+			},
+			{
+				groupName: "reserved-last",
+				elementNamePattern: ["asChild"]
+			}
+		]
+	}]
+};
+const vueRules = {
+	"vue/singleline-html-element-content-newline": "off",
+	"vue/valid-template-root": "off",
+	"vue/block-order": ["warn", { order: [["script", "template"], "style"] }],
+	"vue/custom-event-name-casing": "off"
+};
+const reactRules = { "react/prefer-destructuring-assignment": "off" };
+const typescriptRules = { "ts/consistent-type-imports": ["error", {
+	disallowTypeAnnotations: false,
+	fixStyle: "inline-type-imports",
+	prefer: "type-imports"
+}] };
+const reactNativeRules = {
+	"ts/no-require-imports": "off",
+	"ts/no-use-before-define": "off"
+};
+function resolveRules(rules, ...chosen) {
+	const taken = Object.assign({}, ...chosen);
+	return Object.fromEntries(Object.entries(rules).filter(([rule]) => !(rule in taken)));
 }
 function wongxy(options = {}, ...userConfigs) {
-	const { react: enableReact = ReactPackages.some((i) => isPackageExists(i)), typescript: enableTypeScript = isPackageExists("typescript"), vue: enableVue = VuePackages.some((i) => isPackageExists(i)), tailwindcss: enableTailwind = isPackageExists("tailwindcss"), reactnative: enableReactNative = isPackageExists("react-native") } = options;
-	const configs = [];
-	configs.push({
+	const { react: enableReact = ReactPackages.some((i) => isPackageExists(i)), reactnative: enableReactNative = isPackageExists("react-native"), tailwindcss: enableTailwind = isPackageExists("tailwindcss"), typescript: enableTypeScript = isPackageExists("typescript") || isPackageExists("@typescript/native-preview"), vue: enableVue = VuePackages.some((i) => isPackageExists(i)) } = options;
+	const reactNativeOptions = typeof options.reactnative === "object" ? options.reactnative : {};
+	const tailwindOptions = typeof options.tailwindcss === "object" ? options.tailwindcss : void 0;
+	const globalRules = options.rules;
+	const configs = [{
 		name: "wongxy/common",
-		rules: resolveRules(options.rules ?? {}, {
-			"no-console": "off",
-			"no-alert": "off",
-			"no-multiple-empty-lines": "warn",
-			"antfu/top-level-function": "off",
-			"antfu/if-newline": "off",
-			"style/brace-style": [
-				"error",
-				"1tbs",
-				{ allowSingleLine: true }
-			],
-			"perfectionist/sort-jsx-props": ["warn", {
-				order: "asc",
-				type: "natural",
-				groups: [
-					"reserved-first",
-					"reserved-second",
-					"unknown",
-					"reserved-last"
-				],
-				customGroups: [
-					{
-						groupName: "reserved-first",
-						elementNamePattern: ["key", "ref"]
-					},
-					{
-						groupName: "reserved-second",
-						elementNamePattern: ["id", "name"]
-					},
-					{
-						groupName: "reserved-last",
-						elementNamePattern: ["asChild"]
-					}
-				]
-			}]
-		})
-	});
+		rules: resolveRules(commonRules, globalRules)
+	}];
 	if (enableVue) configs.push({
 		name: "wongxy/vue",
 		files: [GLOB_VUE],
-		rules: resolveRules(getOverrides(options, "vue"), {
-			"vue/singleline-html-element-content-newline": "off",
-			"vue/valid-template-root": "off",
-			"vue/block-order": ["warn", { order: [["script", "template"], "style"] }],
-			"vue/custom-event-name-casing": "off"
-		})
+		rules: resolveRules(vueRules, globalRules, getOverrides(options, "vue"))
 	});
 	if (enableReact) configs.push({
 		name: "wongxy/react",
 		files: [GLOB_SRC],
-		rules: resolveRules(getOverrides(options, "react"), { "react/prefer-destructuring-assignment": "off" })
+		rules: resolveRules(reactRules, globalRules, getOverrides(options, "react"))
 	});
 	if (enableTypeScript) configs.push({
 		name: "wongxy/typescript",
 		files: [GLOB_TS, GLOB_TSX],
-		rules: resolveRules(getOverrides(options, "typescript"), { "ts/consistent-type-imports": ["error", {
-			disallowTypeAnnotations: false,
-			fixStyle: "inline-type-imports",
-			prefer: "type-imports"
-		}] })
+		rules: resolveRules(typescriptRules, globalRules, getOverrides(options, "typescript"))
 	});
 	if (enableReactNative) configs.push({
 		name: "wongxy/reactnative",
 		files: [GLOB_TS, GLOB_TSX],
-		rules: resolveRules(getOverrides(options, "typescript"), {
-			"ts/no-require-imports": "off",
-			"ts/no-use-before-define": "off"
-		})
+		rules: resolveRules(reactNativeRules, globalRules, reactNativeOptions.overrides)
 	});
-	if (enableTailwind) {
-		const tw = typeof options.tailwindcss === "object" ? options.tailwindcss : void 0;
-		configs.push(tailwindcss(tw));
-	}
+	if (enableTailwind) configs.push(tailwindcss(tailwindOptions));
 	return antfu(options, ...configs, ...userConfigs);
 }
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wongxy/eslint-config",
   "type": "module",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "description": "xiyaowong's eslint config",
   "author": "xiyaowong (https://github.com/xiyaowong)",
   "license": "MIT",
@@ -20,35 +20,33 @@
     "eslint": "^10.9.1",
     "eslint-plugin-astro": "^3.1.0",
     "eslint-plugin-better-tailwindcss": "^4.7.0",
-    "eslint-plugin-react-hooks": "^7.0.1",
     "eslint-plugin-react-refresh": "^0.5.5"
   },
   "dependencies": {
-    "@antfu/eslint-config": "^9.3.0",
-    "eslint-flat-config-utils": "^3.2.0",
+    "@antfu/eslint-config": "^9.5.1",
     "local-pkg": "^1.2.1"
   },
   "devDependencies": {
-    "@antfu/ni": "^30.5.0",
+    "@antfu/ni": "^30.6.0",
     "@types/eslint": "^9.6.1",
-    "@types/node": "^24.10.0",
-    "bumpp": "^12.2.2",
-    "eslint": "^10.9.1",
+    "@types/node": "^26.6.4",
+    "bumpp": "^12.3.0",
+    "eslint": "^10.12.0",
     "eslint-typegen": "^2.3.1",
     "esno": "^4.8.0",
-    "tsdown": "^0.22.14",
-    "typescript": "^5.9.3"
+    "tsdown": "^0.23.0",
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "build": "nr typegen && tsdown --clean --dts",
     "stub": "tsdown --format esm",
     "watch": "tsdown --watch",
-    "dev": "tsdown --watch & eslint-flat-config-viewer",
+    "dev": "tsdown --watch & nlx eslint-flat-config-viewer",
     "lint:fix": "eslint . --fix",
     "lint": "eslint .",
     "release": "bumpp && pnpm publish",
     "inspect": "nlx @eslint/config-inspector",
     "typegen": "esno scripts/typegen.ts",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "nr typegen && tsc --noEmit"
   }
 }