tools: validate apidoc links #21889
Closed
tools: validate apidoc links #21889
Conversation
This file contains 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
addaleax
approved these changes
Jul 19, 2018
tools/doc/allhtml.js
Outdated
| @@ -73,3 +73,13 @@ all = all.slice(0, apiStart.index + apiStart[0].length) + | |||
|
|
|||
| // Write results. | |||
| fs.writeFileSync(source + '/all.html', all, 'utf8'); | |||
|
|
|||
| // Validate all hrefs have a target | |||
| const ids = {}; | |||
There was a problem hiding this comment.
Can we use a Set for this? I think that might be a tad more natural 🙂
jasnell
approved these changes
Jul 19, 2018
cjihrig
approved these changes
Jul 19, 2018
addaleax
added
doc
vsemozhetbyt
approved these changes
Jul 19, 2018
tools/doc/allhtml.js
Outdated
| @@ -73,3 +73,13 @@ all = all.slice(0, apiStart.index + apiStart[0].length) + | |||
|
|
|||
| // Write results. | |||
| fs.writeFileSync(source + '/all.html', all, 'utf8'); | |||
|
|
|||
| // Validate all hrefs have a target | |||
There was a problem hiding this comment.
Nit: a period in the end.
This comment has been minimized.
This comment has been minimized.
|
Ignorable nit: not sure if this |
lpinca
approved these changes
Jul 19, 2018
Trott
approved these changes
Jul 19, 2018
|
Just wanted to say thank you – this is super awesome ❤️ |
tools/doc/allhtml.js
Outdated
|
|
||
| const href_re = / href="#(\w+)"/g; | ||
| while (match = href_re.exec(all)) { | ||
| if (!ids.has(match[1])) throw new Error(`link not found: ${match[1]}`); |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
I don't think efficiency is a concern here... it will only be retrieved twice at most one time per run, and only if an error is thrown.
This comment has been minimized.
This comment has been minimized.
lpinca
reviewed
Jul 20, 2018
tools/doc/allhtml.js
Outdated
|
|
||
| // Validate all hrefs have a target. | ||
| const ids = new Set(); | ||
| const id_re = / id="(\w+)"/g; |
vsemozhetbyt
pushed a commit
that referenced
this pull request
Jul 22, 2018
PR-URL: #21889 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
|
Landed in 78039b5 |
targos
pushed a commit
that referenced
this pull request
Jul 24, 2018
PR-URL: #21889 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Merged
This was referenced Aug 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When an API signature changes, it may break a link made to it in another part of the documentation. As a part of the generation of
all.html, check all such links to make sure that they have a valid target.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes