更改规范文档为规则文档

weihongyu12 · weihongyu12 · commit 0e9da3724cae · 2025-09-25T21:28:35.000+08:00
diff --git a/docs/specification/rule/README.md b/docs/specification/rule/README.md
@@ -2,9 +2,9 @@
 sidebar_position: 1
 ---
 
-# 代码规范
+# 代码规则
 
-本文档集合定义了项目中所有编程语言和框架的代码规范，旨在保证代码质量、提高团队协作效率、降低维护成本。每个开发者都应当熟悉并遵循这些规范。
+本文档集合定义了项目中所有编程语言和框架的代码规则，旨在保证代码质量、提高团队协作效率、降低维护成本。每个开发者都应当熟悉并遵循这些规则。
 
 ## 通用原则
 
@@ -18,7 +18,7 @@ sidebar_position: 1
 
 ## 规范执行工具
 
-项目使用多种工具自动执行规范检查：
+项目使用多种工具自动执行规则检查：
 
 - **[ESLint](https://eslint.org/)** - JavaScript/TypeScript 代码检查
 - **[Stylelint](https://stylelint.io/)** - CSS/Sass 代码检查
@@ -28,25 +28,25 @@ sidebar_position: 1
 
 每个规范文档中都详细说明了相关工具配置和使用方法。
 
-## 规范概览
+## 规则概览
 
-以下是各类技术栈的规范文档：
+以下是各类技术栈的规则文档：
 
 ### HTML
 
-HTML 规范专注于标签语义化和优化 DOM 结构，确保页面代码的可读性和可访问性：
+HTML 规则专注于标签语义化和优化 DOM 结构，确保页面代码的可读性和可访问性：
 
 - 强调语义化标签使用（如 `<article>`, `<section>`, `<nav>` 等）
 - 减少不必要的 DOM 层级，优化页面性能
 - 遵循 `html-validate:recommended` 标准进行验证
 - 确保正确的元素嵌套关系和属性使用
 - 标签闭合和属性格式的一致性
 
-[查看 HTML 规范详情](./html/)
+[查看 HTML 规则详情](./html/)
 
 ### CSS
 
-CSS 规范基于 `stylelint-config-twbs-bootstrap` 配置，注重代码组织和性能优化：
+CSS 规则基于 `stylelint-config-twbs-bootstrap` 配置，注重代码组织和性能优化：
 
 - 使用 CSS 命名规范（如 BEM 或 OOCSS）
 - 避免过度特定的选择器，减少选择器嵌套
@@ -55,15 +55,15 @@ CSS 规范基于 `stylelint-config-twbs-bootstrap` 配置，注重代码组织
 - 采用简写属性提高代码简洁性
 - 遵循移动优先的响应式设计原则
 
-[查看 CSS 规范详情](./css/)
+[查看 CSS 规则详情](./css/)
 
 :::tip
 参见 [Airbnb CSS/Sass 风格指南](https://github.com/airbnb/css) 和 [Airbnb CSS-in-JS 风格指南](https://airbnb.io/javascript/css-in-javascript/)
 :::
 
 ### SCSS
 
-SCSS 规范继承自 CSS 规范，并扩展了预处理器特有的最佳实践：
+SCSS 规则继承自 CSS 规则，并扩展了预处理器特有的最佳实践：
 
 - 合理组织变量、Mixin 和函数
 - 避免深层次的选择器嵌套（不超过 3 层）
@@ -72,11 +72,11 @@ SCSS 规范继承自 CSS 规范，并扩展了预处理器特有的最佳实践
 - 采用一致的变量命名方式（kebab-case）
 - 避免在 Mixin 中生成大量重复代码
 
-[查看 SCSS 规范详情](./scss/)
+[查看 SCSS 规则详情](./scss/)
 
 ### JavaScript
 
-JavaScript 规范采用 `eslint-config-airbnb-base` 作为基础配置，强调现代 JS 特性和最佳实践：
+JavaScript 规则采用 `eslint-config-airbnb-base` 作为基础配置，强调现代 JS 特性和最佳实践：
 
 - 优先使用 ES6+ 语法特性（箭头函数、解构、模板字符串等）
 - 避免副作用，倾向于函数式编程理念
@@ -85,15 +85,15 @@ JavaScript 规范采用 `eslint-config-airbnb-base` 作为基础配置，强调
 - 一致的代码格式化（缩进、空格、分号等）
 - 模块化设计，明确的导入/导出规则
 
-[查看 JavaScript 规范详情](./javascript/)
+[查看 JavaScript 规则详情](./javascript/)
 
 :::tip
 参见 [Airbnb JavaScript 风格指南](https://airbnb.io/javascript/)
 :::
 
 ### TypeScript
 
-TypeScript 规范基于 `eslint-config-airbnb-typescript`，聚焦于类型安全和 TS 特性正确使用：
+TypeScript 规则基于 `eslint-config-airbnb-typescript`，聚焦于类型安全和 TS 特性正确使用：
 
 - 严格的类型检查（启用 `strict` 模式）
 - 合理使用接口（Interface）和类型别名（Type）
@@ -103,11 +103,11 @@ TypeScript 规范基于 `eslint-config-airbnb-typescript`，聚焦于类型安
 - 正确处理 null 和 undefined 值
 - 适当使用高级类型（联合类型、交叉类型、映射类型等）
 
-[查看 TypeScript 规范详情](./typescript/)
+[查看 TypeScript 规则详情](./typescript/)
 
 ### React
 
-React 规范基于 `eslint-config-airbnb` 和 React 团队推荐实践，关注组件设计和性能：
+React 规则基于 `eslint-config-airbnb` 和 React 团队推荐实践，关注组件设计和性能：
 
 - 函数组件和 Hooks 优先
 - 组件职责单一，提倡组合而非继承
@@ -122,11 +122,11 @@ React 规范基于 `eslint-config-airbnb` 和 React 团队推荐实践，关注
 参见 [Airbnb React 风格指南](https://airbnb.io/javascript/react/)
 :::
 
-[查看 React 规范详情](./react/)
+[查看 React 规则详情](./react/)
 
 ### Vue
 
-Vue 规范采用 Vue 官方推荐的最佳实践，适配 Vue 3 的新特性：
+Vue 规则采用 Vue 官方推荐的最佳实践，适配 Vue 3 的新特性：
 
 - 组合式 API 与选项式 API 的使用场景区分
 - 单文件组件（SFC）的格式规范
@@ -137,15 +137,15 @@ Vue 规范采用 Vue 官方推荐的最佳实践，适配 Vue 3 的新特性：
 - Vue Router 和 Pinia/Vuex 的集成规范
 - 可测试性设计考量
 
-[查看 Vue 规范详情](./vue/)
+[查看 Vue 规则详情](./vue/)
 
 :::tip
 参见 [Vue 风格指南](https://vuejs.org/style-guide/)
 :::
 
 ### Next.js
 
-Next.js 规范聚焦于服务端渲染和性能优化的最佳实践：
+Next.js 规则聚焦于服务端渲染和性能优化的最佳实践：
 
 - 页面路由和布局组织方式
 - 数据获取策略（SSR、SSG、ISR、CSR）
@@ -156,11 +156,11 @@ Next.js 规范聚焦于服务端渲染和性能优化的最佳实践：
 - 合理使用 Next.js 特有组件（如 Image, Link, Script）
 - SEO 和性能优化策略
 
-[查看 Next.js 规范详情](./nextjs/)
+[查看 Next.js 规则详情](./nextjs/)
 
 ### Jest
 
-Jest 测试规范定义了单元测试和集成测试的编写准则：
+Jest 测试规则定义了单元测试和集成测试的编写准则：
 
 - 测试文件组织和命名约定
 - 测试套件和用例的结构设计
@@ -171,11 +171,11 @@ Jest 测试规范定义了单元测试和集成测试的编写准则：
 - 持续集成中的测试策略
 - 测试驱动开发（TDD）的实践指南
 
-[查看 Jest 规范详情](./jest/)
+[查看 Jest 规则详情](./jest/)
 
 ### Testing Library
 
-Testing Library 规范定义了基于用户行为的测试编写准则，适用于 React 和 Vue 等框架：
+Testing Library 规则定义了基于用户行为的测试编写准则，适用于 React 和 Vue 等框架：
 
 - 优先使用用户可见的查询方式（getByRole、getByText 等）
 - 异步操作的正确处理（await async queries/events）
@@ -186,11 +186,11 @@ Testing Library 规范定义了基于用户行为的测试编写准则，适用
 - 测试清理和隔离机制
 - 调试工具的正确使用
 
-[查看 Testing Library 规范详情](./testing-library/)
+[查看 Testing Library 规则详情](./testing-library/)
 
 ### Playwright
 
-Playwright 端到端测试规范定义了 E2E 测试的编写和组织方式：
+Playwright 端到端测试规则定义了 E2E 测试的编写和组织方式：
 
 - 页面对象模式的实现
 - 测试环境和浏览器配置
@@ -201,4 +201,4 @@ Playwright 端到端测试规范定义了 E2E 测试的编写和组织方式：
 - 并行测试执行策略
 - 测试报告和失败分析方法
 
-[查看 Playwright 规范详情](./playwright/)
+[查看 Playwright 规则详情](./playwright/)
diff --git a/docs/specification/rule/css/README.md b/docs/specification/rule/css/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# CSS 规范
+# CSS 规则
 
 :::tip
 优先使用以下方案，减少 CSS 代码的编写：
diff --git a/docs/specification/rule/html/README.md b/docs/specification/rule/html/README.md
@@ -3,7 +3,7 @@ sidebar_position: 1
 ---
 
 
-# HTML 规范
+# HTML 规则
 
 :::warning
 HTML Validate 规则参考 `html-validate:recommended`，但是由于需要整理的内容非常多，在开发过程中，仍以实际的 HTML Validate 检查为准。本章内容仅供参考
diff --git a/docs/specification/rule/javascript/README.md b/docs/specification/rule/javascript/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-# JavaScript 规范
+# JavaScript 规则
 
 ## Airbnb
 
diff --git a/docs/specification/rule/jest/README.md b/docs/specification/rule/jest/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 6
 ---
 
-# Jest 规范
+# Jest 规则
 
 [`eslint-plugin-jest`](https://github.com/jest-community/eslint-plugin-jest) 针对 Jest 测试框架的推荐规则，用于确保测试文件的语法和最佳实践符合 Jest 的要求，例如检查测试用例的命名、断言的使用等。
 
diff --git a/docs/specification/rule/nextjs/README.md b/docs/specification/rule/nextjs/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-# Next.js 规范
+# Next.js 规则
 
 [`@next/eslint-plugin-next`](https://nextjs.org/docs/app/api-reference/config/eslint) 是针对 Next.js 框架的官方推荐规则集。它会检查 Next.js 项目中的常见错误和最佳实践，例如确保 `next/image` 组件的正确使用，或者 `Link` 组件的 `href` 属性格式正确等，有助于编写符合 Next.js 规范的代码。
 
diff --git a/docs/specification/rule/playwright/README.md b/docs/specification/rule/playwright/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 7
 ---
 
-# Playwright 规范
+# Playwright 规则
 
 [`eslint-plugin-playwright`](https://github.com/mskelton/eslint-plugin-playwright) 插件是为使用Playwright进行 E2E 测试的项目而设计的。它提供了 Playwright 官方推荐的规则，确保 Playwright 测试代码符合最佳实践，从而提高测试的可靠性和可读性。
 
diff --git a/docs/specification/rule/react/README.md b/docs/specification/rule/react/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 4
 ---
 
-# React 规范
+# React 规则
 
 ```js
 // .eslintrc.js
diff --git a/docs/specification/rule/scss/README.md b/docs/specification/rule/scss/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# SCSS 规范
+# SCSS 规则
 
 ```js
 // stylelint.config.js
diff --git a/docs/specification/rule/security/README.md b/docs/specification/rule/security/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 8
 ---
 
-# 安全规范
+# 安全规则
 
 ## no-unsanitized
 
@@ -20,8 +20,8 @@ module.exports = {
 
 | 规则名称 | 错误级别 | 配置选项 | 描述 |
 |----------|----------|----------|------|
-| [`no-unsanitized/method`](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/docs/rules/method.md) | error | - | 检查 JavaScript 中不安全的 DOM 方法调用（如 `insertAdjacentHTML`），防止未经消毒的内容被插入页面，以避免 XSS 攻击 |
-| [`no-unsanitized/property`](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/docs/rules/property.md) | error | - | 检查 JavaScript 中不安全的 DOM 属性赋值（如 `innerHTML` 和 `outerHTML`），防止未经消毒的内容被插入页面，以避免 XSS 攻击 |
+| [no-unsanitized/method](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/docs/rules/method.md) | error | - | 检查 JavaScript 中不安全的 DOM 方法调用（如 `insertAdjacentHTML`），防止未经消毒的内容被插入页面，以避免 XSS 攻击 |
+| [no-unsanitized/property](https://github.com/mozilla/eslint-plugin-no-unsanitized/blob/main/docs/rules/property.md) | error | - | 检查 JavaScript 中不安全的 DOM 属性赋值（如 `innerHTML` 和 `outerHTML`），防止未经消毒的内容被插入页面，以避免 XSS 攻击 |
 
 ## RisXSS
 
@@ -43,6 +43,6 @@ module.exports = {
 
 | 规则名称 | 错误级别 | 配置选项 | 描述 |
 |----------|----------|----------|------|
-| [`risxss/catch-potential-xss-react`](https://github.com/theodo/RisXSS/blob/master/docs/rules/catch-potential-xss-react.md) | error | - | 用于检测 React 应用中潜在的 XSS 风险，例如对 `dangerouslySetInnerHTML` 的不安全使用。 |
-| [`risxss/catch-potential-xss-vue`](https://github.com/theodo/RisXSS/blob/master/docs/rules/catch-potential-xss-vue.md) | error | - | 用于检测 Vue 应用中潜在的 XSS 风险，例如对 `v-html` 指令的不安全使用。 |
+| [risxss/catch-potential-xss-react](https://github.com/theodo/RisXSS/blob/master/docs/rules/catch-potential-xss-react.md) | error | - | 用于检测 React 应用中潜在的 XSS 风险，例如对 `dangerouslySetInnerHTML` 的不安全使用。 |
+| [risxss/catch-potential-xss-vue](https://github.com/theodo/RisXSS/blob/master/docs/rules/catch-potential-xss-vue.md) | error | - | 用于检测 Vue 应用中潜在的 XSS 风险，例如对 `v-html` 指令的不安全使用。 |
 
diff --git a/docs/specification/rule/tailwindcss/README.md b/docs/specification/rule/tailwindcss/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# Tailwind CSS 规范
+# Tailwind CSS 规则
 
 [`eslint-plugin-tailwindcss`](https://github.com/francoismassart/eslint-plugin-tailwindcss) 旨在强制执行使用 Tailwind CSS 时的最佳实践和代码一致性。它的唯一目的就是通过 ESLint 来自动化 Tailwind CSS 的最佳实践，比如按照 Tailwind CSS 的官方排序来重新排列你的类，确保你的 CSS 类始终保持有序、高效和无错误，从而提高项目的可维护性。
 
diff --git a/docs/specification/rule/testing-library/README.md b/docs/specification/rule/testing-library/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 6
 ---
 
-# Testing Library 规范
+# Testing Library 规则
 
 [`eslint-plugin-testing-library`](https://github.com/testing-library/eslint-plugin-testing-library) 插件专注于 React/Vue 组件的测试，特别是当你在使用 Testing Library 时。它会强制执行一些最佳实践，编写出更符合用户行为、更可维护的 React/Vue 测试。
 
diff --git a/docs/specification/rule/typescript/README.md b/docs/specification/rule/typescript/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-# TypeScript 规范
+# TypeScript 规则
 
 [`eslint-config-airbnb-typescript`](https://github.com/iamturns/eslint-config-airbnb-typescript) 是一个针对 TypeScript 的 Airbnb 风格扩展，它允许在 TypeScript 项目中使用 Airbnb 的规则。它通常需要与 [@typescript-eslint/parser](https://typescript-eslint.io/packages/parser/) 和 [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/packages/eslint-plugin/) 一起使用。
 
diff --git a/docs/specification/rule/vue/README.md b/docs/specification/rule/vue/README.md
@@ -2,7 +2,7 @@
 sidebar_position: 4
 ---
 
-# Vue 规范
+# Vue 规则
 
 [`eslint-plugin-vue`](https://eslint.vuejs.org/) 是 Vue 官方推荐的规则集。它专注于 Vue 单文件组件（`.vue`文件）的特定规则，来确保Vue组件的正确性和最佳实践。
 
