CTMGenerator 1.1.0
dotnet add package CTMGenerator --version 1.1.0
NuGet\Install-Package CTMGenerator -Version 1.1.0
<PackageReference Include="CTMGenerator" Version="1.1.0" />
<PackageVersion Include="CTMGenerator" Version="1.1.0" />
<PackageReference Include="CTMGenerator" />
paket add CTMGenerator --version 1.1.0
#r "nuget: CTMGenerator, 1.1.0"
#:package CTMGenerator@1.1.0
#addin nuget:?package=CTMGenerator&version=1.1.0
#tool nuget:?package=CTMGenerator&version=1.1.0
Code To Model Project Model and Source Code Generator - CTMGenerator
A code-first modeling approach utilizing NMF.
Getting started
Once the generator package is added to a project it will run in the background of every build process.
The minimum requirements to have a model created and code generate are:
- An assembly entry for the model interface namespace above the namespace declaration.
- An interface with the ModelInterface attribute.
- The interface needs to either be partial or have IModelElement as base type.
Example interface implementation:
using NMF.Models;
using CTMLib;
[assembly: ModelMetadata("http://github.com/CodeToModel", "CodeToModel.Example.MyExample.nmeta")]
namespace CodeToModel.Example {
[ModelInterface]
public interface IMyExample : IModelElement {
}
}
Comments
To have summary and remarks doc comments transfered to the model elements and generated source code add GenerateDocumentationFile to the .csproj file and set it to true.
Location of generated files
Model location
By default the created model files will be saved to the location of the first file containing the model annotations. This behavior can be overriden by providing a OutputPaths.xml file, added via the <AdditionalFiles Include="OutputPaths.xml"/> property in the .csproj, with the following structure:
<paths>
<path namespace="ALL OR FULL NAMESPACE NAME">
C:\FULL\ABSOLUTE\PATH\TO\DESIRED\LOCATION
</path>
</paths>
ALL means this path will be used for every namespace which has no previously defined path.
Generated source code location
By default generated code will not be directly visible and just be part of the compilation. Should it be desired to have the generated files put in a specific location adding the following properties to the .csproj file will achive it:
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>OUTPUT/LOCATION</CompilerGeneratedFilesOutputPath>
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- CTMLib (>= 1.1.0)
- NMF-Basics (>= 2.0.449)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on CTMGenerator:
| Package | Downloads |
|---|---|
|
CTMAnalyzer
Analyzer for the CTMGenerator Package. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Added default value attribute support.