SuperAPI AI 工具集

naming-conventions

通用与其它

查看项目

更新于 10-16 00:05

技能介绍

用途:为代码库提供统一的命名与组织规范,覆盖文件、目录、类、函数、变量、接口、DTO 和用例,适用于模块化单体与整洁架构项目。

主要能力:规定文件用 kebab-case 加描述性后缀(如 user.entity.ts、create-user.use-case.ts);目录集合用复数、功能模块用单数;类与接口用 PascalCase,接口不加 I 前缀,实现类用技术前缀(如 PostgresUserRepository);函数与变量用 camelCase,常量用 UPPER_SNAKE_CASE;布尔值以 is、has、can、should 开头;DTO 采用 Create{Entity}Dto、{Entity}ResponseDto 等模式;用例采用 {Verb}{Entity}UseCase。还给出有界上下文目录结构示例与提交前检查清单。

使用方式:在创建文件、目录、类、函数或变量,审查命名一致性,或重构代码时参考该规范。资料未提供安装命令或调用方式。

适用场景:模块化单体、整洁架构、领域驱动设计项目的命名与代码组织。

限制:资料未说明支持的编程语言范围、工具集成方式、收费或价格信息。