Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /.editorconfig #1564

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# editorconfig.org
root = true

[*]
charset = utf-8

This comment was marked as abuse.

This comment was marked as abuse.

end_of_line = lf

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

This comment was marked as abuse.

2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
### HEAD

* Add `/.editorconfig` file and documentation
([#1561](https://github.com/h5bp/html5-boilerplate/issues/1561)).
* Add `auto` to the Google Universal Analytics tracker create method
([#1562](https://github.com/h5bp/html5-boilerplate/issues/1562)).
* Add `timeline` and `timelineEnd` to the list of `console` methods
Expand Down
27 changes: 27 additions & 0 deletions doc/misc.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ table of contents](TOC.md)
# Miscellaneous

* [.gitignore](#gitignore)
* [.editorconfig](#editorconfig)
* [.htaccess](#htaccess)
* [crossdomain.xml](#crossdomainxml)

Expand Down Expand Up @@ -32,6 +33,32 @@ globally ignore:
* Comprehensive set of ignores on GitHub: https://github.com/github/gitignore


## .editorconfig

HTML5 Boilerplate includes an `.editorconfig` file that helps you and your team
define and maintain consistent coding styles between different editors and IDEs.
EditorConfig files are easily readable and they work nicely with version control
systems.

When opening any file, your IDE’s EditorConfig plugin will look for a file named
`.editorconfig` in the directory of the opened file and in every parent
directory until the root filepath is reached or an EditorConfig file with
`root = true` is found.

The EditorConfig file provided by this project will inform your IDE to follow
our current practices, which include UTF-8 charset encoding, use of the line
feed character for line breaks, use of four space characters for indentations,
the removal of any whitespace characters preceding newline characters, and the
presence of a final line break character at the end of files.

This comment was marked as abuse.

If you will not be using a server configuration file provided by this project,
remember to block access to `.editorconfig` files, as they may disclose
sensitive information.

* [EditorConfig homepage](http://editorconfig.org/)
* [Download IDE Plugin](http://editorconfig.org/#download)


### `.htaccess`

A `.htaccess` (hypertext access) file is a Apache HTTP server configuration
Expand Down