bottlenoselabs.Sdk

A C# SDK with common stuff for all C# projects at Bottlenose Labs.

Developers: How to use

1. Pin the SDK version in a global.json file above your C# projects:

   {
     "msbuild-sdks": {
       "bottlenoselabs.Sdk": "1.0.0"
     }
   }

2. Use the SDK in your .csproj instead of Microsoft.NET.Sdk:

   <Project Sdk="bottlenoselabs.Sdk">
   
     <PropertyGroup>
       <OutputType>Exe</OutputType>
       <TargetFramework>net10.0</TargetFramework>
     </PropertyGroup>
   
   </Project>

What the SDK sets

Area	Property	Value
Output	UseArtifactsOutput	true
Output	ArtifactsPath	<Git repository root>/artifacts, or <project directory>/artifacts outside a Git repository
Project	Company, Authors	bottlenoselabs
Project	Copyright	© <current year> Bottlenose Labs Inc.
Project	Version	0.0.0.0-pre when not set
Language	LangVersion	latest
Language	Nullable, ImplicitUsings	enable
Language	AllowUnsafeBlocks	true
Build	GenerateDocumentationFile	true
Build	MSBuildTreatWarningsAsErrors	true
Build	TieredCompilation, PublishReadyToRun	false
Platform	IsWindows, IsMacOS, IsLinux, IsFreeBSD	true on the current operating system
Platform	Architecture, Is32Bit, Is64Bit	Current CPU architecture, in lowercase (x64, arm64, ...)
Platform	DefineConstants	WINDOWS, MACOS, LINUX or FREEBSD
Code analysis	IsEnabledAnalyzers	true; set to false to turn off
Code analysis	AnalysisMode, AnalysisLevel	all, latest
Code analysis	TreatWarningsAsErrors	true
Code analysis	Rules	CodeAnalysis/BottlenoseLabs.globalconfig
NuGet	IsPackable	false
NuGet	PackageOutputPath	<Git repository root>/nupkg
NuGet	PackageId	bottlenoselabs.<AssemblyName> when not set
NuGet	PackageIcon	Bottlenose Labs icon.png when not set

Everything above is set before your project file is read, so any of it can be overridden in the .csproj or in a Directory.Build.props file.

To override an analyzer or code style rule, add it to an .editorconfig file in your repository:

[*.cs]
dotnet_diagnostic.IDE0055.severity = warning