enums

Enums

Critical

• Convention: TypeScript enum — the scaffold uses the language construct enum, not as const object literals. Stay consistent.
• Enum name: PascalCase (e.g., Messages, ApiEndpoints, Roles, StorageStatePaths).
• Enum member: SCREAMING_SNAKE_CASE (e.g., LOGIN_SUCCESS, CURRENT_USER, APP).
• Location: app-defined strings go in enums/{area}/*.ts; cross-app constants go in enums/util/*.ts. Do not invent a new top-level folder.
• JSDoc: every enum declaration must have a JSDoc comment describing what the enum groups.
• No hardcoded repeat strings. Any string used in more than one place — endpoint paths, UI messages, roles, storage-state paths — must live in an enum and be imported.
• Message values must match the real app. For enums that mirror UI text (error messages, success messages, validation text), the string must be captured via playwright-cli from the live app, not guessed.
• Edits to existing enum values go through refactor-values. Renaming a key or changing a value cascades through tests, page objects, and schemas.

File Locations

{area} is a placeholder. Before creating or referencing any path below, run ls enums/ to discover the real subdirectory names in this repo (e.g., front-office, back-office) and use those instead.

Type	Directory	Naming	Scaffold examples
App-specific enums	enums/{area}/	[name].ts	Messages, ApiEndpoints, StorageStatePaths (in enums/app/app.ts)
Shared / utility enums	enums/util/	[name].ts	Roles (in enums/util/roles.ts)

Instructions

Phase 1: Decide if the value belongs in an enum

Use this decision table. Each row points to the canonical home — use it to prevent enums/ from overlapping with config/ or test-data/static/.