@fast-china/eslint-config 1.0.47 → 1.1.0

package/README.md

@@ -1,109 +1,218 @@
-[中](https://gitee.com/FastDotnet/Fast.ESLint.Config) | **En**
+[中文](./README.zh.md) | **English**
 
-<h1 align="center">Fast.ESLint.Config</h1>
+# @fast-china/eslint-config
 
-<p align="center">
-  <code>Fast</code> platform An rule library built based on <code>ESLint</code>.
-</p>
+A practical, typed ESLint Flat Config for Vue 3, Vite, TypeScript, and JavaScript projects.
 
-<p align="center">
-  <a href="https://www.npmjs.com/package/@fast-china/eslint-config">
-    <img src="https://img.shields.io/npm/v/@fast-china/eslint-config?color=orange&label=" alt="version" />
-  </a>
-  <a href="https://gitee.com/FastDotnet/Fast.ESLint.Config/blob/master/LICENSE">
-    <img src="https://img.shields.io/npm/l/@fast-china/eslint-config" alt="license" />
-  </a>
-</p>
+[![npm version](https://img.shields.io/npm/v/@fast-china/eslint-config?color=orange)](https://www.npmjs.com/package/@fast-china/eslint-config)
+[![license](https://img.shields.io/npm/l/@fast-china/eslint-config)](./LICENSE)
 
-## Install
+## Highlights
 
-#### Using a Package Manager
+- Built for ESLint 10 and the native Flat Config format.
+- Vue 3 + TypeScript + Vite defaults, with Vue 2 and type-aware linting available explicitly.
+- First-class JavaScript, TypeScript, Vue SFC, JSON, JSONC, JSON5, Markdown, RegExp, and import rules.
+- A zero-configuration default array plus a small `createConfig()` factory for other project types.
+- Schema-generated rule types provide exact rule-name and rule-option completion.
+- Plugins and parsers are regular package dependencies, so consumers do not need to assemble the plugin graph.
+- Prettier stays a formatter: the default only disables conflicting ESLint rules and does not run Prettier inside ESLint.
 
-```sh
-# Choose a package manager of your choice
+## Requirements
+
+- Node.js `^20.19.0`, `^22.13.0`, or `>=24`
+- ESLint `^10.0.0`
+- TypeScript `>=5.3.0 <6.1.0`
 
-# NPM
-npm install @fast-china/eslint-config --save-dev
+These versions follow the runtime requirements of ESLint 10 and the included language plugins.
 
-# Yarn
-yarn add @fast-china/eslint-config --dev
+## Installation
 
-# pnpm (recommend)
-pnpm install @fast-china/eslint-config --save-dev
+```sh
+pnpm add -D eslint typescript @fast-china/eslint-config
 ```
 
-## Use
+Equivalent npm, Yarn, and Bun commands work as well.
 
-#### eslint.config.mjs Example
+## Quick start: Vue 3 + Vite
+
+Create `eslint.config.mjs`:
+
+```js
+import { defineConfig } from "eslint/config";
 
-```typescript
 import fastChina from "@fast-china/eslint-config";
 
-export default [...fastChina];
+export default defineConfig([...fastChina]);
 ```
 
-```typescript
-import fastChina from "@fast-china/eslint-config";
+The default enables Vue 3, TypeScript, JavaScript, JSON dialects, Markdown, import ordering, RegExp checks, `.gitignore`, browser globals, and Node globals for common config, script, test, and CLI files.
+
+## Other project types
+
+Use `createConfig()` to keep only what a project needs.
+
+### Node.js + TypeScript
+
+```js
 import { defineConfig } from "eslint/config";
 
-export default defineConfig(...fastChina);
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig(
+	createConfig({
+		environment: "node",
+		vue: false,
+	})
+);
 ```
 
-```typescript
-import fastChina from "@fast-china/eslint-config";
-import tseslint from "typescript-eslint";
+### JavaScript only
 
-export default tseslint.config({
-  extends: [...fastChina],
-});
-```
+```js
+import { defineConfig } from "eslint/config";
 
-## Update log
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig(
+	createConfig({
+		environment: "node",
+		json: false,
+		markdown: false,
+		typescript: false,
+		vue: false,
+	})
+);
+```
 
-Update log [Click to view](https://gitee.com/FastDotnet/Fast.ESLint.Config/commits/master)
+### Type-aware TypeScript rules
 
-## Protocol
+```js
+import { defineConfig } from "eslint/config";
 
-[Fast.ESLint.Config](https://gitee.com/FastDotnet/Fast.ESLint.Config) complies with the [Apache-2.0](https://gitee.com/FastDotnet/Fast.ESLint.Config/blob/master/LICENSE) open source agreement. Welcome to submit `PR` or `Issue`.
+import { createConfig } from "@fast-china/eslint-config";
 
+export default defineConfig(
+	createConfig({
+		typescript: { typeChecked: true },
+		vue: { typeChecked: true, version: 3 },
+	})
+);
 ```
-Apache Open Source License
 
-Copyright © 2018-Now xiaoFang
+Type-aware linting uses the typescript-eslint project service. Project files must belong to a `tsconfig.json`.
 
-License:
-This Agreement grants any individual or organization that obtains a copy of this software and its related documentation (hereinafter referred to as the "Software").
-Subject to the terms of this Agreement, you have the right to use, copy, modify, merge, publish, distribute, sublicense, and sell copies of the Software:
-1.All copies or major parts of the Software must retain this Copyright Notice and this License Agreement.
-2.The use, copying, modification, or distribution of the Software shall not violate applicable laws or infringe upon the legitimate rights and interests of others.
-3.Modified or derivative works must clearly indicate the original author and the source of the original Software.
+## Options
 
-Special Statement:
-- This Software is provided "as is" without any express or implied warranty of any kind, including but not limited to the warranty of merchantability, fitness for purpose, and non-infringement.
-- In no event shall the author or copyright holder be liable for any direct or indirect loss caused by the use or inability to use this Software.
-- Including but not limited to data loss, business interruption, etc.
+| Option        | Default     | Purpose                                                     |
+| ------------- | ----------- | ----------------------------------------------------------- |
+| `environment` | `"browser"` | Use `"browser"`, `"node"`, or `"universal"` globals.        |
+| `gitignore`   | `true`      | Read ignore patterns from the project `.gitignore`.         |
+| `ignores`     | `[]`        | Add project-specific global ignore patterns.                |
+| `imports`     | `true`      | Enable import-x correctness and ordering rules.             |
+| `json`        | `true`      | Enable JSON/JSONC/JSON5 rules and package/tsconfig sorting. |
+| `markdown`    | `true`      | Enable the official Markdown language rules.                |
+| `prettier`    | `true`      | Disable ESLint rules that conflict with Prettier.           |
+| `regexp`      | `true`      | Enable recommended RegExp rules.                            |
+| `typescript`  | `true`      | Disable it or pass `{ typeChecked: true }`.                 |
+| `vue`         | `3`         | Disable it, use `2`/`3`, or pass Vue options.               |
 
-Disclaimer:
-It is prohibited to use this software to engage in illegal activities such as endangering national security, disrupting social order, or infringing on the legitimate rights and interests of others.
-The author does not assume any responsibility for any legal disputes and liabilities caused by the secondary development of this software.
-```
+## Exact rule types and completion
+
+The package generates `RuleOptions` from the JSON Schemas published by ESLint core and every bundled plugin. The identity helper `defineRules()` adds editor completion for rule names, severities, and options while rejecting misspelled rules and invalid options at type-checking time.
+
+```js
+// @ts-check
+import { defineConfig } from "eslint/config";
+
+import { createConfig, defineRules } from "@fast-china/eslint-config";
 
-## Disclaimer
+const projectRules = defineRules({
+	"@typescript-eslint/no-unused-vars": ["error", { args: "after-used" }],
+	"import-x/order": ["error", { "newlines-between": "always" }],
+	"vue/attributes-order": ["error", { order: ["DEFINITION", "EVENTS", "CONTENT"] }],
+});
 
+export default defineConfig([
+	...createConfig(),
+	{
+		name: "project/rules",
+		rules: projectRules,
+	},
+]);
 ```
-Please do not use it for projects that violate our country's laws
+
+TypeScript configuration and tooling code can use the generated interface directly:
+
+```ts
+import type { RuleOptions } from "@fast-china/eslint-config";
+
+const rules = {
+	"no-console": ["warn", { allow: ["warn", "error"] }],
+} satisfies RuleOptions;
 ```
 
-## Contributors
+The generated set covers ESLint core and plugins bundled by this package. Rules from additional project-installed plugins are outside this type set, and precision ultimately depends on the schema published by each rule.
+
+## Rule risk and maintenance
+
+The default includes a small set of high-impact rules. They can create a large first-run sorting diff, block legacy patterns, or require a review of import side effects, type-only imports, and public component events. Source comments mark these decisions as `[高影响]`, `[可自动修复]`, or `[安全关注]`.
+
+See the [default-rule and risk guide](./docs/rules-risk.md) for inherited presets, the high-impact inventory, scoped override examples, and the maintenance contract. Run a read-only lint before `eslint --fix`, apply fixes in an isolated commit, and review imports, `package.json`, component events, and build output.
 
-Thank you for all their contributions!
+## Project overrides
 
-<a href="https://github.com/China-xiaoFang/Fast.ESLint.Config/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=China-xiaoFang/Fast.ESLint.Config" />
-</a>
+Append project rules after the shared config so they take precedence:
 
-## Supplementary instructions
+```js
+import { defineConfig } from "eslint/config";
 
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig([
+	...createConfig({ vue: 3 }),
+	{
+		name: "project/overrides",
+		rules: {
+			"no-console": "off",
+		},
+	},
+]);
 ```
-If it is helpful to you, you can click ⭐Star in the upper right corner to collect it and get the latest updates. Thank you!
+
+Reusable named exports include `PresetJavascriptConfigs`, `PresetTypeScriptConfigs`, `PresetBasicConfigs`, `PresetJsonConfigs`, `PresetVueConfigs`, individual config groups, constants, and raw rule records from `@fast-china/eslint-config/rules`.
+
+## Prettier
+
+Prettier is intentionally not a peer dependency and is not executed as an ESLint rule. Install and run it separately if the project uses it:
+
+```sh
+pnpm add -D prettier
+pnpm exec prettier --check .
 ```
+
+Set `prettier: false` if another formatter or stylistic rule set should remain fully in control.
+
+## Development
+
+```sh
+pnpm install
+pnpm typegen
+pnpm check
+```
+
+Run `pnpm typegen` after upgrading ESLint or a plugin and commit `src/typegen.d.ts`; never edit the generated file manually. `pnpm check` verifies that generated types are current, builds the package, type-checks source, lints all supported file types, checks formatting, and runs both runtime and consumer type tests against the built package.
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for the contribution workflow, the [default-rule and risk guide](./docs/rules-risk.md) for rule maintenance, and [the engineering audit](./docs/engineering-audit.zh.md) for the current quality baseline.
+
+## Migration from 1.0.48 and earlier
+
+- Existing `export default [...fastChina]` usage still works.
+- The package is ESM-only and no longer exposes a misleading CommonJS condition.
+- Vue 3 is the explicit default; use `createConfig({ vue: 2 })` for Vue 2.
+- `lodash` and `lodash-es` are no longer banned by default. The organization-specific rule records remain available from the rules subpath.
+- Prettier no longer runs inside ESLint. Run the Prettier CLI or editor integration separately.
+- ESLint 10 now determines the Node.js minimum shown above.
+
+## License
+
+[Apache-2.0](./LICENSE)

package/README.zh.md

@@ -1,109 +1,218 @@
-**中** | [En](https://github.com/China-xiaoFang/Fast.ESLint.Config)
+**中文** | [English](./README.md)
 
-<h1 align="center">Fast.ESLint.Config</h1>
+# @fast-china/eslint-config
 
-<p align="center">
-  <code>Fast</code> 平台下基于 <code>ESLint</code> 构建的规则库。
-</p>
+面向 Vue 3、Vite、TypeScript 与 JavaScript 项目的实用型 ESLint Flat Config 规则库。
 
-<p align="center">
-  <a href="https://www.npmjs.com/package/@fast-china/eslint-config">
-    <img src="https://img.shields.io/npm/v/@fast-china/eslint-config?color=orange&label=" alt="version" />
-  </a>
-  <a href="https://gitee.com/FastDotnet/Fast.ESLint.Config/blob/master/LICENSE">
-    <img src="https://img.shields.io/npm/l/@fast-china/eslint-config" alt="license" />
-  </a>
-</p>
+[![npm version](https://img.shields.io/npm/v/@fast-china/eslint-config?color=orange)](https://www.npmjs.com/package/@fast-china/eslint-config)
+[![license](https://img.shields.io/npm/l/@fast-china/eslint-config)](./LICENSE)
 
-## 安装
+## 特性
 
-#### 使用包管理器
+- 基于 ESLint 10 与原生 Flat Config，不再兼容旧式 `.eslintrc`。
+- 默认针对 Vue 3 + TypeScript + Vite，同时可显式选择 Vue 2 或类型感知规则。
+- 完整覆盖 JavaScript、TypeScript、Vue SFC、JSON、JSONC、JSON5、Markdown、正则表达式与导入规则。
+- 保留零配置的默认数组，并提供轻量的 `createConfig()` 工厂适配其他类型项目。
+- 根据 ESLint 与内置插件的规则 schema 生成精确类型，提供规则名和规则选项自动补全。
+- 插件与解析器均由本包直接声明依赖，使用者不需要手工拼装插件依赖树。
+- Prettier 只负责格式化：默认配置仅关闭冲突规则，不在 ESLint 内重复运行 Prettier。
 
-```sh
-# 选择一个你喜欢的包管理器
+## 环境要求
 
-# NPM
-npm install @fast-china/eslint-config --save-dev
+- Node.js `^20.19.0`、`^22.13.0` 或 `>=24`
+- ESLint `^10.0.0`
+- TypeScript `>=5.3.0 <6.1.0`
 
-# Yarn
-yarn add @fast-china/eslint-config --dev
+这些版本范围与 ESLint 10 及内置语言插件的运行要求保持一致。
+
+## 安装
 
-# pnpm（推荐）
-pnpm install @fast-china/eslint-config --save-dev
+```sh
+pnpm add -D eslint typescript @fast-china/eslint-config
 ```
 
-## 使用
+也可以使用 npm、Yarn 或 Bun 的等价命令。
+
+## 快速开始：Vue 3 + Vite
 
-#### eslint.config.mjs 示例
+创建 `eslint.config.mjs`：
+
+```js
+import { defineConfig } from "eslint/config";
 
-```typescript
 import fastChina from "@fast-china/eslint-config";
 
-export default [...fastChina];
+export default defineConfig([...fastChina]);
 ```
 
-```typescript
-import fastChina from "@fast-china/eslint-config";
+默认配置会启用 Vue 3、TypeScript、JavaScript、JSON 各方言、Markdown、导入排序、正则检查、`.gitignore` 与浏览器全局变量；常见配置文件、脚本、测试和 CLI 文件会额外获得 Node.js 全局变量。
+
+## 适配其他项目
+
+通过 `createConfig()` 只保留项目真正需要的能力。
+
+### Node.js + TypeScript
+
+```js
 import { defineConfig } from "eslint/config";
 
-export default defineConfig(...fastChina);
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig(
+	createConfig({
+		environment: "node",
+		vue: false,
+	})
+);
 ```
 
-```typescript
-import fastChina from "@fast-china/eslint-config";
-import tseslint from "typescript-eslint";
+### 纯 JavaScript
 
-export default tseslint.config({
-  extends: [...fastChina],
-});
-```
+```js
+import { defineConfig } from "eslint/config";
 
-## 更新日志
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig(
+	createConfig({
+		environment: "node",
+		json: false,
+		markdown: false,
+		typescript: false,
+		vue: false,
+	})
+);
+```
 
-更新日志 [点击查看](https://gitee.com/FastDotnet/Fast.ESLint.Config/commits/master)
+### 启用 TypeScript 类型感知规则
 
-## 协议
+```js
+import { defineConfig } from "eslint/config";
 
-[Fast.ESLint.Config](https://gitee.com/FastDotnet/Fast.ESLint.Config) 遵循 [Apache-2.0](https://gitee.com/FastDotnet/Fast.ESLint.Config/blob/master/LICENSE) 开源协议，欢迎大家提交 `PR` 或 `Issue`。
+import { createConfig } from "@fast-china/eslint-config";
 
+export default defineConfig(
+	createConfig({
+		typescript: { typeChecked: true },
+		vue: { typeChecked: true, version: 3 },
+	})
+);
 ```
-Apache开源许可证
 
-版权所有 © 2018-Now 小方
+类型感知模式使用 typescript-eslint project service，被检查的文件必须属于某个 `tsconfig.json`。
 
-许可授权：
-本协议授予任何获得本软件及其相关文档（以下简称“软件”）副本的个人或组织。
-在遵守本协议条款的前提下，享有使用、复制、修改、合并、发布、分发、再许可、销售软件副本的权利：
-1.所有软件副本或主要部分必须保留本版权声明及本许可协议。
-2.软件的使用、复制、修改或分发不得违反适用法律或侵犯他人合法权益。
-3.修改或衍生作品须明确标注原作者及原软件出处。
+## 配置选项
 
-特别声明：
-- 本软件按“原样”提供，不提供任何形式的明示或暗示的保证，包括但不限于对适销性、适用性和非侵权的保证。
-- 在任何情况下，作者或版权持有人均不对因使用或无法使用本软件导致的任何直接或间接损失的责任。
-- 包括但不限于数据丢失、业务中断等情况。
+| 选项          | 默认值      | 作用                                                   |
+| ------------- | ----------- | ------------------------------------------------------ |
+| `environment` | `"browser"` | 可选 `"browser"`、`"node"` 或 `"universal"` 全局变量。 |
+| `gitignore`   | `true`      | 读取项目根目录的 `.gitignore`。                        |
+| `ignores`     | `[]`        | 增加项目自己的全局忽略模式。                           |
+| `imports`     | `true`      | 启用 import-x 正确性与排序规则。                       |
+| `json`        | `true`      | 启用 JSON/JSONC/JSON5 及 package/tsconfig 排序。       |
+| `markdown`    | `true`      | 启用官方 Markdown 语言规则。                           |
+| `prettier`    | `true`      | 关闭与 Prettier 冲突的 ESLint 规则。                   |
+| `regexp`      | `true`      | 启用推荐的正则表达式规则。                             |
+| `typescript`  | `true`      | 可关闭，或传入 `{ typeChecked: true }`。               |
+| `vue`         | `3`         | 可关闭、传入 `2`/`3`，或传入 Vue 选项对象。            |
 
-免责条款：
-禁止利用本软件从事危害国家安全、扰乱社会秩序或侵犯他人合法权益等违法活动。
-对于基于本软件二次开发所引发的任何法律纠纷及责任，作者不承担任何责任。
-```
+## 精确规则类型与自动补全
+
+本包根据 ESLint 核心规则和所有随包插件公开的 JSON Schema 生成 `RuleOptions`，并提供不会改变运行时对象的 `defineRules()`。在输入规则名、严重级别或选项时，TypeScript 与支持类型分析的编辑器会给出补全；拼错规则名或填写无效选项时会立即报错。
 
-## 免责申明
+```js
+// @ts-check
+import { defineConfig } from "eslint/config";
+
+import { createConfig, defineRules } from "@fast-china/eslint-config";
 
+const projectRules = defineRules({
+	"@typescript-eslint/no-unused-vars": ["error", { args: "after-used" }],
+	"import-x/order": ["error", { "newlines-between": "always" }],
+	"vue/attributes-order": ["error", { order: ["DEFINITION", "EVENTS", "CONTENT"] }],
+});
+
+export default defineConfig([
+	...createConfig(),
+	{
+		name: "project/rules",
+		rules: projectRules,
+	},
+]);
 ```
-请勿用于违反我国法律的项目上
+
+在 TypeScript 配置或工具代码中，也可以直接使用：
+
+```ts
+import type { RuleOptions } from "@fast-china/eslint-config";
+
+const rules = {
+	"no-console": ["warn", { allow: ["warn", "error"] }],
+} satisfies RuleOptions;
 ```
 
-## 贡献者
+精确类型覆盖 ESLint 核心规则和本包附带的插件规则；项目自行安装的额外插件不在该类型集合内。类型精度取决于对应规则公开的 schema。
+
+## 规则风险与维护
+
+默认配置包含少量高影响规则：它们可能在首次启用时产生大面积排序差异、阻断旧项目写法，或要求复核 import 副作用、类型导入和组件公共事件。源码使用 `[高影响]`、`[可自动修复]` 与 `[安全关注]` 标记这类规则。
+
+完整的默认预置来源、高影响规则清单、关闭示例和维护约定见 [默认规则与风险指南](./docs/rules-risk.zh.md)。运行 `eslint --fix` 前建议先只检查，在独立提交中应用修复，并审查 import、`package.json`、组件事件和构建产物。
+
+## 覆盖项目规则
+
+将项目规则放在共享配置之后即可覆盖：
+
+```js
+import { defineConfig } from "eslint/config";
+
+import { createConfig } from "@fast-china/eslint-config";
+
+export default defineConfig([
+	...createConfig({ vue: 3 }),
+	{
+		name: "project/overrides",
+		rules: {
+			"no-console": "off",
+		},
+	},
+]);
+```
 
-感谢他们的所做的一切贡献！
+可复用导出包括 `PresetJavascriptConfigs`、`PresetTypeScriptConfigs`、`PresetBasicConfigs`、`PresetJsonConfigs`、`PresetVueConfigs`、各独立配置组和常量；原始规则记录可从 `@fast-china/eslint-config/rules` 导入。
 
-<a href="https://github.com/China-xiaoFang/Fast.ESLint.Config/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=China-xiaoFang/Fast.ESLint.Config" />
-</a>
+## Prettier
 
-## 补充说明
+Prettier 不再是 peer dependency，也不会作为 ESLint 规则运行。项目需要格式化时单独安装并执行：
 
+```sh
+pnpm add -D prettier
+pnpm exec prettier --check .
 ```
-如果对您有帮助，您可以点右上角 ⭐Star 收藏一下 ，获取第一时间更新，谢谢！
+
+如果使用其他格式化工具，或希望保留完整的样式类 ESLint 规则，请设置 `prettier: false`。
+
+## 开发与贡献
+
+```sh
+pnpm install
+pnpm typegen
+pnpm check
 ```
+
+升级 ESLint 或插件后运行 `pnpm typegen` 并提交 `src/typegen.d.ts`；不要手工编辑生成文件。`pnpm check` 会验证生成类型没有漂移，然后依次构建、类型检查、检查所有支持的文件类型、验证格式，并针对构建后的真实包运行运行时和消费者类型测试。
+
+贡献流程见 [CONTRIBUTING.md](./CONTRIBUTING.md)，规则维护约定见 [默认规则与风险指南](./docs/rules-risk.zh.md)，本次工程审查和质量基线见 [工程质量审查报告](./docs/engineering-audit.zh.md)。
+
+## 从 1.0.48 及更早版本迁移
+
+- 现有 `export default [...fastChina]` 用法继续有效。
+- 包现在明确为 ESM-only，不再暴露指向 ESM 文件的伪 CommonJS 条件。
+- Vue 3 成为明确默认值；Vue 2 请使用 `createConfig({ vue: 2 })`。
+- 默认不再强制项目改用 `lodash-unified`，组织定制规则仍保留在 rules 子路径中供显式使用。
+- Prettier 不再运行于 ESLint 内部，请改用 Prettier CLI 或编辑器集成。
+- Node.js 最低版本调整为 ESLint 10 的实际要求。
+
+## 开源协议
+
+[Apache-2.0](./LICENSE)