StyleCopPlus 3.4.0
dotnet add package StyleCopPlus --version 3.4.0
NuGet\Install-Package StyleCopPlus -Version 3.4.0
<PackageReference Include="StyleCopPlus" Version="3.4.0" />
<PackageVersion Include="StyleCopPlus" Version="3.4.0" />
<PackageReference Include="StyleCopPlus" />
paket add StyleCopPlus --version 3.4.0
#r "nuget: StyleCopPlus, 3.4.0"
#:package StyleCopPlus@3.4.0
#addin nuget:?package=StyleCopPlus&version=3.4.0
#tool nuget:?package=StyleCopPlus&version=3.4.0
StyleCopPlus Analyzers and Refactorings
This project is an implementation of StyleCop+ rules using the .NET Compiler Platform (Roslyn) as well as some additional opinionated refactorings and analyzers. Original project is available on CodePlex.
Installation
This project is available as a NuGet package. Visual Studio extension is no longer supported.
Analyzers
- SP1001 (Invalid Exception Message) - validates exception message to match best practices. Inspired by Microsoft guidelines and StackOverflow discussion.
- SP1002 (Cancellation token name) - validates that parameters of type
CancellationTokenare namedct. - SP1003 (Separate return with empty line) - validates that return statement in block is separated with empty line.
- SP1131 (Unsafe Condition Analyzer) - validates that constant pattern matching is used instead of
==operator to avoid typos likeif (flag = true), also suggests using negated not pattern instead of!=operator. - SP2100 (Line Too Long Analyzer) - validates that code lines do not exceed 110 symbols.
- SP2101 (Method Too Long Analyzer) - validates that methods length do not exceed 50 lines.
- SP2102 (Property Too Long Analyzer) - validates that property accessors do not exceed 40 lines.
- SP2103 (File Too Long Analyzer) - validates that files length do not exceed 400 lines.
Configuration
Analyzer line limits can be configured through StyleCop configuration file. Add the following snippet with configured values to the end of the file:
"styleCopPlusRules": {
"maxLineLength": 110,
"maxFileLength": 400,
"maxPropertyAccessorLength": 40,
"maxMethodLength": 50
}
Refactorings
- Duplicate Method - creates an exact copy of the method under cursor.
- Delete Method - deletes method and its xml doc comments under cursor.
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.CodeAnalysis.CSharp (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Migration to GitHub actions, other minor enhancements.