[Snyk] Upgrade @astrojs/starlight from 0.14.0 to 0.32.1 #38
+16,749
−8,194
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
Snyk has created this PR to upgrade @astrojs/starlight from 0.14.0 to 0.32.1. See this package in npm: @astrojs/starlight See this project in Snyk: https://app.snyk.io/org/jeremyvoisin/project/c0080801-1e85-42b8-a1b7-3da286cee8e0?utm_source=github&utm_medium=referral&page=upgrade-pr
|
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.
Snyk has created this PR to upgrade @astrojs/starlight from 0.14.0 to 0.32.1.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
The recommended version is 74 versions ahead of your current version.
The recommended version was released a month ago.
Issues fixed by the recommended upgrade:
SNYK-JS-NANOID-8492085
SNYK-JS-PAGEFIND-7886960
SNYK-JS-PAGEFINDDEFAULTUI-7886963
SNYK-JS-POSTCSS-5926692
Release notes
Package name: @astrojs/starlight
Patch Changes
ec5ca59Thanks @ HiDeoo! - Fixes an issue preventing the use of rewrites.Minor Changes
#2390
f493361Thanks @ delucis! - Moves route data toAstro.localsinstead of passing it down via component propsPreviously, all of Starlight’s templating components, including user or plugin overrides, had access to a data object for the current route via
Astro.props.This data is now available as
Astro.locals.starlightRouteinstead.To update, refactor any component overrides you have:
@ astrojs/starlight/props, which is now deprecated.Astro.propsto useAstro.locals.starlightRouteinstead.{...Astro.props}into child components, which is no longer required.In the following example, a custom override for Starlight’s
LastUpdatedcomponent is updated for the new style:import Default from '@ astrojs/starlight/components/LastUpdated.astro';
- import type { Props } from '@ astrojs/starlight/props';
- const { lastUpdated } = Astro.props;
+ const { lastUpdated } = Astro.locals.starlightRoute;
const updatedThisYear = lastUpdated?.getFullYear() === new Date().getFullYear();
---
{updatedThisYear && (
- <Default {...Astro.props}><slot /></Default>
+ <Default><slot /></Default>
)}
Community Starlight plugins may also need to be manually updated to work with Starlight 0.32. If you encounter any issues, please reach out to the plugin author to see if it is a known issue or if an updated version is being worked on.
#2578
f895f75Thanks @ HiDeoo! - Deprecates the Starlight pluginsetuphook in favor of the newconfig:setuphook which provides the same functionality.The Starlight plugin
setuphook is now deprecated and will be removed in a future release. Please update your plugins to use the newconfig:setuphook instead.export default { name: 'plugin-with-translations', hooks: { - 'setup'({ config }) { + 'config:setup'({ config }) { // Your plugin configuration setup code }, }, };#2578
f895f75Thanks @ HiDeoo! - Exposes the built-in localization system in the Starlight pluginconfig:setuphook.This addition changes how Starlight plugins add or update translation strings used in Starlight’s localization APIs.
Plugins previously using the
injectTranslations()callback function from the pluginconfig:setuphook should now use the same function available in thei18n:setuphook.export default { name: 'plugin-with-translations', hooks: { - 'config:setup'({ injectTranslations }) { + 'i18n:setup'({ injectTranslations }) { injectTranslations({ en: { 'myPlugin.doThing': 'Do the thing', }, fr: { 'myPlugin.doThing': 'Faire le truc', }, }); }, }, };#2858
2df9d05Thanks @ XREvo! - Adds support for Pagefind’s multisite search features#2578
f895f75Thanks @ HiDeoo! - Adds a newHookParametersutility type to get the type of a plugin hook’s arguments.#2578
f895f75Thanks @ HiDeoo! - Adds a newuseTranslations()callback function to the Starlight pluginconfig:setuphook to generate a utility function to access UI strings for a given language.#2578
f895f75Thanks @ HiDeoo! - Adds a newabsolutePathToLang()callback function to the Starlight pluginconfig:setupto get the language for a given absolute file path.Patch Changes
9b32ba9Thanks @ HiDeoo! - Fixes styling of filter and metadata elements in Pagefind search UI.Patch Changes
ed6f9fdThanks @ HiDeoo! - Exposes theStarlightIconTypeScript type referencing the names of Starlight’s built-in icons.Minor Changes
#2777
88f4214Thanks @ hippotastic! - Updatesastro-expressive-codedependency to the latest version (0.40).This includes an update to the latest Shiki version (1.26.1), providing access to all current Shiki themes and syntax highlighting languages, and adding the config options
shiki.engine,shiki.bundledLangs,shiki.langAliasandremoveUnusedThemes. It also adds new style variants to the optional collapsible sections plugin.See the Expressive Code release notes for full details.
#2736⚠️ BREAKING CHANGE: The minimum supported version of Astro is now 5.1.5
29a885bThanks @ delucis! -Please update Astro and Starlight together:
#2728
e187383Thanks @ delucis! - Updates minimum Pagefind dependency to v1.3.0, sets new defaults for Pagefind’s ranking options, and adds support for manually configuring the ranking optionsThe new ranking option defaults have been evaluated against Starlight’s own docs to improve the quality of search results. See “Customize Pagefind's result ranking” for more details about how they work.
#157
23bf960Thanks @ tony-sull! - Adds a print stylesheet to improve the appearance of Starlight docs pages when printed#2728
e187383Thanks @ delucis! - Fixes Pagefind logging to respect the Astro log level. When using Astro’s--verboseor--silentCLI flags, these are now respected by Pagefind as well.Patch Changes
#2792
412effbThanks @ dhruvkb! - Uses semanticvar(--sl-color-hairline)for the page sidebar border instead ofvar(--sl-color-gray-6). This is visually the same as previously but makes it easier to override the hairline color consistently across a site.#2736
29a885bThanks @ delucis! - Updates internal dependencies@ astrojs/sitemapand@ astrojs/mdxto the latest versions#2782
d9d415bThanks @ delucis! - Fixes a documentation link in the JSDoc comment for theStarlightExpressiveCodeOptionstype#2708
442c819Thanks @ delucis! - Fixes colour contrast correction in code blocksPatch Changes
#2722
0b206d3Thanks @ techfg! - Fixes display of long site title on mobile#2762
7ab1576Thanks @ HiDeoo! - Prevents the header title from being translated by automatic translation systems.Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information: