@fast-china/eslint-config 1.1.0 → 2.0.1

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# 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.1 - 2026-07-26
+
+### Added
+
+- Added first-class opt-in React support with JavaScript/TypeScript presets, official Hooks and React Compiler diagnostics, DOM safety rules, React-compatible JSX runtime settings, generated rule types, and runtime tests.
+- Added first-class opt-in Angular support for framework TypeScript, external and inline templates, modern recommended rules, configurable template accessibility, generated rule types, and runtime tests.
+
+### Changed
+
+- Changed the newly bundled React and Angular dependencies to caret ranges so compatible minor and patch releases can be installed without editing the manifest.
+- Completed the TypeScript 6 migration with TypeScript 6.0.3, removed the deprecated compiler-option suppression, and replaced tsup with tsdown 0.22.14 for native `.mjs`, `.d.mts`, and source-map builds.
+- Raised the verified runtime baselines to Node.js 22.18.0 and 24.11.0 to match the current tsdown toolchain.
+- Updated the development baseline to ESLint 10.8.0, then upgraded `actions/checkout` plus `actions/setup-node` to their current v7 major releases.
+
+## 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.
+- Upgraded `pnpm/action-setup` to v6 so GitHub Actions uses its Node.js 24 runtime without Node.js 20 deprecation warnings.

package/README.md

@@ -2,7 +2,7 @@
 
 # @fast-china/eslint-config
 
