hkx-eslint-config 2.0.1 → 2.0.3

package/README.md

@@ -8,55 +8,66 @@ HKX 代码规范，基于 ESLint 9 Flat Config。
 pnpm add -D eslint hkx-eslint-config
 ```
 
-要求 **ESLint ^9.32.0**（peerDependency）。
+- **ESLint**：^9.32.0（peerDependency）
+- **TypeScript 配置**（`standard-ts` / `node-ts` / `react-ts` / `vue-ts`）：需在项目中安装 `typescript`，且 type-aware 规则依赖 `tsconfig.json`
 
-## 用法
+## 两种用法
 
-在项目根目录新建 `eslint.config.js`（或 `eslint.config.mjs` / `eslint.config.ts`），按项目类型选用对应 config 并展开：
+### 1. 使用 config（开箱即用）
+
+直接使用预设配置，已包含解析器、extends、语言选项等：
 
 ```js
 import { defineConfig } from 'eslint/config';
-import hkx from 'hkx-eslint-config';
+import nodeTs from 'hkx-eslint-config/node-ts';
 
 export default defineConfig([
-  ...hkx.configs.ts,  // 按需换成 js / node / react / vue / vueTs / reactTs / nodeTs
-  {
-    ignores: ['**/node_modules/**', '**/dist/**'],
-  },
+  ...nodeTs,
+  { ignores: ['**/node_modules/**', '**/dist/**'] },
 ]);
 ```
 
-### 可选配置
+| 子路径 | 说明 |
+|--------|------|
+| `hkx-eslint-config/standard` | 纯 JavaScript |
+| `hkx-eslint-config/standard-ts` | TypeScript |
+| `hkx-eslint-config/node` | Node.js (JS) |
+| `hkx-eslint-config/node-ts` | Node.js (TS) |
+| `hkx-eslint-config/react` | React (JS) |
+| `hkx-eslint-config/react-ts` | React (TS) |
+| `hkx-eslint-config/vue` | Vue (JS) |
+| `hkx-eslint-config/vue-ts` | Vue (TS) |
 
-| 名称     | 说明           |
-|----------|----------------|
-| `js`     | 纯 JavaScript  |
-| `ts`     | TypeScript     |
-| `node`   | Node.js (JS)   |
-| `nodeTs` | Node.js (TS)   |
-| `react`  | React (JS)     |
-| `reactTs`| React (TS)     |
-| `vue`    | Vue (JS)       |
-| `vueTs`  | Vue (TS)       |
+### 2. 仅使用规则，自配解析器等
 
-多种场景可组合多段 config（如先 `...hkx.configs.ts` 再 `...hkx.configs.vueTs`），或按 `files` 在各自 config 里区分。
-
-## 以插件形式使用
-
-可挂载自带的 plugin，通过 `extends` 使用内置规则（plugin 提供 `js` / `ts` / `node` / `react` / `vue`）：
+只引入规则集（`Linter.Config`），自行配置 parser、languageOptions、plugins 等：
 
 ```js
 import { defineConfig } from 'eslint/config';
