What are .EditorConfig files?

What are .EditorConfig files?

https://editorconfig.org/

 

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 readable and they work nicely with version control systems.

 

 

 

What is .editorconfig ?

EditorConfig is a simple configuration file that contains a list of rules which can be applied to any IDE’s or code editors for proper formatting of code. But why use EditorConfig? Consider a scenario where your team is working on a project but the individual members of the team use a different IDE or code editor, these differences might result in inconsistent formatting applied to the code as each IDE/editor has its own configurations. EditorConfig solves this problem by having a single config file that is readable by all IDE’s and code editors with the help of some plugins/extensions. This tool is used extensively in many big projects including Angular, Bootstrap, Django, Nodejs, React, Vuejs, and a lot more.

Advantages of using EditorConfig

1. You can have a common indentation-style (Tabs/Spaces) & indentation-size
2. EditorConfig will help in configuring character encoding and line-endings (lf/crlf)
3. It can also enforce the editor to have a new line at end of each file and many more.

Setting up EditorConfig in your projects: 

To set up EditorConfig, you need to install the plugin/extension respective to your IDE/editor.
Following editors doesn’t need any plugins as they come with native support for EditorConfig:

• IntelliJ
• Pycharm
• Visual Studio
• Github / Gitlab / Gitbucket

 

 

 

 

作者:Chuck Lu    GitHub