New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed

nschonni wants to merge 4 commits into nodejs:master from nschonni:remarklint-no-literal-urls

Member

nschonni commented Apr 6, 2020 •

edited

Loading

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 doc tools labels

nschonni force-pushed the remarklint-no-literal-urls branch from 34fa5e0 to d2849c4 Compare

April 6, 2020 03:59

nschonni commented

View reviewed changes

Member Author

nschonni left a comment

Called out the 2 files where the rendering changes

doc/guides/security-release-process.md

    
            @@ -88,6 +88,6 @@ information described.
          
              * [ ] Make sure the PRs for the vulnerabilities are closed.

              [H1 CVE requests]: https://hackerone.com/nodejs/cve_requests

              [docker-node]: https://github.com/nodejs/docker-node/issues)

Member Author

nschonni Apr 6, 2020

These anchor links were incorrect with trailing bracket

README.md Outdated

    
            @@ -152,392 +152,428 @@ For information about the governance of the Node.js project, see
          
              ### TSC (Technical Steering Committee)

              * [addaleax](https://github.com/addaleax) -

              **Anna Henningsen** &lt;anna@addaleax.net&gt; (she/her)

              **Anna Henningsen** [anna@addaleax.net](mailto:anna@addaleax.net) (she/her)

Member Author

nschonni Apr 6, 2020

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

Member

Trott Apr 6, 2020

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.

Member Author

nschonni Apr 6, 2020

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

Member

Trott Apr 6, 2020

@nodejs/automation-collaborators

Member

richardlau Apr 11, 2020

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.

Member Author

nschonni Apr 23, 2020

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


          feat: enable remark-lint-no-literal-urls

56e1f94

Upstream PR to fix nodejs/node#32676

nschonni mentioned this pull request

feat: enable remark-lint-no-literal-urls nodejs/remark-preset-lint-node#83

Merged

Member

Trott commented Apr 6, 2020 •

edited

Loading

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

Member Author

nschonni commented Apr 6, 2020

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

Member Author

nschonni commented Apr 11, 2020

Rebased for conflict

nschonni added 4 commits

April 22, 2020 22:51


          doc: add angle brackets around implicit links

a6cfc1d


          doc: ignore no-literal-urls in changelogs

96d8655


          doc: convert bare email addresses to mailto links

96e7c55

reflowed for line length after increased url size


           doc: ignore no-literal-urls in README

8b047bc

 Membership lists are currently formatted in a specific way for tooling

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


          feat: enable remark-lint-no-literal-urls

645f345

Upstream PR to fix nodejs/node#32676

Trott approved these changes

View reviewed changes

Trott added the author ready label

Collaborator

nodejs-github-bot commented Apr 24, 2020 •

edited by Trott

Loading

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

Trott pushed a commit that referenced this pull request


          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


          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


          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


          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>

Member

Trott commented Apr 24, 2020

Landed in e99ec39...0619b60

Trott closed this

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


          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


          doc: add angle brackets around implicit links

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

BethGriggs pushed a commit that referenced this pull request


          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


          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

v14.1.0 proposal #33103

Merged

BridgeAR pushed a commit that referenced this pull request


          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


          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


          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


          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


          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


          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


          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


          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

v13.14.0 proposal #33122

Merged

BethGriggs pushed a commit that referenced this pull request


          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


          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


          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


          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


          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


          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


          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


          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

v12.17.0 release proposal #33197

Merged

targos pushed a commit that referenced this pull request


          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


          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


          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


          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


          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


          feat: enable remark-lint-no-literal-urls (#83)

9348fe2

Upstream PR to fix nodejs/node#32676

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready build doc tools