Package Description
Get Started
$ dotnet add package CodeGeneratorCLIReadme
CodeGeneratorCLI
CodeGeneratorCLI is a .NET Core command-line interface (CLI) tool that generates code based on provided arguments.
Getting Started
To use CodeGeneratorCLI, you can download the source code and build the project, or you can install the tool from NuGet using the following command:
dotnet tool install -g CodeGeneratorCLI
Once installed, you can run the tool from the command line using the CodeGeneratorCLI command.
Usage
CodeGeneratorCLI provides several commands for generating code based on different templates and settings.
Initialize
The init command initializes the templates that can be used as an example to generate code and is not required. You can specify the output directory for the templates using the --outDir option.
CodeGeneratorCLI init --outDir Templates
CustomTemplate
The custom-template command generates a new class based on a custom template. You can specify the path to the template using the --template-path option, and you can provide a settings JSON file using the --settings-file option.
CodeGeneratorCLI custom --template-path Templates --param ThisNamespaceName=MyApp.Models --param NamespaceName=MyApp.Models --param Name=MyModels --param SingularName=MyModel --settings-file ControllerGenerator/controller.template.settings.json
Settings Configuration File
Overview
The JSON configuration file contains directives for generating code in a .NET project. It specifies the base output path, notes for developers, and details about what projects and files need to be generated. Each entry under "Projects" represents a different part of the application (e.g., main app, tests) and contains a list of "Generations" which are specific files to be generated.
Example
{
"BaseOutPath": "",
"Projects": [
{
"DestinationRootFolderPath": ".",
"Generations": [
{
"TemplateRelativePath": "Commands\\Create_NAME_Command.cshtml",
"DestinationFolderPath": "C:\\source\\$(Name)\\Commands\\Create$(Name)Command.cs"
},
{
"TemplateRelativePath": "Handlers\\Create_NAME_Handler.cshtml",
"DestinationFolderPath": "C:\\source\\$(Name)\\Handlers\\Create$(Name)Handler.cs"
},
{
"TemplateRelativePath": "Queries\\Get_NAME_Query.cshtml",
"DestinationFolderPath": "C:\\source\\$(Name)\\Queries\\Get$(Name)Query.cs"
},
{
"TemplateRelativePath": "Responses\\Get_NAME_Response.cshtml",
"DestinationFolderPath": "C:\\source\\$(Name)\\Responses\\Get$(Name)Response.cs"
},
{
"TemplateRelativePath": "Validators\\Create_NAME_CommandValidator.cshtml",
"DestinationFolderPath": "C:\\source\\$(Name)\\Validators\\Create$(Name)CommandValidator.cs"
},
{
"TemplateRelativePath": "Controllers\\v2.0\\_PRULARNAME_Controller.cshtml",
"DestinationFolderPath": "C:\\source\\Services\\Profile\\Profile.API\\Controllers\\v2.0\\$(PrularName)Controller.cs"
}
]
}
],
"Notes": null
}
