This document describes the naming conventions used across the CROP-parts-services codebase.

Naming Conventions

This document describes the naming conventions used across the CROP-parts-services codebase.

File Naming

Type	Pattern	Examples
Routes	`kebab-case.ts`	`admin-index.ts`, `cart-sync.ts`, `ctr-analytics.ts`
Services	`kebab-case-service.ts`	`cache-invalidation-service.ts`, `dis-service.ts`
Config	`kebab-case.ts`	`elasticsearch.ts`, `mongodb.ts`
Transformer configs	`kebab-case.config.ts`	`briggs-stratton.config.ts`, `hotsy.config.ts`
Types	`kebab-case.ts`	`search.ts`, `part.ts`
Tests	`*.test.ts`	`search.test.ts`, `transformers.test.ts`

Environment Variables

Naming Pattern: `UPPER_SNAKE_CASE`

Connection Variables (Full Name Prefix)

Used for connection credentials and URLs:

MONGODB_URI - MongoDB connection string
MONGODB_DB_NAME - Database name
ELASTICSEARCH_URL - Elasticsearch cluster URL
ELASTICSEARCH_USERNAME - Basic auth username
ELASTICSEARCH_PASSWORD - Basic auth password
ELASTICSEARCH_API_KEY - API key authentication

Feature/Config Variables (Short Prefix)

Used for feature flags and configuration:

ES_REQUEST_TIMEOUT_MS - Request timeout
ES_QUERY_TIMEOUT - Query timeout
ES_PIT_ENABLED - Point-in-time pagination
ES_LOG_QUERIES - Query logging
CTR_TRACKING_ENABLED - Click-through tracking
CTR_BATCH_SIZE - Batch size for CTR events

Convention Rationale: Connection credentials use full prefix (ELASTICSEARCH_*) for clarity in secrets management. Runtime config uses short prefix (ES_*) for brevity.

Type/Interface Naming

Type	Pattern	Examples
Types	`PascalCase`	`IndexedPart`, `SearchDocument`, `Manufacturer`
Schemas	`PascalCaseSchema`	`SearchQuerySchema`, `PartSchema`
Enums	`PascalCaseEnum`	`PriceBucketEnum`, `CatalogLevelEnum`
Inferred types	`PascalCase`	`type Part = z.infer<typeof PartSchema>`