Naming Conventions

Type Naming

Use type declarations, not interface. This codebase follows type-driven development.

Type Naming Pattern:

typescript
1// CORRECT - Use type declarations
2export type BucketProps = {
3    bucketName: string;
4    env: EnvironmentConfig['env'];
5};
6
7export type EnvironmentConfig = {
8    name: string;
9    region: string;
10    account: string;
11};
12
13// INCORRECT - Don't use interface
14export interface BucketProps {
15    // ❌
16    bucketName: string;
17}

Resource Naming Pattern

Include environment and region to prevent naming collisions:

typescript
1// Resource naming pattern
2`${resourceName}-${props.env.name}-${props.env.region}`
3// Examples
4`aurora-cluster-dev-use1``api-gateway-prod-use1``waf-acl-staging-use1`;

Function Naming

Use verbNoun pattern for function names:

typescript
1// CORRECT
2export const createBucket = () => {};
3export const getVpcConfig = () => {};
4export const updateSecurityGroup = () => {};
5
6// INCORRECT
7export const bucketCreate = () => {};
8export const VpcConfigGet = () => {};

File Naming

• Constructs: kebab-case.ts (e.g., api-gateway.ts)
• Types: kebab-case-type.ts or kebab-case.ts in types directory
• Enums: kebab-case-enum.ts or kebab-case.ts in enum directory
• Utilities: kebab-case.ts in util directory

Export Patterns

• Each package exports from src/index.ts
• Root package exports from src/index.ts
• Use named exports, avoid default exports where possible