feat: 更新 JS/TS 基础规范,将魔法字符串检查规则重命名为仅检查魔法数字,并提升常量定义位置规则严重级别至 error,同时补充 constants 文件命名规则说明

This commit is contained in:
Lyda
2026-04-08 15:52:28 +08:00
parent 041b02c793
commit fc6a0174b9
+5 -4
View File
@@ -39,11 +39,11 @@ function getuserinfo() {
}
```
## 禁止使用字面量魔法字符串和魔法数字 `[JsTs.Base.NoMagicStringsAndNumbers]`
## 禁止使用字面量魔法数字 `[JsTs.Base.NoMagicVar]`
> - severity `warn`
- 只检查数字、字符串、正则字面量,不要检查其他(比如 布尔字面量、对象字面量、函数字面量、数组字面量)
- 只检查数字、正则字面量,不要检查其他(比如 布尔字面量、对象字面量、函数字面量、数组字面量、字符串字面量
- 这块只检查含义不明确的字面量,比如 0 1 500 等,像是 'user' 'admin' 'active' 'inactive' 等是合理的
- 无需检查单词是否完整拼写
- throw 的错误信息无需审查
@@ -69,11 +69,12 @@ const maxCount = 100;
const userStatus = "active";
```
## 基于 JsTs.Base.NoMagicStringsAndNumbers 抽离的静态常量需要放在对应文件里 `[JsTs.Base.ConstantsDefinition]`
## 基于 JsTs.Base.NoMagicVar 抽离的静态常量需要放在对应文件里 `[JsTs.Base.ConstantsDefinition]`
> - severity `warn`
> - severity `error`
- 需要放在指定模块的 constants 文件里
- constants 命名规则: user.constants.js 或者 constants.js 或者 user.constants.ts 或者 constants.ts
### Good