FxCop rule to check name of enum and name of file are the same

Question

Hello,

I want to create a custom rule with Fxcop to check if the name of the enum matchs with the name of the file.

I known that FxCop does not populate the source context for a field. So I tried to load the assembly to parse the files:

public override ProblemCollection Check(TypeNode typeNode)
{

   ...

    Assembly targetAssembly = Assembly.Load(typeNode.DeclaringModule.ContainingAssembly.StrongName);

   ...

}

But I get this error:

Could not load file or assembly 'Name of my assembly, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null' or one of its dependencies.

Does anymore have a similar problem ?

Josh

 

Answer 1

An enum does not contain executable code, so its source context information will not be populated.  Even if a PDB file is available for a given target DLL, you would not be able to locate the file in which the enum is defined.

This rule is a much better candidate for a custom StyleCop rule, where all the information you need to evaluate the rule would be reliably available.

Answer 2

Thank you.

I installed StyleCop but I would like to enable it only for a specific configuration like CodeAnalysis: <RunCodeAnalysis>true</RunCodeAnalysis>

But I found no similar property and when you add the line <Import Project="$(ProgramFiles)\MSBuild\StyleCop\v4.7\StyleCop.targets" /> in the csproj, StyleCop runs whatever the configuration.

Answer 3

If you look at the contents of the StyleCop.targets file, you'll see that a property named StyleCopEnabled can be used to control whether StyleCop is executed during the build.  To disable StyleCop for a given build configuration, tyr adding the following to that configuration's section in your .csproj file:

<StyleCopEnabled>false<StyleCopEnabled>