Naming and Code Style

Requirement An aggregate-owned type's qualified name MUST start with its aggregate root's full name.

Rationale The name then reveals its owner without folder context. This covers events, states, child business records, values, and discriminated unions. A type nested inside a declaring type inherits that type's prefix through its qualified name. PostState.Published therefore satisfies this rule, and PostStatePublishedState repeats the anchor twice.

Example PostPublishedEvent and PostState.Published both lead with Post. PublishedState declared at namespace level does not.

Requirement An architectural type MUST carry the suffix its role assigns in the table in this section.

Example

In the dotnet stack, the repository interface carries the I prefix, options classes carry the Options suffix, and each scanned project carries an assembly marker.

An event-reaction folder names the business fact after an On prefix. It omits the Event suffix. For example, OnPostPublished contains NotifySubscribersOnPostPublishedHandler for PostPublishedEvent. The On prefix already marks the reaction. Folder names carry no technical suffix, so OnPostPublishedEvent is wrong. The event type keeps its Event suffix (litespec/workspace/naming#anchor-aggregate-owned-types-on-the-aggregate-root).

The example does not shorten an Application type to {UseCase}Result, {UseCase}Handler, or {UseCase}Validator. The example does not use an unowned name such as PostSummary for a query-specific result item. The full role suffix distinguishes command coordination from query projection without opening the file.

The example does not shorten an HTTP transport type to {UseCase}Request or {UseCase}Response. Model marks the type as passive boundary data rather than an operation or rich business object. Other project-owned, passive HTTP DTOs also name their concrete role and end in Model, such as ListPostsResponseItemModel or PaginationModel. The example uses ApiMappings instead of the context-dependent Mappings suffix.

A polymorphic transport model mirrors a Domain discriminated union (litespec/backend/api#mirror-a-domain-closed-set-as-a-transport-model-of-the-same-shape). Its abstract base names the concept. Each sealed case names its case. Both end in Model, such as FulfillmentOutcomeModel and ShippedFulfillmentOutcomeModel.

The transport name drops the Domain union's aggregate prefix, such as OrderFulfillmentOutcome. Its discriminator string keeps the Domain union's stable case code unchanged.

Requirement An asynchronous operation MUST reveal its asynchrony in its name and accept cancellation explicitly when the operation is cancelable.

Rationale A caller then sees both the asynchrony and the cancellation contract from the signature. An operation is cancelable when it performs I/O or awaits.

Requirement An exception name MUST state the rule that failed, using {DomainType}{Reason}Exception for a Domain rejection.

Rationale DomainType is the aggregate root or an anchored owned type, so the name always starts with the aggregate root.

Requirement A boolean property or method MUST use Is, Has, Can, or a precise verb.

Rationale HasLines and CanPublish state a condition. LinesPresent and CheckPublish state neither a question nor an answer.

Requirement Production code MUST target the pinned language version and use its current construct over an older equivalent.

Rationale In the dotnet stack, collection expressions, pattern matching, and primary constructors express the same intent with less incidental code.

Requirement A frontend folder MUST use kebab-case, a component file and its export PascalCase, and a React hook file use-{name}.

Rationale One predictable mapping lets a reader move between the documentation tree and the source tree without translation.