Kiruyuto.DotNet.Config 2.4.5

Prefix Reserved

dotnet add package Kiruyuto.DotNet.Config --version 2.4.5

NuGet\Install-Package Kiruyuto.DotNet.Config -Version 2.4.5

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="Kiruyuto.DotNet.Config" Version="2.4.5">
  <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="Kiruyuto.DotNet.Config" Version="2.4.5" />
                    

                            Directory.Packages.props

<PackageReference Include="Kiruyuto.DotNet.Config">
  <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 Kiruyuto.DotNet.Config --version 2.4.5

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

#r "nuget: Kiruyuto.DotNet.Config, 2.4.5"

#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 Kiruyuto.DotNet.Config@2.4.5

#: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=Kiruyuto.DotNet.Config&version=2.4.5
                    

                            Install as a Cake Addin

#tool nuget:?package=Kiruyuto.DotNet.Config&version=2.4.5
                    

                            Install as a Cake Tool

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

Personal set of rules and analyzers distributed as a NuGet package to share configuration across .NET projects.

Heavily based on <a href="https://github.com/meziantou/">Gérald Barré (@Meziantou)</a>'s "<a href="https://www.meziantou.net/sharing-coding-style-and-roslyn-analyzers-across-projects.htm">Sharing coding style and Roslyn analyzers across projects</a>" post and his <a href="https://github.com/meziantou/Meziantou.DotNet.CodingStandard">CodingStandard</a> repository. This config contains rules changed and fine-tuned to my personal and work needs as well as preferences.

Usage

Add the NuGet package to your project, and the configs will be automatically imported.

It is recommended to use Directory.Build.props in your project over per .csproj configuration

This package bans EF Core's AddAsync and AddRangeAsync by default.
Projects that intentionally rely on async value generators, such as HiLo, can disable only those two bans using:

<Project>
  <PropertyGroup>
    <KiruyutoDotNetConfigEnableEntityFrameworkCoreAsyncAddBans>false</KiruyutoDotNetConfigEnableEntityFrameworkCoreAsyncAddBans>
  </PropertyGroup>
</Project>

Structure overview

Dependencies can be found in Kiruyuto.DotNet.Config.csproj
.globalconfig rule configurations are located in files/ directory
.props files are located in build/ directory. These are split into 'categories' for improved maintainability

Contributing

See CONTRIBUTING.md for guidelines, rule authoring, and local build/testing instructions.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

net10.0
- AsyncFixer (>= 2.1.0)
- Microsoft.CodeAnalysis.BannedApiAnalyzers (>= 3.3.4)
- Microsoft.EntityFrameworkCore.Analyzers (>= 10.0.8)
- Microsoft.VisualStudio.Threading.Analyzers (>= 17.14.15)
- SonarAnalyzer.CSharp (>= 10.25.0.139117)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.