在vscode使用editorconfig的正确姿式

editorconfig是什么鬼?

editorconfig是用来帮助开发者定义和维护代码风格(行尾结束符、缩进风格等)的东东。npm

editorconfig支持哪些规则?

请自行参考 editorconfig.org/google

如何在vscode中使用editorconfig?

  • 在当前项目根目录下添加.editorconfig文件
  • 安装EditorConfig扩展(怎么安装扩展哈?纳尼?打开百度或google,输入vscode 安装扩展 | vscode install extension;好了,不能再提示了)
  • 全局安装或局部安装editorconfig依赖包(npm install -g editorconfig | npm install -D editorconfig)
  • 打开须要格式化的文件并手动格式化代码(shift+alt+f)

简单说明下每一步的做用:spa

  • 第一步的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格式化代码就生效的)code

相关文章
相关标签/搜索