Skip to content
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.

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

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

Closed
wants to merge 4 commits into from

Conversation

nschonni
Copy link
Member

@nschonni nschonni commented Apr 6, 2020

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 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
Copy link
Member Author

@nschonni nschonni left a comment

Choose a reason for hiding this comment

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

Called out the 2 files where the rendering changes

@@ -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)
Copy link
Member Author

Choose a reason for hiding this comment

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

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** <anna@addaleax.net> (she/her)
**Anna Henningsen** [anna@addaleax.net](mailto:anna@addaleax.net) (she/her)
Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

@nodejs/automation-collaborators

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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
@Trott
Copy link
Member

Trott commented Apr 6, 2020

@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
Copy link
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
Copy link
Member Author

Rebased for conflict

nschonni added a commit to nschonni/remark-preset-lint-node that referenced this pull request Apr 23, 2020
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 24, 2020
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 24, 2020

Trott pushed a commit that referenced this pull request Apr 24, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Trott pushed a commit that referenced this pull request Apr 24, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
Trott pushed a commit that referenced this pull request Apr 24, 2020
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
 Membership lists are currently formatted in a specific way for tooling

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

Trott commented Apr 24, 2020

Landed in e99ec39...0619b60

@Trott Trott closed this Apr 24, 2020
@nschonni 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
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 27, 2020
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Apr 27, 2020
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
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
 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
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
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
 Membership lists are currently formatted in a specific way for tooling

PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Apr 28, 2020
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
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
 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
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 30, 2020
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
 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 May 13, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
PR-URL: #32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request May 13, 2020
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
 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
patrickm68 added a commit to patrickm68/Node-preset-lint that referenced this pull request Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, 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
Development

Successfully merging this pull request may close these issues.

4 participants