@fast-china/eslint-config 2.1.9 → 2.1.10

package/CHANGELOG.md

@@ -1,18 +1,28 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project are 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.1.10] - 2026-09-22
 
-## 2.1.9 - 2026-09-14
+### Fixed
+
+- Exclude root and nested `.agents` directories and `skills-lock.json` from the shared default ignores; keep Prettier ignores independent.
+
+### Documentation and Tooling
+
+- Correct localized Fast.Docs links and retain minimal README examples.
+- Align public-contract comments and agent guidance; keep licenses and `.editorconfig` unchanged.
+- Keep ESLint and Prettier skill-file ignores separate and add regression checks.
+
+## [2.1.9] - 2026-09-14
 
 ### Changed
 
 - Disabled `@typescript-eslint/switch-exhaustiveness-check` for Vue single-file components while retaining the error-level check for regular TypeScript and TSX files.
 
-## 2.1.8 - 2026-09-12
+## [2.1.8] - 2026-09-12
 
 ### Added
 
@@ -37,7 +47,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Removed the 2.x default export, `fastConfig()`, and `FastConfigOptions`; consumers now select the Vue or UniApp named configuration explicitly.
 - Removed Vue-to-UniApp capability leakage from the new Vue-only entry and removed `prefer-object-has-own` from the defaults.
 
-## 2.1.7 - 2026-09-11
+## [2.1.7] - 2026-09-11
 
 ### Added
 
@@ -47,7 +57,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 
 - Allowed Promise-returning event handlers in Vue templates and TSX attributes while retaining all other `no-misused-promises` checks.
 
-## 2.1.6 - 2026-09-11
+## [2.1.6] - 2026-09-11
 
 ### Added
 
@@ -63,31 +73,31 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Reduced syntax-only enforcement for type declarations, indexed objects, literal class properties, RegExp calls, dynamic object deletion, and static utility classes; deprecated APIs and apparently unnecessary runtime guards now warn instead of blocking builds.
 - Updated runtime and development dependencies to their latest compatible releases while retaining TypeScript 6, tsdown 0.22, and the existing peer compatibility ranges.
 
-## 2.1.5 - 2026-09-01
+## [2.1.5] - 2026-09-01
 
 ### Changed
 
 - Unified `extraFileExtensions: [".vue", ".nvue"]` across type-aware TypeScript, TSX, Vue, and NVue parsing so Project Service does not reload the project while linting mixed file types.
 
-## 2.1.4 - 2026-08-30
+## [2.1.4] - 2026-08-30
 
 ### Changed
 
 - Classified `@/**` root aliases as leading internal imports and moved the `type` group after every other non-style import group, while styles remain in their final stable group.
 
-## 2.1.3 - 2026-08-29
+## [2.1.3] - 2026-08-29
 
 ### Changed
 
 - Enabled `import-x/order` `sortTypesGroup` so separate type imports retain the final type group while sorting by their original source category within it.
 
-## 2.1.2 - 2026-08-29
+## [2.1.2] - 2026-08-29
 
 ### Changed
 
 - Changed `@typescript-eslint/consistent-type-imports` fixes from inline type specifiers to separate `import type` declarations.
 
-## 2.1.1 - 2026-08-29
+## [2.1.1] - 2026-08-29
 
 ### Added
 
@@ -98,7 +108,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Expanded the inline documentation for local ESLint rules and scoped overrides, including their purpose, important exceptions, and ownership of duplicate React checks.
 - Excluded stylesheet imports from `import-x/order` while preserving its grouping, alphabetizing, and `warnOnUnassignedImports` checks for all other imports.
 
-## 2.1.0 - 2026-08-26
+## [2.1.0] - 2026-08-26
 
 ### Added
 
@@ -125,27 +135,27 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 
 - Removed `defaultConfigOptions`, root language/framework/plugin switches, factory-level rules/globals/ignores, `typeChecked`, and `tsconfigRootDir`. Native trailing Flat Config and focused factories replace these wrapper options.
 
-## 2.0.10 - 2026-08-19
+## [2.0.10] - 2026-08-19
 
 ### Changed
 
 - Changed the default export to a ready-to-use Flat Config array that can be exported directly or spread into another configuration; configurable usage remains available through the named `fastConfig()` export.
 - Enabled Markdown, `package.json` sorting, and `tsconfig*.json` sorting by default while keeping React and Angular disabled by default.
 
-## 2.0.9 - 2026-08-10
+## [2.0.9] - 2026-08-10
 
 ### Changed
 
 - Allowed type-aware TypeScript configurations to forward `unknown` Promise rejection reasons without disabling `prefer-promise-reject-errors` for statically known non-`Error` values.
 
-## 2.0.8 - 2026-08-09
+## [2.0.8] - 2026-08-09
 
 ### Changed
 
 - Added prioritized import path groups for the uni-app, Vue, Element Plus, Fast Element Plus, Fast China, and Lodash ecosystems while keeping type-only imports in the dedicated type group.
 - Changed import group spacing to a compact no-blank-line style and normalized the repository imports to the new policy.
 
-## 2.0.7 - 2026-08-08
+## [2.0.7] - 2026-08-08
 
 ### Changed
 
@@ -153,7 +163,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Removed `src` and declaration maps that referenced unpublished source files while retaining self-contained runtime source maps.
 - Added package-contract coverage for the publish allowlist and source-map integrity.
 
-## 2.0.6 - 2026-08-04
+## [2.0.6] - 2026-08-04
 
 ### Changed
 
@@ -161,14 +171,14 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Simplified the test pipeline to runtime, type-contract, and package-contract verification by removing documentation- and comment-governance tests.
 - Included contribution and security documents in the published package and refreshed the engineering guidance for the current workflow.
 
-## 2.0.5 - 2026-08-02
+## [2.0.5] - 2026-08-02
 
 ### Changed
 
 - Upgraded public API documentation to complete TSDoc, including standard defaults, parameters, return values, thrown errors, remarks, examples, and package-level documentation.
 - Separated runtime, type-contract, rule-governance, and package-contract tests, and replaced the hard-coded release version assertion with SemVer and changelog consistency checks.
 
-## 2.0.4 - 2026-08-02
+## [2.0.4] - 2026-08-02
 
 ### Added
 
@@ -184,21 +194,21 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - Changed `createGlobalIgnores()` to return a config array like the other fragment factories, so direct composition consistently uses spread syntax.
 - Updated `@eslint-react/eslint-plugin`, `@eslint/config-inspector`, and `globals` within their existing compatible version ranges.
 
-## 2.0.3 - 2026-07-29
+## [2.0.3] - 2026-07-29
 
 ### Changed
 
 - Renamed the internal factory directory from `src/code` to the clearer `src/core` and updated all source and type-generation imports.
 - Expanded JSDoc for public and internal configuration interfaces, covering defaults, activation conditions, file scopes, option interactions, performance tradeoffs, and behavior intentionally left to project tooling.
 
-## 2.0.2 - 2026-07-29
+## [2.0.2] - 2026-07-29
 
 ### Changed
 
 - Moved the `fastConfig()` factory implementation to `src/code/index.ts` so the source layout groups the primary code entry consistently.
 - Inlined `defineRules()` into the root entry and kept `@fast-china/eslint-config/rules` focused on the documented raw rule records and generated `RuleOptions` type.
 
-## 2.0.1 - 2026-07-26
+## [2.0.1] - 2026-07-26
 
 ### Added
 
@@ -212,7 +222,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 - 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
+## [2.0.0] - 2026-07-26
 
 ### Added
 
@@ -230,3 +240,26 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 
 - 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.
+
+[2.1.10]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.9...v2.1.10
+[2.1.9]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.8...v2.1.9
+[2.1.8]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.7...v2.1.8
+[2.1.7]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.6...v2.1.7
+[2.1.6]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.5...v2.1.6
+[2.1.5]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.4...v2.1.5
+[2.1.4]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.3...v2.1.4
+[2.1.3]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.2...v2.1.3
+[2.1.2]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.1...v2.1.2
+[2.1.1]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.1.0...v2.1.1
+[2.1.0]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.10...v2.1.0
+[2.0.10]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.9...v2.0.10
+[2.0.9]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.8...v2.0.9
+[2.0.8]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.7...v2.0.8
+[2.0.7]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.6...v2.0.7
+[2.0.6]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.5...v2.0.6
+[2.0.5]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.4...v2.0.5
+[2.0.4]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.3...v2.0.4
+[2.0.3]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.2...v2.0.3
+[2.0.2]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.1...v2.0.2
+[2.0.1]: https://gitee.com/FastDotnet/fast.eslint.config/compare/v2.0.0...v2.0.1
+[2.0.0]: https://gitee.com/FastDotnet/fast.eslint.config/releases/tag/v2.0.0

