Meziantou.NET.Sdk 1.0.127

Meziantou.NET.Sdk

MSBuild SDK that helps standardize build and quality settings across repositories. It provides:

• Opinionated defaults and naming conventions for .NET projects
• Best practices for build, CI, and test workflows
• A static analysis baseline with Roslyn analyzers
• Set ContinuousIntegrationBuild based on the context
• dotnet test features
  • Dump on crash or hang
  • Loggers when running on GitHub
  • Disable Roslyn analyzers to speed up build
• Relevant NuGet packages based on the project type

Blog post: Creating a custom MSBuild SDK to reduce boilerplate in dotnet projects

Usage

Method 1

To use it, create a global.json file at the solution root with the following content:

{
  "sdk": {
    "version": "9.0.304"
  },
  "msbuild-sdks": {
    "Meziantou.NET.Sdk": "1.0.16",
    "Meziantou.NET.Sdk.BlazorWebAssembly": "1.0.16",
    "Meziantou.NET.Sdk.Razor": "1.0.16",
    "Meziantou.NET.Sdk.Test": "1.0.16",
    "Meziantou.NET.Sdk.Web": "1.0.16",
    "Meziantou.NET.Sdk.WindowsDesktop": "1.0.16"
  }
}

And reference the SDK in your project file:

<Project Sdk="Meziantou.NET.Sdk">
</Project>

Method 2

You can the SDK by specifying the version inside the csproj file:

<Project Sdk="Meziantou.NET.Sdk/1.0.16">
</Project>

Method 3

<Project Sdk="Microsoft.NET.SDK">
    <Sdk Name="Meziantou.NET.Sdk" Version="1.0.16" />
</Project>

File-based apps (.NET 10+)

You can use the SDK with file-based apps using the #:sdk directive:

#:sdk Meziantou.NET.Sdk@1.0.16
Console.WriteLine("Hello from a file-based app!");

Then run with:

dotnet run Program.cs

You can also use it as an additional SDK alongside Microsoft.NET.Sdk:

#:sdk Microsoft.NET.Sdk
#:sdk Meziantou.NET.Sdk@1.0.16
Console.WriteLine("Hello!");

Build configuration properties

Set these properties in your project file or a directory-level props file. Unless stated otherwise, defaults apply only when the property is empty.

General build

Package validation and auditing

Banned symbols and analyzers

The SDK also blocks selected NuGet packages by default:

• YamlDotNet (use Meziantou.Framework.Yaml)
• CliWrap (use Meziantou.Framework.ProcessWrapper)
• Testcontainers (use Meziantou.Framework.TemporaryContainers)

Web SDK and containers

Packaging metadata

npm restore

Testing