Repository files navigation

This repository contains an implementation of the StyleCop rules using the .NET Compiler Platform. Where possible, code fixes are also provided to simplify the process of correcting violations.

The preferable way to use the analyzers is to add the nuget packageStyleCop.Analyzersto the project where you want to enforce StyleCop rules.

The severity of individual rules may be configured usingrule set filesin Visual Studio 2015 or newer.Settings.StyleCop is not supported, but astylecop.json file may be used tocustomize the behavior of certain rules. SeeConfiguration.md for more information.

For documentation and reasoning on the rules themselves, see theDocumentation.

For users upgrading from StyleCop Classic, seeKnownChanges.mdfor information about known differences which you may notice when switching to StyleCop Analyzers.

Not all versions of StyleCop.Analyzers support all features of each C# language version. The table below shows the minimum version of StyleCop.Analyzers required for proper support of a C# language version.

StyleCopAnalyzers can be installed using the NuGet command line or the NuGet Package Manager in Visual Studio 2015.

Install using the command line:

Install-Package StyleCop.Analyzers

Install using the package manager:

If you use older versions of Visual Studio in addition to Visual Studio 2015 or Visual Studio 2017, you may still install these analyzers. They will be automatically disabled when you open the project back up in Visual Studio 2013 or earlier.

SeeContributing

An up-to-date list of which StyleCop rules are implemented and which have code fixes can be foundhere.