@astrojs/starlight 0.5.6 → 0.6.0

package/utils/routing.ts

@@ -2,29 +2,29 @@ import type { GetStaticPathsItem } from 'astro';
 import { type CollectionEntry, getCollection } from 'astro:content';
 import config from 'virtual:starlight/user-config';
 import {
-  type LocaleData,
-  localizedId,
-  localizedSlug,
-  slugToLocaleData,
-  slugToParam,
+	type LocaleData,
+	localizedId,
+	localizedSlug,
+	slugToLocaleData,
+	slugToParam,
 } from './slugs';
 
 export type StarlightDocsEntry = Omit<CollectionEntry<'docs'>, 'slug'> & {
-  slug: string;
+	slug: string;
 };
 
 export interface Route extends LocaleData {
-  entry: StarlightDocsEntry;
-  entryMeta: LocaleData;
-  slug: string;
-  id: string;
-  isFallback?: true;
-  [key: string]: unknown;
+	entry: StarlightDocsEntry;
+	entryMeta: LocaleData;
+	slug: string;
+	id: string;
+	isFallback?: true;
+	[key: string]: unknown;
 }
 
 interface Path extends GetStaticPathsItem {
-  params: { slug: string | undefined };
-  props: Route;
+	params: { slug: string | undefined };
+	props: Route;
 }
 
 /**
@@ -35,64 +35,60 @@ interface Path extends GetStaticPathsItem {
 const normalizeIndexSlug = (slug: string) => (slug === 'index' ? '' : slug);
 
 /** All entries in the docs content collection. */
-const docs: StarlightDocsEntry[] = (await getCollection('docs')).map(
-  ({ slug, ...entry }) => ({ ...entry, slug: normalizeIndexSlug(slug) })
-);
+const docs: StarlightDocsEntry[] = (await getCollection('docs')).map(({ slug, ...entry }) => ({
+	...entry,
+	slug: normalizeIndexSlug(slug),
+}));
 
 function getRoutes(): Route[] {
-  const routes: Route[] = docs.map((entry) => ({
-    entry,
-    slug: entry.slug,
-    id: entry.id,
-    entryMeta: slugToLocaleData(entry.slug),
-    ...slugToLocaleData(entry.slug),
-  }));
+	const routes: Route[] = docs.map((entry) => ({
+		entry,
+		slug: entry.slug,
+		id: entry.id,
+		entryMeta: slugToLocaleData(entry.slug),
+		...slugToLocaleData(entry.slug),
+	}));
 
-  // In multilingual sites, add required fallback routes.
-  if (config.isMultilingual) {
-    /** Entries in the docs content collection for the default locale. */
-    const defaultLocaleDocs = getLocaleDocs(
-      config.defaultLocale?.locale === 'root'
-        ? undefined
-        : config.defaultLocale?.locale
-    );
-    for (const key in config.locales) {
-      if (key === config.defaultLocale.locale) continue;
-      const localeConfig = config.locales[key];
-      if (!localeConfig) continue;
-      const locale = key === 'root' ? undefined : key;
-      const localeDocs = getLocaleDocs(locale);
-      for (const fallback of defaultLocaleDocs) {
-        const slug = localizedSlug(fallback.slug, locale);
-        const id = localizedId(fallback.id, locale);
-        const doesNotNeedFallback = localeDocs.some((doc) => doc.slug === slug);
-        if (doesNotNeedFallback) continue;
-        routes.push({
-          entry: fallback,
-          slug,
-          id,
-          isFallback: true,
-          lang: localeConfig.lang || 'en',
-          locale,
-          dir: localeConfig.dir,
-          entryMeta: slugToLocaleData(fallback.slug),
-        });
-      }
-    }
-  }
+	// In multilingual sites, add required fallback routes.
+	if (config.isMultilingual) {
+		/** Entries in the docs content collection for the default locale. */
+		const defaultLocaleDocs = getLocaleDocs(
+			config.defaultLocale?.locale === 'root' ? undefined : config.defaultLocale?.locale
+		);
+		for (const key in config.locales) {
+			if (key === config.defaultLocale.locale) continue;
+			const localeConfig = config.locales[key];
+			if (!localeConfig) continue;
+			const locale = key === 'root' ? undefined : key;
+			const localeDocs = getLocaleDocs(locale);
+			for (const fallback of defaultLocaleDocs) {
+				const slug = localizedSlug(fallback.slug, locale);
+				const id = localizedId(fallback.id, locale);
+				const doesNotNeedFallback = localeDocs.some((doc) => doc.slug === slug);
+				if (doesNotNeedFallback) continue;
+				routes.push({
+					entry: fallback,
+					slug,
+					id,
+					isFallback: true,
+					lang: localeConfig.lang || 'en',
+					locale,
+					dir: localeConfig.dir,
+					entryMeta: slugToLocaleData(fallback.slug),
+				});
+			}
+		}
+	}
 
-  // Sort alphabetically by page slug to guarantee order regardless of platform.
-  return routes.sort((a, b) =>
-    a.slug < b.slug ? -1 : a.slug > b.slug ? 1 : 0
-  );
+	return routes;
 }
 export const routes = getRoutes();
 
 function getPaths(): Path[] {
-  return routes.map((route) => ({
-    params: { slug: slugToParam(route.slug) },
-    props: route,
-  }));
+	return routes.map((route) => ({
+		params: { slug: slugToParam(route.slug) },
+		props: route,
+	}));
 }
 export const paths = getPaths();
 
