从命令行运行 FxCop 分析器

Running FxCop analyzers from command line

提问人:anon 提问时间:6/20/2020 更新时间:6/25/2020 访问量:502

问:

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

(我知道fxcopcmd.exe,但这是旧版本,它仅适用于构建的.exe或.dll。如果可能的话,我需要一些在构建之前有效的东西。

C# .NET NuGet vsix FXCOP

评论

0赞 Flydog57 6/20/2020
我在当前文档中没有看到任何命令行选项。你可以将它们放在项目文件中(通过 NuGet),然后从 MSBUILD 运行它们。只是一个猜测

答:

1赞 anon 6/25/2020 #1

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

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

理想情况下,您将(从同一 C# 程序内部)对 .sln 文件调用 msbuild,保存与正则表达式 “): warning 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 分析器似乎效率低下,但我还没有找到更好的方法来做到这一点。它们看起来像是为仅在编译器中工作而构建的。我希望我错了,我仍然希望得到任何关于如何自动运行分析器而无需构建整个项目的建议。

评论

0赞 Mark Mayo 10/16/2020
/下巴掉落。从那以后你有没有机会在这方面有所改进?