feat(markdown): Add support for imageReference paths when collecting images
#8475
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
🦋 Changeset detectedLatest commit: f9f37d4 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
webpro
commented
Sep 10, 2023
| if (shouldOptimizeImage(node.url)) imagePaths.add(node.url); | ||
| } | ||
| if (node.type === 'imageReference') { | ||
| const imageDefinition = definition(node.identifier); |
There was a problem hiding this comment.
Instead of pre-loading the definitions(tree), we could also look them up lazily here. This would lower the performance impact when not using the additional imageReference syntax (the majority I guess), but slow down the implementation in this PR when that syntax is used.
Either way, this type of AST traversal is fast. We could traverse only direct tree.children (no further descendants) to minimize overhead.
|
!preview img-ref |
bluwy
approved these changes
Sep 12, 2023
ematipico
approved these changes
Sep 12, 2023
Merged
Closed
1 task
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.
Usually images in Markdown are authored like so:
Yet they can also use an
imageReferencewith adefinition:Both syntaxes work fine when it comes to rendering HTML, but images referenced in the second form are not collected in
remarkCollectImages()as that only catchesimagenodes, but notimageReferencenodes.Changes
This PR adds a unit test for the former, and support and a unit test for the latter.
Did not measure, but the impact on performance should be minimal. Also see the note with the relevant code.
Testing
This PR contains a test for existing functionality to assert image collection, and adds a test for the new functionality.
Docs
/cc @withastro/maintainers-docs for feedback!
Since I had all my images in the yet unsupported syntax, it I didn't see why my images weren't rendered at all. Also because the docs on images do not include an example with an image in the same directory as the Markdown file (yet I did have warnings in the console).
Accepting this PR will make all the problems go away ✨