Add /.editorconfig

[jonathantneal]

See: http://editorconfig.org/

[jonathantneal]

Try it now, @alrra.

[drublic]

I +1 on merging this since I am a big fan of consistency. EditorConfig adds this. For v6 this project could totally become a bit more of an extended template which integrates some more opinionated features which the community thinks are good and somewhat stable and established.

[alrra]

Try it now, @alrra.

@jonathantneal LGTM, however, we should also add a few lines in the docs about it (including a note about the disclosure issue).

I'm also ok with this addition, and now, since it works with quite a few editors, I think it can be useful.

[jonathantneal]

What do you think of the following documentation?

EDIT: Removed

[alrra]

What do you think of the following documentation?

@jonathantneal can you add this to the commit, it is easier to review that way as comments can be added to specific lines. :)

[jonathantneal]

@alrra, updated.

[jonathantneal]

@alrra, updated.

[koistya]

If there will be package.json, bower.json, .travis.yml and similar files, it would be nice to have ident_size=2 just for these files.

[{bower.json,package.json,.travis.yml}]
indent_style = space
indent_size = 2

[alrra]

If there will be package.json, bower.json, travis.yml and similar files,

@koistya if we ever provide those files, we will certainly add those properties, otherwise will just include the bare minimum and let users change and add new properties according to their needs.

updated.

Thank you @jonathantneal! 💜

I'll leave this open for a few more days so that people have the chance to state their opinion.

[sindresorhus]

👍 I find editorconfig very useful. We have it included in our Yeoman generators and Web Starter Kit.

[thasmo]

+1 Even if people don't use editors supporting/using the .editorconfig file it's still a nice way of documenting how certain files should be formatted. Definitely include it! :)

[alrra]

I've asked people on Twitter what they think about this addition, and since some of them prefer to respond there, here is the link to the tweet: https://twitter.com/h5bp/status/490559737667149824.

[bezoerb]

+1 for editorconfig

[MariusRumpf]

+1 for it. Using it in all my projects very helpful.

[arthurvr]

+1 for adding it

[gabeidx]

👍

[koistya]

As a Windows user I don't personally see any problems with end_of_line = lf. There could be an issue leading to mixed LF / CR LF line endings within files if team members use different editors (some with EditorConfig support and some without). Maybe it's worth mentioning this in docs?

👍

[koistya]

I personally sort these parameters by "importance" - the most important is space/tabs and how many spaces for indentation.

# EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[sindresorhus]

I personally sort these parameters by "importance" - the most important is space/tabs and how many spaces for indentation.

👍

[mischah]

Enough »chit chat«. Merge that in. 👍

People who are already using a editor config plugin will be able to adapt the .editorconfig according to their needs.

People who don’t know editor config could ignore this file. But I guess it will spread the usage of editor config and will make the world a better place

[dustinhorton]

What's the reason for insert_final_newline = true? I see it's a common default but don't know why.

I'd also question indent_size = 4 being the default. Probably the 2 most popular CSS frameworks, Bootstrap & Foundation, as well as the Google & Mozilla JS styleguides call for 2. Haven't looked beyond that.

[treyhunner]

Regarding insert_final_newline, here are some reasons that it's a good practice:

• git complains when files do not end in a newline
• Unix text processing utilities act strangely if a final newline is missing (wc miscounts the lines, read in bash doesn't read the last line, more fails to print a newline before the terminal prompt, etc.)
• Vim (among other editors) ends files in newlines by default and this option is not possible to disable in Vim (though there is a plugin that seems to allow disabling the behavior)
• I have heard that the C standard requires that files end in newlines. This seems largely historical.

[alrra]

sort these parameters by "importance"

@koistya Importance is kinda subjective, so let's just stick to alphabetical order.

indent_size = 4 being the default.

@dustinhorton We currently use 4 spaces throughout the code.

@jonathantneal Merged with some modifications in a99d856

Thanks everyone for the feedback, we sincerely appreciate it! :)