@astrojs/starlight 0.15.2 → 0.15.4

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @astrojs/starlight
 
+## 0.15.4
+
+### Patch Changes
+
+- [#1378](https://github.com/withastro/starlight/pull/1378) [`0f4a31d`](https://github.com/withastro/starlight/commit/0f4a31da4b6d384c569e8556dcc559dc8bfbfebd) Thanks [@delucis](https://github.com/delucis)! - Updates dependencies: `@astrojs/mdx`, `@astrojs/sitemap`, and `astro-expressive-code`
+
+## 0.15.3
+
+### Patch Changes
+
+- [#1303](https://github.com/withastro/starlight/pull/1303) [`3eefd21`](https://github.com/withastro/starlight/commit/3eefd21f2267648b17bc2d6874350fd5dd8bbcb2) Thanks [@lilnasy](https://github.com/lilnasy)! - chore: fix type errors in Starlight internals
+
+- [#1351](https://github.com/withastro/starlight/pull/1351) [`932c022`](https://github.com/withastro/starlight/commit/932c0229d7d8d55f30161ccc36c908140c1f252a) Thanks [@roberto-butti](https://github.com/roberto-butti)! - Adds Italian translation for `search.devWarning` UI
+
+- [#1298](https://github.com/withastro/starlight/pull/1298) [`c7e995c`](https://github.com/withastro/starlight/commit/c7e995cb018179789b5ee45bae5fdd9c20309945) Thanks [@kevinzunigacuellar](https://github.com/kevinzunigacuellar)! - Fixes incorrect sorting behavior for some autogenerated sidebars
+
+- [#1347](https://github.com/withastro/starlight/pull/1347) [`8994d00`](https://github.com/withastro/starlight/commit/8994d007266e0bd8e6116b306ccd9e24c9710411) Thanks [@kevinzunigacuellar](https://github.com/kevinzunigacuellar)! - Refactor `getLastUpdated` to use `node:child_process` instead of `execa`.
+
+- [#1353](https://github.com/withastro/starlight/pull/1353) [`90fe8da`](https://github.com/withastro/starlight/commit/90fe8da15c8eb227817c2232345ac359aef6bab5) Thanks [@delucis](https://github.com/delucis)! - Fixes sidebar scrollbar hiding behind navbar
+
 ## 0.15.2
 
 ### Patch Changes

package/components/PageFrame.astro

@@ -49,9 +49,8 @@ const { hasSidebar, labels } = Astro.props;
 		visibility: var(--sl-sidebar-visibility, hidden);
 		position: fixed;
 		z-index: var(--sl-z-index-menu);
-		inset-block: 0;
+		inset-block: var(--sl-nav-height) 0;
 		inset-inline-start: 0;
-		padding-top: var(--sl-nav-height);
 		width: 100%;
 		background-color: var(--sl-color-black);
 		overflow-y: auto;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.15.2",
+  "version": "0.15.4",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -162,21 +162,20 @@
     "astro": "^4.0.0"
   },
   "devDependencies": {
-    "@astrojs/markdown-remark": "^4.0.0",
+    "@astrojs/markdown-remark": "^4.0.1",
     "@types/node": "^18.16.19",
     "@vitest/coverage-v8": "^0.33.0",
     "astro": "^4.0.1",
     "vitest": "^0.33.0"
   },
   "dependencies": {
-    "@astrojs/mdx": "^2.0.0",
-    "@astrojs/sitemap": "^3.0.3",
+    "@astrojs/mdx": "^2.0.4",
+    "@astrojs/sitemap": "^3.0.4",
     "@pagefind/default-ui": "^1.0.3",
     "@types/hast": "^3.0.3",
     "@types/mdast": "^4.0.3",
-    "astro-expressive-code": "^0.30.1",
+    "astro-expressive-code": "^0.31.0",
     "bcp-47": "^2.1.0",
-    "execa": "^8.0.1",
     "hast-util-select": "^6.0.2",
     "hastscript": "^8.0.0",
     "mdast-util-directive": "^3.0.0",

package/translations/it.json

@@ -3,7 +3,7 @@
   "search.label": "Cerca",
   "search.shortcutLabel": "(Usa / per cercare)",
   "search.cancelLabel": "Cancella",
-  "search.devWarning": "Search is only available in production builds. \nTry building and previewing the site to test it out locally.",
+  "search.devWarning": "La ricerca è disponibile solo nelle build di produzione. \nProvare ad eseguire il processo di build e visualizzare la preview del sito per testarlo localmente.",
   "themeSelect.accessibleLabel": "Seleziona tema",
   "themeSelect.dark": "Scuro",
   "themeSelect.light": "Chiaro",

package/utils/createTranslationSystem.ts

@@ -76,8 +76,8 @@ function buildDictionary(
 	// Iterate over alternate dictionaries to avoid overwriting preceding values with `undefined`.
 	for (const dict of dictionaries) {
 		for (const key in dict) {
-			const value = dict[key as keyof typeof dict];
-			if (value) dictionary[key as keyof typeof dict] = value;
+			const value = dict[key];
+			if (value) dictionary[key as keyof typeof dictionary] = value;
 		}
 	}
 	return dictionary;

package/utils/git.ts

@@ -1,74 +1,24 @@
-/**
- * Heavily inspired by
- * https://github.com/facebook/docusaurus/blob/46d2aa231ddb18ed67311b6195260af46d7e8bdc/packages/docusaurus-utils/src/gitUtils.ts
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
 import { basename, dirname } from 'node:path';
-import { execaSync } from 'execa';
+import { spawnSync } from 'node:child_process';
 
-/** Custom error thrown when the current file is not tracked by git. */
-class FileNotTrackedError extends Error {}
+export function getNewestCommitDate(file: string) {
+	const result = spawnSync('git', ['log', '--format=%ct', '--max-count=1', basename(file)], {
+		cwd: dirname(file),
+		encoding: 'utf-8',
+	});
 
-/**
- * Fetches the git history of a file and returns a relevant commit date.
- * It gets the commit date instead of author date so that amended commits
- * can have their dates updated.
- *
- * @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.
- */
-export function getFileCommitDate(
-	file: string,
-	age: 'oldest' | 'newest' = 'oldest'
-): {
-	date: Date;
-	timestamp: number;
-} {
-	const result = execaSync(
-		'git',
-		[
-			'log',
-			`--format=%ct`,
-			'--max-count=1',
-			...(age === 'oldest' ? ['--follow', '--diff-filter=A'] : []),
-			'--',
-			basename(file),
-		],
-		{
-			cwd: dirname(file),
-		}
-	);
-	if (result.exitCode !== 0) {
-		throw new Error(
-			`Failed to retrieve the git history for file "${file}" with exit code ${result.exitCode}: ${result.stderr}`
-		);
+	if (result.error) {
+		throw new Error(`Failed to retrieve the git history for file "${file}"`);
 	}
-
 	const output = result.stdout.trim();
-
-	if (!output) {
-		throw new FileNotTrackedError(
-			`Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`
-		);
-	}
-
 	const regex = /^(?<timestamp>\d+)$/;
 	const match = output.match(regex);
 
-	if (!match) {
-		throw new Error(
-			`Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`
-		);
+	if (!match?.groups?.timestamp) {
+		throw new Error(`Failed to validate the timestamp for file "${file}"`);
 	}
 
-	const timestamp = Number(match.groups!.timestamp);
+	const timestamp = Number(match.groups.timestamp);
 	const date = new Date(timestamp * 1000);
-
-	return { date, timestamp };
+	return date;
 }

package/utils/navigation.ts

@@ -212,19 +212,24 @@ function getOrder(routeOrDir: Route | Dir): number {
 		: // If no order value is found, set it to the largest number possible.
 		  routeOrDir.entry.data.sidebar.order ?? Number.MAX_VALUE;
 }
+/** Get the comparison ID for a given route to sort them alphabetically. */
+function getComparisonId(id: string) {
+	const filename = stripExtension(basename(id));
+	return filename === 'index' ? '' : filename;
+}
 
 /** Sort a directory’s entries by user-specified order or alphabetically if no order specified. */
-function sortDirEntries(
-	dir: [string, Dir | Route][],
-	locale: string | undefined
-): [string, Dir | Route][] {
-	const collator = new Intl.Collator(localeToLang(locale));
+function sortDirEntries(dir: [string, Dir | Route][]): [string, Dir | Route][] {
+	const collator = new Intl.Collator(localeToLang(undefined));
 	return dir.sort(([keyA, a], [keyB, b]) => {
 		const [aOrder, bOrder] = [getOrder(a), getOrder(b)];
 		// Pages are sorted by order in ascending order.
 		if (aOrder !== bOrder) return aOrder < bOrder ? -1 : 1;
 		// If two pages have the same order value they will be sorted by their slug.
-		return collator.compare(isDir(a) ? keyA : a.slug, isDir(b) ? keyB : b.slug);
+		return collator.compare(
+			isDir(a) ? keyA : getComparisonId(a.id),
+			isDir(b) ? keyB : getComparisonId(b.id)
+		);
 	});
 }
 
@@ -237,7 +242,7 @@ function groupFromDir(
 	locale: string | undefined,
 	collapsed: boolean
 ): Group {
-	const entries = sortDirEntries(Object.entries(dir), locale).map(([key, dirOrRoute]) =>
+	const entries = sortDirEntries(Object.entries(dir)).map(([key, dirOrRoute]) =>
 		dirToItem(dirOrRoute, `${fullPath}/${key}`, key, currentPathname, locale, collapsed)
 	);
 	return {
@@ -270,7 +275,7 @@ function sidebarFromDir(
 	locale: string | undefined,
 	collapsed: boolean
 ) {
-	return sortDirEntries(Object.entries(tree), locale).map(([key, dirOrRoute]) =>
+	return sortDirEntries(Object.entries(tree)).map(([key, dirOrRoute]) =>
 		dirToItem(dirOrRoute, key, key, currentPathname, locale, collapsed)
 	);
 }

package/utils/route-data.ts

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url';
 import project from 'virtual:starlight/project-context';
 import config from 'virtual:starlight/user-config';
 import { generateToC, type TocItem } from './generateToC';
-import { getFileCommitDate } from './git';
+import { getNewestCommitDate } from './git';
 import { getPrevNextLinks, getSidebar, type SidebarEntry } from './navigation';
 import { ensureTrailingSlash } from './path';
 import type { Route } from './routing';
@@ -70,17 +70,22 @@ function getToC({ entry, locale, headings }: PageProps) {
 }
 
 function getLastUpdated({ entry }: PageProps): Date | undefined {
-	if (entry.data.lastUpdated ?? config.lastUpdated) {
+	const { lastUpdated: frontmatterLastUpdated } = entry.data;
+	const { lastUpdated: configLastUpdated } = config;
+
+	if (frontmatterLastUpdated ?? configLastUpdated) {
 		const currentFilePath = fileURLToPath(new URL('src/content/docs/' + entry.id, project.root));
-		let date = typeof entry.data.lastUpdated !== 'boolean' ? entry.data.lastUpdated : undefined;
-		if (!date) {
-			try {
-				({ date } = getFileCommitDate(currentFilePath, 'newest'));
-			} catch {}
+		try {
+			return frontmatterLastUpdated instanceof Date
+				? frontmatterLastUpdated
+				: getNewestCommitDate(currentFilePath);
+		} catch {
+			// If the git command fails, ignore the error.
+			return undefined;
 		}
-		return date;
 	}
-	return;
+
+	return undefined;
 }
 
 function getEditUrl({ entry, id, isFallback }: PageProps): URL | undefined {

package/utils/translations.ts

@@ -8,6 +8,8 @@ let userTranslations: Record<string, i18nSchemaOutput> = {};
 try {
 	// Load the user’s i18n collection and ignore the error if it doesn’t exist.
 	userTranslations = Object.fromEntries(
+		// @ts-ignore — may be an error in projects without an i18n collection
+
 		(await getCollection('i18n')).map(({ id, data }) => [id, data] as const)
 	);
 } catch {}