refactor(test utils): Add options object to test utility functions (getRouteDataTestContext, getTestHead) #3543
Conversation
This file contains hidden or 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
…ithastro#3420) Co-authored-by: Chris Swithinbank <[email protected]> Co-authored-by: trueberryless <[email protected]>
…th missing href" solution (withastro#3501) Co-authored-by: Anders Kaseorg <[email protected]> Co-authored-by: Chris Swithinbank <[email protected]>
…th the options object
🦋 Changeset detectedLatest commit: b4bee23 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Created a new PR, as the previous one (#3542) was synced with main, thus making reviewing it a pain.
Description
<head>#3496In a previous PR, I have added tests to the invalid canonical changes. This required me to include additional arguments to getRouteDataTestContext and getTestHead functions. This refactor is meant to make these changes more readable and developer friendly by adding an options object to both of them. This PR also makes sure all usage of these functions are updated as well. As of now, all tests pass.
Here, route has an additonal
| undefinedbecause of the 'includes description based on page description frontmatter field if provided' test in the same file (TypeScript doesn't like it without that).Other options object type added:
Note: I have placed the new types above these functions. If I need to move them, or if you would prefer interfaces instead, I'd really like to know!