Visual Studio 现可使用 EditorConfig

  • Jeff Martin
  • Rays

2017 年 1 月 15 日

话题:.NET语言 & 开发

Visual Studio 2017 的首个候选发布版(VS2017RC)中提供了支持EditorConfig标准的特性。秉承该标准可使开发人员一次性地定义一种编码风格,即可轻易地在不同的编辑器中使用该风格。另一显著优点是对于在 EditorConfig 文件中定义的风格,可由源代码控制系统进行保存,这避免了特定编辑器的对话框或配置中的风格丢失。VS2017 将支持对多种语言使用 EditorConfig 功能,包括 C#、Visual Basic、C++、JavaScript、F# 和 TypeScript。

正如 Microsoft 的 Kasey Uhlenhuth 所介绍的,EditorConfig 的优点之一在于它是一种定义用于全解决方案范围内的宽泛标准,并额外提供了可用于特定项目或目录定义标准的 EditorConfig 文件。文件中可添加对编码样式(Code Formatting)规则和编码风格(Code Style)规则的定义。当前 VS20177RC 支持下列五种样式规则:

  1. indent_style
  2. indent_size
  3. tab_width
  4. end_of_line
  5. charset

当前尚不支持另两个广为使用的规则,即“trim_trailing_whitespace”和“insert_final_newline”。同样也可定义编码风格规则,并且在该机制得以实现后,可以根据严重程度(none/suggestion/warning/error)中断构建过程(当前 VS2017 中构建会继续进行)。按照 Microsoft 的说法,VS2017 RTM 版可能并将会更新 Visual Studio 中对 EditorConfig 支持的特性,目的在于通过更新过程提供完全符合规范的 EditorConfig 特性。

对于已有的源码树,为使开发人员按个人喜好定义的各种编码样式和编码风格规则生效,需要关闭并重新打开文件,或是去改变 EditorConfig 文件。Uhlenhuth 给出了一些用于快速应用规则的快捷键。

  • 更新编辑器中的单个文件:“Format Document”菜单,快捷键“CTRL-K, D”;
  • 应用更新到整个项目 / 解决方案中的所有文件:“Quick Actions”菜单,快捷键“CTRL-+”。

注意当存在 EditorConfig 文件时,文件规则将覆盖 Visual Studio 的“Tools | Options”菜单使用的快捷键定义。Mads Kristensen 实现了开源插件“EditorConfig Language Service”,使得在 VS2017 中编辑 EditorConfig 文件时可以利用上编辑器所提供的便利。当前得需要 VS2017RC 才能使用编码样式与编码风格功能,但将该功能与构建系统集成的 NuGet 软件包正在开发中。

(本文于 2017 年 1 月 10 日更新,添加了语言支持和未来可用更新的信息。)

查看英文原文:Putting EditorConfig to Work in Visual Studio


感谢冬雨对本文的审校。

给 InfoQ 中文站投稿或者参与内容翻译工作,请邮件至editors@cn.infoq.com。也欢迎大家通过新浪微博(@InfoQ@丁晓昀),微信(微信号:InfoQChina)关注我们。

.NET语言 & 开发