将 Visual Studio 的“代码样式设置”导出为 .editorconfig

Posted 2023-02-22

【中文标题】将 Visual Studio 的“代码样式设置”导出为 .editorconfig

【英文标题】：Export Visual Studio's 'Code Style settings' as .editorconfig

【发布时间】：2018-12-23 16:25:18

【问题描述】：

我们的团队使用 Visual Studio 2017 Professional。

我一直在尝试统一整个团队的代码风格，显然现在的行业标准是使用 .editorconfig 文件。甚至 Visual Studio 在其设置窗口中也建议使用该配置文件并链接到 useful page 以了解如何编写 editorconfig 文件。

但我不想手动编写我已经在 VS 中配置的所有设置。我想要一个将这些设置导出为 .editorconfig 文件的工具来分发它们。

我找不到任何工具来做到这一点，所以我想自己纠正它并与像我一样的其他人分享。但显然，如果转到“工具-> 导入和导出设置...”，您将无法下载当前的代码样式设置。

有没有办法解决这个问题？

您知道任何将我的设置转换为 editorconfig 文件的工具或导出我当前代码样式设置的方法吗？

编辑

我根据here

中的信息创建了自己的

.editorconfig

文件版本

你可以在我的github repo找到它

【参考方案1】：

我知道这个问题很古老但值得回答......

最新的Visual Studio extension 允许您这样做（Guide here）：

基本上安装扩展并右键单击解决方案或项目（您可以将规则限制为解决方案/项目甚至文件夹）然后单击add > new EditorConfig (IntelliCode)

在最新版本的 Visual Studio 中您可以执行的操作仍有一些限制，但 Visual Studio 2017 15.8 Preview 3 或更高版本允许您使用新的扩展“格式化文档”命令为当前版本执行额外的代码清理文件。

很遗憾，您不能让所有规则都导致构建错误，只有一些选项允许这样做 - 没有这个，很多样式选项都可以忽略。

【讨论】：

扩展从你的代码库推断设置。如果您的代码库不遵守您的规则怎么办？也许您继承了代码或已决定使用新的样式指南。我不敢相信没有人写任何东西来从 VS 规则转换为 .editorconfig。

如果代码库不遵循您的规则，那么您可以使用该工具创建一个起点，然后进行编辑以匹配您的规则，或者您从头开始只添加您想要的规则

我明白了。但是是否有用于编辑规则的 GUI？这就是我要找的。如果我从现有代码创建一个起点，我会得到我不想要的规则。如果我从头开始，我必须手写大量规则。两者都不理想。

它似乎只为我生成 C# 配置。

【参考方案2】：

我意识到这对 VS2017 用户没有多大帮助，但 VS2019 在Code Style options page 上有一个“从设置生成 .editorconfig 文件”按钮：

此选项页面位于工具 > 选项 > 文本编辑器 > [C# 或 Basic] > 代码样式 > 常规。

【讨论】：

请不要在答案中提问。而是发布一个新问题。否则这会破坏这个问答系统[s 概念和 UI]。评论不是回答问题的好方法。请参阅本网站的帮助和介绍。

VS 2019 在您打开解决方案时加载 .editorconfig。因此，虽然没有从其他地方导入的显式导入，但您绝对可以让 VS 加载一个编辑器配置，对代码样式设置进行一些更改，然后再次生成/导出它。