在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

相關文章
相關標籤/搜索