很多团队协作,需要对代码风格进行统一,不然会有代码审核规范的问题。
EditorConfig 是一个用于统一代码风格的工具,它通过一个名为 .editorconfig的配置文件,让不同的编辑器和IDE在保持代码风格(如缩进、字符编码等)上保持一致。
# .editorconfig
# 1. 根配置声明
root = true
# 2. 通用配置节
[*]
# 3. 字符编码设置
charset = utf-8
# 4. 换行符类型
end_of_line = lf
# 5. 文件末尾空行
insert_final_newline = true
# 6. 清理行尾空格
trim_trailing_whitespace = true
# 7. 缩进方式
indent_style = space
# 8. 缩进大小
indent_size = 2
[*.{js,ts,jsx,tsx}]
indent_style = space
indent_size = 2
[*.{xml}]
indent_style = space
indent_size = 2
[*.{java,py}]
indent_style = space
indent_size = 4
[*.md]
trim_trailing_whitespace = false
验证配置是否生效
在 WebStorm 中:
-
查看文件右下角状态栏
-
会显示当前文件的编码、换行符、缩进等信息
-
应该显示:
UTF-8 | LF | 2 spaces
