Basilisque.CommonBuild 1.0.0

Requires NuGet 4.0 or higher.

dotnet add package Basilisque.CommonBuild --version 1.0.0

NuGet\Install-Package Basilisque.CommonBuild -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Basilisque.CommonBuild" Version="1.0.0">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Basilisque.CommonBuild" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Basilisque.CommonBuild">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Basilisque.CommonBuild --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Basilisque.CommonBuild, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Basilisque.CommonBuild@1.0.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Basilisque.CommonBuild&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Basilisque.CommonBuild&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Basilisque - Common Build

Overview

This project provides optional common build configuration for projects that use the Basilisque framework. But it also can be used without Basilique.
So if you like the contained configuration feel free to use it, otherwise simply don't.

Description

This project doesn't contain any assemblies that will be deployed with the target project. Instead it only contains build time configuration (.props/.targets-files, ...) to provide a common basic set of configuration to all target projects.

Usage

Simply installing this NuGet package will automatically include the contained .props and .targets files in the build. For more information about how this can be configured, please see the GitHub page.

Conventions

The configuration is based on conventions regarding the names of the target projects. (The folder structure of the solution is irrelevant.)

ExampleSolution

MyProject.Service
Containing the startup code of a backend (Windows) service

MyProject.Service.Tests
Containing automated tests. In this case for the MyProject.Service-project

MyProject.API
Containing the public facing code of the backend (API-Controllers, ...)

MyProject.API.Tests
Containing automated tests. In this case for the MyProject.API-project

MyProject.Domain
Containing the business logic

MyProject.Domain.Tests
Containing automated tests. In this case for the MyProject.Domain-project

MyProject.DataAccess
Containing the data access layer (e.g. using Entity Framework)

MyProject.DataAccess.Tests
Containing automated tests. In this case for the MyProject.DataAccess-project

MyProject.Benchmarks
Containing benchmarks for a project

MyProject.CodeAnalysis
Containing code analysis support for the project like source generators, analyzers and fixes

Obviously not all applications need all of those project types. So e.g. if you don't need data access, then just do not create a project named like it. But if you do need data access, then let the project name end with .DataAccess. That is the intention behind the configuration in Basilisque.CommonBuild.

Provided Configuration

The package provides many different default configurations and versioning. For detailed information, please have a look at the GitHub page:

License

The Basilisque framework (including this repository) is licensed under the Apache License, Version 2.0.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Basilisque.CommonBuild:

Package	Downloads
Basilisque.CommonFrameworkBuild This project provides common build configuration for all parts of the Basilisque framework. It is NOT recommended to use this unless you're developing a part of the framework.	4.4K