naming-conventions

Enforces codebase naming rules for files, classes, database objects, and HTTP paths.

Updated Jul 26, 2026
One-click install
npx skills add https://github.com/aymansalkhatib/medledger --skill naming-conventions-aymansalkhatib
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: naming-conventions
Source: https://github.com/aymansalkhatib/medledger/tree/main/.claude/skills/naming-conventions
Command: npx skills add https://github.com/aymansalkhatib/medledger --skill naming-conventions-aymansalkhatib

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Inconsistent naming across folders, files, classes, database tables, and API routes creates confusion and technical debt. This Skill provides a single source of truth for every naming decision in a NestJS/TypeScript codebase, so names stay consistent as the project grows. ## Core Features & Use Cases - Comprehensive naming rules: Covers module folders, file suffixes, classes, interfaces, enums, variables, DB tables/columns/indexes, migrations, and HTTP paths with concrete examples. - Reserved verb vocabulary: Standardizes method names like findById, findByIdOrFail, and assert<Constraint> so teams stop inventing synonyms. - Three usage modes: check <path> audits a file for violations, propose <thing> generates compliant names for new code, and show prints the detailed reference. - Use Case: Before creating a new transfers module, ask the Skill to propose the folder structure, entity class, DTO names, and table/column names so everything matches the convention from day one. ## Quick Start Ask the assistant to check whether the names in a given source file follow the project's naming conventions and report any violations with proposed fixes.

Frequently Asked Questions about naming-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if a file follows project naming conventions?▼

Run the check mode with a file path, such as `/naming-conventions check src/modules/holdings/holding.service.ts`. It reads the file, reports each name that violates a rule, cites the rule, and proposes a corrected name without editing anything.

What naming convention should NestJS files and classes use?▼

Files use kebab-case with a role suffix like `holding.entity.ts` or `create-transfer.dto.ts`, while classes use PascalCase with a matching suffix like `HoldingEntity` or `CreateTransferDto`. Folders are plural kebab-case; files and classes are singular.

How should database tables, columns, and indexes be named?▼

Tables use plural snake_case like `ledger_entries`, columns use singular snake_case like `holding_id`, and indexes follow `idx_<table>_<cols>` or `uq_<table>_<cols>` for unique constraints. Enum types use the `<col>_enum` pattern.

Does the naming check rename files automatically?▼

No. The Skill never applies renames silently because renames cascade across callers. It runs a project-wide report first and asks you to confirm the scope before any edits are made.

When should an interface use the I prefix in TypeScript?▼

Use the `I` prefix only for DI or seam contracts that signal a swappable implementation, like `IWebhookDispatcher`. Shape-only DTOs use plain `type` aliases with no prefix, and single-implementation interfaces are discouraged.