菜单
Source of truth for naming — folders, files, classes, methods, DTOs, DB tables/columns/indexes, HTTP paths, i18n keys, migrations. Use when creating, renaming, or reviewing names. Triggers "/naming-conventions", "rename", "is this name correct".
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Add an HTTP endpoint to an existing module — updates the audience-scoped controller (creates one if needed), DTO, service method, and i18n keys for any new error messages. Triggers: "add an endpoint", "expose endpoint X on module Y", "add a route to <module>", "/add-endpoint".
Add a TypeORM entity to an existing module — entity file, repository, TypeOrmModule.forFeature registration, generated migration. Triggers: "add an entity", "add a table", "add <Entity> to module X", "/add-entity".
Add mirrored Arabic + English translation keys to src/infrastructure/i18n/translations/{ar,en}/<feature>.json, then regenerate translation-keys.ts via npm run i18n:sync. Triggers: "add a translation", a Translator.tr('<key>') call without a matching JSON key, "/add-i18n-keys".
Generate a new role-scoped controller for an existing module (e.g. admin-foo.controller.ts next to user-foo.controller.ts). Wires @Protected(Role.X), the path/version, and registers in the module. Triggers: "expose this module to admins/users", "add an admin controller for <module>", "/add-protected-controller".
Diagnose and break a circular dependency between NestJS modules or providers — without reaching for forwardRef. Triggers: Nest "circular dependency" / "can't resolve dependencies" startup error, "ModuleA imports ModuleB and back", a new cross-module service injection, "how do I avoid a cycle", "/circular-deps".
Apply when writing, reviewing, or removing comments. Triggers: /comments, "should I comment this", "is this comment good", "explain why this code does X".
| name | naming-conventions |
| description | Source of truth for naming — folders, files, classes, methods, DTOs, DB tables/columns/indexes, HTTP paths, i18n keys, migrations. Use when creating, renaming, or reviewing names. Triggers "/naming-conventions", "rename", "is this name correct". |
| user-invocable | true |
| argument-hint | [check <path>] | [propose <thing>] | [show <category>] |
| allowed-tools | Read, Grep, Glob |
Source of truth for every name in this codebase. If a rule here conflicts with an older file, the file is wrong — open a renaming PR.
| Thing | Case | Number | Example |
|---|---|---|---|
| Module folder | kebab-case | plural | src/modules/cities/ |
| Sub-folder | kebab-case | plural | controllers/, dto/, entities/ |
| File name | kebab-case | singular | city.entity.ts, create-city.dto.ts |
| Class | PascalCase | singular | CityEntity, AdminUserController |
| Interface (DI contract) | PascalCase + I | singular | IPaginatedResponse, IAuthUserResolver |
| Type alias | PascalCase | singular | MulterFile, PaginatedResult |
| Enum type | PascalCase | singular | Role, Gender |
| Enum member | UPPER_SNAKE | — | Role.ADMIN, OtpPurpose.USER_LOGIN |
| Function / method | camelCase | verb | findById, deactivateByAdmin |
| Variable / property | camelCase | noun | cityId, createdAt |
| Boolean | camelCase | is/has | isActive, isProfileCompleted |
| Constant (truly global) | UPPER_SNAKE | — | MAX_PAGE_SIZE |
| DB table | snake_case | plural | cities, refresh_tokens |
| DB column | snake_case | singular | user_id, created_at, is_active |
| DB FK column | <entity>_id | singular | city_id, user_id |
| DB enum type | <col>_enum | singular | role_enum |
| DB index | idx_<tbl>_<cols> | — | idx_areas_city_id |
| DB unique index | uq_<tbl>_<cols> | — | uq_cities_name_en |
| i18n namespace | kebab-case | singular | city, user |
| i18n key path | dot.snake_case | — | city.errors.not_found |
| Migration class | PascalCase | — | AddIsActiveToAccounts1747600000003 |
| HTTP path segment | kebab-case | plural | /admin/users, /admin/cities |
The rule: plural for collections (folders, tables, URL paths); singular for the thing itself (class, file, column).
| Concept | Verb | Not |
|---|---|---|
| Read one | findById, findOne | get, fetch, lookup, read |
| Read many | findAll | list, getMany, index |
| Read paginated | findPageFor<Audience> (svc + repo) | getPage, list, paginate* |
| Read or 404 | findByIdOrFail | getOrThrow, requireById |
| Predicate | is<State>, has<Thing> | check, verify |
| Throw-on-failure | assert<Constraint> | validate, ensure |
| Create draft | create (repo) | build, make |
| Persist | save (repo) | store, persist |
| Update | update (svc) / mergeAndSave (repo) | edit, modify |
| Remove | remove (controller) / delete (svc) / deleteById (repo) | destroy, purge |
| Soft-delete | softDelete* | archive, disable |
| Reactivate | restore* / reactivate* | revive |
| Translate | translator.tr(...) | t, i18n, localize |
| Domain action | domain verb: activate, deactivate, complete, rotate, revoke, seed | process, handle |
Other categories (methods, DTOs, DB columns, routes, i18n keys) are covered by the Quick Reference + Reserved verbs tables above.
Prefer rename now over let it accumulate — every additional caller makes the rename more expensive.
/naming-conventions [arg]:
check <path> — read the file, report each name that violates a rule, cite rule + proposed name. No edits.propose <thing> — given a short description, output the proposed file path, class name, method names, table/column names. No files written.show — print code-naming.md (folders, files, classes, enums, variables).Never apply renames silently. Renames cascade — run a project-wide report first and confirm scope with the user before editing.