Aksio.CodeAnalysis 1.6.8

Defaults

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>