@astrojs/starlight 0.14.0 → 0.15.1

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # @astrojs/starlight
 
+## 0.15.1
+
+### Patch Changes
+
+- [#1273](https://github.com/withastro/starlight/pull/1273) [`ae53155`](https://github.com/withastro/starlight/commit/ae531557aa4d42bd27c15f8f08bb3ca8242c9beb) Thanks [@natemoo-re](https://github.com/natemoo-re)! - Updates `<SocialIcon />` styling for improved accessibility. Specifically, the component now meets the [Target Size (Minimum)](https://www.w3.org/WAI/WCAG22/Understanding/target-size-minimum.html) success criteria defined by [Web Content Accessibility Guidelines (WCAG) 2.2](https://www.w3.org/TR/WCAG22/).
+
+- [#1289](https://github.com/withastro/starlight/pull/1289) [`9bd343f`](https://github.com/withastro/starlight/commit/9bd343fb1efab90a0aa03a95b1928a53c1674000) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds French translations for Expressive Code UI
+
+- [#1280](https://github.com/withastro/starlight/pull/1280) [`6b1693d`](https://github.com/withastro/starlight/commit/6b1693d55552a48316a31d986e1cbaf695f10a61) Thanks [@kevinzunigacuellar](https://github.com/kevinzunigacuellar)! - Adds Spanish translations for Expressive Code UI
+
+- [#1276](https://github.com/withastro/starlight/pull/1276) [`667f23d`](https://github.com/withastro/starlight/commit/667f23d615742b44bb18ace39d981f8797b8ac55) Thanks [@hippotastic](https://github.com/hippotastic)! - Updates `astro-expressive-code` dependency to the latest version
+
+- [#1266](https://github.com/withastro/starlight/pull/1266) [`c9edf30`](https://github.com/withastro/starlight/commit/c9edf30b16f66757797dcaa5161b4afc18027476) Thanks [@alex-way](https://github.com/alex-way)! - Removes redundant subprocess calls in git last-updated time utility to improve performance
+
+- [#1278](https://github.com/withastro/starlight/pull/1278) [`e88abb0`](https://github.com/withastro/starlight/commit/e88abb0cc8b329500c15bc77aaed3907ec7dc507) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Exports the `StarlightUserConfig` TypeScript type representing the user's Starlight configuration received by plugins.
+
+## 0.15.0
+
+### Minor Changes
+
+- [#1238](https://github.com/withastro/starlight/pull/1238) [`02a808e`](https://github.com/withastro/starlight/commit/02a808e4a0b9ac2383576e3495f6a766b663d773) Thanks [@delucis](https://github.com/delucis)! - Add support for Astro v4, drop support for Astro v3
+
+  ⚠️ **BREAKING CHANGE** Astro v3 is no longer supported. Make sure you [update Astro](https://docs.astro.build/en/guides/upgrade-to/v4/) and any other integrations at the same time as updating Starlight.
+
+  Use the new `@astrojs/upgrade` command to upgrade Astro and Starlight together:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
+- [#1242](https://github.com/withastro/starlight/pull/1242) [`d8fc9e1`](https://github.com/withastro/starlight/commit/d8fc9e15bd2ae4c945b5a3856a6ce3b5629e8b29) Thanks [@delucis](https://github.com/delucis)! - Enables link prefetching on hover by default
+
+  Astro v4’s [prefetch](https://docs.astro.build/en/guides/prefetch) support is now enabled by default. If `prefetch` is not set in `astro.config.mjs`, Starlight will use `prefetch: { prefetchAll: true, defaultStrategy: 'hover' }` by default.
+
+  If you want to preserve previous behaviour, disable link prefetching in `astro.config.mjs`:
+
+  ```js
+  import { defineConfig } from 'astro/config';
+  import starlight from '@astrojs/starlight';
+
+  export default defineConfig({
+  	// Disable link prefetching:
+  	prefetch: false,
+
+  	integrations: [
+  		starlight({
+  			// ...
+  		}),
+  	],
+  });
+  ```
+
+### Patch Changes
+
+- [#1226](https://github.com/withastro/starlight/pull/1226) [`909afa2`](https://github.com/withastro/starlight/commit/909afa2d468099e237bfbd25eda56270b7b00082) Thanks [@tlandmangh](https://github.com/tlandmangh)! - Add Dutch translations of default aside labels
+
+- [#1243](https://github.com/withastro/starlight/pull/1243) [`ee234eb`](https://github.com/withastro/starlight/commit/ee234ebddcba8d07e2c879f33e38631c8955ffcf) Thanks [@khajimatov](https://github.com/khajimatov)! - Fix typo in Russian untranslated content notice
+
+- [#1170](https://github.com/withastro/starlight/pull/1170) [`bcc2301`](https://github.com/withastro/starlight/commit/bcc2301c06796edec3923c666078e82eaf5a1990) Thanks [@tmcw](https://github.com/tmcw)! - Fix timezone-reliance in LastUpdated
+
+- [#1203](https://github.com/withastro/starlight/pull/1203) [`4601449`](https://github.com/withastro/starlight/commit/4601449894bbbd619e4149788113090b67697fe1) Thanks [@orhun](https://github.com/orhun)! - Adds Matrix social link icon
+
 ## 0.14.0
 
 ### Minor Changes

package/components/Icons.ts

@@ -101,4 +101,6 @@ export const Icons = {
 		'<path d="M22.04 7.6c0-2.8-2.19-5.1-4.75-5.93a15.19 15.19 0 0 0-10.44.55C3.16 3.96 2 7.78 1.95 11.58c-.02 3.12.3 11.36 4.94 11.42 3.45.04 3.97-4.4 5.56-6.55 1.14-1.52 2.6-1.95 4.4-2.4 3.1-.76 5.2-3.2 5.2-6.44Z"/>',
 	slack:
 		'<path d="M5.042 15.165a2.528 2.528 0 0 1-2.52 2.523A2.528 2.528 0 0 1 0 15.165a2.527 2.527 0 0 1 2.522-2.52h2.52v2.52Zm1.271 0a2.527 2.527 0 0 1 2.521-2.52 2.527 2.527 0 0 1 2.521 2.52v6.313A2.528 2.528 0 0 1 8.834 24a2.528 2.528 0 0 1-2.521-2.522v-6.313ZM8.834 5.042a2.528 2.528 0 0 1-2.521-2.52A2.528 2.528 0 0 1 8.834 0a2.528 2.528 0 0 1 2.521 2.522v2.52H8.834Zm0 1.271a2.528 2.528 0 0 1 2.521 2.521 2.528 2.528 0 0 1-2.521 2.521H2.522A2.528 2.528 0 0 1 0 8.834a2.528 2.528 0 0 1 2.522-2.521h6.312Zm10.122 2.521a2.528 2.528 0 0 1 2.522-2.521A2.528 2.528 0 0 1 24 8.834a2.528 2.528 0 0 1-2.522 2.521h-2.522V8.834Zm-1.268 0a2.528 2.528 0 0 1-2.523 2.521 2.527 2.527 0 0 1-2.52-2.521V2.522A2.527 2.527 0 0 1 15.165 0a2.528 2.528 0 0 1 2.523 2.522v6.312Zm-2.523 10.122a2.528 2.528 0 0 1 2.523 2.522A2.528 2.528 0 0 1 15.165 24a2.527 2.527 0 0 1-2.52-2.522v-2.522h2.52Zm0-1.268a2.527 2.527 0 0 1-2.52-2.523 2.526 2.526 0 0 1 2.52-2.52h6.313A2.527 2.527 0 0 1 24 15.165a2.528 2.528 0 0 1-2.522 2.523h-6.313Z"/>',
+	matrix:
+		'<path d="M22.5 1.5v21h-2.25V24H24V0h-3.75v1.5h2.25ZM7.46 7.95V9.1h.04a3.02 3.02 0 0 1 2.61-1.39c.54 0 1.03.1 1.48.32.44.2.78.58 1.01 1.1.26-.37.6-.7 1.03-.99.44-.28.95-.43 1.55-.43.45 0 .87.06 1.26.17.38.11.71.29.99.53.27.24.49.56.64.95.15.4.23.86.23 1.42v5.72h-2.34v-4.85c0-.29-.01-.56-.04-.8a1.73 1.73 0 0 0-.18-.67 1.1 1.1 0 0 0-.44-.45 1.6 1.6 0 0 0-.78-.16c-.33 0-.6.06-.8.19-.2.12-.37.29-.48.5a2 2 0 0 0-.23.69c-.04.26-.06.52-.06.78v4.77H10.6v-4.8l-.01-.75a2.29 2.29 0 0 0-.14-.69c-.08-.2-.23-.38-.42-.5a1.5 1.5 0 0 0-.85-.2c-.15.01-.3.04-.44.08-.19.06-.37.15-.52.28-.18.14-.32.34-.44.6-.12.26-.18.6-.18 1.02v4.96H5.25V7.94h2.21ZM1.5 1.5v21h2.25V24H0V0h3.75v1.5H1.5Z"/>',
 };

package/components/LastUpdated.astro

@@ -9,7 +9,7 @@ const { labels, lang, lastUpdated } = Astro.props;
 		<p>
 			{labels['page.lastUpdated']}{' '}
 			<time datetime={lastUpdated.toISOString()}>
-				{lastUpdated.toLocaleDateString(lang, { dateStyle: 'medium' })}
+				{lastUpdated.toLocaleDateString(lang, { dateStyle: 'medium', timeZone: 'UTC' })}
 			</time>
 		</p>
 	)

package/components/SocialIcons.astro

@@ -24,6 +24,8 @@ const links = Object.entries(config.social || {}) as [Platform, SocialConfig][];
 <style>
 	a {
 		color: var(--sl-color-text-accent);
+		padding: 0.5em;
+		margin: -0.5em;
 	}
 	a:hover {
 		opacity: 0.66;

package/index.ts

@@ -1,5 +1,5 @@
 import mdx from '@astrojs/mdx';
-import type { AstroIntegration, AstroUserConfig } from 'astro';
+import type { AstroIntegration } from 'astro';
 import { spawn } from 'node:child_process';
 import { dirname, relative } from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -41,11 +41,11 @@ export default function StarlightIntegration({
 
 				injectRoute({
 					pattern: '404',
-					entryPoint: '@astrojs/starlight/404.astro',
+					entrypoint: '@astrojs/starlight/404.astro',
 				});
 				injectRoute({
 					pattern: '[...slug]',
-					entryPoint: '@astrojs/starlight/index.astro',
+					entrypoint: '@astrojs/starlight/index.astro',
 				});
 				// Add built-in integrations only if they are not already added by the user through the
 				// config or by a plugin.
@@ -61,7 +61,7 @@ export default function StarlightIntegration({
 				if (!allIntegrations.find(({ name }) => name === '@astrojs/mdx')) {
 					integrations.push(mdx());
 				}
-				const newConfig: AstroUserConfig = {
+				updateConfig({
 					integrations,
 					vite: {
 						plugins: [vitePluginStarlightUserConfig(starlightConfig, config)],
@@ -76,8 +76,9 @@ export default function StarlightIntegration({
 							config.markdown.shikiConfig.theme !== 'github-dark' ? {} : { theme: 'css-variables' },
 					},
 					scopedStyleStrategy: 'where',
-				};
-				updateConfig(newConfig);
+					// If not already configured, default to prefetching all links on hover.
+					prefetch: config.prefetch ?? { prefetchAll: true },
+				});
 			},
 
 			'astro:build:done': ({ dir }) => {

package/integrations/asides.ts

@@ -1,3 +1,5 @@
+/// <reference types="mdast-util-directive" />
+
 import type { AstroConfig, AstroUserConfig } from 'astro';
 import { h as _h, s as _s, type Properties } from 'hastscript';
 import type { Paragraph as P, Root } from 'mdast';
@@ -100,7 +102,7 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
 		const locale = pathToLocale(file.history[0], options);
 		const t = options.useTranslations(locale);
 		visit(tree, (node, index, parent) => {
-			if (!parent || index === null || node.type !== 'containerDirective') {
+			if (!parent || index === undefined || node.type !== 'containerDirective') {
 				return;
 			}
 			const variant = node.name;
@@ -112,7 +114,7 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
 			// title prop, and remove the paragraph from children.
 			let title = t(`aside.${variant}`);
 			remove(node, (child): boolean | void => {
-				if (child.data?.directiveLabel) {
+				if (child.data && 'directiveLabel' in child.data && child.data.directiveLabel) {
 					if (
 						'children' in child &&
 						Array.isArray(child.children) &&

package/integrations/code-rtl-support.ts

@@ -1,4 +1,4 @@
-import type { Root } from 'hastscript/lib/core';
+import type { Root } from 'hast';
 import { CONTINUE, SKIP, visit } from 'unist-util-visit';
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.14.0",
+  "version": "0.15.1",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -159,32 +159,34 @@
     "./style/markdown.css": "./style/markdown.css"
   },
   "peerDependencies": {
-    "astro": "^3.2.0"
+    "astro": "^4.0.0"
   },
   "devDependencies": {
-    "@astrojs/markdown-remark": "^3.2.1",
+    "@astrojs/markdown-remark": "^4.0.0",
     "@types/node": "^18.16.19",
     "@vitest/coverage-v8": "^0.33.0",
-    "astro": "^3.2.3",
+    "astro": "^4.0.1",
     "vitest": "^0.33.0"
   },
   "dependencies": {
-    "@astrojs/mdx": "^1.1.0",
+    "@astrojs/mdx": "^2.0.0",
     "@astrojs/sitemap": "^3.0.3",
     "@pagefind/default-ui": "^1.0.3",
-    "@types/mdast": "^3.0.11",
-    "astro-expressive-code": "^0.29.0",
+    "@types/hast": "^3.0.3",
+    "@types/mdast": "^4.0.3",
+    "astro-expressive-code": "^0.30.1",
     "bcp-47": "^2.1.0",
     "execa": "^8.0.1",
-    "hast-util-select": "^5.0.5",
-    "hastscript": "^7.2.0",
+    "hast-util-select": "^6.0.2",
+    "hastscript": "^8.0.0",
+    "mdast-util-directive": "^3.0.0",
     "pagefind": "^1.0.3",
-    "rehype": "^12.0.1",
-    "remark-directive": "^2.0.1",
-    "unified": "^10.1.2",
-    "unist-util-remove": "^3.1.1",
-    "unist-util-visit": "^4.1.2",
-    "vfile": "^5.3.7"
+    "rehype": "^13.0.1",
+    "remark-directive": "^3.0.0",
+    "unified": "^11.0.4",
+    "unist-util-remove": "^4.0.0",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.1"
   },
   "scripts": {
     "test": "vitest",

package/schemas/social.ts

@@ -25,6 +25,7 @@ export const socialLinks = [
 	'reddit',
 	'patreon',
 	'slack',
+	'matrix',
 ] as const;
 
 export const SocialLinksSchema = () =>
@@ -65,6 +66,7 @@ export const SocialLinksSchema = () =>
 					reddit: 'Reddit',
 					patreon: 'Patreon',
 					slack: 'Slack',
+					matrix: 'Matrix',
 				}[key];
 				labelledLinks[key] = { label, url };
 			}

package/translations/es.json

@@ -22,5 +22,8 @@
   "aside.note": "Nota",
   "aside.tip": "Consejo",
   "aside.caution": "Precaución",
-  "aside.danger": "Peligro"
+  "aside.danger": "Peligro",
+  "expressiveCode.copyButtonCopied": "¡Copiado!",
+  "expressiveCode.copyButtonTooltip": "Copiar al portapapeles",
+  "expressiveCode.terminalWindowFallbackTitle": "Ventana de terminal"
 }

package/translations/fr.json

@@ -22,5 +22,8 @@
   "aside.note": "Note",
   "aside.tip": "Astuce",
   "aside.caution": "Attention",
-  "aside.danger": "Danger"
+  "aside.danger": "Danger",
+  "expressiveCode.copyButtonCopied": "Copié !",
+  "expressiveCode.copyButtonTooltip": "Copier dans le presse-papiers",
+  "expressiveCode.terminalWindowFallbackTitle": "Fenêtre de terminal"
 }

package/translations/nl.json

@@ -19,8 +19,8 @@
   "page.previousLink": "Vorige",
   "page.nextLink": "Volgende",
   "404.text": "Pagina niet gevonden. Controleer de URL of probeer de zoekbalk.",
-  "aside.note": "Note",
+  "aside.note": "Opmerking",
   "aside.tip": "Tip",
-  "aside.caution": "Caution",
-  "aside.danger": "Danger"
+  "aside.caution": "Opgepast",
+  "aside.danger": "Gevaar"
 }

package/translations/ru.json

@@ -13,7 +13,7 @@
   "sidebarNav.accessibleLabel": "Основное",
   "tableOfContents.onThisPage": "На этой странице",
   "tableOfContents.overview": "Обзор",
-  "i18n.untranslatedContent": "Этот содержимое пока не доступно на вашем языке.",
+  "i18n.untranslatedContent": "Это содержимое пока не доступно на вашем языке.",
   "page.editLink": "Редактировать страницу",
   "page.lastUpdated": "Последнее обновление:",
   "page.previousLink": "Предыдущая",

package/types.ts

@@ -1,2 +1,5 @@
 export type { StarlightConfig } from './utils/user-config';
-export type { StarlightPlugin } from './utils/plugins';
+export type {
+	StarlightPlugin,
+	StarlightUserConfigWithPlugins as StarlightUserConfig,
+} from './utils/plugins';

package/user-components/rehype-tabs.ts

@@ -1,3 +1,4 @@
+import type { Element } from 'hast';
 import { select } from 'hast-util-select';
 import { rehype } from 'rehype';
 import { CONTINUE, SKIP, visit } from 'unist-util-visit';
@@ -50,7 +51,7 @@ const getIDs = () => {
 const tabsProcessor = rehype()
 	.data('settings', { fragment: true })
 	.use(function tabs() {
-		return (tree, file) => {
+		return (tree: Element, file) => {
 			file.data.panels = [];
 			let isFirst = true;
 			visit(tree, 'element', (node) => {

package/utils/git.ts

@@ -8,12 +8,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import path from 'node:path';
+import { basename, dirname } from 'node:path';
 import { execaSync } from 'execa';
 
-/** Custom error thrown when git is not found in `PATH`. */
-class GitNotFoundError extends Error {}
-
 /** Custom error thrown when the current file is not tracked by git. */
 class FileNotTrackedError extends Error {}
 
@@ -22,7 +19,6 @@ class FileNotTrackedError extends Error {}
  * It gets the commit date instead of author date so that amended commits
  * can have their dates updated.
  *
- * @throws {GitNotFoundError} If git is not found in `PATH`.
  * @throws {FileNotTrackedError} If the current file is not tracked by git.
  * @throws Also throws when `git log` exited with non-zero, or when it outputs
  * unexpected text.
@@ -34,24 +30,6 @@ export function getFileCommitDate(
 	date: Date;
 	timestamp: number;
 } {
-	try {
-		const { stdout } = execaSync('which', ['git']);
-		if (!stdout) {
-			throw new GitNotFoundError(
-				`Failed to retrieve git history for "${file}" because git is not installed.`
-			);
-		}
-	} catch {}
-
-	try {
-		const { stdout } = execaSync('test', ['-f', file]);
-		if (!stdout) {
-			throw new Error(
-				`Failed to retrieve git history for "${file}" because the file does not exist.`
-			);
-		}
-	} catch {}
-
 	const result = execaSync(
 		'git',
 		[
@@ -60,10 +38,10 @@ export function getFileCommitDate(
 			'--max-count=1',
 			...(age === 'oldest' ? ['--follow', '--diff-filter=A'] : []),
 			'--',
-			path.basename(file),
+			basename(file),
 		],
 		{
-			cwd: path.dirname(file),
+			cwd: dirname(file),
 		}
 	);
 	if (result.exitCode !== 0) {
@@ -71,7 +49,6 @@ export function getFileCommitDate(
 			`Failed to retrieve the git history for file "${file}" with exit code ${result.exitCode}: ${result.stderr}`
 		);
 	}
-	let regex = /^(?<timestamp>\d+)$/;
 
 	const output = result.stdout.trim();
 
@@ -81,6 +58,7 @@ export function getFileCommitDate(
 		);
 	}
 
+	const regex = /^(?<timestamp>\d+)$/;
 	const match = output.match(regex);
 
 	if (!match) {