Edit the absolute link linter #126
Merged
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
Allow JavaScript code as the value of the `href` attribute. This allows us to import assets as MDX modules so we can refer to the asset paths in HTML tags. Otherwise, the linter encounters a runtime exception and fails even if there is a comment that ignores messages from the linter. An example of the linter failing is gravitational/teleport#51193, which imports a bot avatar logo as a module so users can download it.
|
Amplify deployment status
|
ptgott
force-pushed
the
paul.gottschling/2025-01-31-href
branch
from
aae2c4e to
1a3bad9
Compare
avatus
approved these changes
Jan 31, 2025
Comment on lines
26
to
32
| const isAnAbsoluteDocsLink = (href: string): boolean => { | ||
| // The href is not a string value, and is likely an AST node object. Skip | ||
| // the absolute link check. | ||
| if (typeof href != "string") { | ||
| return false; | ||
| } | ||
| return ( |
There was a problem hiding this comment.
if typescript is doing its job, this should only be able to be called with a string anyway. but, i suppose it doesnt hurt to be extra safe
There was a problem hiding this comment.
if typescript is doing its job, this should only be able to be called with a string anyway. but, i suppose it doesnt hurt to be extra safe
👍 For some reason, TypeScript is letting remark call the link linter on non-strings, I guess because it doesn't check the site where remark calls its plugins.
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.
Allow JavaScript code as the value of the
hrefattribute. This allows us to import assets as MDX modules so we can refer to the asset paths in HTML tags. Otherwise, the linter encounters a runtime exception and fails even if there is a comment that ignores messages from the linter.An example of the linter failing is gravitational/teleport#51193, which imports a bot avatar logo as a module so users can download it.