From 6a5006077b09fa054c660912cdfac22613ecc363 Mon Sep 17 00:00:00 2001 From: Lyda <1829913225@qq.com> Date: Wed, 4 Mar 2026 10:52:17 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=9C=A8=20JS/TS=20=E5=9F=BA=E7=A1=80?= =?UTF-8?q?=E8=A7=84=E8=8C=83=E5=92=8C=20NestJS=20=E8=A7=84=E8=8C=83?= =?UTF-8?q?=E4=B8=AD=E6=B7=BB=E5=8A=A0=E5=B8=B8=E9=87=8F=E5=AE=9A=E4=B9=89?= =?UTF-8?q?=E4=BD=8D=E7=BD=AE=E8=A7=84=E5=88=99,=E8=A6=81=E6=B1=82?= =?UTF-8?q?=E5=B8=B8=E9=87=8F=E6=94=BE=E5=9C=A8=E5=AF=B9=E5=BA=94=E6=A8=A1?= =?UTF-8?q?=E5=9D=97=E7=9A=84=20constants=20=E6=96=87=E4=BB=B6=E4=B8=AD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- references/js&ts.base.md | 20 ++++++++++++++++++++ references/js&ts.nest.md | 23 ++++++++++++++++++++++- 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/references/js&ts.base.md b/references/js&ts.base.md index d844125..368bc85 100644 --- a/references/js&ts.base.md +++ b/references/js&ts.base.md @@ -69,6 +69,26 @@ const maxCount = 100; const userStatus = "active"; ``` +## 基于 JsTs.Base.NoMagicStringsAndNumbers 抽离的静态常量需要放在对应文件里 `[JsTs.Base.ConstantsDefinition]` + +> - severity `warn` + +- 需要放在指定模块的 constants 文件里 + +### Good + +```javascript +// user.constants.js +const MAX_COUNT = 100; // 这是 user 模块需要的 +``` + +### Bad + +```javascript +// class.constants.js +const MAX_COUNT = 100; // 这是 user 模块需要的 +``` + ## class 和 interface 命名使用大驼峰命名 `[JsTs.Base.ClassUpperCamel]` > - severity `warn` diff --git a/references/js&ts.nest.md b/references/js&ts.nest.md index a5a6581..79563fc 100644 --- a/references/js&ts.nest.md +++ b/references/js&ts.nest.md @@ -1,6 +1,6 @@ # Nestjs 项目下的规范 `[JsTs.Nest]` -> - includes `*.controller.ts` `*.service.ts` `*.module.ts` `*.dto.ts` `*.pipe.ts` `*.guard.ts` `*.interceptor.ts` `*.filter.ts` `*.exception-filter.ts` `*.proxy.ts` `*.model.ts` +> - includes `*.controller.ts` `*.service.ts` `*.module.ts` `*.dto.ts` `*.pipe.ts` `*.guard.ts` `*.interceptor.ts` `*.filter.ts` `*.exception-filter.ts` `*.proxy.ts` `*.model.ts` `*.constants.ts` > - override `[JsTs.FileName]` ## 目录框架规范 `[JsTs.Nest.DirStructure]` @@ -248,3 +248,24 @@ export class UserProxy { ```typescript // proxy/user.js ``` + +## 基于 JsTs.Base.NoMagicStringsAndNumbers 抽离的静态常量需要放在对应文件里 `[JsTs.Nest.ConstantsDefinition]` + +> - severity `warn` +> - override `[JsTs.Base.ConstantsDefinition]` + +- 需要放在指定模块的 constants 文件里 + +### Good + +```typescript +// user.constants.ts +const MAX_COUNT = 100; // 这是 user 模块需要的 +``` + +### Bad + +```typescript +// class.constants.ts +const MAX_COUNT = 100; // 这是 user 模块需要的 +```