AebSolutions.CodeConvention.SolutionTemplates 6.0.0

💻 Solution Templates

Solution templates for the .NET command-line interface using dotnet new, and Visual Studio 2022.

The templates have a focus on database connection and coding standards.

ℹ️ Language: C#

Entity Framework Core is used for database access with the following providers available to select.

• Microsoft SQL Server
• SQLite

StyleCop is used for coding conventions and file header creation.

💻 Features

Projects

The following projects will be appended to the solution/project name. example: MyAppName.ConsoleUI, MyAppName.Core, etc.

• ConsoleUI (Console)

• Core (Library)

• Data (Library)

• WebUI (Razor Pages)

Files

Example files:

• Person entity class
• Person configuration class

StyleCop

A stylecop.json file is included and configurations added based on the options selected below.

Options

• Company (Optional)

The company or author name for the solution. If left empty, the company will be omitted from the file header.

• License Identifier

The license identifier for the solution. If the default selection None is selected, no LICENSE file will be created and the license identifier will be omitted from the file header.

• Database (Optional)

The name of the initial database for the solution. If left empty, the solution name will be used.

• Database Provider

The Entity Framework Core database provider for the initial database connection. The default selection is SqlServerLocalDB

create-database.bat

Creates the initial database using dotnet ef commands. Right-Click the file in Visual Studio (located under Solution Items), and select Execute File.

💻 Templates

💡 Requirements

• Visual Studio 2022 (For Visual Studio use only)
• .NET 6.0
• Entity Framework Core tools for .NET Core CLI
• SQL Server Express

💡 Installation

.NET CLI

dotnet new --install AebSolutions.CodeConvention.SolutionTemplates::6.0.0

Visual Studio 2022

❔ Help

dotnet new cc-full --help

Code Convention Full Solution (C#)
Author: Aeb Solutions
Description: A solution for creating an application focused on database connection and coding standards.
This template contains technologies from parties other than Microsoft, see https://github.com/bboy77/Templates/ for details.
Options:                                                                                                                         
  -c|--company              The company or author name for the solution.                                                         
                            string - Optional                                                                                    

  -db|--database            The name of the initial database for the solution.                                                   
                            string - Optional                                                                                    

  -dbp|--database-provider  The Entity Framework Core database provider.                                                         
                                Sqlite              - SQLite database provider for Entity Framework Core.                        
                                SqlServerExpress    - Microsoft SQL Server (Express) database provider for Entity Framework Core.
                                SqlServerLocalDB    - Microsoft SQL Server (LocalDB) database provider for Entity Framework Core.
                            Default: SqlServerLocalDB                                                                            

  -li|--license-identifier  The Software Package Data Exchange (SPDX) license identifier for the solution.                       
                                Apache-2.0      - Apache License 2.0                                                             
                                BSD-3-Clause    - BSD 3-Clause "New" or "Revised" License                                        
                                GPL-3.0         - GNU General Public License v3.0                                                
                                MIT             - MIT License                                                                    
                                None            - No license                                                                     
                                Unlicense       - The Unlicense                                                                  
                            Default: None

ℹ️ Usage Examples

Longhand

dotnet new cc-full --company "My Company Name" --database MyCompanyData --database-provider SqlServerExpress --license-identifier MIT --name "MyDataApp" --output "MyDataApp"
dotnet new cc-full --company "John E. Sanchez" --database Stats --database-provider SqlServerLocalDB --license-identifier BSD-3-Clause --name StatsApp --output StatsApp
dotnet new cc-full --company "Sandra M. Smith" --database Accounts --database-provider Sqlite --license-identifier Apache-2.0 --name AccountsApp --output AccountsApp

Shorthand

dotnet new cc-full -c "My Company Name" -db MyData -dbp SqlServerExpress -li MIT -n "MyDataApp" -o "MyDataApp"
dotnet new cc-full -c "John E. Sanchez" -db Stats -dbp SqlServerLocalDB -li BSD-3-Clause -n StatsApp -o StatsApp
dotnet new cc-full -c "Sandra M. Smith" -db Accounts -dbp Sqlite -li Apache-2.0 -n AccountsApp -o AccountsApp

ℹ️ Resources

• Sayed Ibrahim Hashimi: template-sample
• .NET Core Template Engine