混淆了规则集文件和editorconfig文件 [英] Confused over ruleset files vs editorconfig files

问题描述

我们的组织使用包含我们组织的StyleCop.Analyzer设置的规则集文件。这位于源代码管理中，我们组织中所有解决方案中的所有项目都引用此文件。如果我编辑规则集(通过项目属性->；代码分析选项卡)，我会看到一条消息，提示我将规则集迁移到editorconfig文件。有人能解释一下我为什么要这么做吗？两者有什么不同？

我还注意到，在VS Tools->；Options->；Text Editor->；C#->；Code Style中，有许多设置与许多StyleCop.Analyzer规则惊人地相似(例如，与使用"；this"；、VS StyleCop SA1101"；前缀"；有关的几个设置)。这里还有一个根据这些设置创建editorconfig文件的按钮，那么这些设置将如何与StyleCop.Analyzer设置共存，哪个将优先？

此外，我们的Azure DevOps自动化构建会报告任何代码&违反&StyleCop规则的警告。如果我们将规则集替换为editorconfig文件，生成是否仍会执行此操作？

最后，有一个用于编辑StyleCop.Analyzer设置的GUI(项目属性->；代码分析选项卡->；&配置&报价；按钮)，而editorconfig文件似乎是使用VS文本编辑器进行编辑的。考虑到有数百条规则需要管理，您从哪里可以获得需要键入的规则的完整列表呢？这不是很乏味吗？

推荐答案

引号和图片来自https://docs.microsoft.com/de-de/visualstudio/code-quality/use-roslYn-analyzers?view=vs-2019#rule-severity

优先在EditorConfig文件中设置规则的严重性 超过在规则集或解决方案资源管理器中设置的任何严重性。

如果未提供.editorconfig文件或未在其中配置规则，则使用Visual Studio(VS工具->；选项->；文本编辑器->；C#->；代码样式)中的设置。

根据我的经验，最好只选择一种配置方式。此外，我还体验到，只要有任何.ruleset文件可用，.editorconfig文件的以下描述配置就无法工作/或编辑.ruleset。

通过灯泡配置规则

通过错误窗口配置规则

通过解决方案资源管理器配置规则。您也可以在这里找到所有可用规则的列表。

命令行工具遵循.editorconfig文件：

在命令行生成项目时，规则冲突 如果满足以下条件，则显示在生成输出中：

• 分析器作为NuGet软件包安装，而不是作为VSIX扩展安装。
• 项目代码中违反了一个或多个规则。
• 违反规则的严重性设置为"警告"(在这种情况下，违反不会导致生成失败)或"错误"(在这种情况下，违反会导致生成失败)。

这篇关于混淆了规则集文件和editorconfig文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！