Skip to content

tools: enable final newline in .editorconfig - #9410

Closed
silverwind wants to merge 2 commits into
nodejs:masterfrom
silverwind:trailing-newlines
Closed

tools: enable final newline in .editorconfig#9410
silverwind wants to merge 2 commits into
nodejs:masterfrom
silverwind:trailing-newlines

Conversation

@silverwind

@silverwindsilverwind commented Nov 1, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor
Checklist
  • make -j8 test (UNIX), or vcbuild test nosign (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

tools

Description of change

This enables the final newline insertion for editors supporting .editorconfig, which hopefully will eliminate noise in pull requests concerning the final newline.

The first commit is the result of the following command (requires GNU versions of find and sed):

$ find . -type f -not -path "./.git/*" -not -path "./deps/*" -not -path "./out/*" -not -path "./tools/eslint/*" -not -path "./tools/gyp/*" -not -path "./tools/icu/*" -not -path "./tools/msvs/*" -not -path "*/node_modules/*" -not -path "*.min.js" -not -path "./test/fixtures/*" -iregex '\(js\|cc\|h\|d\|man\|manifest|\rc\|md\|mardown\|eslintrc\|py\|txt\|sh\|pl\|json\|pem\|key\|crt\|ini\|cnf\|html\|css\|makefile\|gyp\|gypi\|mk\|status\|xml\|gitignore\|r\|tmpl\|stp\|spec\|remarkrc\|rc\|mailmap\|inc\|gitattributes\|eslintignore\|editorconfig\|1\)$'| xargs sed -i -e '$a\'

The only offending file was benchmark/README.md. I've opted to not change test assets which would have required changes in a bunch of tests.

The second commit enables the editorconfig option. The pattern was written with the assumption that no one will manually edit files inside any node_modules directory or .min.js files.

@silverwindsilverwind added the tools Issues and PRs related to the tools directory. label Nov 1, 2016
@silverwindsilverwind mentioned this pull request Nov 2, 2016
Closed
@thefourtheye

thefourtheye commented Nov 2, 2016

Copy link
Copy Markdown
Contributor

So we are not doing eol-last, eslint rule?

@silverwind

silverwind commented Nov 2, 2016•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

eol-last is already in effect, I totally missed that earlier.

@silverwind

silverwind commented Nov 4, 2016

Copy link
Copy Markdown
ContributorAuthor

Thanks, landed in dc88d19 and 15b83b9.

silverwind added a commit that referenced this pull request Nov 4, 2016
@silverwind
benchmark: add trailing newline for consistency
dc88d19
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
silverwind added a commit that referenced this pull request Nov 4, 2016
@silverwind
tools: enable final newline in .editorconfig
15b83b9
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
evanlucas pushed a commit that referenced this pull request Nov 7, 2016
@silverwind@evanlucas
benchmark: add trailing newline for consistency
dafdb7b
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
evanlucas pushed a commit that referenced this pull request Nov 7, 2016
@silverwind@evanlucas
tools: enable final newline in .editorconfig
aac4af2
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
@evanlucasevanlucas mentioned this pull request Nov 7, 2016
Merged
@MylesBorins

MylesBorins commented Nov 22, 2016

Copy link
Copy Markdown
Contributor

this will require manual backporting

silverwind added a commit to silverwind/node that referenced this pull request Nov 22, 2016
@silverwind
benchmark: add trailing newline for consistency
5243202
PR-URL: nodejs#9410Fixes: nodejs#9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
silverwind added a commit to silverwind/node that referenced this pull request Nov 22, 2016
@silverwind
tools: enable final newline in .editorconfig
c52e74d
PR-URL: nodejs#9410Fixes: nodejs#9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
@silverwind

silverwind commented Nov 22, 2016•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@thealphanerd you can cherry-pick just 15b83b9. The EOL issue on benchmark/README.md seems to not be present in v6.x, v6.x-staging and v4.x, so the first commit would be a empty one :)

If we're okay with empty commits, I could provide you one though.

MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind@MylesBorins
tools: enable final newline in .editorconfig
a5d27f3
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind@MylesBorins
tools: enable final newline in .editorconfig
e42ee4e
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind@MylesBorins
tools: enable final newline in .editorconfig
5c6d908
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind@MylesBorins
tools: enable final newline in .editorconfig
459ec73
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind@MylesBorins
tools: enable final newline in .editorconfig
0e745e7
PR-URL: #9410Fixes: #9402
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
This was referenced Dec 21, 2016
Merged
Merged
@alisccoaliscco mentioned this pull request Jun 21, 2023
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@lpincalpincalpinca approved these changes
@JungMinuJungMinuJungMinu approved these changes
+2 more reviewers
@thefourtheyethefourtheyethefourtheye approved these changes
@gibfahngibfahngibfahn approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

toolsIssues and PRs related to the tools directory.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@silverwind@thefourtheye@MylesBorins@jasnell@lpinca@JungMinu@gibfahn