mirror of
https://github.com/samiyev/puaros.git
synced 2025-12-28 07:16:53 +05:00
111 lines
2.7 KiB
TypeScript
111 lines
2.7 KiB
TypeScript
/**
|
|
* Naming Convention Detector Constants
|
|
*
|
|
* Following Clean Code principles:
|
|
* - No magic strings
|
|
* - Single source of truth
|
|
* - Easy to maintain
|
|
*/
|
|
|
|
/**
|
|
* Files to exclude from naming convention checks
|
|
*/
|
|
export const EXCLUDED_FILES = [
|
|
"index.ts",
|
|
"BaseUseCase.ts",
|
|
"BaseMapper.ts",
|
|
"IBaseRepository.ts",
|
|
"BaseEntity.ts",
|
|
"ValueObject.ts",
|
|
"BaseRepository.ts",
|
|
"BaseError.ts",
|
|
"DomainEvent.ts",
|
|
"Suggestions.ts",
|
|
] as const
|
|
|
|
/**
|
|
* File suffixes for pattern matching
|
|
*/
|
|
export const FILE_SUFFIXES = {
|
|
SERVICE: "Service.ts",
|
|
DTO: "Dto.ts",
|
|
REQUEST: "Request.ts",
|
|
RESPONSE: "Response.ts",
|
|
MAPPER: "Mapper.ts",
|
|
CONTROLLER: "Controller.ts",
|
|
REPOSITORY: "Repository.ts",
|
|
ADAPTER: "Adapter.ts",
|
|
} as const
|
|
|
|
/**
|
|
* Path patterns for detection
|
|
*/
|
|
export const PATH_PATTERNS = {
|
|
USE_CASES: "/use-cases/",
|
|
USE_CASES_ALT: "/usecases/",
|
|
} as const
|
|
|
|
/**
|
|
* Common words for pattern matching
|
|
*/
|
|
export const PATTERN_WORDS = {
|
|
REPOSITORY: "Repository",
|
|
I_PREFIX: "I",
|
|
} as const
|
|
|
|
/**
|
|
* Error messages for naming violations
|
|
*/
|
|
export const NAMING_ERROR_MESSAGES = {
|
|
DOMAIN_FORBIDDEN:
|
|
"Domain layer should not contain DTOs, Controllers, or Request/Response objects",
|
|
USE_PASCAL_CASE: "Use PascalCase noun (e.g., User.ts, Order.ts, Email.ts)",
|
|
USE_DTO_SUFFIX: "Use *Dto, *Request, or *Response suffix (e.g., UserResponseDto.ts)",
|
|
USE_VERB_NOUN: "Use verb + noun in PascalCase (e.g., CreateUser.ts, UpdateProfile.ts)",
|
|
USE_CASE_START_VERB: "Use cases should start with a verb",
|
|
} as const
|
|
|
|
/**
|
|
* DDD folder names for aggregate boundary detection
|
|
*/
|
|
export const DDD_FOLDER_NAMES = {
|
|
ENTITIES: "entities",
|
|
AGGREGATES: "aggregates",
|
|
VALUE_OBJECTS: "value-objects",
|
|
VO: "vo",
|
|
EVENTS: "events",
|
|
DOMAIN_EVENTS: "domain-events",
|
|
REPOSITORIES: "repositories",
|
|
SERVICES: "services",
|
|
SPECIFICATIONS: "specifications",
|
|
DOMAIN: "domain",
|
|
CONSTANTS: "constants",
|
|
SHARED: "shared",
|
|
FACTORIES: "factories",
|
|
PORTS: "ports",
|
|
INTERFACES: "interfaces",
|
|
ERRORS: "errors",
|
|
EXCEPTIONS: "exceptions",
|
|
} as const
|
|
|
|
/**
|
|
* Repository method suggestions for domain language
|
|
*/
|
|
export const REPOSITORY_METHOD_SUGGESTIONS = {
|
|
SEARCH: "search",
|
|
FIND_BY_PROPERTY: "findBy[Property]",
|
|
GET_ENTITY: "get[Entity]",
|
|
CREATE: "create",
|
|
ADD_ENTITY: "add[Entity]",
|
|
STORE_ENTITY: "store[Entity]",
|
|
UPDATE: "update",
|
|
MODIFY_ENTITY: "modify[Entity]",
|
|
SAVE: "save",
|
|
DELETE: "delete",
|
|
REMOVE_BY_PROPERTY: "removeBy[Property]",
|
|
FIND_ALL: "findAll",
|
|
LIST_ALL: "listAll",
|
|
DEFAULT_SUGGESTION:
|
|
"Use domain-specific names like: findBy[Property], save, create, delete, update, add[Entity]",
|
|
} as const
|