c# - 在构建/保存和提交时设置 C# editorconfig 代码清理

Question

我们的团队希望在我们的 C# 项目中强制执行样式规则。我在某个地方读到微软说“.editorconfig 是 future ”，所以我们想使用它。注意:我们不想使用 ReSharper。

C# 有很多很棒的规则，现在可以在 editorconfig 中定义，请参阅 Microsofts own editorconfig guide

我们希望使用它，并强制在 Visual Studio 中编码时遵循编辑器配置中设置的规则，并强制提交到 git 的代码遵循规则。

添加 .editorconfig 规则时，我们的文件会得到很好的 linting，如下所示:

在 Visual Studio 2019 中运行完全启用的“代码清理”，它可以根据需要完全格式化我们的代码:

问题1:如何让“运行代码清理”在保存/构建时自动运行？即使我们将某些规则设置为严重性“:error”，编译器仍然不会提示构建时 C# 文件中的问题。

注意:我尝试过名为 Format document on Save 的 Visual Studio 插件但它并不遵循 editorconfig 中设置的所有规则(只有少数规则，例如修复制表符/空格和文件末尾换行符)

我们还想确保对 git 存储库的所有提交都已格式化。

有一个工具叫 dotnet-format这应该根据 editorconfig 规则格式化代码。

我们想添加一个运行以下 2 个命令的预提交 Hook :

dotnet tool install -g dotnet-format
dotnet-format

这可以正常工作，但问题是 dotnet-format 也不能​​修复代码给出严重性“:error”的文件中的问题。

dotnet-format 的行为与“保存时格式化文档”的行为相同，只是修复了一些问题，例如制表符/空格和文件末尾换行符。

编辑:dotnet-format 目前似乎只支持一些规则，如 Wiki

问题 2:我们如何从命令行运行与 Visual Studio 2019 中的“代码清理”命令相同的命令？

Answer 1

我只能回答你的第一个问题:

我一直在寻找这个，我发现了一个名为 Code Cleanup on Save 的扩展程序，您只需安装它并在“工具”->“选项”->“保存时清理代码”中进行配置，决定要设置的配置文件，仅此而已，希望对您有帮助!