tools: Added .editorconfig file for basic encoding/indentation enforcement by ronkorving · Pull Request #2993 · nodejs/node

ronkorving · 2015-09-22T03:42:10Z

This helps editors (see http://editorconfig.org/#download) to apply the right indentation, end-of-line characters, and encoding rules to files of any type (extension) directly and without going through linters, etc. I can imagine some of the contents of this PR may need tweaking, so feedback is most appreciated.

silverwind · 2015-09-22T06:02:46Z

.editorconfig

I'd remove that comment

+1 on removing that

silverwind · 2015-09-22T06:04:53Z

I'd add trim_trailing_whitespace for everything except markdown files.

ronkorving · 2015-09-22T06:50:41Z

Why leave trailing whitespace in markdown files?

sindresorhus · 2015-09-22T06:53:48Z

Two trailing spaces forces linebreak in Markdown.

ronkorving · 2015-09-22T07:47:17Z

That is an absolutely horrible syntax. But sure.

ronkorving · 2015-09-22T07:56:11Z

.editorconfig

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.

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.

@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.

reqshark · 2015-09-22T07:56:42Z

does atom editor care about that file?

ronkorving · 2015-09-22T07:57:36Z

@reqshark if you install the plugin for it, it will

reqshark · 2015-09-22T08:00:13Z

cool

ronkorving · 2015-09-22T08:02:02Z

@reqshark I'm using Atom too, and that's the primary reason for wanting to see a .editorconfig file included in the project (since it doesn't have "project settings" or anything, which in a way is actually great).

bnoordhuis · 2015-09-22T09:57:09Z

.editorconfig

.py files have two space indent.

Might as well put the 2-space indent into * and use sections for files that differ.

+1. Can we match configure here as well?

@jbergstroem configure's indentation is all over the place tbh, but I don't mind adding it.
2 space indent?

silverwind · 2015-09-30T21:47:12Z

Another addition: vcbuild.bat should be crlf.

jbergstroem · 2015-09-30T22:30:07Z

.editorconfig

If you end up moving indent_size = 2 to *, can you add 8 here? (Ok, call me a unix beard but it's at least relatively default in make-land)

silverwind · 2015-10-09T16:34:22Z

ping @ronkorving

ronkorving · 2015-10-14T03:32:39Z

@silverwind perhaps *.bat should be CRLF? I've added that, but let me know if inappropriate or incomplete.

silverwind · 2015-10-14T18:18:15Z

Hmm, not sure about that or if there even is a specific reason for CRLF in bat files, but we're somewhat inconsistent here thought most of these are in deps:

$ file $(find . -name "*.bat")
./deps/uv/docs/make.bat:                                  DOS batch file, ASCII text, with CRLF line terminators
./deps/uv/vcbuild.bat:                                    DOS batch file, ASCII text, with CRLF line terminators
./deps/npm/make.bat:                                      ASCII text
./deps/npm/node_modules/node-gyp/gyp/gyp.bat:             DOS batch file, ASCII text, with CRLF line terminators
./deps/npm/node_modules/node-gyp/gyp/samples/samples.bat: DOS batch file, ASCII text, with CRLF line terminators
./deps/openssl/openssl/ms/testss.bat:                     DOS batch file, ASCII text
./deps/openssl/openssl/ms/mingw32.bat:                    DOS batch file, ASCII text
./deps/openssl/openssl/ms/do_win64a.bat:                  ASCII text
./deps/openssl/openssl/ms/x86asm.bat:                     ASCII text
./deps/openssl/openssl/ms/tpem.bat:                       ASCII text
./deps/openssl/openssl/ms/mw.bat:                         DOS batch file, ASCII text
./deps/openssl/openssl/ms/testce.bat:                     DOS batch file, ASCII text
./deps/openssl/openssl/ms/test.bat:                       DOS batch file, ASCII text
./deps/openssl/openssl/ms/testssce.bat:                   ASCII text
./deps/openssl/openssl/ms/tencce.bat:                     ASCII text
./deps/openssl/openssl/ms/speed32.bat:                    ASCII text
./deps/openssl/openssl/ms/testpem.bat:                    DOS batch file, ASCII text
./deps/openssl/openssl/ms/do_nt.bat:                      ASCII text
./deps/openssl/openssl/ms/do_ms.bat:                      ASCII text
./deps/openssl/openssl/ms/do_win64i.bat:                  ASCII text
./deps/openssl/openssl/ms/testencce.bat:                  DOS batch file, ASCII text
./deps/openssl/openssl/ms/testenc.bat:                    DOS batch file, ASCII text
./deps/openssl/openssl/ms/tenc.bat:                       ASCII text
./deps/openssl/openssl/ms/32all.bat:                      ASCII text
./deps/openssl/openssl/ms/testpemce.bat:                  DOS batch file, ASCII text
./deps/openssl/openssl/ms/do_nasm.bat:                    ASCII text
./deps/openssl/openssl/ms/bcb4.bat:                       ASCII text
./deps/openssl/openssl/ms/testce2.bat:                    ASCII text
./deps/openssl/openssl/ms/tpemce.bat:                     ASCII text
./deps/openssl/openssl/engines/capierr.bat:               ASCII text
./deps/openssl/openssl/crypto/threads/win32.bat:          ASCII text
./deps/openssl/openssl/crypto/threads/ptest.bat:          ASCII text
./deps/openssl/openssl/crypto/threads/netware.bat:        DOS batch file, ASCII text
./deps/openssl/openssl/shlib/win32dll.bat:                ASCII text
./deps/openssl/openssl/shlib/win32.bat:                   ASCII text
./deps/openssl/openssl/Netware/build.bat:                 DOS batch file, ASCII text
./deps/openssl/openssl/Netware/cpy_tests.bat:             DOS batch file, ASCII text
./deps/openssl/openssl/Netware/set_env.bat:               DOS batch file, ASCII text
./deps/v8/tools/windows-tick-processor.bat:               DOS batch file, ASCII text
./deps/zlib/contrib/masmx86/bld_ml32.bat:                 ASCII text
./deps/zlib/contrib/masmx64/bld_ml64.bat:                 ASCII text
./tools/msvs/nodevars.bat:                                DOS batch file, ASCII text
./tools/gyp/gyp.bat:                                      DOS batch file, ASCII text, with CRLF line terminators
./tools/gyp/samples/samples.bat:                          DOS batch file, ASCII text, with CRLF line terminators
./vcbuild.bat:                                            DOS batch file, ASCII text, with very long lines, with CRLF line terminators

jbergstroem · 2015-10-14T18:26:21Z

Looks like we'd want to exclude deps/ for the most part.

silverwind · 2015-10-14T18:30:28Z

Looks *.bat has been attempted before in .gitattributes, but caused #330.

Would a line-ending conversion mess up git history?

ronkorving · 2015-10-29T08:18:32Z

I've changed *.bat to vcbuild.bat
I think things should be good now?

thefourtheye · 2015-10-29T09:28:50Z

.editorconfig

Why not trimming this?

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 <br> tags into the content.

If that is the case, I am okay with that. @silverwind

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.

silverwind · 2015-10-29T11:22:23Z

Is it possible to exclude deps/ somehow through a glob?

ronkorving · 2015-10-30T07:41:44Z

@silverwind I'm not aware of any way to do this, especially in .editorconfig

silverwind · 2015-12-16T06:24:54Z

tools should be the correct category, I'll fix that when landing.

This helps editors (see http://editorconfig.org/#download) to apply the right indentation and encoding rules to files by default.

ronkorving · 2015-12-16T08:29:00Z

Prepended "tools: " ;)

jbergstroem · 2015-12-16T10:04:00Z

@ronkorving all lowercase in commit title please (unless you reference acronyms, variables, classes, etc). Also, keep it shorter than 51 characters. There's a commit style-guide here.

targos · 2015-12-16T10:08:30Z

We also usually write in the imperative form ("add" instead of "added") but it's not in the guide so I don't know if it's really a rule

jbergstroem · 2015-12-16T10:09:35Z

@targos its in the extended guide we link to.

This helps editors (see http://editorconfig.org/#download) to apply the right indentation and encoding rules to files by default. PR-URL: #2993 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>

silverwind · 2015-12-16T15:24:49Z

Thanks! Landed in d63ccee with a conforming commit message. Please make sure to honor our commit message guidlines in the future. 😉

This helps editors (see http://editorconfig.org/#download) to apply the right indentation and encoding rules to files by default. PR-URL: #2993 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>

This helps editors (see http://editorconfig.org/#download) to apply the right indentation and encoding rules to files by default. PR-URL: nodejs#2993 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>

ronkorving changed the title ~~Added .editorconfig file for basic style enforcement~~ Added .editorconfig file for basic encoding/indentation enforcement Sep 22, 2015

mscdex added the meta Issues and PRs related to the general management of the project. label Sep 22, 2015

silverwind reviewed Sep 22, 2015
View reviewed changes

ronkorving force-pushed the editorconfig branch from ae3071b to 13215f4 Compare September 22, 2015 07:47

ronkorving reviewed Sep 22, 2015
View reviewed changes

bnoordhuis reviewed Sep 22, 2015
View reviewed changes

jbergstroem reviewed Sep 30, 2015
View reviewed changes

ronkorving force-pushed the editorconfig branch 2 times, most recently from 1905416 to 3a7bc86 Compare October 14, 2015 03:35

ronkorving force-pushed the editorconfig branch from 3a7bc86 to e6c421d Compare October 29, 2015 08:18

thefourtheye reviewed Oct 29, 2015
View reviewed changes

ronkorving force-pushed the editorconfig branch from e6c421d to 73d8b68 Compare October 30, 2015 07:41

tools: Added .editorconfig file for basic style enforcement

838b9cf

This helps editors (see http://editorconfig.org/#download) to apply the right indentation and encoding rules to files by default.

ronkorving force-pushed the editorconfig branch from 45704ac to 838b9cf Compare December 16, 2015 08:28

ronkorving changed the title ~~Added .editorconfig file for basic encoding/indentation enforcement~~ tools: Added .editorconfig file for basic encoding/indentation enforcement Dec 16, 2015

silverwind closed this Dec 16, 2015

Fishrock123 mentioned this pull request Dec 16, 2015

v5.3.0 Release Proposal (Stable) #4281

Closed

rvagg mentioned this pull request Dec 17, 2015

Release 4.2.4 Planning #4321

Closed

MylesBorins mentioned this pull request Jan 14, 2016

Audit commits not found on v4.x-staging #4698

Closed

rvagg added the lts-watch-v4.x label Jan 15, 2016

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Jan 19, 2016

MylesBorins mentioned this pull request Jan 19, 2016

V4.2.5 proposal #4768

Merged

snyk-bot mentioned this pull request Jan 17, 2022

[Snyk] Fix for 14 vulnerabilities nigelhanlon/node#1

Open

Uh oh!

Conversation

ronkorving commented Sep 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind commented Sep 22, 2015

Uh oh!

ronkorving commented Sep 22, 2015

Uh oh!

sindresorhus commented Sep 22, 2015

Uh oh!

ronkorving commented Sep 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

reqshark commented Sep 22, 2015

Uh oh!

ronkorving commented Sep 22, 2015

Uh oh!

reqshark commented Sep 22, 2015

Uh oh!

ronkorving commented Sep 22, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind commented Sep 30, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind commented Oct 9, 2015

Uh oh!

ronkorving commented Oct 14, 2015

Uh oh!

silverwind commented Oct 14, 2015

Uh oh!

jbergstroem commented Oct 14, 2015

Uh oh!

silverwind commented Oct 14, 2015

Uh oh!

ronkorving commented Oct 29, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

silverwind commented Oct 29, 2015

Uh oh!

ronkorving commented Oct 30, 2015

Uh oh!

silverwind commented Dec 16, 2015

Uh oh!

ronkorving commented Dec 16, 2015

Uh oh!

jbergstroem commented Dec 16, 2015

Uh oh!

targos commented Dec 16, 2015

Uh oh!

jbergstroem commented Dec 16, 2015

Uh oh!

silverwind commented Dec 16, 2015

Uh oh!

Reviewers

Assignees