I'm trying to build a NuGet package that adds our company's code analysis dictionary automatically and updatable.
The rule set is added in the content folder and now I want to use the install.ps1 script to add the rule set in the project file.
I figured out the way to go would be to use the envDTE, but I can't find much useful documentation about it other then this overwhelming object graph in which I can't find the CodeAnalysisRuleset node.
http://msdn.microsoft.com/en-us/library/za2b25t3(v=vs.100).aspx
Am I pursuing the right path?
Is there any relevant tutorial/documentation on how to use the envDTE in NuGet powershell?
How can I run/debug my install script without having to actually add it to a package and install it against a project?
Sidenote
Although @Nicole Calinoiu showed the better way, this morsel of information might come in handy later on:
foreach ($config in $project.ConfigurationManager){
$config.Properties.Item("CodeAnalysisRuleSet").Value = "myruleset.ruleset"
}
There's no need to script this. Both the ruleset and dictionary can be registered via an imported MSBuild
.props
file, as described at https://docs.microsoft.com/en-us/nuget/create-packages/creating-a-package#including-msbuild-props-and-targets-in-a-package.For example, your NuGet source folder structure might look like this (assuming "CodeAnalysisSettings" is your package ID):
where the contents of
CodeAnalysisSettings.props
are something like the following:You can also do it manually by using the following steps.
You may repeat the step for other projects in the solution.
I had the same problem as reported in the comments: the dictionary was added as content, not as a
CodeAnalysisDictionary
.I added this piece of code in the install.ps1 of the nuget package to solve this: