Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

editorconfig-sublime

Helps developers maintain consistent coding styles between different editors - Sublime Text plugin

Subscribe to updates I use editorconfig-sublime


Statistics on editorconfig-sublime

Number of watchers on Github 1590
Number of open issues 10
Average time to close an issue about 2 months
Main language Python
Average time to merge a PR 7 days
Open pull requests 2+
Closed pull requests 9+
Last commit about 2 years ago
Repo Created about 7 years ago
Repo Last Updated over 1 year ago
Size 58 KB
Organization / Authorsindresorhus
Contributors10
Page Updated
Do you use editorconfig-sublime? Leave a review!
View open issues (10)
View editorconfig-sublime activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating editorconfig-sublime for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

EditorConfig

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

Install EditorConfig with Package Control and restart Sublime.

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

[*.md]
trim_trailing_whitespace = false

Tips

EditorConfig snippet

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.

View active config

The active config is printed in the Sublime console.

Trailing whitespace

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.

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.

License

MIT Sindre Sorhus

editorconfig-sublime open issues Ask a question     (View All Issues)
  • almost 3 years Plugin seems to ignore language-specific indent settings for makefile, auto-converting tabs to spaces
  • almost 3 years Support max_line_length
  • about 3 years Breaks git commit -v (git commit --verbose)
  • about 3 years Plugin should respect current file settings
  • over 4 years insert_final_newline = false | not working
  • almost 5 years Rules for files in subdirectory doesn't apply
  • about 5 years Defaults for files without an .editorconfig file
  • almost 6 years Automatic .editorconfig generation
  • over 6 years Editorconfig doesn't work on new files
editorconfig-sublime open pull requests (View All Pulls)
  • Introducing support for max_line_length.
  • Disable EditorConfig console output by default
editorconfig-sublime questions on Stackoverflow (View All Questions)
  • Identation not working with EditorConfig Sublime Text 3
editorconfig-sublime list of languages used
Other projects in Python