Skip to content

tools: update capitalized-comments eslint rule #26849

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
wants to merge 6 commits into from
Closed

tools: update capitalized-comments eslint rule #26849

wants to merge 6 commits into from

Conversation

BridgeAR
Copy link
Member

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@BridgeAR BridgeAR requested review from Trott and vsemozhetbyt March 22, 2019 02:47
@nodejs-github-bot
Copy link
Collaborator

@BridgeAR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/3005/pipeline

@nodejs-github-bot nodejs-github-bot added http Issues or PRs related to the http subsystem. tools Issues and PRs related to the tools directory. labels Mar 22, 2019
Trott
Trott reviewed Mar 22, 2019
View reviewed changes
Trott
Trott reviewed Mar 22, 2019
View reviewed changes
test/parallel/test-repl.js
@@ -358,7 +358,7 @@ const errorTests = [
send: ')',
expect: 'undefined'
},
// npm prompt error message
// `npm` prompt error message.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of chafe at markdown in comments, so this is (from my perspective) mildly unfortunate. Not blocking--only commenting in case you have another idea. (Maybe we can just add |npm to the end of the ignorePatterns regexp? Maybe long-term goal can be that the whole regexp will just be a set of words separated by pipe characters like var|let|const|npm?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add a couple of words to the blacklist but I guess it might become relatively big if we only use a blacklist. So I would definitely keep the current ignore pattern as it overall worked very well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I personally would say this specific case actually benefits by making clear that npm is something specific. If it would be a more generic word, it would be difficult to distinguish it from the rest of the comment.

Trott
Trott approved these changes Mar 22, 2019
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Churn, baby, churn!

vsemozhetbyt
vsemozhetbyt approved these changes Mar 23, 2019
View reviewed changes
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With some nits: 1) eliminate introduced inconsistencies with adjacent lowercased comments (diff is weird in these cases — some GitHub bug adds extra space?); 2) some doubts if the first word is actually a mentioned variable (false-positive).

@BridgeAR BridgeAR force-pushed the stricter-capitalize-comments branch from fbb4308 to 665055d Compare March 24, 2019 22:19
@BridgeAR
Copy link
Member Author

BridgeAR commented Mar 24, 2019 •
edited
Loading

Rebased due to conflicts. I incorporated all feedback in the "fixup" commits. PTAL.

Lite CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3025/
Lite CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3026/

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 24, 2019
@BridgeAR BridgeAR force-pushed the stricter-capitalize-comments branch from 443f712 to 3de5713 Compare March 25, 2019 15:34
@BridgeAR
Copy link
Member Author

Rebased due to conflicts.

Lite CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3035/

BridgeAR added a commit to BridgeAR/node that referenced this pull request Mar 27, 2019
@BridgeAR
benchmark,doc,lib: capitalize more comments
b08a867 
PR-URL: nodejs#26849
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
BridgeAR added a commit to BridgeAR/node that referenced this pull request Mar 27, 2019
@BridgeAR
tools: update capitalize-comments eslint rule
3914142 
This strictens the rule to apply from 20 characters on instead of
from 30.

PR-URL: nodejs#26849
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
@BridgeAR
Copy link
Member Author

Landed in b08a867 and 3914142.

@BridgeAR BridgeAR closed this Mar 27, 2019
BethGriggs pushed a commit that referenced this pull request Apr 5, 2019
@BridgeAR @BethGriggs
benchmark,doc,lib: capitalize more comments
4e565da 
PR-URL: #26849
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 5, 2019
@BridgeAR @BethGriggs
tools: update capitalize-comments eslint rule
3658718 
This strictens the rule to apply from 20 characters on instead of
from 30.

PR-URL: #26849
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
This was referenced Apr 23, 2019
Closed
Closed
Closed
This was referenced Apr 23, 2019
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@BridgeAR BridgeAR deleted the stricter-capitalize-comments branch January 20, 2020 11:57
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@Trott Trott Trott approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. http Issues or PRs related to the http subsystem. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@BridgeAR @nodejs-github-bot @Trott @vsemozhetbyt @targos