从命令行运行 FxCop 分析器

Question

我正在尝试使用the new FxCop analyzers，但它们仅作为 NuGet 包或 VSIX 扩展提供。我希望能够从 C# 程序内部或从命令行直接运行它们。有人有什么建议吗？即使是关于在哪里可以找到 NuGet 或 VSIX 可执行文件的一般信息也会有所帮助。

（我知道 fxcopcmd.exe，但这是旧版本，它仅适用于构建的 .exe 或 .dll。如果可能的话，我需要在构建之前运行的东西。）

Answer 1

回答我自己的问题，以防其他人不得不处理这个问题。我找到了一个解决方案，但公平警告，它并不漂亮。

• 我从 Github 获取了一个示例 C# 解决方案，将其加载到 Visual Studio 中，并使用 NuGet 安装 FxCop 分析器。这安装了分析器，并更改了解决方案的 .csproj 文件以引用它们。就我而言，我在 C:\users\myname.nuget\packages 中找到了分析器的副本。
• 我将修改后的 .csproj 文件与原始文件进行了比较，以查看在安装过程中进行了哪些更改。我建议任何跟随的人自己进行比较，但就我而言，变化是：
  • 顶部的五个 Import 元素引用了各种 .props 文件。
  • 一个空的 NuGetPackageImportStamp 元素。
  • 靠近底部的两个新 ItemGroup，第一个包含一个名为“None”的元素，第二个包含引用 .dll 的各种 Analyzer 元素。
  • 用于确保 .props 文件实际存在的新目标。
• 我编写了一个 C# 程序，该程序采用任意解决方案，找到其中的所有 .csproj 文件，然后手动将这些新的 XML 元素添加到其中。我跳过了单元素 ItemGroup 和 Target 没有任何问题。

理想情况下，您将（从同一个 C# 程序内部）在 .sln 文件上调用 msbuild，保存与正则表达式匹配的每个输出行“）：警告 CA\d\d\d\d:”（即警告FxCop 生成），并恢复原始 .csproj 文件。我都是手动完成的。下面是 XML 操作的代码：

static void addAnalyzersToCsProj(string file)
    {
        string[] packages = new string[]
        {
            @"C:\users\myname\.nuget\packages\microsoft.codeanalysis.fxcopanalyzers\3.0.0\build\Microsoft.CodeAnalysis.FxCopAnalyzers.props",
            @"C:\users\myname\.nuget\packages\microsoft.codeanalysis.versioncheckanalyzer\3.0.0\build\Microsoft.CodeAnalysis.VersionCheckAnalyzer.props",
            @"C:\users\myname\.nuget\packages\microsoft.codequality.analyzers\3.0.0\build\Microsoft.CodeQuality.Analyzers.props",
            @"C:\users\myname\.nuget\packages\microsoft.netcore.analyzers\3.0.0\build\Microsoft.NetCore.Analyzers.props",
            @"C:\users\myname\.nuget\packages\microsoft.netframework.analyzers\3.0.0\build\Microsoft.NetFramework.Analyzers.props",
        };
        var root = XElement.Load(file);
        var ns = "";
        for (var i = 0; i < 5; i++)
        {
            XElement packageImport = new XElement(ns+"Import");
            packageImport.SetAttributeValue("Project", packages[i]);
            string condition = "Exists('" + packages[i] + "')";
            packageImport.SetAttributeValue("Condition", condition);
            root.AddFirst(packageImport);
        }

        var propertyGroup = root.Descendants(ns + "PropertyGroup").First();
        var stamp = new XElement(ns+"NuGetPackageImportStamp", "");
        propertyGroup.Elements().Last().AddAfterSelf(stamp);

        var newGroup = new XElement(ns+"ItemGroup");
        // do we need to include the "None Include="packages.config"" thing?
        string[] libraries = new string[]
        {
            @"C:\users\myname\.nuget\packages\microsoft.codeanalysis.versioncheckanalyzer\3.0.0\analyzers\dotnet\cs\Microsoft.CodeAnalysis.VersionCheckAnalyzer.resources.dll",
            @"C:\users\myname\.nuget\packages\microsoft.codeanalysis.versioncheckanalyzer\3.0.0\analyzers\dotnet\Microsoft.CodeAnalysis.VersionCheckAnalyzer.dll",
            @"C:\users\myname\.nuget\packages\microsoft.codequality.analyzers\3.0.0\analyzers\dotnet\cs\Humanizer.dll",
            @"C:\users\myname\.nuget\packages\microsoft.codequality.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.CodeQuality.Analyzers.dll",
            @"C:\users\myname\.nuget\packages\microsoft.codequality.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.CodeQuality.CSharp.Analyzers.dll",
            @"C:\users\myname\.nuget\packages\microsoft.netcore.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.NetCore.Analyzers.dll",
            @"C:\users\myname\.nuget\packages\microsoft.netcore.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.NetCore.CSharp.Analyzers.dll",
            @"C:\users\myname\.nuget\packages\microsoft.netframework.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.NetFramework.Analyzers.dll",
            @"C:\users\myname\.nuget\packages\microsoft.netframework.analyzers\3.0.0\analyzers\dotnet\cs\Microsoft.NetFramework.CSharp.Analyzers.dll",
        };
        foreach (string lib in libraries)
        {
            XElement analyzer = new XElement(ns+"Analyzer");
            analyzer.SetAttributeValue("Include", lib);
            newGroup.AddFirst(analyzer);
        }
        Console.WriteLine(root.Elements().Last().ToString());
        root.Elements().Last().AddAfterSelf(newGroup);
        root.Save(file, SaveOptions.None);
        // and do we need to include the error checking target?
    }

据我所知，它可以工作，但我不知道如果您尝试在已正常安装分析器的解决方案上执行此操作会发生什么。

通过 msbuild 运行 FxCop 分析器似乎效率低下，但我还没有找到更好的方法。它们看起来像是被构建为只能在编译器中工作。我希望我是错的，我仍然会感谢任何关于如何自动运行分析器的建议而不必构建整个项目。