package/CONTRIBUTING.md

@@ -30,7 +30,7 @@ Use `pnpm lint:fix` and `pnpm format` for safe mechanical fixes. `pnpm test` fir
 5. Preserve the documented JavaScript, TypeScript, and Vue behavior unless a release explicitly changes it; keep historical comparisons in the changelog rather than source comments.
 6. Keep organization-specific dependency restrictions out of this general-purpose package; projects should own those policies.
 7. Explain the purpose, rationale, and important exception or risk immediately above every local rule override.
-8. Document every default rule's severity and valid exceptions; every generated rule entry must have explicitly reviewed incorrect and correct code rather than placeholder comments. Keep repository overrides before third-party preset rules, verify `meta.fixable` before claiming auto-fix support, run `pnpm run docs:rules` after any rule or dependency change, and keep `docs/rules-risk.md` plus `docs/rules-risk.zh.md` synchronized.
+8. Document every default rule's severity and valid exceptions; every generated rule entry must have explicitly reviewed incorrect and correct code rather than placeholder comments. Keep repository overrides before third-party preset rules, verify `meta.fixable` before claiming auto-fix support, run `pnpm run docs:rules` after any rule or dependency change, and keep [rules-risk.en](http://docs.fastdotnet.cn/en-US/frontend/eslint-config/rules-risk) plus [rules-risk](http://docs.fastdotnet.cn/zh-CN/frontend/eslint-config/rules-risk) synchronized.
 9. Never sort a map whose key order has semantics, including conditional objects under `package.json#exports`.
 10. Regenerate `src/typegen.d.ts` whenever ESLint or a bundled plugin changes; confirm new rules and changed option schemas intentionally.
 11. Add or update an integration test for every parser, plugin, option, auto-fix, generated type, or public export change. The root API is intentionally limited to the Vue, UniApp, and framework-neutral project factories, their ready configurations, `defineRules`, and related types.

package/README.md

@@ -1,16 +1,20 @@
-<p align="left">
-	<a href="./README.zh.md">简体中文</a> | <strong>English</strong>
-</p>
+[简体中文](./README.zh.md) | **English**
 
 <p align="center">
-	<img src="./Fast.png" alt="logo" width="160" />
+	<img src="./Fast.png" width="128" alt="Fast.ESLint.Config Logo" />
 </p>
 
-# @fast-china/eslint-config
+<h1 align="center">Fast.ESLint.Config</h1>
+
+<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?logo=npm" alt="npm version" /></a>
+	<a href="https://www.npmjs.com/package/@fast-china/eslint-config"><img src="https://img.shields.io/npm/dm/@fast-china/eslint-config" alt="npm downloads" /></a>
+	<a href="./LICENSE"><img src="https://img.shields.io/npm/l/@fast-china/eslint-config" alt="License" /></a>
+</p>
 
-A practical ESLint Flat Config for Vue 3, UniApp, SDKs, Node.js, React, Angular, TypeScript, and JavaScript projects.
+Typed ESLint Flat Config for Vue 3, uni-app, TypeScript and Node.js, with optional framework integrations.
 
