Skip to content

Hack around remark-validate-link warnings#58599

Merged
amcasey merged 1 commit intoDefinitelyTyped:masterfrom
amcasey:ReadmeHack
Feb 4, 2022
Merged

Hack around remark-validate-link warnings#58599
amcasey merged 1 commit intoDefinitelyTyped:masterfrom
amcasey:ReadmeHack

Conversation

@amcasey
Copy link
Copy Markdown
Contributor

@amcasey amcasey commented Feb 4, 2022

It appears that remark-validate-link uses hosted-git-info to convert our GH permalink into a relative link (since it shares a prefix with our GH repo) and then warns that the relative link is dangling. This change uses URL encoding to defeat the tool's simple prefix matching.

Filed #58598 to investigate a real solution.

It appears that `remark-validate-link` uses `hosted-git-info` to convert our GH permalink into a relative link (since it shares a prefix with our GH repo) and then warns that the relative link is dangling.  This change uses URL encoding to defeat the tool's simple prefix matching.

Filed DefinitelyTyped#58598 to investigate a real solution.
@amcasey amcasey requested a review from sandersn February 4, 2022 01:47
@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Feb 4, 2022

@amcasey Thank you for submitting this PR!

This is a live comment which I will keep updated.

This PR touches some part of DefinitelyTyped infrastructure, so a DT maintainer will need to review it. This is rare — did you mean to do this?

0 packages in this PR (and infra files)

Code Reviews

There aren't any other owners of this package, so a DT maintainer will review it.

You can test the changes of this PR in the Playground.

Status

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 58599,
  "author": "amcasey",
  "headCommitOid": "b3c6a16668d620adecf4f9e5e8fd29ccc2060a18",
  "mergeBaseOid": "0c4fe9aa89dac0e458677e0f697bca253bccabed",
  "lastPushDate": "2022-02-04T01:47:24.000Z",
  "lastActivityDate": "2022-02-04T01:47:56.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": null,
      "kind": "edit",
      "files": [
        {
          "path": "README.es.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.it.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.ja.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.ko.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.pt.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.ru.md",
          "kind": "infrastructure"
        },
        {
          "path": "README.zh.md",
          "kind": "infrastructure"
        }
      ],
      "owners": [],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 1029565410,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Copy Markdown
Contributor

🔔 @amcasey — there are no owners, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@amcasey amcasey merged commit 730a0dc into DefinitelyTyped:master Feb 4, 2022
@amcasey amcasey deleted the ReadmeHack branch February 4, 2022 01:54
martin-badin pushed a commit to martin-badin/DefinitelyTyped that referenced this pull request Feb 23, 2022
It appears that `remark-validate-link` uses `hosted-git-info` to convert our GH permalink into a relative link (since it shares a prefix with our GH repo) and then warns that the relative link is dangling.  This change uses URL encoding to defeat the tool's simple prefix matching.

Filed DefinitelyTyped#58598 to investigate a real solution.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants