@fast-china/eslint-config 1.0.48 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases should follow [Semantic Versioning](https://semver.org/).
+
+## Unreleased
+
+## 2.0.0 - 2026-07-26
+
+### Added
+
+- Published the ESM-only `fastConfig(options, ...overrides)` factory for Vue 3, Vite, TypeScript, JavaScript, Node.js, JSON dialects, Markdown, RegExp, import rules, Prettier conflict handling, and project overrides.
+- Added environment-aware globals, `.gitignore` support, global ignore patterns, language switches, and file-scoped trailing overrides.
+- Added optional type-aware TypeScript and Vue linting through typescript-eslint Project Service.
+- Added opt-in `lodash` and `lodash-unified` static import policies without requiring an additional ESLint plugin.
+- Added opt-in, semantics-aware `package.json` and `tsconfig*.json` sorting that preserves conditional export order.
+- Added schema-generated `RuleOptions`, factory-level typed rules, and `defineRules()` for exact rule-name and rule-option completion.
+- Published fully commented raw rule records through `@fast-china/eslint-config/rules`.
+- Added bilingual usage and risk documentation, contribution guidance, and an engineering quality audit.
+- Added deterministic type-generation checks, consumer type tests, runtime integration tests, multi-version Node.js CI, and publish-archive inspection.
+
+### Changed
+
+- Raised the minimum supported Node.js version to 22.13.0 so the package, local development workflow, and pnpm 11 CI use one consistent runtime baseline.

package/README.md

@@ -1,109 +1,244 @@
-[中](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 type-aware linting and language integrations controlled explicitly.
+- First-class JavaScript, TypeScript, Vue SFC, JSON, JSONC, JSON5, Markdown, RegExp, and import rules.
+- One focused `fastConfig()` factory with a compact public API and no project-file reads at module import time.
+- 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.
+- Manifest sorting is explicit opt-in, preventing an unexpected large first-fix diff.
+- An opt-in Lodash policy keeps projects on either `lodash` or `lodash-unified` without mixing package entry points.
+
+## Requirements
+
+- Node.js `^22.13.0` or `^24.0.0`
+- ESLint `^10.0.0`
+- TypeScript `>=5.3.0 <6.1.0`
+
+These versions follow the runtime requirements of ESLint 10 and the included language plugins.
+
+## Installation
 
 ```sh
-# Choose a package manager of your choice
+pnpm add -D eslint typescript @fast-china/eslint-config
+```
+
+Equivalent npm, Yarn, and Bun commands work as well.
 
-# NPM
-npm install @fast-china/eslint-config --save-dev
+## Quick start: Vue 3 + Vite
 
-# Yarn
-yarn add @fast-china/eslint-config --dev
+Create `eslint.config.mjs`:
 
-# pnpm (recommend)
-pnpm install @fast-china/eslint-config --save-dev
+```js
+import fastChina from "@fast-china/eslint-config";
+
+export default fastChina();
 ```
 
-## Use
+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 the default `fastConfig()` factory to keep only what a project needs.
 
-#### eslint.config.mjs Example
+### Node.js + TypeScript
 
-```typescript
+```js
 import fastChina from "@fast-china/eslint-config";
 
-export default [...fastChina];
+export default fastChina({
+	environment: "node",
+	vue: false,
+});
 ```
 
-```typescript
+### JavaScript only
+
+```js
 import fastChina from "@fast-china/eslint-config";
-import { defineConfig } from "eslint/config";
 
-export default defineConfig(...fastChina);
+export default fastChina({
+	environment: "node",
+	json: false,
+	markdown: false,
+	typescript: false,
+	vue: false,
+});
 ```
 
-```typescript
+### Type-aware TypeScript rules
+
+```js
 import fastChina from "@fast-china/eslint-config";
-import tseslint from "typescript-eslint";
 
-export default tseslint.config({
-  extends: [...fastChina],
+export default fastChina({
+	typescript: {
+		tsconfigRootDir: import.meta.dirname,
+		typeChecked: true,
+	},
 });
 ```
 
-## Update log
+Type-aware linting uses the typescript-eslint Project Service. Project files must belong to a `tsconfig.json`. Most projects can omit `tsconfigRootDir`; complex monorepos should pass the directory containing the ESLint config explicitly.
+
+## Options
+
+| Option            | Default     | Purpose                                                             |
+| ----------------- | ----------- | ------------------------------------------------------------------- |
+| `environment`     | `"browser"` | Use `"browser"`, `"node"`, or `"universal"` globals.                |
+| `globals`         | none        | Add globals supplied by a host platform or test runner.             |
+| `gitignore`       | `true`      | Read ignore patterns from the project `.gitignore`.                 |
+| `ignores`         | `[]`        | Append project-specific global ignore patterns.                     |
+| `imports`         | `true`      | Enable import-x correctness and ordering rules.                     |
+| `javascript`      | `true`      | Process JavaScript and JSX files.                                   |
+| `json`            | `true`      | Enable recommended JSON, JSONC, and JSON5 rules.                    |
+| `lodash`          | `false`     | Select `"lodash"` or `"lodash-unified"` for static imports.         |
+| `markdown`        | `true`      | Enable the official Markdown language rules.                        |
+| `prettier`        | `true`      | Disable ESLint rules that conflict with Prettier.                   |
+| `regexp`          | `true`      | Enable recommended RegExp rules.                                    |
+| `rules`           | none        | Add exactly typed project rules to every enabled code file.         |
+| `sortPackageJson` | `false`     | Sort safe package.json keys without entering conditional `exports`. |
+| `sortTsconfig`    | `false`     | Sort `tsconfig*.json` by TypeScript documentation topics.           |
+| `typescript`      | `true`      | Disable it or pass `{ typeChecked: true, tsconfigRootDir }`.        |
+| `vue`             | `true`      | Enable Vue 3 single-file components.                                |
+
+## Lodash import policy
 
-Update log [Click to view](https://gitee.com/FastDotnet/Fast.ESLint.Config/commits/master)
+The default, `lodash: false`, leaves the dependency choice to the project. Select one policy when every static import should use the same package:
 
-## Protocol
+- `lodash: "lodash-unified"` rejects static imports and re-exports from `lodash`, `lodash-es`, and their subpaths.
+- `lodash: "lodash"` rejects static imports and re-exports from `lodash-es`, `lodash-unified`, and their subpaths. The `lodash` root and `lodash/*` method imports remain valid.
 
-[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`.
+Choose `lodash-unified`:
 
+```sh
+pnpm add lodash-unified
 ```
-Apache Open Source License
 
-Copyright © 2018-Now xiaoFang
+```js
+import fastChina from "@fast-china/eslint-config";
+import { cloneDeep, debounce } from "lodash-unified";
 
-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.
+export default fastChina({ lodash: "lodash-unified" });
+```
 
-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.
+Choose standard `lodash`:
 
-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.
+```sh
+pnpm add lodash
+pnpm add -D @types/lodash
 ```
 
-## Disclaimer
+```js
+import fastChina from "@fast-china/eslint-config";
+import debounce from "lodash/debounce";
 
+export default fastChina({ lodash: "lodash" });
 ```
-Please do not use it for projects that violate our country's laws
+
+This feature uses ESLint core `no-restricted-imports`, adds no plugin, and does not install Lodash for the project. It checks static `import`/`export` only, not dynamic `import()` or CommonJS `require()`. Setting `imports: false` disables import-x but leaves an explicitly selected Lodash policy active.
+
+If a later `rules` record or file-scoped override sets `no-restricted-imports`, ESLint replaces this complete policy instead of merging its options. Projects that need additional package restrictions can import raw `preferLodashRules` or `preferLodashUnifiedRules` from `@fast-china/eslint-config/rules` and maintain one combined rule.
+
+## 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 fastChina, { 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 fastChina(
+	{ rules: projectRules },
+	{
+		files: ["**/*.generated.ts"],
+		name: "project/generated",
+		rules: defineRules({ "@typescript-eslint/no-unused-vars": "off" }),
+	}
+);
 ```
 
-## Contributors
+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;
+```
 
-Thank you for all their contributions!
+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.
 
-<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>
+## Rule risk and maintenance
 
-## Supplementary instructions
+The default includes a small set of high-impact rules. They can block particular patterns or require a review of import side effects, type-only imports, and public component events. Manifest sorting is also high-impact but is disabled by default. 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.
+
+## Project overrides
+
+Put common overrides in `rules`, and pass file-scoped overrides as later arguments. Later configurations take precedence:
+
+```js
+import fastChina, { defineRules } from "@fast-china/eslint-config";
+
+export default fastChina(
+	{
+		rules: {
+			"no-console": "warn",
+		},
+	},
+	{
+		files: ["**/{scripts,tests}/**/*.{js,ts}"],
+		name: "project/node-files",
+		rules: defineRules({ "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!
+
+The root entry exports only `fastConfig`, `defaultConfigOptions`, `defineRules`, and their related types. Advanced consumers can import the fully commented 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
+pnpm pack --dry-run
 ```
+
+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.
+
+## License
+
+[Apache-2.0](./LICENSE)

package/README.zh.md

@@ -1,109 +1,244 @@
-**中** | [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。
+- 默认针对 Vue 3 + TypeScript + Vite，可显式开启类型感知规则或关闭不需要的语言能力。
+- 完整覆盖 JavaScript、TypeScript、Vue SFC、JSON、JSONC、JSON5、Markdown、正则表达式与导入规则。
+- 默认导出单一 `fastConfig()` 工厂，公共 API 清晰，并且不会在导入模块时读取项目文件。
+- 根据 ESLint 与内置插件的规则 schema 生成精确类型，提供规则名和规则选项自动补全。
+- 插件与解析器均由本包直接声明依赖，使用者不需要手工拼装插件依赖树。
+- Prettier 只负责格式化：默认配置仅关闭冲突规则，不在 ESLint 内重复运行 Prettier。
+- `package.json` 与 `tsconfig.json` 排序为显式 opt-in，避免安装后首次修复产生非预期大 diff。
+- 可选统一使用 `lodash` 或 `lodash-unified`，避免同一项目混用多个 Lodash 入口。
+
+## 环境要求
+
+- Node.js `^22.13.0` 或 `^24.0.0`
+- ESLint `^10.0.0`
+- TypeScript `>=5.3.0 <6.1.0`
 
-#### 使用包管理器
+这些版本范围与 ESLint 10 及内置语言插件的运行要求保持一致。
+
+## 安装
 
 ```sh
-# 选择一个你喜欢的包管理器
+pnpm add -D eslint typescript @fast-china/eslint-config
+```
 
-# NPM
-npm install @fast-china/eslint-config --save-dev
+也可以使用 npm、Yarn 或 Bun 的等价命令。
 
-# Yarn
-yarn add @fast-china/eslint-config --dev
+## 快速开始：Vue 3 + Vite
 
-# pnpm（推荐）
-pnpm install @fast-china/eslint-config --save-dev
+创建 `eslint.config.mjs`：
+
+```js
+import fastChina from "@fast-china/eslint-config";
+
+export default fastChina();
 ```
 
-## 使用
+默认配置会启用 Vue 3、TypeScript、JavaScript、JSON 各方言、Markdown、导入排序、正则检查、`.gitignore` 与浏览器全局变量；常见配置文件、脚本、测试和 CLI 文件会额外获得 Node.js 全局变量。
+
+## 适配其他项目
 
-#### eslint.config.mjs 示例
+通过默认导出的 `fastConfig()` 只保留项目真正需要的能力。
 
-```typescript
+### Node.js + TypeScript
+
+```js
 import fastChina from "@fast-china/eslint-config";
 
-export default [...fastChina];
+export default fastChina({
+	environment: "node",
+	vue: false,
+});
 ```
 
-```typescript
+### 纯 JavaScript
+
+```js
 import fastChina from "@fast-china/eslint-config";
-import { defineConfig } from "eslint/config";
 
-export default defineConfig(...fastChina);
+export default fastChina({
+	environment: "node",
+	json: false,
+	markdown: false,
+	typescript: false,
+	vue: false,
+});
 ```
 
-```typescript
+### 启用 TypeScript 类型感知规则
+
+```js
 import fastChina from "@fast-china/eslint-config";
-import tseslint from "typescript-eslint";
 
-export default tseslint.config({
-  extends: [...fastChina],
+export default fastChina({
+	typescript: {
+		tsconfigRootDir: import.meta.dirname,
+		typeChecked: true,
+	},
 });
 ```
 
-## 更新日志
+类型感知模式使用 typescript-eslint Project Service，被检查的文件必须属于某个 `tsconfig.json`。普通项目通常可省略 `tsconfigRootDir`；复杂 monorepo 建议显式传入配置文件所在目录。
+
+## 配置选项
+
+| 选项              | 默认值      | 作用                                                           |
+| ----------------- | ----------- | -------------------------------------------------------------- |
+| `environment`     | `"browser"` | 可选 `"browser"`、`"node"` 或 `"universal"` 全局变量。         |
+| `globals`         | 无          | 增加项目宿主、测试运行器等提供的全局变量。                     |
+| `gitignore`       | `true`      | 读取项目根目录的 `.gitignore`。                                |
+| `ignores`         | `[]`        | 追加项目自己的全局忽略模式。                                   |
+| `imports`         | `true`      | 启用 import-x 正确性与排序规则。                               |
+| `javascript`      | `true`      | 处理 JavaScript 与 JSX。                                       |
+| `json`            | `true`      | 启用 JSON、JSONC 与 JSON5 推荐规则。                           |
+| `lodash`          | `false`     | 可选 `"lodash"` 或 `"lodash-unified"`，统一静态导入来源。      |
+| `markdown`        | `true`      | 启用官方 Markdown 语言规则。                                   |
+| `prettier`        | `true`      | 关闭与 Prettier 冲突的 ESLint 规则。                           |
+| `regexp`          | `true`      | 启用推荐的正则表达式规则。                                     |
+| `rules`           | 无          | 对所有已启用代码文件追加具有精确类型的项目规则。               |
+| `sortPackageJson` | `false`     | 按安全白名单排序 `package.json`，不会进入 `exports` 条件对象。 |
+| `sortTsconfig`    | `false`     | 按 TypeScript 文档主题排序 `tsconfig*.json`。                  |
+| `typescript`      | `true`      | 可关闭，或传入 `{ typeChecked: true, tsconfigRootDir }`。      |
+| `vue`             | `true`      | 启用 Vue 3 单文件组件支持。                                    |
 
-更新日志 [点击查看](https://gitee.com/FastDotnet/Fast.ESLint.Config/commits/master)
+## Lodash 导入策略
 
-## 协议
+默认值 `lodash: false` 不限制项目选择。需要统一依赖入口时，可选择以下任一策略：
 
-[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`。
+- `lodash: "lodash-unified"`：禁止从 `lodash`、`lodash-es` 及其子路径静态导入或重新导出。
+- `lodash: "lodash"`：禁止从 `lodash-es`、`lodash-unified` 及其子路径静态导入或重新导出；允许 `lodash` 根入口和 `lodash/*` 按方法导入。
 
+选择 `lodash-unified`：
+
+```sh
+pnpm add lodash-unified
 ```
-Apache开源许可证
 
-版权所有 © 2018-Now 小方
+```js
+import fastChina from "@fast-china/eslint-config";
+import { cloneDeep, debounce } from "lodash-unified";
 
-许可授权：
-本协议授予任何获得本软件及其相关文档（以下简称“软件”）副本的个人或组织。
-在遵守本协议条款的前提下，享有使用、复制、修改、合并、发布、分发、再许可、销售软件副本的权利：
-1.所有软件副本或主要部分必须保留本版权声明及本许可协议。
-2.软件的使用、复制、修改或分发不得违反适用法律或侵犯他人合法权益。
-3.修改或衍生作品须明确标注原作者及原软件出处。
+export default fastChina({ lodash: "lodash-unified" });
+```
 
-特别声明：
-- 本软件按“原样”提供，不提供任何形式的明示或暗示的保证，包括但不限于对适销性、适用性和非侵权的保证。
-- 在任何情况下，作者或版权持有人均不对因使用或无法使用本软件导致的任何直接或间接损失的责任。
-- 包括但不限于数据丢失、业务中断等情况。
+选择标准 `lodash`：
 
-免责条款：
-禁止利用本软件从事危害国家安全、扰乱社会秩序或侵犯他人合法权益等违法活动。
-对于基于本软件二次开发所引发的任何法律纠纷及责任，作者不承担任何责任。
+```sh
+pnpm add lodash
+pnpm add -D @types/lodash
 ```
 
-## 免责申明
+```js
+import fastChina from "@fast-china/eslint-config";
+import debounce from "lodash/debounce";
 
+export default fastChina({ lodash: "lodash" });
 ```
-请勿用于违反我国法律的项目上
+
+该能力使用 ESLint 核心 `no-restricted-imports`，不需要额外插件，也不会替项目安装 Lodash。它只检查静态 `import`/`export`，不检查动态 `import()` 或 CommonJS `require()`。`imports: false` 只关闭 import-x，不会关闭已经显式选择的 Lodash 策略。
+
+如果后续 `rules` 或文件级覆写再次设置 `no-restricted-imports`，ESLint 会用后面的完整规则替换这套策略，而不是合并选项。需要组合更多包限制时，可从 `@fast-china/eslint-config/rules` 导入原始 `preferLodashRules` 或 `preferLodashUnifiedRules`，统一维护一份完整规则。
+
+## 精确规则类型与自动补全
+
+本包根据 ESLint 核心规则和所有随包插件公开的 JSON Schema 生成 `RuleOptions`，并提供不会改变运行时对象的 `defineRules()`。在输入规则名、严重级别或选项时，TypeScript 与支持类型分析的编辑器会给出补全；拼错规则名或填写无效选项时会立即报错。
+
+```js
+// @ts-check
+import fastChina, { 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 fastChina(
+	{ rules: projectRules },
+	{
+		files: ["**/*.generated.ts"],
+		name: "project/generated",
+		rules: defineRules({ "@typescript-eslint/no-unused-vars": "off" }),
+	}
+);
 ```
 
-## 贡献者
+在 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`、组件事件和构建产物。
+
+## 覆盖项目规则
 
-感谢他们的所做的一切贡献！
+最常用的全局覆盖可以直接放入 `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>
+```js
+import fastChina, { defineRules } from "@fast-china/eslint-config";
 
-## 补充说明
+export default fastChina(
+	{
+		rules: {
+			"no-console": "warn",
+		},
+	},
+	{
+		files: ["**/{scripts,tests}/**/*.{js,ts}"],
+		name: "project/node-files",
+		rules: defineRules({ "no-console": "off" }),
+	}
+);
+```
+
+根入口只公开 `fastConfig`、`defaultConfigOptions`、`defineRules` 及相关类型。高级使用者可以从 `@fast-china/eslint-config/rules` 导入有完整注释的原始规则记录。
+
+## 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
+pnpm pack --dry-run
 ```
+
+升级 ESLint 或插件后运行 `pnpm typegen` 并提交 `src/typegen.d.ts`；不要手工编辑生成文件。`pnpm check` 会验证生成类型没有漂移，然后依次构建、类型检查、检查所有支持的文件类型、验证格式，并针对构建后的真实包运行运行时和消费者类型测试。
+
+贡献流程见 [CONTRIBUTING.md](./CONTRIBUTING.md)，规则维护约定见 [默认规则与风险指南](./docs/rules-risk.zh.md)，本次工程审查和质量基线见 [工程质量审查报告](./docs/engineering-audit.zh.md)。
+
+## 开源协议
+
+[Apache-2.0](./LICENSE)