skills.rest
crmagz
crmagzCOMMUNITY
Explore all skills by this author →
GitHub

naming-conventions

Enforce TypeScript naming conventions for types, functions, files, and resources.

6|Updated Dec 26, 2025
Search Tags:#typescript#refactoring#codebase#conventions#best-practices#naming
One-click install
npx skills add https://github.com/crmagz/cdk-constructs-library --skill naming-conventions-crmagz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: naming-conventions
Source: https://github.com/crmagz/cdk-constructs-library/tree/main/.claude/skills/naming-conventions
Command: npx skills add https://github.com/crmagz/cdk-constructs-library --skill naming-conventions-crmagz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent naming across a codebase makes code harder to read, review, and refactor. This skill provides clear rules for how to name types, functions, files, and resources to improve predictability and collaboration.

Core Features & Use Cases

  • Type Naming: Use PascalCase for types and enums; use camelCase for functions and variables.
  • Resource Naming Pattern: Include environment and region in resource names to avoid collisions and improve traceability.
  • File and Export Conventions: Use kebab-case for construct files and explicit named exports to improve discoverability.
  • Consistency Across Projects: Apply the same naming rules across packages to simplify onboarding and tooling.
  • Real-world Use Case: When adding a new AWS construct, apply these conventions to generate file names, type definitions, and export names.

Quick Start

Follow these conventions when introducing new code by renaming a resource to include env and region, name a type as EnvironmentConfig, and export functions with camelCase.

Frequently Asked Questions about naming-conventions

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

FAQPage Schema
What's the best way to standardize naming conventions in a TypeScript codebase?▼

To standardize naming conventions, use PascalCase for types, camelCase for functions, and kebab-case for files to reduce cognitive load and improve maintainability across packages.

How do I name resources in a multi-package repository to avoid environment collisions?▼

Include the environment and region in resource names to avoid collisions and improve traceability across multi-package repositories during implementation and reviews.

When do I need to include environment and region in file or resource names?▼

Include environment and region in resource names when adding new constructs to avoid collisions, improve traceability, and ensure resource discoverability across different deployment targets.

Does this naming approach work for both type definitions and file exports?▼

Yes, applying PascalCase to type definitions like EnvironmentConfig and using explicit named exports with kebab-case file names improves discoverability and consistency across the codebase.

How do I apply consistent naming rules when adding a new AWS construct?▼

When adding an AWS construct, apply naming rules by including env and region in resource names, defining types in PascalCase, and exporting functions in camelCase to maintain codebase predictability.

Why does inconsistent naming make refactoring a codebase harder?▼

Inconsistent naming makes refactoring harder because unpredictable type, function, and file names increase cognitive load, making code difficult to read, review, and collaborate on across packages.

Related Skills

Explore More Software Engineering Skills→
kensauruskensaurus
8

codebase-coherency

Audit codebases for naming, organization, and architectural pattern consistency.

Community
Advanced
lonewolfyxlonewolfyx
2

ts-type-naming

Enforce TypeScript interface and type naming conventions with file-location rules.

Community
Intermediate
jdubrayjdubray
27

coding-standard-javascript

Enforce JavaScript/TypeScript naming conventions for files, variables, functions, classes, and constants.

Community
Intermediate
ahandselahandsel
1

ux-key-reviewer

Validate UX copy key naming conventions in Markdown tables against project style guides.

Community
Intermediate