如何从 .editorconfig 中的 stylecop.json 覆盖 StyleCop 规则严重性

Question

我在我的项目中使用 StyleCop.Analyzers 并有一个

stylecop.json

文件，其中配置了一些特定规则。

这是我的样本

stylecop.json

{
  "settings": {
    "layoutRules": {
      "newlineAtEndOfFile": "allow"
    }
  }
}

这是我的

.editorconfig

# .editorconfig example
[*.cs]
dotnet_diagnostic.SA1518.severity = error

但是，它仍然显示为警告。如何确保

.editorconfig

覆盖

stylecop.json

中设置的严重性？

Answer 1

为确保使用 StyleCop.Analyzers 时

.editorconfig

覆盖

stylecop.json

中设置的严重性级别，请按照以下步骤操作：

1.确保正确的

.editorconfig

语法

确认您已在

.editorconfig

中正确设置诊断严重性级别。例如：

[*.cs]
dotnet_diagnostic.SA1518.severity = error

2.清除构建缓存

缓存的设置有时会干扰新配置的应用。对

.editorconfig,

进行更改后，通过重建解决方案清除构建缓存。

3.验证

.csproj

中的 StyleCop.Analyzers 参考

确认在项目文件中正确引用了 StyleCop.Analyzers (

.csproj

)。这可确保分析器和配置在项目中均处于活动状态：

<PackageReference Include="StyleCop.Analyzers" Version="x.x.x" />

4.检查 Visual Studio 设置（如果使用 Visual Studio）

要确保强制执行

.editorconfig

，请转到 Visual Studio 中的工具 > 选项 > 文本编辑器 > C# > 代码样式 > 常规，并将分析器诊断严重性设置为“在 .editorconfig 中启用”。

5.验证配置一致性

最后，确保在

.editorconfig

或

stylecop.json

中的其他位置没有为相同规则定义冲突的严重性级别，因为冲突可能会导致

.editorconfig

设置被忽略。