Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 3.13 KB

Troubleshooting.md

File metadata and controls

73 lines (58 loc) · 3.13 KB
Raw

NsDepCop Troubleshooting

NsDepCop NuGet package is not adding config.nsdepcop file to the project

If the project uses the PackageReference package manager format then content files are not added to the project. Workaround:

  • Use the packages.config package manager format.
  • Or add config.nsdepcop to the project manually.
    • Right-click on project >> Add >> New Item... >> NsDepCop Config File
    • Or simply add a file called config.nsdepcop and fill it in using the examples in Help.

Anonymous types raise false alarms

Applies to versions before v1.6 only. NsDepCop v1.6 leaves anonymous types out of the analysis.

For anonymous types the compiler generates a class with no namespace so they will belong to the 'global namespace'. If your NsDepCop config does not allow referencing the global namespace (denoted with a single dot) then it will raise an alarm that you may consider a false positive.

To avoid alarms caused by anonymous types you have to add a rule that you allow referencing the global namespace:

<Allowed From="YourNamespace" To="." />

Or to be more lax:

<Allowed From="*" To="." />

Setup is unable to add NsDepCop target to the C# build workflow

Applies to machine-wide MSBuild integration only. Does not apply when NsDepCop is added as a NuGet package.

In order to insert the NsDepCop task into the C# project build workflow, setup creates (or modifies) the "Custom.After.Microsoft.CSharp.targets" file at "(Program Files folder)\MsBuild\v14.0". It redefines the "BuildDependsOn" property group to include the NsDepCop target as the last step just before the "Build" target executes. If you already have this file and it already contains the definition of the BuildDependsOn property group then setup won't change it (so not to mess up anything).

In this case you have to insert the NsDepCop target manually. Append a semicolon and the string "NsDepCop" at the end of the text inside the "BuildDependsOn" tags.

Before:

<PropertyGroup>
  <BuildDependsOn>
    $(BuildDependsOn);
    MyCustomTask
  </BuildDependsOn>
</PropertyGroup>"

After:

<PropertyGroup>
  <BuildDependsOn>
    $(BuildDependsOn);
    MyCustomTask;
    NsDepCop
  </BuildDependsOn>
</PropertyGroup>

Setup is unable to remove NsDepCop target from the C# build workflow

Applies to machine-wide MSBuild integration only. Does not apply when NsDepCop is added as a NuGet package.

The same problem as above when uninstalling NsDepCop. The "Custom.After.Microsoft.CSharp.targets" file at "(Program Files folder)\MsBuild\v14.0" contains a definition of the BuildDependsOn property group that is different from the content that setup creates. You have to remove the NsDepCop string from the BuildDependsOn definition manually.