-The policy starts from common ecosystem conventions and concise, readable code. It then prioritizes real bugs and type safety, consistency, and finally Fast project preferences. It does not force unusual rewrites merely to satisfy ESLint.
+**[Documentation](http://docs.fastdotnet.cn/en-US/frontend/eslint-config/) · [Official website](http://fastdotnet.com)**
 
 ## Highlights
 
@@ -28,11 +32,15 @@ The policy starts from common ecosystem conventions and concise, readable code.
 - ESLint `^10.0.0`
 - TypeScript `^6.0.0`
 
+## Installation
+
 ```sh
 pnpm add -D eslint typescript @fast-china/eslint-config
 ```
 
-## Vue 3
+## Quick start
+
+Create `eslint.config.mjs` in the Vue 3 project:
 
 ```js
 import { vueConfig } from "@fast-china/eslint-config";
@@ -42,139 +50,43 @@ export default defineConfig([
 	...vueConfig,
 	{
 		name: "project/custom",
-		rules: {
-			"no-console": "warn",
-		},
+		rules: {},
 	},
 ]);
 ```
 
-This entry covers JavaScript, type-aware TypeScript, Vue SFCs, and standalone `.jsx`/`.tsx` components used by Vue projects. Vue JSX/TSX keeps checks for explicit emits, duplicate keys, readonly props, reactivity loss, and reserved component names without inheriting template-only kebab-case, attribute-order, or `v-text`/`v-html` rules. The entry also includes JSON, Import, RegExp, `.gitignore`, and Prettier compatibility without loading UniApp capabilities.
-
-## UniApp
-
-```js
-import { uniAppConfig } from "@fast-china/eslint-config";
-import { defineConfig } from "eslint/config";
-
-export default defineConfig([
-	...uniAppConfig,
-	{
-		name: "project/custom",
-		ignores: ["src/generated/**"],
-		rules: {
-			"no-console": "warn",
-		},
-	},
-]);
-```
-
-The UniApp entry adds `.nvue`, `uni`, `uniCloud`, page APIs, conditional-platform globals, the `unpackage` ignore, and comment handling for `pages.json` and `manifest.json`.
-
-ESLint does not execute `#ifdef` or `#endif`, so it can recognize platform objects but cannot prove that they occur in the correct branch. `.uvue` and `.uts` remain unsupported because they require dedicated parsers.
-
-## Factories and project overrides
-
-The root entry provides explicit named configurations and factories. Use a factory when the project needs to select its runtime environment or append overrides:
-
-```js
-import { createVueProjectConfigs, defineRules } from "@fast-china/eslint-config";
-import { defineConfig } from "eslint/config";
-
-export default defineConfig([
-	...createVueProjectConfigs({ environment: "universal" }),
-	{
-		name: "project/custom",
-		ignores: ["public/vendor/**"],
-		languageOptions: {
-			globals: {
-				__APP_VERSION__: "readonly",
-			},
-		},
-		rules: defineRules({
-			"no-console": "warn",
-		}),
-	},
-]);
+```sh
+pnpm exec eslint .
 ```
 
-Available factories:
-
-- `createVueProjectConfigs(options, ...overrides)`
-- `createUniAppProjectConfigs(options, ...overrides)`
-- `createBaseConfigs(options)` for framework-neutral Node.js, SDK, and explicit composition
-
-`environment` accepts `"browser"`, `"node"`, or `"universal"` and defaults to `"browser"`. Configuration, script, test, and CLI files always receive Node.js globals separately.
-
-Trailing Flat Config objects have the highest precedence. `defineRules()` returns its input unchanged and only adds precise rule typing.
-
-## TypeScript policy
+Type-aware source files must belong to the project tsconfig. The Vue configuration does not include uni-app capabilities.
 
-Type-aware files must belong to a `tsconfig.json` discoverable by Project Service.
+## Common usage
 
-- `explicit-module-boundary-types: "error"` requires explicit parameter and return types for exported `.ts`, `.mts`, and `.cts` functions and public boundaries of exported classes.
-- `.tsx` disables the module-boundary annotation requirement by default: component props remain type checked without forcing an otherwise inferable JSX return annotation.
-- `explicit-function-return-type: "off"` leaves internal functions, local handlers, and inline callbacks to TypeScript inference.
-- `no-inferrable-types` preserves explicit parameter and property types.
-- Vue/NVue SFCs and standalone TSX components do not require module-boundary or function-return annotations, retaining common concise component forms.
-- `no-floating-promises` is disabled because Promise waiting depends on business ordering and error semantics.
-- `no-void: "error"` rejects `void promise` and other `void` expressions as lint workarounds.
-- `require-await: "error"` requires removing `async` when there is no real `await`, avoiding changed return and exception semantics.
-- `no-misused-promises`, `await-thenable`, unsafe-type rules, and selected high-confidence type rules remain errors.
-- Standard non-null assertions are permitted; contradictory, redundant, or invalid assertions remain checked by focused rules.
-- Numbers and booleans may be interpolated directly in template strings, and runtime guards are not rejected merely because types make them look unnecessary.
-
-## JavaScript, Import, and Vue policy
-
-- `no-empty` permits a completely empty `catch` while reporting other empty blocks.
-- `camelcase: ["error", { properties: "never" }]` applies to variables and types while preserving external protocol property names.
-- Real-risk rules such as `no-eval`, `no-implied-eval`, `no-new-func`, and `no-debugger` remain errors.
-- `import-x/first`, `import-x/no-duplicates`, and `import-x/order` are errors; declaration ordering supports automatic fixes.
-- Common path groups cover UniApp, Vue, React, Angular, Vite, Element Plus, Fast, and Lodash. `@/**` is internal, and type imports do not participate in path-group matching.
-- `sort-imports` checks only member order inside one import declaration and does not order declarations.
-- `import-x/style-imports-last` keeps stylesheets in the final contiguous group without reordering that group internally.
-- Vue SFCs use the official `flat/recommended`; script-semantic checks for explicit emits, duplicate keys, readonly props, reactivity loss, and reserved component names also apply to Vue JSX/TSX.
-- Kebab-case attributes, template attribute ordering, and component `v-text`/`v-html` remain limited to `.vue/.nvue` templates; JSX attributes retain JavaScript camelCase conventions. `no-v-html` remains a warning.
-
-## React and Angular
+Use the independent uni-app entry rather than stacking both complete configurations:
 
 ```js
-import { createBaseConfigs } from "@fast-china/eslint-config";
-import { createReactConfigs } from "@fast-china/eslint-config/configs";
+import { uniAppConfig } from "@fast-china/eslint-config";
 import { defineConfig } from "eslint/config";
 
 export default defineConfig([
-	...createBaseConfigs(),
-	...createReactConfigs(),
+	...uniAppConfig,
 	{
 		name: "project/custom",
-		rules: { "no-console": "warn" },
+		rules: {},
 	},
 ]);
 ```
 
-Angular composes `createAngularConfigs()` in the same way. The base configuration loads neither Vue nor UniApp.
-
-## Optional capabilities and manifest sorting
-
-Markdown and Lodash import policy require explicit composition:
+For framework-independent Node.js projects:
 
 ```js
 import { createBaseConfigs } from "@fast-china/eslint-config";
-import { createMarkdownConfigs } from "@fast-china/eslint-config/configs";
-import { defineConfig } from "eslint/config";
 
-export default defineConfig([
-	...createBaseConfigs({ environment: "node" }),
-	...createMarkdownConfigs(),
-	{
-		name: "project/custom",
-		rules: { "no-console": "warn" },
-	},
-]);
+export default createBaseConfigs({ environment: "node" });
 ```
 
-`createBaseConfigs()`, `vueConfig`, and `uniAppConfig` all enable `package.json` and `tsconfig*.json` sorting by default. Package sorting does not enter conditional `exports` objects whose order has runtime meaning.
+Append project configuration after the shared preset; leave `rules: {}` empty until project-specific rules are needed. Use the configuration factories to customize the runtime environment. Fast repositories maintaining local rule copies continue following their own AGENTS.md synchronization policy.
 
 ## Public entries
 
@@ -189,8 +101,8 @@ Prettier does not run as an ESLint rule. The defaults only load `eslint-config-p
 
 ## Documentation
 
-- [Complete rule reference (Chinese)](./docs/rules/index.zh.md)
-- [Default rules and risk guide](./docs/rules-risk.md)
+- [Complete rule reference (Chinese)](http://docs.fastdotnet.cn/en-US/frontend/eslint-config/rules/)
+- [Default rules and risk guide](http://docs.fastdotnet.cn/en-US/frontend/eslint-config/rules-risk)
 - [Chinese engineering audit](./docs/engineering-audit.zh.md)
 - [Changelog](./CHANGELOG.md)
 
@@ -203,3 +115,17 @@ pnpm install --frozen-lockfile
 pnpm typegen
 pnpm check
 ```
+
+## Contribution and security
+
+[Contributing](./CONTRIBUTING.md) · [Security policy](./SECURITY.md)
+
+## Copyright, license and use
+
+Copyright © 2018-Now 小方. This project uses [Apache License 2.0](./LICENSE). Use, modification, distribution and commercial use are permitted subject to its terms.
+
+When redistributing, provide the license, mark modified files and preserve applicable copyright, attribution and supplied NOTICE information as required. This summary does not replace the license or impose additional UI attribution.
+
+Users are responsible for the legal compliance and authorization of their own modifications, deployment, data processing and operations. This reminder is not an additional license condition.
+
+Except as required by applicable law or agreed in writing, the software is provided on an "AS IS" basis. Sections 7 and 8 govern warranty disclaimers and liability limits. Providing the project does not endorse downstream activities or assume users' contractual commitments. This statement does not exclude liability that cannot lawfully be excluded.