-import hkx from 'hkx-eslint-config';
+import recommendedTypescript from 'hkx-eslint-config/rules/recommended-typescript';
+import node from 'hkx-eslint-config/rules/node';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
 
 export default defineConfig([
   {
-    plugins: {
-      hkx: hkx.plugin,
+    files: ['**/*.ts'],
+    extends: [recommendedTypescript, node],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: { projectService: true },
+      globals: { ...globals.node },
     },
-    extends: ['hkx/ts'],
   },
 ]);
 ```
 
-推荐直接展开 `hkx.configs.xxx`，按需组合、可配合 `files` 与 `ignores`。
+| 子路径 | 说明 |
+|--------|------|
+| `hkx-eslint-config/rules/recommended-javascript` | JS 基础规则集 |
+| `hkx-eslint-config/rules/recommended-typescript` | TS 基础规则集 |
+| `hkx-eslint-config/rules/node` | Node 规则集 |
+| `hkx-eslint-config/rules/react` | React 规则集 |
+| `hkx-eslint-config/rules/vue` | Vue 规则集 |
+
+可任意组合 rules，再自行设置 parser、globals、plugins 等。

package/dist/config/node-js.d.ts

@@ -0,0 +1,4 @@
+//#region config/node-js.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/node-js.js

@@ -0,0 +1,14 @@
+import "../import.js";
+import config$1 from "../rules/recommended-javascript.js";
+import { t as config$2 } from "../node.js";
+import globals from "globals";
+
+//#region config/node-js.ts
+const config = [{
+	files: ["**/*.js"],
+	extends: [config$1, config$2],
+	languageOptions: { globals: { ...globals.node } }
+}];
+
+//#endregion
+export { config as default };

package/dist/config/node-ts.d.ts

@@ -0,0 +1,4 @@
+//#region config/node-ts.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/node-ts.js

@@ -0,0 +1,19 @@
+import "../import.js";
+import { t as config$1 } from "../node.js";
+import { t as config$2 } from "../recommended-typescript.js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+//#region config/node-ts.ts
+const config = [{
+	files: ["**/*.ts"],
+	extends: [config$2, config$1],
+	languageOptions: {
+		parser: tseslint.parser,
+		parserOptions: { projectService: true },
+		globals: { ...globals.node }
+	}
+}];
+
+//#endregion
+export { config as default };

package/dist/config/react-js.d.ts

@@ -0,0 +1,4 @@
+//#region config/react-js.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/react-js.js

@@ -0,0 +1,17 @@
+import "../import.js";
+import config$1 from "../rules/recommended-javascript.js";
+import { t as config$2 } from "../react.js";
+import globals from "globals";
+
+//#region config/react-js.ts
+const config = [{
+	files: ["**/*.js", "**/*.jsx"],
+	extends: [config$1, config$2],
+	languageOptions: {
+		parserOptions: { ecmaFeatures: { jsx: true } },
+		globals: { ...globals.browser }
+	}
+}];
+
+//#endregion
+export { config as default };

package/dist/config/react-ts.d.ts

@@ -0,0 +1,4 @@
+//#region config/react-ts.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/react-ts.js

@@ -0,0 +1,19 @@
+import "../import.js";
+import { t as config$1 } from "../recommended-typescript.js";
+import { t as config$2 } from "../react.js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+//#region config/react-ts.ts
+const config = [{
+	files: ["**/*.ts", "**/*.tsx"],
+	extends: [config$1, config$2],
+	languageOptions: {
+		parser: tseslint.parser,
+		parserOptions: { projectService: true },
+		globals: { ...globals.browser }
+	}
+}];
+
+//#endregion
+export { config as default };

package/dist/config/standard-js.d.ts

@@ -0,0 +1,4 @@
+//#region config/standard-js.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/standard-js.js

@@ -0,0 +1,11 @@
+import "../import.js";
+import config$1 from "../rules/recommended-javascript.js";
+
+//#region config/standard-js.ts
+const config = [{
+	files: ["**/*.js"],
+	extends: [config$1]
+}];
+
+//#endregion
+export { config as default };

package/dist/config/standard-ts.d.ts

@@ -0,0 +1,4 @@
+//#region config/standard-ts.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/standard-ts.js

@@ -0,0 +1,16 @@
+import "../import.js";
+import { t as config$1 } from "../recommended-typescript.js";
+import tseslint from "typescript-eslint";
+
+//#region config/standard-ts.ts
+const config = [{
+	files: ["**/*.ts"],
+	extends: [config$1],
+	languageOptions: {
+		parser: tseslint.parser,
+		parserOptions: { projectService: true }
+	}
+}];
+
+//#endregion
+export { config as default };

package/dist/config/vue-js.d.ts

@@ -0,0 +1,4 @@
+//#region config/vue-js.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/vue-js.js

@@ -0,0 +1,34 @@
+import "../import.js";
+import config$1 from "../rules/recommended-javascript.js";
+import { t as config$2 } from "../vue.js";
+import globals from "globals";
+import pluginVue from "eslint-plugin-vue";
+import vueParser from "vue-eslint-parser";
+
+//#region config/vue-js.ts
+const config = [{
+	files: ["**/*.js", "**/*.jsx"],
+	extends: [config$1],
+	languageOptions: {
+		parserOptions: { ecmaFeatures: { jsx: true } },
+		globals: { ...globals.browser }
+	}
+}, {
+	files: ["**/*.vue"],
+	extends: [config$1, config$2],
+	plugins: { get vue() {
+		return pluginVue;
+	} },
+	languageOptions: {
+		parser: vueParser,
+		parserOptions: {
+			extraFileExtensions: [".vue", ".jsx"],
+			ecmaFeatures: { jsx: true }
+		},
+		globals: { ...globals.browser }
+	},
+	processor: "vue/vue"
+}];
+
+//#endregion
+export { config as default };

package/dist/config/vue-ts.d.ts

@@ -0,0 +1,4 @@
+//#region config/vue-ts.d.ts
+declare const config: any;
+//#endregion
+export { config as default };

package/dist/config/vue-ts.js

@@ -0,0 +1,44 @@
+import "../import.js";
+import { t as config$1 } from "../recommended-typescript.js";
+import { t as config$2 } from "../vue.js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import pluginVue from "eslint-plugin-vue";
+import vueParser from "vue-eslint-parser";
+
+//#region config/vue-ts.ts
+const config = [{
+	files: ["**/*.ts", "**/*.tsx"],
+	extends: [config$1],
+	languageOptions: {
+		parser: tseslint.parser,
+		parserOptions: {
+			projectService: true,
+			ecmaFeatures: { jsx: true }
+		},
+		globals: { ...globals.browser }
+	}
+}, {
+	files: ["**/*.vue"],
+	extends: [config$1, config$2],
+	plugins: { get vue() {
+		return pluginVue;
+	} },
+	languageOptions: {
+		parser: vueParser,
+		parserOptions: {
+			parser: tseslint.parser,
+			extraFileExtensions: [".vue", ".tsx"],
+			ecmaFeatures: { jsx: true }
+		},
+		globals: { ...globals.browser }
+	},
+	processor: "vue/vue",
+	rules: {
+		"@typescript-eslint/restrict-plus-operands": "off",
+		"@typescript-eslint/dot-notation": "off"
+	}
+}];
+
+//#endregion
+export { config as default };