tools: Added .editorconfig file for basic encoding/indentation enforcement #2993
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| root = true | ||
|
|
||
| [*] | ||
| end_of_line = lf | ||
| charset = utf-8 | ||
| trim_trailing_whitespace = true | ||
|
There was a problem hiding this comment. I would recommend adding There was a problem hiding this comment. All files seems a bit aggressive, no? Not better to do this on a per-file-category basis? There was a problem hiding this comment. +1 on whose comment? :) |
||
|
|
||
| [vcbuild.bat] | ||
| end_of_line = crlf | ||
|
|
||
| [*.{md,markdown}] | ||
| trim_trailing_whitespace = false | ||
|
There was a problem hiding this comment. Why not trimming this? There was a problem hiding this comment. Someone mentioned before that end of line spaces can be used to enforce white lines iirc. I'm not a fan of the practice, but I think the only alternative to that is introducing There was a problem hiding this comment. If that is the case, I am okay with that. @silverwind There was a problem hiding this comment. Yes, trailing space to force a line break in markdown. Not a fan of it either, but we should leave that option available to collaborators. |
||
|
|
||
| [{lib,src,test}/**.js] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [src/**.{h,cc}] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [test/*.py] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [configure] | ||
| indent_style = space | ||
| indent_size = 2 | ||
|
|
||
| [Makefile] | ||
| indent_style = tab | ||
| indent_size = 8 | ||
|
|
||
| [{deps,tools}/**] | ||
| indent_style = ignore | ||
| indent_size = ignore | ||
| end_of_line = ignore | ||
| trim_trailing_whitespace = ignore | ||
| charset = ignore | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm personally confused as to when to use
*and**. In the hello world style example on http://editorconfig.org they show[*]as a sort of default setting for all files, but they also explain how * does not include slashes. So wouldn't that mean that this rule will match only files in the root dir? That would be a very odd default, so I must be mistaken. I just can't find an explanation for it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the thing that confuses me too about editorconfig. I think
*is fine for a catch-all, but you should double check if the correct files match with the CLI tool.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ronkorving this works because patterns without a slash are equivalent to
**/pattern(essentially matching in the root directory and all child directories). If you need to match something specifically in the root, add an initial slash like/*(which will only match top-level files). We modeled this after the way globs work in.gitignore.