editorconfig-sublime
editorconfig-sublime copied to clipboard
Sublime Text plugin for EditorConfig - helps developers define and maintain consistent coding styles between different editors and IDEs
EditorConfig - Sublime Text plugin
EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readibly and they work nicely with version control systems.
Install
Sublime Text 2
Install with Package Control
Sublime Text 3
Download, unzip, and put the contents in ~/Library/Application Support/Sublime Text 3/Packages/EditorConfig
.
Will be easier when Package Control is fully compatible.
Getting started
See the EditorConfig site for documentation.
Supported properties
- 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.
Example file
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
Tips
Trailing whitespace
Even though there is a trim_trailing_whitespace
property. I would still recommend you set "draw_white_space": "all"
in your Sublime preferences to prevent you from accidentally committing whitespace garbage whenever a project is missing a .editorconfig file.
Show changes
This plugin does its changes transparently in the background. I would recommend the excellent Modific plugin if you would like to see what changed.