Nucleotide

Mission Statement

To provide a tool that automatically generates repeditive .NET code to allow better use of developers time.

Introduction

Nucleotide is a library to aid in the generation of .NET code for manipulation the following types of objects:

• Client\Server Services (Interfaces)
• Commands (Classes)
• Command Factory (Interfaces and Classes)
• Entity Framework DbSet (Classes)
• Entity Framework Models (Classes)
• Entity Framework Entity Type Configuration (Classes)
• Entity Framework Parent and Child Foreign Keys Representation (Interfaces)
• Models (Interfaces and Classes)
• MVC Controllers (Classes)
• Queries (Classes)
• Query Factories (Interfaces and Classes)
• Request DTO POCO Objects (Classes)
• Response DTO POCO Objects (Classes)
• SignalR Hubs (Classes)
• WCF Service classes (Classes)
• Web Api Client (Classes)
• Web Api Controllers (Classes)

This project leverages Roslyn functionality to combine a DSL style model with the power of the compiler to give a simple way to generate code.

Credits

• https://github.com/AArnott/CodeGeneration.Roslyn : Allowed the original migration away from T4 to Roslyn

Getting Started

Pre-requisites

You will need:

• An IDE \ Build chain that supports Roslyn (Recent versions of VSCode, Visual Studio, Jetbrains Rider, etc.)
• A project using
  • A supported version of .NET core (Version 8)
  • C# 9 language compiler settings or later

Before you start

You can use the following project structure

• Your generation model sits in a project above the project where it will be generated

flowchart TD
  GenProject(Generation Project) --> TargetProject(TargetProject)

Loading

• You can also have a common model, then sub projects used to generate specific code

flowchart TD
  CommonModel(Common Model Project) --> MvcGenProject(ASP.NET Core MVC Service Generation Project)
  MvcGenProject --> MvcSvcProject(ASP.NET Core MVC Project)
  CommonModel --> WebApiSvcGenProject(ASP.NET Core Web API Service Generation Project)
  CommonModel --> WebApiClientGenProject(Web API Client Generation Project)
  CommonModel --> WpfAppGenProject(Wpf App Generation Project)
  CommonModel --> CommonProject(Common Shared Code Project)
  WebApiClientGenProject --> WebApiClientProject(Web API Client Project)
  WebApiSvcGenProject --> WebApiSvcProject(Web API Service Project)
  WpfAppGenProject --> WpfAppProject(WPF App Project)
  CommonProject -.-> MvcSvcProject
  CommonProject -.-> WebApiClientProject
  CommonProject -.-> WebApiSvcProject
  CommonProject -.-> WpfAppProject

Loading

NOTE: There is an intention to simplify this use case to reduce the number of proxy projects.

flowchart TD
  CommonGenerationModel(Common Generation Model Project) --> MvcSvcProject(ASP.NET Core MVC Service Project)
  CommonGenerationModel --> CommonProject(Common Shared Code Project)
  CommonGenerationModel --> WebApiClientProject(Web API Client Project)
  CommonGenerationModel --> WebApiSvcProject(Web API Service Project)
  CommonGenerationModel --> WpfAppProject(WPF App Project)
  CommonProject -.-> MvcSvcProject
  CommonProject -.-> WebApiClientProject
  CommonProject -.-> WebApiSvcProject
  CommonProject -.-> WpfAppProject

Loading

2. Your code generation model is in Project1, while your generated code is in Project2.

Get the package (Single Project)

You want to install Nucleotide in the project where you want to place your generated model.

Install-Package Dhgms.Nucleotide

Get the package (Dual Project)

In project1.

1. Install-Package Dhgms.Nucleotide

2. Add Your Code Generation Models

3. Inherit the Code Generation Attributes.

In project2.

1. Reference Project1.

2. Install-Package Dhgms.Nucleotide

3. Apply the Assembly Code Generation Attributes.

Get started with a Code Generation Model

TODO.

Apply a Model Generation Attribute

TODO.

Viewing the documentation

The documentation can be found at http://dpvreony.github.io/nucleotide/

Contributing to the code

See the contribution guidelines.