tools,doc: lint for additional strings in docs #17492
Conversation
Trott
added
doc
nodejs-github-bot
added
doc
Trott
changed the title
Use `GitHub` rather than `Github` and `Node.js` rather than `Node.JS`.
Check for uses of `Github` (rather than `GitHub`) and `Node.JS` (rather than `Node.js`) in markdown files.
|
Fixed commit message (and PR title) typo. (Thanks, @cjihrig!) Rebased against master while I was at it. |
| @@ -42,8 +42,10 @@ module.exports.plugins = [ | |||
| [ | |||
| require('remark-lint-prohibited-strings'), | |||
| [ | |||
| { no: 'v8', yes: 'V8' }, | |||
| { no: 'Javascript', yes: 'JavaScript' } | |||
| { no: 'Github', yes: 'GitHub' }, | |||
There was a problem hiding this comment.
Isn't tools/remark-preset-lint-node/index.js technically provided by watilde/remark-preset-lint-node, and shouldn't be edited downstream? Ref #17441
There was a problem hiding this comment.
It's a small thing, but I'd prefer that the version downstream get synchronized with this version (after this lands) rather than landing downstream first. If it lands downstream first, there's a race condition where new errors can creep in here before the updated version lands here. Not too big a deal for us as we can fix the problematic text, but potentially irksome for anyone installing the preset locally and suddenly getting errors on the Node.js master branch.
The problem with the approach I suggest above is that some info in the package.json will be wrong for a period of time. We're not running the version specified in the package.json. We're running a modified version and we need to update it again when this gets published upstream.
Anyway, I don't feel too strongly about this and can be persuaded that this should wait for downstream rather than the other way around if people feel strongly about it. Related: We should probably move the repo to the nodejs org and allow a few more folks to publish it, assuming @watilde has no problem with that.
There was a problem hiding this comment.
It's a small thing, but I'd prefer that the version downstream get synchronized with this version (after this lands) rather than landing downstream first.
Ok, fine by me.
My other point (and why I put a link to my PR) was that this (very small) module should live within the nodejs/node repo, so that we don't have to worry about upstreaming/downstreaming changes and publishing versions to npm.
|
Raspberry Pi failures are build issues and unrelated. CI is good. |
Trott
added
author ready
Use `GitHub` rather than `Github` and `Node.js` rather than `Node.JS`. PR-URL: nodejs#17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Check for uses of `Github` (rather than `GitHub`) and `Node.JS` (rather than `Node.js`) in markdown files. PR-URL: nodejs#17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
|
Here's a PR to downstream to sync: https://github.com/watilde/remark-preset-lint-node/pull/3 |
Use `GitHub` rather than `Github` and `Node.js` rather than `Node.JS`. PR-URL: #17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Check for uses of `Github` (rather than `GitHub`) and `Node.JS` (rather than `Node.js`) in markdown files. PR-URL: #17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Use `GitHub` rather than `Github` and `Node.js` rather than `Node.JS`. PR-URL: #17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Check for uses of `Github` (rather than `GitHub`) and `Node.JS` (rather than `Node.js`) in markdown files. PR-URL: #17492 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
gibfahn
added
baking-for-lts
Check for uses of
Github(rather thanGitHub) andNode.JS(ratherthan
Node.js) in markdown files.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
tools, doc