StyleSharp.Analyzers 3.16.2

<br> <a href="https://github.com/glennawatson/RoslynCommonAnalyzers"> <img width="160" height="160" src="https://raw.githubusercontent.com/glennawatson/RoslynCommonAnalyzers/main/icons/icon.png" alt="StyleSharp.Analyzers"> </a> <br>

RoslynCommonAnalyzers

Two fast Roslyn analyzer and code-fix packages for .NET codebases, built from one repository:

• StyleSharp.Analyzers (SST####) — style and consistency: spacing, readability, ordering, layout, naming, maintainability, documentation, extension blocks, records, lock-target safety, modernization, collection expressions, and modern C# syntax.
• PerformanceSharp.Analyzers (PSH####) — runtime performance of your code: avoidable allocations, collection and LINQ enumeration costs, string handling, concurrency and async patterns, and cheaper API selection.

Both packages are analyzer-only, target netstandard2.0, ship as a DevelopmentDependency, and pack analyzer/code-fix assemblies for multiple Roslyn slots under one NuGet package each. The analyzers themselves are engineered for build-time speed: allocation-free no-diagnostic paths, syntax-first candidate filtering, and per-rule benchmarks.

Installation

dotnet add package StyleSharp.Analyzers
dotnet add package PerformanceSharp.Analyzers

Each package adds no runtime assemblies to your output and is not transitive to consumers of your library. They are independent — install either or both.

Documentation

• Full rule catalog (both packages): docs/README.md
• Configuration: docs/CONFIGURATION.md
• Performance guidance: docs/PERFORMANCE.md
• Ready-to-use presets: recommended.editorconfig (StyleSharp) and recommended-performancesharp.editorconfig (PerformanceSharp)

The rule catalog is intentionally split out of this README so the GitHub landing page stays readable while the detailed rule index can grow with the project.

Rule Categories

StyleSharp (SST####)

• Spacing for token and whitespace conventions
• Readability for query layout, unique-line lists, tuple/null/style conventions, expression simplification, redundant-code removal, and similar readability rules
• Ordering for using ordering, modifier ordering, accessor ordering, and member ordering
• Layout for brace placement, blank-line rules, and block consistency
• Naming for .NET naming conventions, async-method suffixes, and override parameter names
• Maintainability for access modifiers, precedence, auto-properties, nameof, trailing commas, redundant modifiers, exception handling, type design, and related rules
• Documentation for XML docs, file headers, and documentation quality rules
• Extensions for C# 14 extension-block conventions
• Records for record and record-struct conventions
• Concurrency for lock-target safety rules
• Modernization for runtime throw-helper adoption and pattern-matching forms
• CollectionExpressions for collection-expression usage
• ModernSyntax for new language features such as the C# 14 field keyword

PerformanceSharp (PSH####)

• Allocations (PSH10xx) for closure/delegate allocations, throwaway empty arrays, and empty finalizers
• Collections (PSH11xx) for LINQ on hot paths, redundant iterator layers, O(1) count/indexer alternatives, and repeated dictionary/set lookups
• Strings (PSH12xx) for case-conversion comparison allocations, char overloads, and StringBuilder patterns
• Concurrency (PSH13xx) for System.Threading.Lock adoption and async/concurrency perf patterns
• ApiSelection (PSH14xx) for cheaper framework APIs such as one-shot HashData

Rules whose primary motivation is runtime performance live in PerformanceSharp; rules about style and consistency live in StyleSharp. Unless a rule is marked opt-in, it is enabled by default at Warning severity.

Configuration

Both packages are configured entirely through .editorconfig. Severity uses the standard dotnet_diagnostic.<RuleId>.severity keys, and rule options use the compiler-provided analyzer config system with a per-package prefix (stylesharp. / performancesharp.).

[*.cs]
dotnet_diagnostic.SST1309.severity = warning
stylesharp.tuple_element_naming = pascal_case

dotnet_diagnostic.PSH1100.severity = warning
performancesharp.avoid_linq_on_hot_path = true

See docs/CONFIGURATION.md for the full option list and the recommended configuration approach.

Repository Layout

Building And Testing

Run these commands from src/:

dotnet build RoslynCommonAnalyzers.slnx -c Release
dotnet test --project tests/StyleSharp.Analyzers.Tests/StyleSharp.Analyzers.Tests.csproj -c Release
dotnet test --project tests/PerformanceSharp.Analyzers.Tests/PerformanceSharp.Analyzers.Tests.csproj -c Release

To pack every Roslyn slot into the published NuGet packages:

dotnet pack StyleSharp.Analyzers.Package/StyleSharp.Analyzers.Packages.csproj -c Release
dotnet pack PerformanceSharp.Analyzers.Package/PerformanceSharp.Analyzers.Packages.csproj -c Release

Contributing

Issues and pull requests are welcome.

When adding a rule, update all of the following (in whichever package the rule belongs to):

• analyzer implementation
• code-fix implementation if the rule is fixable
• tests
• docs/rules/SST####.md or docs/rules/PSH####.md
• that package's AnalyzerReleases.Unshipped.md
• the matching preset (recommended.editorconfig / recommended-performancesharp.editorconfig) if the rule should appear there

Performance is a first-class requirement. Read docs/PERFORMANCE.md before changing analyzer hot paths, and benchmark changes rather than guessing.

License

MIT — see LICENSE.

Acknowledgements

The analyzers and code fixes here are written from scratch. No source code was copied from the projects below. License references are included in LICENSE where applicable.

• StyleCop.Analyzers, licensed under the MIT License, inspired the original shape of the project. Thanks to Sam Harwell and the StyleCop.Analyzers contributors.
• Roslynator, licensed under the Apache License 2.0, inspired some diagnostic design choices. Thanks to Josef Pihrt and the Roslynator contributors.
• The .NET SDK analyzer guidance and dotnet/roslyn, licensed under the MIT License, inspired parts of the style-rule coverage. Thanks to the .NET and Roslyn teams.