Aksio.Defaults 1.6.8

.NET Standard 2.0
dotnet add package Aksio.Defaults --version 1.6.8
NuGet\Install-Package Aksio.Defaults -Version 1.6.8
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="Aksio.Defaults" Version="1.6.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aksio.Defaults --version 1.6.8
#r "nuget: Aksio.Defaults, 1.6.8"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Aksio.Defaults as a Cake Addin
#addin nuget:?package=Aksio.Defaults&version=1.6.8

// Install Aksio.Defaults as a Cake Tool
#tool nuget:?package=Aksio.Defaults&version=1.6.8

Defaults

Build Nuget Nuget

This repository contains the default setup for projects with properties for how they should build and also static code analysis for projects. It contains custom rules and the default rule-sets with the tuned rules we care about.

Read more about the custom analyzers here.

Getting Started

In your project all you need is to add a PackageReference to the package. The dotnet tool-chain will during build include any .props or .targets files found in the package by convention. From the .props file you'll get a lot of default configuration set up, it will put in package information saying it is an Aksio package and all the defaults of Aksio. This can be overridden if you're only interested in parts of the configuration.

If you're using an IDE such as Visual Studio, add a reference to the Aksio.Defaults package from the UI.

If you're using the dotnet tool you add the reference by doing the following from your terminal:

$ dotnet add package Aksio.Defaults

Or manually add the following to your .csproj - obviously for good measure, you should just add the <PackageReference> inside an existing <ItemGroup> with package references.

<ItemGroup>
    <PackageReference Include="Aksio.Defaults" Version="1.*" PrivateAssets="All"/>
</ItemGroup>

Note: The PrivateAssets="All" is important to not let the rules and setup affect any consumer of your package.

By using a wildcard for minor in the version of the packages, you're guaranteed to have the latest of the package.

For your spec projects there is a second package with specific rules for that context as we tend to write the specs differently; Aksio.Defaults.Specs.

MSBuild

This project relies heavily on MSBuild and its capabilities. It leverages both reserved well known properties and common project properties. It takes advantage of a feature in MSBuild that by convention will include props from a file named the same as its package name in any consumers. In our case this is the Aksio.Defaults.props and Aksio.Defaults.Specs.props.

Static Code Analysis

The props files configures a default behavior for builds with a common set of static code analysis rules and stylecop rules. In addition to this it provides a set of default NuGet metadata properties to ease the creation of projects that are to be published as NuGet packages.

Read more about the ruleset format and the default rulset. In addition, we leverage a 3rd party ruleset - read more about the different rules here.

This repository also adds custom Aksio rules. Read the documentation on the different rules.

With the introduction of Global AnalyserConfig one can take typical things one would hav ein .editorconfig files and package for reuse. This project does so as well by adding a global editorconfig. For examples on how these can be set up look here or here.

Debug vs Release

The default behavior of the static code analysis is to have it disabled while building with the Debug Configuration. Typically for CI/CD pipelines we run in Release and will therefor run all rules there.

If one wants to check things before committing or finalizing a pull request for instance, one could run the build with Release configuration

$ dotnet build --configuration Release

You can still enable the static code analysis rules by adding the following PropertyGroup to your .csproj or Directory.Build.props file:

<PropertyGroup>
    <RunAnalyzers>True</RunAnalyzers>
    <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
    <MSBuildTreatWarningsAsErrors>True</MSBuildTreatWarningsAsErrors>
</PropertyGroup>

Note: It is also possible to run this command as a Git Hook either on commit, pre-push or pre-receive for instance, read more here. Since most hooks run on the client and is not configured for the repository, its harder to share in a team. Recommend reading this.

Packages

NuGet packages that are published on the public NuGet feed should adhere to the defined best practices. The default props file puts in most of the metadata, but some of it is specific to each project and should be included specifically in the .csproj or Directory.Build.props.

Add the following properties and configure them according to your project:

<PropertyGroup>
    <IsPackable>true</IsPackable>
    <RepositoryUrl>https://github.com/aksio-system/{repository}</RepositoryUrl>
    <PackageProjectUrl>https://github.com/aksio-system/{repository}</PackageProjectUrl>
</PropertyGroup>

In addition you might want to include the README file of your project. Add the following with the correct relative filepath to the README file:

<PropertyGroup>
    <PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
    <Content Include="../README.md" PackagePath="/" />
</ItemGroup>
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.6.8 474 10/14/2022
1.6.7 735 9/30/2022
1.6.6 561 9/6/2022
1.6.6-pr83.33f98e0 38 9/30/2022
1.6.5 52 9/6/2022
1.6.4 502 5/24/2022
1.6.3 224 5/4/2022
1.6.2 70 5/4/2022
1.6.1 71 5/4/2022
1.6.0 78 5/4/2022
1.5.15 658 4/24/2022
1.5.14 121 4/18/2022
1.5.13 76 4/18/2022
1.5.12 77 4/17/2022
1.5.11 84 4/16/2022
1.5.10 215 3/25/2022
1.5.9 74 3/25/2022
1.5.8 397 1/15/2022
1.5.7 83 1/15/2022
1.5.6 86 1/15/2022
1.5.5 91 1/15/2022
1.5.4 89 1/14/2022
1.5.3 84 1/14/2022
1.5.2 84 1/14/2022
1.5.1 91 1/14/2022
1.5.0 85 1/14/2022
1.4.12 137 12/16/2021
1.4.11 103 12/16/2021
1.4.10 99 12/16/2021
1.4.9 118 12/16/2021
1.4.8 96 12/15/2021
1.4.7 111 12/15/2021
1.4.6 105 12/15/2021
1.4.5 107 12/15/2021
1.4.4 112 12/15/2021
1.4.3 104 12/15/2021
1.4.2 105 12/15/2021
1.4.1 112 12/15/2021
1.4.0 100 12/15/2021
1.3.1 99 12/15/2021
1.2.6 111 12/15/2021
1.2.5 104 12/15/2021
1.2.4 96 12/14/2021
1.2.3 90 12/14/2021
1.2.2 100 12/14/2021
1.2.1 109 12/6/2021
1.2.0 114 12/6/2021
1.1.19 99 11/23/2021
1.1.18 180 10/28/2021
1.1.17 137 10/27/2021
1.1.16 122 10/26/2021
1.1.15 120 10/13/2021
1.1.14 104 10/13/2021
1.1.13 122 10/6/2021
1.1.12 118 10/1/2021
1.1.11 160 9/22/2021
1.1.10 148 9/17/2021
1.1.9 228 9/15/2021
1.1.8 215 9/15/2021
1.1.7 214 9/15/2021
1.1.6 228 9/15/2021
1.1.5 223 9/15/2021
1.1.3 195 9/14/2021
1.1.2 206 9/14/2021
1.1.1 315 9/14/2021
1.1.0 207 9/14/2021
1.0.2 213 9/14/2021
1.0.1 220 9/14/2021