Running StyleCop without an installation to empower continuous integration

Mon, 07 Nov 2011 22:32:00 +0100

Problem

A continuous integration server should only have a minimal toolset installed. This ensures that no unwanted libraries could affect the build and other steps.

Clearly that with this slogan also StyleCop should not be installed to the CI server. But we wanna have this analysis as an part of the whole build.

My own set of SuppressMessage-lines

Mon, 05 Jul 2010 10:35:00 +0200

StyleCop issues

inheritedoc-comment

Using -comment is not recognized by StyleCop. So this needs a suppression:

// <inheritdoc />
[SuppressMessage(
 "Microsoft.StyleCop.CSharp.DocumentationRules",
 "SA1604:ElementDocumentationMustHaveSummary",
 Justification = "InheritDoc")]

FxCop issues

Too few namespaces

[module: SuppressMessage(
 "Microsoft.Design",
 "CA1020:AvoidNamespacesWithFewTypes",
 Scope = "namespace",
 Target = "EsriDE.Core.Service.Logging",
 Justification = "We want to have this namespace, but do not have enough classes to go in it right now to satisfy the rule.")]

ReSharper only supports non static test methods

[SuppressMessage(
 "Microsoft.Performance",
 "CA1822:MarkMembersAsStatic",
 Justification = "ReSharper could not handle static test methods.")]

No strong name

[assembly: SuppressMessage(
 "Microsoft.Design",
 "CA2210:AssembliesShouldHaveValidStrongNames",
 Justification = "Strong name is not needed for this.")]

Catching general exception

[SuppressMessage(
 "Microsoft.Design",
 "CA1031:DoNotCatchGeneralExceptionTypes",
 Justification = "We do not know which exceptions could be thrown.")]

Justification for samples and fixtures

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "For fixtures this is OK.")]

Setter but no Getter (for example in IoC or NHibernate-context)

[SuppressMessage(
 "Microsoft.Usage",
 "CA2227:CollectionPropertiesShouldBeReadOnly",
 Justification = "Setter is needed for nhibernate, otherwise a NHibernate.PropertyNotFoundException will be thrown.")]

[SuppressMessage(
 "Microsoft.Xyz",
 "CAxyz:XYZ",
 Justification = "We only need a setter for setter injection.")]

Instantiation with IoC

[SuppressMessage(
 "Microsoft.Performance",
 "CA1811:AvoidUncalledPrivateCode",
 Justification = "We need this for unit tests.")]

[SuppressMessage(
 "Microsoft.Performance",
 "CA1812:AvoidUninstantiatedInternalClasses",
 Justification = "Class would be instantiated by IoC framework.")]

Incorrect naming

[SuppressMessage(
 "Microsoft.StyleCop.CSharp.NamingRules",
 "SA1310:FieldNamesMustNotContainUnderscore",
 Justification = "Windows message constants are commonly named as WM\_xxxxx")]

Incorrect casing

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 Target = "EsriDE.Data.Access.IDbFactory",
 MessageId = "<WrongCasedWord>")]

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 MessageId = "<WrongCasedWord>)]

Parametername should match base declaration

[SuppressMessage(
 "Microsoft.Naming",
 "CA1725:ParameterNamesShouldMatchBaseDeclaration",
 Justification = "Rule CA1725 has a bug when inspecting parameters from methods from interfaces. So suppress it with class.")]

Throwing ApplicationException

[SuppressMessage(
 "Microsoft.Usage",
 "CA2201:DoNotRaiseReservedExceptionTypes",
 Justification = "ApplicationException is OK.")]

FxCop is too strict

[SuppressMessage("
 Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "We decide that this is OK.")]

[module: SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Scope = "resource",
 Target = "EsriDE.PipelineManagement.Core.Properties.Messages.resources",
 MessageId = "Toolbar",
 Justification = "We decide that this is OK.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "This is by design.")]

Code from untaught colleagues

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Currently, we do not have enough knowledge or experience to fix this.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Cowboy-coding colleagues.")]

StyleCop throws documentation warning SA1600 for private elements

Thu, 12 Nov 2009 06:24:00 +0100

if you see the following warnings in your code:

You have two choices:

deactivate the rule but this disables this rule for all documentations – also the wanted
tune the detail settings In the settings editor you see additional options if you select the “Documentation Rules” root node

Installing StyleCop for ReSharper

Thu, 12 Nov 2009 05:58:00 +0100

Installing StyleCop for ReSharper under an administrative account does not activate this ReSharper plugin under my developer account.

A system analysis show, that this plugin is installed under

%userprofile%\Local Settings\Application Data\JetBrains\ReSharper\v4.5\vs9.0\Plugins\Microsoft StyleCop for ReSharper

Post-build event with folders which contains spaces

Mon, 27 Apr 2009 03:47:00 +0200

If you want to use a Post-build event with folders which contains a space often you get an error like:

The system cannot find the file specified.

c:\WINDOWS\Microsoft.NET\Framework\v3.5\Microsoft.Common.targets(3397,13):
error MSB3073: The command
"COPY C:\Projekte\_Learning By Doing\EsriDE.QA.StyleCop\bin\Debug\EsriDE.QA.StyleCop.dll
"C:\Program Files\Microsoft StyleCop 4.3""
exited with code 1.

In my case I used the macro $(TargetPath) in following line which contains indirectly the spaces in _Learning By Doing:

StyleCop on Marko Apfel