@@ -101,7 +97,7 @@ export const paths = getPaths();
  * A locale of `undefined` is treated as the “root” locale, if configured.
  */
 export function getLocaleRoutes(locale: string | undefined): Route[] {
-  return filterByLocale(routes, locale);
+	return filterByLocale(routes, locale);
 }
 
 /**
@@ -109,27 +105,20 @@ export function getLocaleRoutes(locale: string | undefined): Route[] {
  * A locale of `undefined` is treated as the “root” locale, if configured.
  */
 function getLocaleDocs(locale: string | undefined): StarlightDocsEntry[] {
-  return filterByLocale(docs, locale);
+	return filterByLocale(docs, locale);
 }
 
 /** Filter an array to find items whose slug matches the passed locale. */
-function filterByLocale<T extends { slug: string }>(
-  items: T[],
-  locale: string | undefined
-): T[] {
-  if (config.locales) {
-    if (locale && locale in config.locales) {
-      return items.filter(
-        (i) => i.slug === locale || i.slug.startsWith(locale + '/')
-      );
-    } else if (config.locales.root) {
-      const langKeys = Object.keys(config.locales).filter((k) => k !== 'root');
-      const isLangIndex = new RegExp(`^(${langKeys.join('|')})$`);
-      const isLangDir = new RegExp(`^(${langKeys.join('|')})/`);
-      return items.filter(
-        (i) => !isLangIndex.test(i.slug) && !isLangDir.test(i.slug)
-      );
-    }
-  }
-  return items;
+function filterByLocale<T extends { slug: string }>(items: T[], locale: string | undefined): T[] {
+	if (config.locales) {
+		if (locale && locale in config.locales) {
+			return items.filter((i) => i.slug === locale || i.slug.startsWith(locale + '/'));
+		} else if (config.locales.root) {
+			const langKeys = Object.keys(config.locales).filter((k) => k !== 'root');
+			const isLangIndex = new RegExp(`^(${langKeys.join('|')})$`);
+			const isLangDir = new RegExp(`^(${langKeys.join('|')})/`);
+			return items.filter((i) => !isLangIndex.test(i.slug) && !isLangDir.test(i.slug));
+		}
+	}
+	return items;
 }

package/utils/slugs.ts

@@ -1,12 +1,12 @@
 import config from 'virtual:starlight/user-config';
 
 export interface LocaleData {
-  /** Writing direction. */
-  dir: 'ltr' | 'rtl';
-  /** BCP-47 language tag. */
-  lang: string;
-  /** The base path at which a language is served. `undefined` for root locale slugs. */
-  locale: string | undefined;
+	/** Writing direction. */
+	dir: 'ltr' | 'rtl';
+	/** BCP-47 language tag. */
+	lang: string;
+	/** The base path at which a language is served. `undefined` for root locale slugs. */
+	locale: string | undefined;
 }
 
 /**
@@ -16,16 +16,16 @@ export interface LocaleData {
  * @param slug A collection entry slug
  */
 function slugToLocale(slug: string): string | undefined {
-  const locales = Object.keys(config.locales || {});
-  const baseSegment = slug.split('/')[0];
-  if (baseSegment && locales.includes(baseSegment)) return baseSegment;
-  return undefined;
+	const locales = Object.keys(config.locales || {});
+	const baseSegment = slug.split('/')[0];
+	if (baseSegment && locales.includes(baseSegment)) return baseSegment;
+	return undefined;
 }
 
 /** Get locale information for a given slug. */
 export function slugToLocaleData(slug: string): LocaleData {
-  const locale = slugToLocale(slug);
-  return { dir: localeToDir(locale), lang: localeToLang(locale), locale };
+	const locale = slugToLocale(slug);
+	return { dir: localeToDir(locale), lang: localeToLang(locale), locale };
 }
 
 /**
@@ -33,12 +33,9 @@ export function slugToLocaleData(slug: string): LocaleData {
  * @param locale Locale string or `undefined` for the root locale.
  */
 export function localeToLang(locale: string | undefined): string {
-  const lang = locale
-    ? config.locales?.[locale]?.lang
-    : config.locales?.root?.lang;
-  const defaultLang =
-    config.defaultLocale?.lang || config.defaultLocale?.locale;
-  return lang || defaultLang || 'en';
+	const lang = locale ? config.locales?.[locale]?.lang : config.locales?.root?.lang;
+	const defaultLang = config.defaultLocale?.lang || config.defaultLocale?.locale;
+	return lang || defaultLang || 'en';
 }
 
 /**
@@ -46,23 +43,21 @@ export function localeToLang(locale: string | undefined): string {
  * @param locale Locale string or `undefined` for the root locale.
  */
 function localeToDir(locale: string | undefined): 'ltr' | 'rtl' {
-  const dir = locale
-    ? config.locales?.[locale]?.dir
-    : config.locales?.root?.dir;
-  return dir || config.defaultLocale.dir;
+	const dir = locale ? config.locales?.[locale]?.dir : config.locales?.root?.dir;
+	return dir || config.defaultLocale.dir;
 }
 
 export function slugToParam(slug: string): string | undefined {
-  return slug === 'index' || slug === ''
-    ? undefined
-    : slug.endsWith('/index')
-    ? slug.replace(/\/index$/, '')
-    : slug;
+	return slug === 'index' || slug === ''
+		? undefined
+		: slug.endsWith('/index')
+		? slug.replace(/\/index$/, '')
+		: slug;
 }
 
 export function slugToPathname(slug: string): string {
-  const param = slugToParam(slug);
-  return param ? '/' + param + '/' : '/';
+	const param = slugToParam(slug);
+	return param ? '/' + param + '/' : '/';
 }
 
 /**
@@ -75,20 +70,15 @@ export function slugToPathname(slug: string): string {
  * localizedSlug('en/home', 'fr')       // => 'fr/home'
  * localizedSlug('en/home', undefined)  // => 'home'
  */
-export function localizedSlug(
-  slug: string,
-  locale: string | undefined
-): string {
-  const slugLocale = slugToLocale(slug);
-  if (slugLocale === locale) return slug;
-  locale = locale || '';
-  if (slugLocale === slug) return locale;
-  if (slugLocale) {
-    return slug
-      .replace(slugLocale + '/', locale ? locale + '/' : '')
-      .replace(/\/$/, '');
-  }
-  return slug ? locale + '/' + slug : locale;
+export function localizedSlug(slug: string, locale: string | undefined): string {
+	const slugLocale = slugToLocale(slug);
+	if (slugLocale === locale) return slug;
+	locale = locale || '';
+	if (slugLocale === slug) return locale;
+	if (slugLocale) {
+		return slug.replace(slugLocale + '/', locale ? locale + '/' : '').replace(/\/$/, '');
+	}
+	return slug ? locale + '/' + slug : locale;
 }
 
 /**
@@ -102,12 +92,12 @@ export function localizedSlug(
  * localizedSlug('en/home.md', undefined)  // => 'home.md'
  */
 export function localizedId(id: string, locale: string | undefined): string {
-  const idLocale = slugToLocale(id);
-  if (idLocale) {
-    return id.replace(idLocale + '/', locale ? locale + '/' : '');
-  } else if (locale) {
-    return locale + '/' + id;
-  } else {
-    return id;
-  }
+	const idLocale = slugToLocale(id);
+	if (idLocale) {
+		return id.replace(idLocale + '/', locale ? locale + '/' : '');
+	} else if (locale) {
+		return locale + '/' + id;
+	} else {
+		return id;
+	}
 }

package/utils/translations.ts

@@ -9,18 +9,18 @@ const defaultLocale = config.defaultLocale?.locale || 'root';
 /** All translation data from the i18n collection, keyed by `id`, which matches locale. */
 let userTranslations: Record<string, CollectionEntry<'i18n'>['data']> = {};
 try {
-  // Load the user’s i18n collection and ignore the error if it doesn’t exist.
-  userTranslations = Object.fromEntries(
-    (await getCollection('i18n')).map(({ id, data }) => [id, data] as const)
-  );
+	// Load the user’s i18n collection and ignore the error if it doesn’t exist.
+	userTranslations = Object.fromEntries(
+		(await getCollection('i18n')).map(({ id, data }) => [id, data] as const)
+	);
 } catch {}
 
 /** Default map of UI strings based on Starlight and user-configured defaults. */
 const defaults = buildDictionary(
-  builtinTranslations.en!,
-  userTranslations.en,
-  builtinTranslations[defaultLocale],
-  userTranslations[defaultLocale]
+	builtinTranslations.en!,
+	userTranslations.en,
+	builtinTranslations[defaultLocale],
+	userTranslations[defaultLocale]
 );
 
 /**
@@ -31,33 +31,27 @@ const defaults = buildDictionary(
  * const label = t('search.label'); // => 'Search'
  */
 export function useTranslations(locale: string | undefined) {
-  // TODO: Use better mapping, e.g. so that `en-GB` matches `en`.
-  const lang = localeToLang(locale);
-  const dictionary = buildDictionary(
-    defaults,
-    builtinTranslations[lang],
-    userTranslations[lang]
-  );
-  const t = <K extends keyof typeof dictionary>(key: K) => dictionary[key];
-  t.pick = (startOfKey: string) =>
-    Object.fromEntries(
-      Object.entries(dictionary).filter(([k]) => k.startsWith(startOfKey))
-    );
-  return t;
+	// TODO: Use better mapping, e.g. so that `en-GB` matches `en`.
+	const lang = localeToLang(locale);
+	const dictionary = buildDictionary(defaults, builtinTranslations[lang], userTranslations[lang]);
+	const t = <K extends keyof typeof dictionary>(key: K) => dictionary[key];
+	t.pick = (startOfKey: string) =>
+		Object.fromEntries(Object.entries(dictionary).filter(([k]) => k.startsWith(startOfKey)));
+	return t;
 }
 
 /** Build a dictionary by layering preferred translation sources. */
 function buildDictionary(
-  base: (typeof builtinTranslations)[string],
-  ...dictionaries: (CollectionEntry<'i18n'>['data'] | undefined)[]
+	base: (typeof builtinTranslations)[string],
+	...dictionaries: (CollectionEntry<'i18n'>['data'] | undefined)[]
 ) {
-  const dictionary = { ...base };
-  // 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;
-    }
-  }
-  return dictionary;
+	const dictionary = { ...base };
+	// 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;
+		}
+	}
+	return dictionary;
 }