File Naming Convention
project structure & convention
| Category | Purpose | Naming Convention | Example |
|----------------|----------------------------|------------------------------------|----------------------------------|
| **Business Logic** | Controller | <resource>.controller.ts | s3Backend.controller.ts |
| **Business Logic** | Manager | <resource>.manager.ts | s3Backend.manager.ts |
| **Business Logic** | Service | <resource>.service.ts | s3Backend.service.ts |
| **Configuration** | Configuration | <resource>.config.ts | s3Backend.config.ts |
| **Data** | Model | <resource>.model.ts | s3Backend.model.ts |
| **Data** | Repository | <resource>.repository.ts | s3Backend.repository.ts |
| **Definition** | Constants | <resource>.constants.ts | s3Backend.constants.ts |
| **Definition** | Enum | <resource>.enum.ts | s3Backend.enum.ts |
| **Definition** | Interface Definitions | <resource>.interfaces.ts | s3Backend.interfaces.ts |
| **Middleware** | Middleware | <resource>.middleware.ts | s3Backend.middleware.ts |
| **Resource** | Main Resource | <resource>.<type>.helper.ts | s3Backend.resource.ts |
| **Resource** | Resource Helper | <resource>.<type>.helper.ts | s3Backend.helper.ts |
| **Resource** | Terraform Resource Helper | <resource>.terraform.helper.ts | s3Backend.terraform.helper.ts |
| **Testing** | Mock Data | <resource>.mocks.ts | s3Backend.mocks.ts |
| **Testing** | Test | <resource>.<filename>.test.ts | s3Backend.test.ts |
| **Utility** | Factory | <resource>.factory.ts | s3Backend.factory.ts |
| **Utility** | Prop Generator | <resource>.props.generator.ts | s3Backend.props.generator.ts |
| **Utility** | Transformer | <resource>.transformer.ts | s3Backend.transformer.ts |
| **Utility** | Utility Functions | <resource>.utils.ts | s3Backend.utils.ts |
| **Utility** | Validator | <resource>.validator.ts | s3Backend.validator.ts |
Note: Replace <resource>
with the specific resource name (e.g., s3Backend
, iamIdentity
, ec2Instance
).
Last updated
Was this helpful?