BT

如何利用碎片时间提升技术认知与能力? 点击获取答案

Visual Studio现可使用EditorConfig

| 作者 Jeff Martin 关注 16 他的粉丝 ,译者 Rays 关注 3 他的粉丝 发布于 2017年1月16日. 估计阅读时间: 4 分钟 | Google、Facebook、Pinterest、阿里、腾讯 等顶尖技术团队的上百个可供参考的架构实例!

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)关注我们。

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我
社区评论

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT