editorconfig 是什么鬼?
editorconfig 是用来帮助开发者定义和维护代码风格 (行尾结束符, 缩进风格等) 的东东.
editorconfig 支持哪些规则?
请自行参考 editorconfig.org/ https://note.youdao.com/
如何在 vscode 中使用 editorconfig?
在当前项目根目录下添加. editorconfig 文件
安装 EditorConfig 扩展(怎么安装扩展哈? 纳尼? 打开百度或 google, 输入 vscode 安装扩展 | vscode install extension; 好了, 不能再提示了)
全局安装或局部安装 editorconfig 依赖包(npm install -g editorconfig | npm install -D editorconfig)
打开需要格式化的文件并手动格式化代码(shift+alt+f)
简单说明下每一步的作用:
第一步的 editorconfig 文件是定义一些格式化规则(此规则并不会被 vscode 直接解析)
第二步 EditorConfig 扩展的作用是读取第一步创建的 editorconfig 文件中定义的规则, 并覆盖 user/workspace settings 中的对应配置(从这我们也可以看出 vscode 本身其实是并不直接支持 editorconfig 的)
第三步安装 editorconfig 依赖包主要是因为 EditorConfig 依赖于 editorconfig 包, 不安装的可能会导致 EditorConfig 无法正常解析我们在第一步定义的 editorconfig 文件
第四步的作用就是让经过 EditorConfig 扩展覆盖后的 user/workspace settings 生效
可能会遇到的问题
当 user/workspace setting 中的 files.trimTrailingWhitespace=true 时 trim_trailing_whitespace = false 就不会生效了
end_of_line 属性貌似不被支持(可直接修改 user/workspace setting 中的 files.eol 配置, 直接配置成 "files.eol": "\n" 即可)
注意: 结束符需要 ctrl+s 当前文件才会生效(其他规则是按下 shift+alt+f 格式化代码就生效的)
来源: https://juejin.im/post/5b50269b5188251a9f249ed2