-A practical, typed ESLint Flat Config for Vue 3, Vite, TypeScript, and JavaScript projects.
+A practical, typed ESLint Flat Config for Vue 3, React, Angular, Vite, TypeScript, and JavaScript projects.
 
 [![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)
@@ -10,18 +10,20 @@ A practical, typed ESLint Flat Config for Vue 3, Vite, TypeScript, and JavaScrip
 ## Highlights
 
 - 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.
+- Vue 3 + TypeScript + Vite defaults; React and Angular are first-class opt-in integrations, so existing Vue projects do not activate unrelated rules.
+- First-class JavaScript, TypeScript, Vue SFC, JSX/TSX, Angular TypeScript and templates, JSON dialects, 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 `^20.19.0`, `^22.13.0`, or `>=24`
+- Node.js `^22.18.0` or `>=24.11.0`
 - ESLint `^10.0.0`
-- TypeScript `>=5.3.0 <6.1.0`
+- TypeScript `>=6.0.0 <6.1.0`
 
 These versions follow the runtime requirements of ESLint 10 and the included language plugins.
 
@@ -38,83 +40,161 @@ Equivalent npm, Yarn, and Bun commands work as well.
 Create `eslint.config.mjs`:
 
 ```js
-import { defineConfig } from "eslint/config";
-
 import fastChina from "@fast-china/eslint-config";
 
-export default defineConfig([...fastChina]);
+export default fastChina();
 ```
 
 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.
+Use the default `fastConfig()` factory to keep only what a project needs.
 
-### Node.js + TypeScript
+### React + Vite
 
 ```js
-import { defineConfig } from "eslint/config";
+import fastChina from "@fast-china/eslint-config";
 
-import { createConfig } from "@fast-china/eslint-config";
+export default fastChina({
+	react: true,
+	vue: false,
+});
+```
 
-export default defineConfig(
-	createConfig({
-		environment: "node",
-		vue: false,
-	})
-);
+React support applies the modern `@eslint-react` JavaScript/TypeScript preset, the official React Hooks Flat Config, and additional DOM safety checks. JSX and TSX are parsed by the existing JavaScript and TypeScript integrations. For a React-compatible JSX runtime such as Preact, set `react: { importSource: "preact" }`.
+
+### Angular
+
+```js
+import fastChina from "@fast-china/eslint-config";
+
+export default fastChina({
+	angular: true,
+	vue: false,
+});
+```
+
+Angular support checks framework TypeScript, external `.html` templates, and inline component templates. Template accessibility and inline-template extraction are enabled by default:
+
+```js
+export default fastChina({
+	angular: {
+		inlineTemplates: true,
+		templateAccessibility: true,
+	},
+	vue: false,
+});
+```
+
+Angular requires the TypeScript integration; `angular: true` together with `typescript: false` fails early with a clear configuration error.
+
+### Node.js + TypeScript
+
+```js
+import fastChina from "@fast-china/eslint-config";
+
+export default fastChina({
+	environment: "node",
+	vue: false,
+});
 ```
 
 ### JavaScript only
 
 ```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,
-	})
-);
+import fastChina from "@fast-china/eslint-config";
+
+export default fastChina({
+	environment: "node",
+	json: false,
+	markdown: false,
+	typescript: false,
+	vue: false,
+});
 ```
 
 ### Type-aware TypeScript rules
 
 ```js
-import { defineConfig } from "eslint/config";
-
-import { createConfig } from "@fast-china/eslint-config";
+import fastChina from "@fast-china/eslint-config";
 
-export default defineConfig(
-	createConfig({
-		typescript: { typeChecked: true },
-		vue: { typeChecked: true, version: 3 },
-	})
-);
+export default fastChina({
+	typescript: {
+		tsconfigRootDir: import.meta.dirname,
+		typeChecked: true,
+	},
+});
 ```
 
-Type-aware linting uses the typescript-eslint project service. Project files must belong to a `tsconfig.json`.
+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.        |
-| `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.               |
+| Option            | Default     | Purpose                                                                    |
+| ----------------- | ----------- | -------------------------------------------------------------------------- |
+| `angular`         | `false`     | Enable Angular TypeScript and templates, or pass Angular-specific options. |
+| `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.                          |
+| `react`           | `false`     | Enable React/JSX/Hooks, or pass runtime and React-version settings.        |
+| `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.                                       |
+
+## Framework coverage
+
+Vue 3, React, and Angular have dedicated parsers or processors, presets, options, generated rule types, and integration tests. Nuxt can use the Vue base; Next.js and Remix can use the React base, then append their framework-specific Flat Config after `fastConfig()` when needed. React-compatible JSX runtimes can use `react.importSource`.
+
+Svelte, Astro, and Solid use different template or compiler semantics and are not presented as first-class integrations yet. Their official Flat Config can already be appended as a trailing override, but first-class switches should only be added together with the correct parser, processor, rule schemas, documentation, and runtime fixtures.
+
+## Lodash import policy
+
+The default, `lodash: false`, leaves the dependency choice to the project. Select one policy when every static import should use the same package:
+
+- `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.
+
+Choose `lodash-unified`:
+
+```sh
+pnpm add lodash-unified
+```
+
+```js
+import fastChina from "@fast-china/eslint-config";
+import { cloneDeep, debounce } from "lodash-unified";
+
+export default fastChina({ lodash: "lodash-unified" });
+```
+
+Choose standard `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" });
+```
+
+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
 
@@ -122,23 +202,25 @@ The package generates `RuleOptions` from the JSON Schemas published by ESLint co
 
 ```js
 // @ts-check
-import { defineConfig } from "eslint/config";
-
-import { createConfig, defineRules } from "@fast-china/eslint-config";
+import fastChina, { defineRules } from "@fast-china/eslint-config";
 
 const projectRules = defineRules({
+	"@angular-eslint/template/alt-text": "error",
+	"@eslint-react/dom-no-missing-button-type": "error",
 	"@typescript-eslint/no-unused-vars": ["error", { args: "after-used" }],
 	"import-x/order": ["error", { "newlines-between": "always" }],
+	"react-hooks/exhaustive-deps": "warn",
 	"vue/attributes-order": ["error", { order: ["DEFINITION", "EVENTS", "CONTENT"] }],
 });
 
-export default defineConfig([
-	...createConfig(),
+export default fastChina(
+	{ rules: projectRules },
 	{
-		name: "project/rules",
-		rules: projectRules,
-	},
-]);
+		files: ["**/*.generated.ts"],
+		name: "project/generated",
+		rules: defineRules({ "@typescript-eslint/no-unused-vars": "off" }),
+	}
+);
 ```
 
 TypeScript configuration and tooling code can use the generated interface directly:
@@ -155,31 +237,32 @@ The generated set covers ESLint core and plugins bundled by this package. Rules
 
 ## 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 `[安全关注]`.
+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. React and Angular are disabled globally by default, but enabling them also enables their documented modern-framework and accessibility policies. Manifest sorting is high-impact and 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
 
-Append project rules after the shared config so they take precedence:
+Put common overrides in `rules`, and pass file-scoped overrides as later arguments. Later configurations take precedence:
 
 ```js
-import { defineConfig } from "eslint/config";
-
-import { createConfig } from "@fast-china/eslint-config";
+import fastChina, { defineRules } from "@fast-china/eslint-config";
 
-export default defineConfig([
-	...createConfig({ vue: 3 }),
+export default fastChina(
 	{
-		name: "project/overrides",
 		rules: {
-			"no-console": "off",
+			"no-console": "warn",
 		},
 	},
-]);
+	{
+		files: ["**/{scripts,tests}/**/*.{js,ts}"],
+		name: "project/node-files",
+		rules: defineRules({ "no-console": "off" }),
+	}
+);
 ```
 
-Reusable named exports include `PresetJavascriptConfigs`, `PresetTypeScriptConfigs`, `PresetBasicConfigs`, `PresetJsonConfigs`, `PresetVueConfigs`, individual config groups, constants, and raw rule records from `@fast-china/eslint-config/rules`.
+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
 
@@ -198,21 +281,13 @@ Set `prettier: false` if another formatter or stylistic rule set should remain f
 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.
 
-## 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)