Skip to content

README.md

Latest commit

 

History

History
36 lines (26 loc) · 5.32 KB

README.md

File metadata and controls

36 lines (26 loc) · 5.32 KB
Raw

CoreEx.CodeGen.RefData

Provides the reference-data code-generation pipeline: typed configuration models, generator classes, and the embedded Handlebars templates that together produce the full reference-data layer from a ref-data.yaml input file.

Overview

CoreEx.CodeGen.RefData contains all the moving parts of the reference-data generation workflow. The Config sub-namespace holds the three typed configuration models (CodeGenConfig, EntityConfig, PropertyConfig) that OnRamp deserialises from ref-data.yaml and enriches with defaults before passing to the generators. The Generators sub-namespace holds the six CodeGeneratorBase implementations that select the appropriate configuration nodes for each template pass. The Templates folder contains the embedded Handlebars (.hbs) templates, one per generated artefact type.

OnRamp drives the overall orchestration: ref-data-script.yaml (also embedded in the package) lists the generation steps in order — contract, controller, provider, repository interface, repository, mapper, then (mutable entities only) service interface, service and per-entity controller — binding each step to its generator class, template, output file name pattern, and output directory. The RootGenerator runs once against the whole CodeGenConfig for the single-file artefacts (provider, repository interface, repository); ApiGenerator similarly runs once for the controller template, but only when the Api project directory exists. ContractGenerator and MapperGenerator each iterate over the entity collection to produce one file per entity.

Key capabilities

  • 🗂️ Typed configuration hierarchy: CodeGenConfig → EntityConfig → PropertyConfig mirrors the YAML structure exactly; all defaults are resolved during the PrepareAsync phase before any template is evaluated.
  • ⚙️ Six-generator pattern: RootGenerator (single-file artefacts), ApiGenerator (single-file controller, conditional on the Api project existing), ContractGenerator (per-entity contracts), MapperGenerator (per-entity mappers, with opt-out support), RootMutableGenerator (service interface and service, only when any entity is mutable) and MutableApiGenerator (per-mutable-entity controller) cleanly separate the generation concerns.
  • ✏️ Readonly vs mutation: mutability is opt-in per entity (None / CreateUpdate / CreateUpdateDelete); see Readonly vs Mutation.
  • 📐 Embedded templates: Contract_cs.hbs, Controller_cs.hbs, MutableController_cs.hbs, Provider_cs.hbs, IService_cs.hbs, Service_cs.hbs, IRepository_cs.hbs, Repository_cs.hbs, Mapper_cs.hbs — all embedded in the package so consuming projects carry no template files.
  • 🔀 Property-level control: PropertyConfig supports ^-prefixed reference-data types, ?-suffixed nullable types, per-property model name overrides, and per-property exclusion from contract or mapping generation.

Key types

Type Description
CodeGenConfig Root configuration model; deserialised from ref-data.yaml and enriched with defaults for domain name, project paths, namespace strings, idType, collectionSortOrder, route, routeConvention, and the entity collection.
EntityConfig Per-entity configuration: name, plural, text, idType, collectionSortOrder, route, repository mode and parameter name, EF model name, mapper name, excludeMapper, mutability, validator, mutableAttribute, and the properties collection.
PropertyConfig Per-property configuration: name, type (with ^/? conventions), text, data model property name, excludeContract, and excludeMapping.
RootMutableGenerator Selects CodeGenConfig only when at least one entity is mutable; used by the service interface and service templates.
MutableApiGenerator Selects each mutable EntityConfig (when the Api project exists); produces one {Name}Controller.g.cs per mutable entity.
RootGenerator Selects CodeGenConfig itself as the generation target; used by the provider, repository interface, and repository templates to produce one file for the entire entity set.
ApiGenerator Selects CodeGenConfig only when the Api project directory exists; used by the controller template — API generation is skipped entirely (with a warning) when the Api project isn't found relative to the CodeGen project.
ContractGenerator Selects each EntityConfig in turn; produces one contract .g.cs file per reference-data entity.
MapperGenerator Selects each EntityConfig where excludeMapper is not true; produces one mapper .g.cs file per entity.

Related namespaces

  • CoreEx.CodeGen - Root package: CodeGenConsole entry point, CommandType enum, and the embedded ref-data-script.yaml that drives this pipeline.
  • CoreEx.CodeGen.Counting - Companion utility for reporting generated vs. hand-authored file and line counts.