Where is the Stylecop configuration file?

c# .net stylecop
user9993 picture user9993 · Mar 22, 2015 · Viewed 30.8k times · Source

I've installed Stylecop via NuGet. I wish to disable some rules, and I know this can be done via a configuration file from what I've read. However, I can't find the file anywhere, and there seems to be little documentation describing where to create the file.

How do I go about making the file?

Edit: As this question still seems to be getting attention a couple of years later, I recommend using Roslyn Analyzer based StyleCop now.

This has a few advantages:

  1. It's actually maintained and active.
  2. Takes advantage of Roslyn, and can perform some changes for you.
  3. It's a NuGet package so is installed as part of your projects, meaning you no longer need to install the seemingly unmaintained StyleCop Visual Studio extension (that's if you can even find the right place to download it from in the first place!). This way you can enforce code style/conventions much easier in for example OSS.
  4. Automatically creates the .ruleset file for you, and as a result of using Roslyn Analyzers you get IDE support for enabling/disabling rules.

Answer

Hywel Rees picture Hywel Rees · Mar 2, 2016

If you installed Stylecop via NuGet (the StyleCop.MSBuild package), then you will not have the folder detailed in the other answers.

You will find the file in your project folder here:
packages\StyleCop.MSBuild.{version}\tools\Settings.StyleCop

You should copy this file to the root of your project.

If you would rather not manually edit the file, there is also a nice gui tool called StyleCopSettingsEditor in the tools folder, which you can just drag your settings file onto.

Related questions

Should 'using' directives be inside or outside the namespace?

I have been running StyleCop over some C# code, and it keeps reporting that my using directives should be inside the namespace. Is there a technical reason for putting the using directives inside instead of outside the namespace?

Read More
How to suppress a StyleCop warning?

I'm using StyleCop and want to suppress some warning which does not suit my style. I prefer to have solution for 1) in-line code suppressing 2) global setting suppressing I've searched the internet but still not sure how to do the suppressing. …

Read More
StyleCop XML Documentation Header - Using 3 /// instead of 2 //

I am using XML documentation headers on my c# files to pass the StyleCop rule SA1633. Currently, I have to use the 2 slash commenting rule to allow StyleCop to recognize the header. for example: // <copyright file="abc.ascx.cs" …

Read More