Use EditorConfig For Your Project

This might be the first time you’re hearing about EditorConfig. But don’t worry, I was in the same boat just a couple of months ago. So, what is it? It is a simple file format, that helps keeping coding styles consistent across different editors. And more importantly, across different team members.

How does it work?

EditorConfig consists of two components. Firstly, .editorconfig file, that you put in the root of your project. Secondly, a plugin for the editor of your choice.

The .editorconfig file is written in .ini format. You can define things such as number of spaces to indent or whether to use tabs or spaces. Moreover, you can use different settings for different file formats. For complete explanation, head over to the official site.

In order to enforce the settings from .editorconfig, you need a plugin for your editor. For the most popular ones, such as Vim, Emacs, Atom, Sublime Text or Brackets, the are plugins readily available. The Jetbrains IDEs even include EditorConfig support in their core.

EditorConfig Example

To give you a better idea of EditorConfig, I decided to include a configuration that I use for one of my projects. As you can see, it is fairly short:

# Top-most EditorConfig file.
root = true

# Set charset and Unix-style newlines
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{py,ini}]
indent_style = space
indent_size = 4

[*.{yml,yaml}]
indent_style = space
indent_size = 2

Conclusion

With everything set up, you can enjoy the benefits of not having to configure your editors manually for every project. To save even more time, see my advice on how to manage your Vim plugins and increase your productivity.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.