基于 EditorConfig 实现代码格式标准化

EditorConfig 有助于为跨越各种编辑器和 IDE 的同一项目的多个开发人员维护一致的编码样式。EditorConfig 项目由用于定义编码样式的文件格式和一组文本编辑器插件组成,这些插件使编辑器能够读取文件格式并遵循定义的样式。EditorConfig 文件易于阅读并且可以与版本控制系统配合使用。

1. 编辑器

目前,绝大多数的编辑器支持 EditorConfig 配置,例如以下编辑器不需要安装插件,只需要配置。editorconfig:

attachments-2020-02-IGG5zMkP5e5a11e002281.png

以下编辑器需要安装插件和配置。editorconfig 文件:

attachments-2020-02-h5UXOh4Q5e5a11f5df8ff.png

2. 插件安装

在接下来的教程中,为了保证我们的代码风格一致,以避免引起不必要的歧义。我们在 phpstorm 上安装一个叫 EditorConfig 的插件,在进行团队协作开发时,这个插件能保证所有人编码格式的统一。

应用菜单 Preferences > Package Control,点击后,输入 ins 会自动补全:

attachments-2020-02-JbXoboeM5e5a11693d09c.png

按回车键进入以后,第一次初始化时间可能会比较久,请耐心等待。加载成功后,输入 EditorConfig 然后再按回车键进行安装。

3. 文件配置

因此在团队项目里,我们可以用 EditorConfig 实现编码风格统一。除了 WordPress、Laravel、Symfony 等大型框架有自成一套的编码规范以外,我建议所有的 PHP 项目都应该遵循 PSR PHP 标准规范。目前 PSR 中与编码规范有关的项目有已定稿的 PSR-1 和 PSR-2,将来还会有正在草稿阶段的 PSR-12。现在我们只需要按照 PSR-2 来执行就可以了。在项目里我们可以在根目录建立一个 .editorconfig 文件,内容如下:

  • 发表于 · 2020.02.29 15:26 · 阅读 · 614

[版权声明] :本文文字、代码及图片版权归原作者所有,任何媒体、网站或个人未经本网协议授权不得采集、整理、转载或以其他方式复制发表。已经本站协议授权的媒体、网站,在使用时必须注明“稿件来源:学研谷”。

0 条评论

请先 登录 后评论
猜猜我是谁
Divma

8
提问
10
回答
4
文章