在vscode使用editorconfig的正確姿勢

程式設計師大白發表於2018-07-19

editorconfig是什麼鬼?

editorconfig是用來幫助開發者定義和維護程式碼風格(行尾結束符、縮排風格等)的東東。

editorconfig支援哪些規則?

請自行參考 editorconfig.org/

如何在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格式化程式碼就生效的)

相關文章