EditorConfig helps developers maintain consistent coding styles between different editors
π¦
Support this project & level up your Sublime skills with this excellent Sublime Power User course by Wes Bos
Try his free JavaScript 30 course for a taste of what to expect. Also check out his ES6 and React course.
π
Install EditorConfig
with Package Control and restart Sublime.
See the EditorConfig site for documentation.
- root
- indent_style
- indent_size
- end_of_line
- charset
- trim_trailing_whitespace
- insert_final_newline
Explanation of the properties can be found on the EditorConfig site.
My recommended default settings
# editorconfig.org
root = true
[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
If you can't remember all settings managed by the EditorConfig file, you'll love the editorconfig
snippet.
Just type editorconfig
+ tab, and your editor will focus on the first setting's value (indent_style = lf). You can change the value, if you want, and jump to the next setting's value by hitting tab and so on. Settings are somewhat autocompleted, and if you don't remember all possible values, simply remove the setting value to see them all as a comment.
You can be in a context where editorconfig
+ tab trigger another snippet. In that case, simply use Goto anywhere
(Ctrl + P on Linux/Windows or β + P on macOS), type editorconfig
, select Snippet: editorconfig
and hit Enter.
The active config is printed in the Sublime console.
Even though there is a trim_trailing_whitespace
property. I would still recommend you set "draw_white_space": "all"
and/or "trim_trailing_white_space_on_save": true
in your Sublime preferences to prevent you from accidentally committing whitespace garbage whenever a project is missing a .editorconfig file.
This plugin does its changes transparently in the background. I would recommend the excellent Modific plugin if you would like to see what changed.
MIT Β© Sindre Sorhus