.editorconfig 代码风格配置

前面写了一篇博客关于不同操作系统回车出现的 \r 对shell的影响,@Wi1dcard 评论建议使用 .editorconfig 来规范代码风格,以前在一些项目里看过这个文件,但是没有仔细研究过个文件,今天特地测试了一下这个配置。
editorconfig 说明可参考 https://editorconfig.org/

  • 以下编辑器不需要安装插件,只需要配置.editorconfig
    file
  • 以下编辑器需要安装插件和配置.editorconfig文件
    file
  • 以下是phpstorm 安装 editorconfig 流程
    file
    file
    file
    安装完后重启 phpstorm 就生效了
  • 在项目目录下添加 .editorconfig 文件,内容如下
#EditorConfig文件使用INI格式。斜杠(/)作为路径分隔符,#或者;作为注释。路径支持通配符:
#表明是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件
root = true
#* 匹配除/之外的任意字符
#**    匹配任意字符串
#? 匹配任意单个字符
#[name]    匹配name字符
#[!name]   不匹配name字符
#[s1,s2,s3]    匹配给定的字符串
#[num1..num2]  匹配num1到mun2直接的整数
[*]
#文件的charset。有以下几种类型:latin1, utf-8, utf-8-bom, utf-16be, utf-16le
charset = utf-8

#缩进使用 tab 或者 space
indent_style = space

#缩进为 space 时,缩进的字符数
indent_size = 2

#缩进为 tab 时,缩进的宽度
#tab_width = 2

#换行符的类型。lf, cr, crlf三种
end_of_line = lf

#是否将行尾空格自动删除
trim_trailing_whitespace = true

#是否使文件以一个空白行结尾
insert_final_newline = true

把 end_of_line 值改为 cr,修改文件并传到 linux,vi 打开文件
file
把 end_of_line 值改为 crlf, 修改文件并传到 linux, vi 打开文件
file
把 end_of_line 值改为 lf,变动文件保存并上传到linux,vi 打开文件
file
trim_trailing_whitespace = true 行尾的空格会被去掉
insert_final_newline = true 时,总会在末尾添加一个 \n

  • 虽然.editorconfig 提供的配置比较少,但个人觉得这个回车换行的约束很有必要!!!
本作品采用《CC 协议》,转载必须注明作者和本文链接
雪花飘
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 3

不断学习,不断总结,加油!

2年前 评论

@Wi1dcard 谢谢,大家一起加油!

2年前 评论

给你点动力,刚想知道这个文件的作用,一搜就你这篇文章了,给你个 like

1年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!