Skip to content

refactor(test utils): Add options object to test utility functions (getRouteDataTestContext, getTestHead) #3542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 40 commits into from
Closed

refactor(test utils): Add options object to test utility functions (getRouteDataTestContext, getTestHead) #3542

wants to merge 40 commits into from

Conversation

@erbierc
Copy link
Contributor

@erbierc erbierc commented Nov 9, 2025

Description

  • Closes #N/A - follow up to Don’t generate invalid meta tags in <head> #3496
  • What does this PR change? Give us a brief description.
    In 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.
type GetTestHeadOptions = {
	heads?: HeadConfig,
	route?: Route | undefined,
	setSite?: boolean
}

Here, route has an additonal | undefined because 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:

type RouteDataTestContextOptions = {
	pathname?: string,
	setSite?: boolean
}

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!

brauliodiez and others added 30 commits October 23, 2025 10:30
@brauliodiez @HiDeoo @delucis
Doc Resources Section: Adding card Content Island CLI - Starlight
1c3d999 
@lunaria-ignore:docs/src/content/docs/es/resources/plugins.mdx

Co-authored-by: HiDeoo <[email protected]>
Co-authored-by: delucis <[email protected]>
@trueberryless
i18n(de): update plugins.mdx (withastro#3498)
8720f8b
@jsparkdev
i18n(ko-KR): update plugins.mdx (withastro#3502)
5018793
@ematipico
chore: add Biome to showcase (withastro#3505)
0ccdf9f
@ArmandPhilippot @HiDeoo
i18n(fr): update resources/plugins.mdx (withastro#3506)
2953c4e 
Co-authored-by: HiDeoo <[email protected]>
@erbierc @HiDeoo
docs: update CONTRIBUTING.md to clarify development environment setup (…
482a995 
…withastro#3495)

Co-authored-by: HiDeoo <[email protected]>
@delucis
Update release workflow for OIDC (withastro#3500)
7700456
@astrobot-houston @github-actions
[ci] release (withastro#3490)
27e8b6c 
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@HiDeoo @delucis
Disable Prettier on GitHub Actions workflow files (withastro#3509)
dad3709 
Co-authored-by: delucis <[email protected]>
@hudlow @delucis
[i18nIgnore] Match title case convention for components/using-compone…
e49b76f 
…nts (withastro#3508)

Co-authored-by: Chris Swithinbank <[email protected]>
@astrobot-houston @delucis @HiDeoo
ci: update file icons (withastro#3511)
8727df1 
Co-authored-by: delucis <[email protected]>
Co-authored-by: HiDeoo <[email protected]>
@dlcastillop @HiDeoo
Add starlight-page-actions (withastro#3515)
3c49b3d 
Co-authored-by: HiDeoo <[email protected]>
@haydenhoang @HiDeoo @delucis
docs(plugin): starlight-docsearch-typesense (withastro#3504)
fe9bda8 
Co-authored-by: HiDeoo <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
@delucis @astrobot-houston
[ci] format
fea3b89
@HiDeoo @delucis
Tweak a11y e2e tests (withastro#3507)
28e44c0 
Co-authored-by: delucis <[email protected]>
@dragomano
i18n(ru): update translations (withastro#3512)
e823ca9
@HiDeoo @delucis
Speed up Linux e2e tests (withastro#3517)
4cab45f 
Co-authored-by: delucis <[email protected]>
@delucis @HiDeoo
Skip a11y CI checks for docs changes that aren’t tested anyway (witha…
60592b9 
…stro#3520)

Co-authored-by: HiDeoo <[email protected]>
@trueberryless
i18n(de): update translation guides/site-search.mdx (withastro#3518)
07a9d4a
@trueberryless @delucis
i18n(de): update translation resources/plugins.mdx (withastro#3519)
975d6d1 
Co-authored-by: Chris Swithinbank <[email protected]>
@HiDeoo @delucis
docs: add starlight-themes link (withastro#3510)
2934b4c 
Co-authored-by: Chris Swithinbank <[email protected]>
@ArmandPhilippot @HiDeoo
i18n(fr): update resources/plugins.mdx (withastro#3523)
d56f7e5 
Co-authored-by: HiDeoo <[email protected]>
@ArmandPhilippot @HiDeoo
i18n(fr): update guides/site-search.mdx (withastro#3524)
1466904 
Co-authored-by: HiDeoo <[email protected]>
@delucis
Fix file filters added in withastro#3520 (withastro#3522)
0cfa009
@ArmandPhilippot @HiDeoo
i18n(fr): update resources/themes (withastro#3526)
a9599bb 
Co-authored-by: HiDeoo <[email protected]>
@trueberryless @delucis
feat: add some of trueberryless' new Starlight blogs to community con…
cef0c74 
…tent (withastro#3525)

Co-authored-by: Chris Swithinbank <[email protected]>
@jsparkdev
i18n(ko-KR): update themes.mdx (withastro#3533)
44c4fe9
@jsparkdev @HiDeoo
i18n(ko-KR): update plugins.mdx (withastro#3532)
8a5f516 
Co-authored-by: HiDeoo <[email protected]>
@jsparkdev @HiDeoo
i18n(ko-KR): update site-search.mdx (withastro#3530)
c4d6536 
Co-authored-by: HiDeoo <[email protected]>
@jsparkdev @HiDeoo
i18n(ko-KR): update community-content.mdx (withastro#3531)
8a72a19 
Co-authored-by: HiDeoo <[email protected]>
ArmandPhilippot and others added 10 commits November 6, 2025 12:16
@ArmandPhilippot @HiDeoo
i18n(fr): update resources/community-content.mdx (withastro#3535)
c1838cf 
Co-authored-by: HiDeoo <[email protected]>
@trueberryless @deining @delucis
i18n(de): update community-content.mdx (withastro#3529)
5604cdd 
Co-authored-by: Andreas Deininger <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
@HiDeoo @delucis
ci: use Firefox for Windows E2E tests (withastro#3538)
5a89a16 
Co-authored-by: delucis <[email protected]>
@jacobdalamb @Adammatthiesen @HiDeoo
Remove broken showcase sites (withastro#3536)
4d17c21 
Co-authored-by: Adammatthiesen <[email protected]>
Co-authored-by: HiDeoo <[email protected]>
@IEvangelist @HiDeoo
chore: add aspire.dev to showcase (withastro#3539)
7dafc44 
Co-authored-by: HiDeoo <[email protected]>
@deining @delucis
Fixing typos (withastro#3528)
6365936 
Co-authored-by: Chris Swithinbank <[email protected]>
@erbierc
refactor(test utils): add initial setup of options objects
3763950
@erbierc
refactor(test utils): add option objects to getRouteDataTestContext a…
7d5a003 
…nd getTestHead
@erbierc
reafactor(test utils): update the usage of getRouteDataTestContext wi…
b4bee23 
…th the options object
@erbierc
Merge branch 'withastro:main' into add-options-obj-to-test-utils
f54bc1d
@changeset-bot
Copy link

changeset-bot bot commented Nov 9, 2025

🦋 Changeset detected

Latest commit: f54bc1d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Patch

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 github-actions bot added 🚨 action Changes to GitHub Action workflows i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package 🌟 tailwind Changes to Starlight’s Tailwind package 🌟 markdoc Changes to Starlight’s Markdoc package 🌟 docsearch Changes to Starlight’s DocSearch plugin labels Nov 9, 2025
@erbierc
Copy link
Contributor Author

erbierc commented Nov 9, 2025

Okay, maybe it was a bad idea to sync the branches before the PR! Here are my commits:
3763950
7d5a003
b4bee23

@erbierc erbierc marked this pull request as draft November 9, 2025 19:46
@erbierc erbierc closed this Nov 9, 2025
This was referenced Nov 9, 2025
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

🚨 action Changes to GitHub Action workflows 🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes 🌟 docsearch Changes to Starlight’s DocSearch plugin i18n Anything to do with internationalization & translation efforts 🌟 markdoc Changes to Starlight’s Markdoc package 🌟 tailwind Changes to Starlight’s Tailwind package

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.