Azure DevOps管道的代码格式任务

如何解决Azure DevOps管道的代码格式任务

TL; DR -在构建过程中是否存在用于格式化代码的Azure DevOps管道任务？我一直找不到，真的会觉得有用。

我的团队使用免费的CodeMaid Visual Studio扩展来“美化”（格式）C＃代码。虽然扩展程序运行良好，但是依赖于开发人员在Visual Studio中格式化自己的代码仍存在一些限制：

• 开发人员经常忘记运行该工具。
• 启用“在保存时自动运行文件清除”功能在代码工作时会令人沮丧，因为它会重新组织代码，这可能会破坏人们的思路。
• 开发人员可以按照自己的喜好更改格式设置，而不必遵守团队的格式化标准，这可能会导致代码合并问题和格式化大战。

我认为一个更好的解决方案是在Azure DevOps中执行管道任务，并在构建过程中运行诸如Code Maid之类的工具。这样可以确保没有任何代码以丑陋，未经格式化的状态进入源代码管理，并确保所有代码都被格式化为构建过程中启用的任何标准。

解决方法

我认为，触发构建的提交应该是不可变的。如果您将某些内容格式化为代码，则将向存储库推送新的提交，以使更改真正被合并。那么，您是要再次触发CI构建吗？

我的建议可能是自动化运行格式化工具作为管道的一部分。如果它发现将要进行的任何更改（意味着有人在推送到远程之前未运行该工具），则只需使构建失败即可。将传递构建作为合并“拉取请求”的要求。如果人们无法通过正常流程完成工作，他们将排队。您在管道中为其配置的设置将是标准设置，以便解决开发人员选择标签或空格的问题。 ：）

代码女仆可能不是最佳选择。我看到了一个开放的github票证，它对于命令行自动化并不是很好。它与Visual Studio紧密耦合。另外，这可能会花费很大的精力，但我想您会希望有人在完整源代码上运行格式化，以便每个人都可以从绿色开始。

,

您可以在命令行dotnet-format上运行本机命令，这将实现您想要的功能。您可以在管道中运行它。它确实需要安装，因此可能会增加构建成本。

使用以下命令进行安装：

dotnet tool install -g dotnet-format

然后直接使用当前格式格式化当前项目或解决方案，

dotnet format

要仅修复代码样式分析器警告，您也可以使用以下命令：

dotnet format --fix-style warn

可用的命令的完整列表在项目GitHub上。

,

我认为更好的解决方案是在 在构建过程中运行了诸如Code Maid之类的工具的Azure DevOps 处理。这样可以确保没有代码进入 丑陋，未格式化的状态，将确保所有代码都被格式化为 在构建过程中启用了任何标准。

Azure Devops没有此类管道任务来在管道运行期间格式化文件。并且不建议在管道运行期间更改git repo。

正常情况是：

1。我们在Azure Devops中托管了git repo，并且有人正在使用dev分支进行本地开发。

2。有人进行一些更改并提交更改（修改代码或添加额外的源文件）

3。将提交与远程回购同步，远程回购中的更改会触发相应的管道运行。 （CI用于检查代码是否正常，CD用于部署新更改）

现在，如果您在管道过程中修改源文件，除非您禁用CI，否则它将导致无限的触发。相反，您可以使用Branch policy来改善流程，可以为master分支设置分支策略。因此，通过PR对母版所做的任何更改均应由审阅者批准。而且特定的审阅者可以帮助检查代码格式。