darkcloud14/monodevelop.stylecop

Use the latest StyleCop version in MonoDevelop.

MonoDevelop.StyleCop

MonoDevelop.StyleCop is an addin for MonoDevelop 8.3 and Visual Studio For Mac 8.3.

It integrates the source code analyzer StyleCop into MonoDevelop/Visual Studio For Mac.

DEPRECATION NOTICE

As I don't have much time anymore to work on the project and also StyleCop is more or less obsolete as there is the Roslyn-based StyleCopAnalyzers I'll stop working on this project and also highly recommend to switch to StyleCopAnalyzers instead.

I tested it with VS for Mac + a .Net Core project and after adding the StyleCop.Analyzers NuGet package it worked out of the box, for old .Net projects I had to add the following manually to the project file:

<ItemGroup>
  <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    <PrivateAssets>all</PrivateAssets>
  </PackageReference>
</ItemGroup>

The above has the advantage, that it correctly gets updated with each version update.

If you can't use the new NuGet PackageReference in your old style .Net project file you must add the following manually to the project file after adding the StyleCop.Analyzers NuGet package to the project in VS for Mac.

<ItemGroup>
  <Analyzer Visible="False" Include="..\packages\StyleCop.Analyzers.1.1.118\analyzers\dotnet\cs\StyleCop.Analyzers.CodeFixes.dll" />
  <Analyzer Visible="False" Include="..\packages\StyleCop.Analyzers.1.1.118\analyzers\dotnet\cs\StyleCop.Analyzers.dll" />
</ItemGroup>

If you must use the above entry instead of PackageReference the version number must be corrected of course and maybe some other parts of the path (e.g. the relative part to the packages directory) so please check and correct the path to the two dlls, also the paths must be updated after each version update manually!

Another thing you've to do is write a new configuration file as the old StyleCop configuration file won't work anymore, for more information about the configuration etc. of StyleCopAnalyzers goto the projects GitHub website and look everything up you want to know.

Issues are closed for MonoDevelop.StyleCop project

Installation

Get the latest addin package build or source code from GitHub releases site and use MonoDevelops Addin-Manager to install.

You may have to enable the addin after installation.

Remarks

The spell checker is only available on Windows!

Check the StyleCop website for more informations about StyleCop or StyleCop documentation for it's rules.

Usage

After the installation you can find menu entries under Tools, by right clicking on a file, folder, project,
solution in Projectpad, by right clicking in an opened document or it's document tabulator.

By right clicking on a project you can also open the StyleCop settings editor to enable/disable StyleCop rules and so on.

The StyleCop entries only show up if the file, folder, project or solution are known by StyleCop!