Add validateOptions hook to Image Service API #6555
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
🦋 Changeset detectedLatest commit: 6f1d337 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 |
github-actions
bot
added
pkg: astro
Princesseuh
changed the title
bluwy
approved these changes
Mar 15, 2023
Merged
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.
Changes
Add a
validateOptionhook that can be used to validate / augment the passed options by the user. This is necessary because certain options (namely format) need to be augmented before reaching other hooks /addStaticImage.For instance, for
format, if we change the file format insidetransformlike we did previously, the final file will have the wrong file extension because the path has already been decided beforetransform. And while it's possible to correct the output path (sincetransformreturns the outputted format), then we would have the wrong file path in the HTML file as it would point to the previous file extension. This hook solves that. I tried to find another solution, but this was the easiest one.Fun-fact: This hook was present in the first version of the RFC, but it was removed during internal discussions as I could not remember the use case, oops.
Fix #6540
Testing
Added a test testing the fix, which uses the hook
Docs
withastro/docs#2859