squirix.analyzers 0.1.8

dotnet add package squirix.analyzers --version 0.1.8

NuGet\Install-Package squirix.analyzers -Version 0.1.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="squirix.analyzers" Version="0.1.8">
  <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="squirix.analyzers" Version="0.1.8" />
                    

                            Directory.Packages.props

<PackageReference Include="squirix.analyzers">
  <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 squirix.analyzers --version 0.1.8

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

#r "nuget: squirix.analyzers, 0.1.8"

#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 squirix.analyzers@0.1.8

#: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=squirix.analyzers&version=0.1.8
                    

                            Install as a Cake Addin

#tool nuget:?package=squirix.analyzers&version=0.1.8
                    

                            Install as a Cake Tool

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

Squirix.Analyzers

Design-time Roslyn analyzers for the squirix ecosystem.

Purpose

Squirix.Analyzers hosts the custom Roslyn diagnostics that enforce squirix's internal coding conventions across its repositories: brace style, member-size limits, naming rules, and code-smell guards. They are applied at build time and their findings are surfaced as compiler diagnostics (fail the build when TreatWarningsAsErrors is active).

Installation

Add the package reference from nuget.org:

<ItemGroup>
    <PackageReference Include="squirix.analyzers" Version="0.1.0"
                      PrivateAssets="all" OutputItemType="Analyzer"/>
</ItemGroup>

The package ships the analyzer assembly under analyzers/dotnet/cs, so it is loaded as a Roslyn analyzer at build time.

The root .editorconfig carries the severity configuration for the SQR diagnostics. Copy it (or the relevant dotnet_diagnostic.SQR000x entries) into the consuming repository's .editorconfig.

Some rules read their thresholds from per-rule .editorconfig options. SQR0002 defaults SQR0002.max_methods_per_type to 20 methods per type, and SQR0003 defaults SQR0003.max_fields_per_type to 15 fields per type. Add the key under a [*.cs] section in the consuming repository's .editorconfig, e.g.:

[*.cs]
SQR0002.max_methods_per_type = 30

Rules

Rules are prefixed with SQR. Detailed documentation, including non-compliant/compliant examples, lives in docs/rules. No rule ships an auto-fix (code fix provider) yet.

Rule	Category	Analyzer	What it enforces
`SQR0001`	Style	`OmitOuterLoopBracesAnalyzer`	Outer loop body is only a nested loop: drop braces.
`SQR0002`	Design	`TooManyMethodsAnalyzer`	Cap instance/static methods per type (default 20).
`SQR0003`	Design	`TooManyFieldsAnalyzer`	Cap non-literal, non-static-readonly fields (default 15).
`SQR0004`	Naming	`TypeNameTooLongAnalyzer`	Type name at most 40 characters.
`SQR0005`	Naming	`MethodNameTooLongAnalyzer`	Method name at most 40 chars (accessors drop prefix).
`SQR0006`	Naming	`FieldNameTooLongAnalyzer`	Field name at most 40 characters.
`SQR0007`	Naming	`TypeNamespacePrefixAnalyzer`	Type name must not repeat its namespace segment.
`SQR0008`	Style	`RequireMultilineLoopBodyBracesAnalyzer`	Require braces on multi-line loop bodies.
`SQR0009`	Style	`RedundantNamedArgumentAnalyzer`	Prefer positional args; drop names in declaration order.
`SQR0010`	Style	`OmitSingleStatementBracesAnalyzer`	Omit braces for single-line bodies; keep multi-line.
`SQR0011`	Style	`RedundantDefaultArgumentAnalyzer`	Omit arguments equal to the parameter default.
`SQR0012`	Style	`PreferEqualityOperatorAnalyzer`	Prefer ==/!= over is/is-not for null checks.
`SQR0013`	Style	`PreferEqualityOperatorAnalyzer`	Prefer == over is when comparing to a constant.
`SQR0014`	Style	`PreferEqualityOperatorAnalyzer`	Prefer != over is-not when comparing to a constant.
`SQR0015`	Concurrency	`NoBoolDisposedFieldAnalyzer`	Dispose guard must be an int flag via Interlocked.
`SQR0016`	Concurrency	`NoBoolDisposedFieldAnalyzer`	int dispose flag only via Interlocked/Volatile.
`SQR0017`	Usage	`NoDirectTestContextCancelTokenAnalyzer`	Don't use TestContext.Current.CancellationToken directly.
`SQR0018`	Style	`RequireMultilineIfBodyBracesAnalyzer`	Require braces on multi-line if/else bodies.
`SQR0019`	Usage	`NoAllocatingThrowsAssertAnalyzer`	Avoid allocating exception assert invocations.
`SQR0020`	Usage	`MergeDuplicateCatchBlocksAnalyzer`	Merge consecutive catch blocks with identical bodies.
`SQR0021`	Usage	`UseArgumentExceptionThrowHelperAnalyzer`	Prefer ArgumentException.ThrowIf* over manual guards.
`SQR0022`	Usage	`UseTimeSpanThrowHelperAnalyzer`	Prefer ArgumentOutOfRangeException.ThrowIf* for TimeSpan guards.
`SQR0023`	Usage	`CoalesceThrowIfNullAnalyzer`	Prefer ArgumentNullException.ThrowIfNull over null-coalescing throw.
`SQR0024`	Usage	`CoalesceThrowHelperAnalyzer`	Prefer a throw-helper method over null-coalescing throw.

Building

Requires the .NET SDK. The analyzer target is netstandard2.1; the unit-test project targets net10.0.

dotnet build Squirix.Analyzers.slnx -c Release
dotnet test tests/squirix.analyzers.unit-tests/Squirix.Analyzers.UnitTests.csproj -c Release
dotnet pack src/squirix.analyzers/squirix.analyzers.csproj -c Release -o ./artifacts

The packed analyzer is emitted under artifacts/squirix.analyzers.<version>.nupkg.

License

Licensed under the Apache License, Version 2.0.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

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
0.1.8	324	9/9/2026
0.1.7	93	9/9/2026
0.1.6	421	9/4/2026
0.1.5	146	9/4/2026
0.1.4	123	9/3/2026
0.1.3	132	9/3/2026
0.1.2	264	8/31/2026
0.1.1	119	8/31/2026
0.1.0	259	8/28/2026