FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: enable remark-lint-no-literal-urls by nschonni · Pull Request #32676 · nodejs/node · GitHub

/ node Public

doc: enable remark-lint-no-literal-urls - #32676

Closed
nschonni wants to merge 4 commits into
nodejs:masterfrom
nschonni:remarklint-no-literal-urls
ConversationCommits (4)ChecksFiles changed
Closed

doc: enable remark-lint-no-literal-urls#32676
nschonni wants to merge 4 commits into
nodejs:masterfrom
nschonni:remarklint-no-literal-urls

Conversation

nschonni commented Apr 6, 2020 •
edited
Loading

Copy link
Copy Markdown
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

nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Apr 6, 2020
nschonni force-pushed the remarklint-no-literal-urls branch from 34fa5e0 to d2849c4 Compare April 6, 2020 03:59
nschonni commented Apr 6, 2020
View reviewed changes

nschonni left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Called out the 2 files where the rendering changes

Comment thread doc/guides/security-release-process.md Outdated

nschonni Apr 6, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

These anchor links were incorrect with trailing bracket

Comment thread README.md Outdated

nschonni Apr 6, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

If the mailto format isn't prefered here, the rule could be disabled at the file level

Trott Apr 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think node-core-utils might parse these lines of the README file for some operations. If I'm not wrong about that, then that would need to be tested.

nschonni Apr 6, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

any idea how to test this or who to ping? I'm also good with just disabling at the file or block level

Trott Apr 6, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@nodejs/automation-collaborators

richardlau Apr 11, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

You could attempt to use node-core-utils to land a PR?

The parsing is done in https://github.com/nodejs/node-core-utils/blob/master/lib/collaborators.js.

nschonni Apr 23, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

To avoid conflicts with the tooling, I've disabled the rule at the top of the README and reverted these changes.
I didn't actually test to see if there was an issue with the tool

nschonni added a commit to nschonni/remark-preset-lint-node that referenced this pull request Apr 6, 2020
feat: enable remark-lint-no-literal-urls
56e1f94 
Upstream PR to fix nodejs/node#32676
nschonni mentioned this pull request Apr 6, 2020
Merged

Trott commented Apr 6, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

@nschonni Am I correct that these are the reasons for doing this?:

  • Some markdown renderers will autolink bare URLs and others won't. By surrounding them by < and >, that explicitly tells all conformant renderers to autolink, thus resulting in consistent rendering.
  • This rule is enabled by default in remark-preset-lint-recommended so this will be one less rule that we need to override.

Anything else?

nschonni commented Apr 6, 2020

Copy link
Copy Markdown
Member Author

That seems to cover it @Trott. It also makes it explicit when you leave bare links that should be in code blocks like example.com where you don't want them to be URLs

nschonni force-pushed the remarklint-no-literal-urls branch from d2849c4 to e0f90bb Compare April 11, 2020 06:42

nschonni commented Apr 11, 2020

Copy link
Copy Markdown
Member Author

Rebased for conflict

nschonni force-pushed the remarklint-no-literal-urls branch from e0f90bb to 8b047bc Compare April 23, 2020 02:55
nschonni added a commit to nschonni/remark-preset-lint-node that referenced this pull request Apr 23, 2020
feat: enable remark-lint-no-literal-urls
645f345 
Upstream PR to fix nodejs/node#32676
Trott added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Apr 24, 2020

nodejs-github-bot commented Apr 24, 2020 •
edited by Trott
Loading

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30942/ ✔️

Trott pushed a commit that referenced this pull request Apr 24, 2020
doc: add angle brackets around implicit links
7183d70 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Trott pushed a commit that referenced this pull request Apr 24, 2020
doc: ignore no-literal-urls in changelogs
6fc17fb 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Trott pushed a commit that referenced this pull request Apr 24, 2020
doc: convert bare email addresses to mailto links
414199d 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Trott pushed a commit that referenced this pull request Apr 24, 2020
doc: ignore no-literal-urls in README
0619b60 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>

Trott commented Apr 24, 2020

Copy link
Copy Markdown
Member

Landed in e99ec39...0619b60

Trott closed this Apr 24, 2020
nschonni deleted the remarklint-no-literal-urls branch April 24, 2020 04:52
Trott pushed a commit to nodejs/remark-preset-lint-node that referenced this pull request Apr 24, 2020
feat: enable remark-lint-no-literal-urls (#83)
0c360d7 
Upstream PR to fix nodejs/node#32676
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
doc: add angle brackets around implicit links
7231490 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
doc: ignore no-literal-urls in changelogs
e202244 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
doc: ignore no-literal-urls in README
e054ed5 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs mentioned this pull request Apr 27, 2020
Merged
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: add angle brackets around implicit links
1b325f5 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in changelogs
9af2eb3 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: convert bare email addresses to mailto links
e9b5978 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in README
1b61e56 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: add angle brackets around implicit links
2eb5262 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in changelogs
f7c7713 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: convert bare email addresses to mailto links
a5bed1e 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in README
e372b8b 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR mentioned this pull request Apr 28, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
doc: add angle brackets around implicit links
71f9023 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in changelogs
2bde116 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
doc: convert bare email addresses to mailto links
f92b398 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
doc: ignore no-literal-urls in README
bf331b4 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
doc: add angle brackets around implicit links
2b9576e 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
doc: ignore no-literal-urls in changelogs
59b21a8 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
doc: convert bare email addresses to mailto links
276c2c4 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
doc: ignore no-literal-urls in README
67bf427 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos mentioned this pull request May 2, 2020
Merged
targos pushed a commit that referenced this pull request May 13, 2020
doc: add angle brackets around implicit links
92d91d1 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
doc: ignore no-literal-urls in changelogs
b057175 
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
doc: convert bare email addresses to mailto links
d8bb226 
reflowed for line length after increased url size

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
doc: ignore no-literal-urls in README
7397f80 
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Marlyfleitas added a commit to Marlyfleitas/Node-remark-preset-lint that referenced this pull request Aug 26, 2022
feat: enable remark-lint-no-literal-urls (#83)
c54ffd3 
Upstream PR to fix nodejs/node#32676
patrickm68 added a commit to patrickm68/Node-preset-lint that referenced this pull request Sep 14, 2023
feat: enable remark-lint-no-literal-urls (#83)
9348fe2 
Upstream PR to fix nodejs/node#32676
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

richardlau richardlau left review comments
Trott Trott approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. 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.

4 participants

Back | FazBrowse Home | New Git URL