{"id":17,"date":"2013-05-06T17:25:34","date_gmt":"2013-05-06T16:25:34","guid":{"rendered":"http:\/\/thisblessedplot.com\/wp\/?p=17"},"modified":"2013-05-06T17:25:34","modified_gmt":"2013-05-06T16:25:34","slug":"stylecop-and-the-msbuild-extension-pack","status":"publish","type":"post","link":"https:\/\/thedifficultbit.com\/?p=17","title":{"rendered":"StyleCop and the MSBuild Extension Pack"},"content":{"rendered":"

I use StyleCop<\/a> to check my C# code, running it both manually on particular projects or files from within Visual Studio as well as automatically for all code files as part of the build. The MSBuild Extension Pack<\/a> provides a Task<\/a> to run StyleCop from MSBuild. The build file imports the MSBuild Extension Pack tasks and then uses the StyleCop task:<\/p>\n

\n<Project DefaultTargets=\"RunStyleCop\" xmlns=\"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003\" ToolsVersion=\"4.0\">\n   <Import Project=\"$(ProgramFiles)MSBuildExtensionPack4.0MSBuild.ExtensionPack.tasks\"\/>\n\n      <!-- Run StyleCop -->\n      <Target Name=\"RunStyleCop\">\n         <MSBuild.ExtensionPack.CodeQuality.StyleCop\n            remainder not shown ...\n<\/pre>\n
However as initially set up this does not work, returning the error: MSB4062: The \"MSBuild.ExtensionPack.CodeQuality.StyleCop\" task could not be loaded from the assembly C:Program Files (x86)StyleCop 4.7MSBuild.ExtensionPack.StyleCop.dll. Could not load file or assembly 'file:\/\/\/C:Program Files (x86)StyleCop 4.7MSBuild.ExtensionPack.StyleCop.dll' or one of its dependencies. The system cannot find the file specified. Confirm that the declaration is correct, that the assembly and all its dependencies are available, and that the task contains a public class that implements Microsoft.Build.Framework.ITask.<\/code><\/p>\n
The imported tasks file MSBuild.ExtensionPack.tasks<\/code> contains an entry for StyleCop <UsingTask AssemblyFile=\"$(MSBuildProgramFiles32)StyleCop 4.7MSBuild.ExtensionPack.StyleCop.dll\" TaskName=\"MSBuild.ExtensionPack.CodeQuality.StyleCop\"\/><\/code> but the MSBuild.ExtensionPack.StyleCop.dll<\/code> file is not located in the StyleCop 4.7<\/code> folder but is in fact in the same folder as the tasks file, MSBuildExtensionPack4.0<\/code>.<\/p>\n
The obvious move is to change the StyleCop entry in MSBuild.ExtensionPack.tasks<\/code> to point to the right location i.e. <UsingTask AssemblyFile=\"$(ExtensionTasksPath)MSBuild.ExtensionPack.StyleCop.dll\" TaskName=\"MSBuild.ExtensionPack.CodeQuality.StyleCop\"\/><\/code>. But this will not work and will return the error “Failed to add file<\/code>” even though the file named is in fact present.<\/p>\n
After a little searching<\/a> and experimentation it seems that the StyleCop.*<\/code> DLLs need to be in the same directory as the MSBuild.ExtensionPack.StyleCop.dll<\/code> for the StyleCop task to work.<\/p>\n
The easiest way to get the task working is not to modify the MSBuild.ExtensionPack.tasks<\/code> StyleCop entry but instead copy the MSBuild.ExtensionPack.StyleCop.dll<\/code> from the MSBuild Extension Pack folder to the StyleCop 4.7<\/code> folder which contains the required DLLs.<\/p>\n
Using: MS Build Extension Pack 4.0.7.0; StyleCop 4.7.44.0<\/p>\n","protected":false},"excerpt":{"rendered":"
I use StyleCop to check my C# code, running it both manually on particular projects or files from within Visual Studio as well as automatically for all code files as part of the build. The MSBuild Extension Pack provides a Task to run StyleCop from MSBuild. The build file imports the MSBuild Extension Pack tasks […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[3,4,5],"class_list":["post-17","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-code-analysis","tag-msbuild","tag-stylecop"],"_links":{"self":[{"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=\/wp\/v2\/posts\/17","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=17"}],"version-history":[{"count":0,"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=\/wp\/v2\/posts\/17\/revisions"}],"wp:attachment":[{"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=17"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=17"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/thedifficultbit.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=17"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}