@astrojs/starlight 0.5.6 → 0.6.0

package/user-components/rehype-tabs.ts

@@ -3,43 +3,43 @@ import { rehype } from 'rehype';
 import { CONTINUE, SKIP, visit } from 'unist-util-visit';
 
 interface Panel {
-  panelId: string;
-  tabId: string;
-  label: string;
+	panelId: string;
+	tabId: string;
+	label: string;
 }
 
 declare module 'vfile' {
-  interface DataMap {
-    panels: Panel[];
-  }
+	interface DataMap {
+		panels: Panel[];
+	}
 }
 
 export const TabItemTagname = 'starlight-tab-item';
 
 // https://github.com/adobe/react-spectrum/blob/99ca82e87ba2d7fdd54f5b49326fd242320b4b51/packages/%40react-aria/focus/src/FocusScope.tsx#L256-L275
 const focusableElementSelectors = [
-  'input:not([disabled]):not([type=hidden])',
-  'select:not([disabled])',
-  'textarea:not([disabled])',
-  'button:not([disabled])',
-  'a[href]',
-  'area[href]',
-  'summary',
-  'iframe',
-  'object',
-  'embed',
-  'audio[controls]',
-  'video[controls]',
-  '[contenteditable]',
-  '[tabindex]:not([disabled])',
+	'input:not([disabled]):not([type=hidden])',
+	'select:not([disabled])',
+	'textarea:not([disabled])',
+	'button:not([disabled])',
+	'a[href]',
+	'area[href]',
+	'summary',
+	'iframe',
+	'object',
+	'embed',
+	'audio[controls]',
+	'video[controls]',
+	'[contenteditable]',
+	'[tabindex]:not([disabled])',
 ]
-  .map((selector) => `${selector}:not([hidden]):not([tabindex="-1"])`)
-  .join(',');
+	.map((selector) => `${selector}:not([hidden]):not([tabindex="-1"])`)
+	.join(',');
 
 let count = 0;
 const getIDs = () => {
-  const id = count++;
-  return { panelId: 'tab-panel-' + id, tabId: 'tab-' + id };
+	const id = count++;
+	return { panelId: 'tab-panel-' + id, tabId: 'tab-' + id };
 };
 
 /**
@@ -48,51 +48,51 @@ const getIDs = () => {
  * attributes.
  */
 const tabsProcessor = rehype()
-  .data('settings', { fragment: true })
-  .use(function tabs() {
-    return (tree, file) => {
-      file.data.panels = [];
-      let isFirst = true;
-      visit(tree, 'element', (node) => {
-        if (node.tagName !== TabItemTagname || !node.properties) {
-          return CONTINUE;
-        }
+	.data('settings', { fragment: true })
+	.use(function tabs() {
+		return (tree, file) => {
+			file.data.panels = [];
+			let isFirst = true;
+			visit(tree, 'element', (node) => {
+				if (node.tagName !== TabItemTagname || !node.properties) {
+					return CONTINUE;
+				}
 
-        const { dataLabel } = node.properties;
-        const ids = getIDs();
-        file.data.panels?.push({
-          ...ids,
-          label: String(dataLabel),
-        });
+				const { dataLabel } = node.properties;
+				const ids = getIDs();
+				file.data.panels?.push({
+					...ids,
+					label: String(dataLabel),
+				});
 
-        // Remove `<TabItem>` props
-        delete node.properties.dataLabel;
-        // Turn into `<section>` with required attributes
-        node.tagName = 'section';
-        node.properties.id = ids.panelId;
-        node.properties['aria-labelledby'] = ids.tabId;
-        node.properties.role = 'tabpanel';
+				// Remove `<TabItem>` props
+				delete node.properties.dataLabel;
+				// Turn into `<section>` with required attributes
+				node.tagName = 'section';
+				node.properties.id = ids.panelId;
+				node.properties['aria-labelledby'] = ids.tabId;
+				node.properties.role = 'tabpanel';
 
-        const focusableChild = select(focusableElementSelectors, node);
-        // If the panel does not contain any focusable elements, include it in
-        // the tab sequence of the page.
-        if (!focusableChild) {
-          node.properties.tabindex = 0;
-        }
-        
-        // Hide all panels except the first
-        // TODO: make initially visible tab configurable
-        if (isFirst) {
-          isFirst = false;
-        } else {
-          node.properties.hidden = true;
-        }
+				const focusableChild = select(focusableElementSelectors, node);
+				// If the panel does not contain any focusable elements, include it in
+				// the tab sequence of the page.
+				if (!focusableChild) {
+					node.properties.tabindex = 0;
+				}
 
-        // Skip over the tab panel’s children.
-        return SKIP;
-      });
-    };
-  });
+				// Hide all panels except the first
+				// TODO: make initially visible tab configurable
+				if (isFirst) {
+					isFirst = false;
+				} else {
+					node.properties.hidden = true;
+				}
+
+				// Skip over the tab panel’s children.
+				return SKIP;
+			});
+		};
+	});
 
 /**
  * Process tab panel items to extract data for the tab links and format
@@ -100,11 +100,11 @@ const tabsProcessor = rehype()
  * @param html Inner HTML passed to the `<Tabs>` component.
  */
 export const processPanels = (html: string) => {
-  const file = tabsProcessor.processSync({ value: html });
-  return {
-    /** Data for each tab panel. */
-    panels: file.data.panels,
-    /** Processed HTML for the tab panels. */
-    html: file.toString(),
-  };
+	const file = tabsProcessor.processSync({ value: html });
+	return {
+		/** Data for each tab panel. */
+		panels: file.data.panels,
+		/** Processed HTML for the tab panels. */
+		html: file.toString(),
+	};
 };

package/utils/base.ts

@@ -2,19 +2,19 @@ const base = stripTrailingSlash(import.meta.env.BASE_URL);
 
 /** Get the a root-relative URL path with the site’s `base` prefixed. */
 export function pathWithBase(path: string) {
-  path = stripLeadingSlash(stripTrailingSlash(path));
-  return path ? base + '/' + path + '/' : base + '/';
+	path = stripLeadingSlash(stripTrailingSlash(path));
+	return path ? base + '/' + path + '/' : base + '/';
 }
 
 /** Get the a root-relative file URL path with the site’s `base` prefixed. */
 export function fileWithBase(path: string) {
-  path = stripLeadingSlash(stripTrailingSlash(path));
-  return path ? base + '/' + path : base;
+	path = stripLeadingSlash(stripTrailingSlash(path));
+	return path ? base + '/' + path : base;
 }
 
 function stripLeadingSlash(path: string) {
-  return path.replace(/^\//, '');
+	return path.replace(/^\//, '');
 }
 function stripTrailingSlash(path: string) {
-  return path.replace(/\/$/, '');
+	return path.replace(/\/$/, '');
 }

package/utils/git.ts

@@ -28,69 +28,69 @@ class FileNotTrackedError extends Error {}
  * unexpected text.
  */
 export function getFileCommitDate(
-  file: string,
-  age: 'oldest' | 'newest' = 'oldest'
+	file: string,
+	age: 'oldest' | 'newest' = 'oldest'
 ): {
-  date: Date;
-  timestamp: number;
+	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('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 {}
+	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',
-    [
-      'log',
-      `--format=%ct`,
-      '--max-count=1',
-      ...(age === 'oldest' ? ['--follow', '--diff-filter=A'] : []),
-      '--',
-      path.basename(file),
-    ],
-    {
-      cwd: path.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}`
-    );
-  }
-  let regex = /^(?<timestamp>\d+)$/;
+	const result = execaSync(
+		'git',
+		[
+			'log',
+			`--format=%ct`,
+			'--max-count=1',
+			...(age === 'oldest' ? ['--follow', '--diff-filter=A'] : []),
+			'--',
+			path.basename(file),
+		],
+		{
+			cwd: path.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}`
+		);
+	}
+	let regex = /^(?<timestamp>\d+)$/;
 
-  const output = result.stdout.trim();
+	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.`
-    );
-  }
+	if (!output) {
+		throw new FileNotTrackedError(
+			`Failed to retrieve the git history for file "${file}" because the file is not tracked by git.`
+		);
+	}
 
-  const match = output.match(regex);
+	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) {
+		throw new Error(
+			`Failed to retrieve the git history for file "${file}" with unexpected output: ${output}`
+		);
+	}
 
-  const timestamp = Number(match.groups!.timestamp);
-  const date = new Date(timestamp * 1000);
+	const timestamp = Number(match.groups!.timestamp);
+	const date = new Date(timestamp * 1000);
 
-  return { date, timestamp };
+	return { date, timestamp };
 }

package/utils/head.ts

@@ -4,11 +4,11 @@ const HeadSchema = HeadConfigSchema();
 
 /** Create a fully parsed, merged, and sorted head entry array from multiple sources. */
 export function createHead(defaults: HeadUserConfig, ...heads: HeadConfig[]) {
-  let head = HeadSchema.parse(defaults);
-  for (const next of heads) {
-    head = mergeHead(head, next);
-  }
-  return sortHead(head);
+	let head = HeadSchema.parse(defaults);
+	for (const next of heads) {
+		head = mergeHead(head, next);
+	}
+	return sortHead(head);
 }
 
 /**
@@ -20,76 +20,78 @@ export function createHead(defaults: HeadUserConfig, ...heads: HeadConfig[]) {
  * `property`, and `http-equiv` attributes for `<meta>` tags.
  */
 function hasTag(head: HeadConfig, entry: HeadConfig[number]): boolean {
-  switch (entry.tag) {
-    case 'title':
-      return head.some(({ tag }) => tag === 'title');
-    case 'meta':
-      return hasOneOf(head, entry, ['name', 'property', 'http-equiv']);
-    default:
-      return false;
-  }
+	switch (entry.tag) {
+		case 'title':
+			return head.some(({ tag }) => tag === 'title');
+		case 'meta':
+			return hasOneOf(head, entry, ['name', 'property', 'http-equiv']);
+		default:
+			return false;
+	}
 }
 
 /**
  * Test if a head config object contains a tag of the same type
  * as `entry` and a matching attribute for one of the passed `keys`.
  */
-function hasOneOf(
-  head: HeadConfig,
-  entry: HeadConfig[number],
-  keys: string[]
-): boolean {
-  const attr = getAttr(keys, entry);
-  if (!attr) return false;
-  const [key, val] = attr;
-  return head.some(({ tag, attrs }) => tag === entry.tag && attrs[key] === val);
+function hasOneOf(head: HeadConfig, entry: HeadConfig[number], keys: string[]): boolean {
+	const attr = getAttr(keys, entry);
+	if (!attr) return false;
+	const [key, val] = attr;
+	return head.some(({ tag, attrs }) => tag === entry.tag && attrs[key] === val);
 }
 
 /** Find the first matching key–value pair in a head entry’s attributes. */
 function getAttr(
-  keys: string[],
-  entry: HeadConfig[number]
+	keys: string[],
+	entry: HeadConfig[number]
 ): [key: string, value: string | boolean] | undefined {
-  let attr: [string, string | boolean] | undefined;
-  for (const key of keys) {
-    const val = entry.attrs[key];
-    if (val) {
-      attr = [key, val];
-      break;
-    }
-  }
-  return attr;
+	let attr: [string, string | boolean] | undefined;
+	for (const key of keys) {
+		const val = entry.attrs[key];
+		if (val) {
+			attr = [key, val];
+			break;
+		}
+	}
+	return attr;
 }
 
 /** Merge two heads, overwriting entries in the first head that exist in the second. */
 function mergeHead(oldHead: HeadConfig, newHead: HeadConfig) {
-  return [...oldHead.filter((tag) => !hasTag(newHead, tag)), ...newHead];
+	return [...oldHead.filter((tag) => !hasTag(newHead, tag)), ...newHead];
 }
 
 /** Sort head tags to place important tags first and relegate “SEO” meta tags. */
 function sortHead(head: HeadConfig) {
-  return head.sort((a, b) => {
-    const aImportance = getImportance(a);
-    const bImportance = getImportance(b);
-    return aImportance > bImportance ? -1 : bImportance > aImportance ? 1 : 0;
-  });
+	return head.sort((a, b) => {
+		const aImportance = getImportance(a);
+		const bImportance = getImportance(b);
+		return aImportance > bImportance ? -1 : bImportance > aImportance ? 1 : 0;
+	});
 }
 
 /** Get the relative importance of a specific head tag. */
 function getImportance(entry: HeadConfig[number]) {
-  // 1. Important meta tags.
-  if (
-    entry.tag === 'meta' &&
-    ('charset' in entry.attrs ||
-      'http-equiv' in entry.attrs ||
-      entry.attrs.name === 'viewport')
-  ) {
-    return 100;
-  }
-  // 2. Page title
-  if (entry.tag === 'title') return 90;
-  // 3. Anything that isn’t an SEO meta tag.
-  if (entry.tag !== 'meta') return 80;
-  // 4. SEO meta tags.
-  return 0;
+	// 1. Important meta tags.
+	if (
+		entry.tag === 'meta' &&
+		('charset' in entry.attrs || 'http-equiv' in entry.attrs || entry.attrs.name === 'viewport')
+	) {
+		return 100;
+	}
+	// 2. Page title
+	if (entry.tag === 'title') return 90;
+	// 3. Anything that isn’t an SEO meta tag.
+	if (entry.tag !== 'meta') {
+		// The default favicon should be below any extra icons that the user may have set
+		// because if several icons are equally appropriate, the last one is used and we
+		// want to use the SVG icon when supported.
+		if (entry.tag === 'link' && 'rel' in entry.attrs && entry.attrs.rel === 'shortcut icon') {
+			return 70;
+		}
+		return 80;
+	}
+	// 4. SEO meta tags.
+	return 0;
 }

package/utils/i18n.ts

@@ -9,8 +9,8 @@
  * pickLang({ en: 'Hello', fr: 'Bonjour' }, 'en'); // => 'Hello'
  */
 export function pickLang<T extends Record<string, string>>(
-  dictionary: T,
-  lang: keyof T
+	dictionary: T,
+	lang: keyof T
 ): string | undefined {
-  return dictionary[lang];
+	return dictionary[lang];
 }

package/utils/localizedUrl.ts

@@ -4,29 +4,29 @@ import config from 'virtual:starlight/user-config';
  * Get the equivalent of the passed URL for the passed locale.
  */
 export function localizedUrl(url: URL, locale: string | undefined): URL {
-  // Create a new URL object to void mutating the global.
-  url = new URL(url);
-  if (!config.locales) {
-    // i18n is not configured on this site, no localization required.
-    return url;
-  }
-  if (locale === 'root') locale = '';
-  /** Base URL with trailing `/` stripped. */
-  const base = import.meta.env.BASE_URL.replace(/\/$/, '');
-  const hasBase = url.pathname.startsWith(base);
-  // Temporarily remove base to simplify
-  if (hasBase) url.pathname = url.pathname.replace(base, '');
-  const [_leadingSlash, baseSegment] = url.pathname.split('/');
-  if (baseSegment && baseSegment in config.locales) {
-    // We’re in a localized route, substitute the new locale (or strip for root lang).
-    url.pathname = locale
-      ? url.pathname.replace(baseSegment, locale)
-      : url.pathname.replace('/' + baseSegment, '');
-  } else if (locale) {
-    // We’re in the root language. Inject the new locale if we have one.
-    url.pathname = '/' + locale + url.pathname;
-  }
-  // Restore base
-  if (hasBase) url.pathname = base + url.pathname;
-  return url;
+	// Create a new URL object to void mutating the global.
+	url = new URL(url);
+	if (!config.locales) {
+		// i18n is not configured on this site, no localization required.
+		return url;
+	}
+	if (locale === 'root') locale = '';
+	/** Base URL with trailing `/` stripped. */
+	const base = import.meta.env.BASE_URL.replace(/\/$/, '');
+	const hasBase = url.pathname.startsWith(base);
+	// Temporarily remove base to simplify
+	if (hasBase) url.pathname = url.pathname.replace(base, '');
+	const [_leadingSlash, baseSegment] = url.pathname.split('/');
+	if (baseSegment && baseSegment in config.locales) {
+		// We’re in a localized route, substitute the new locale (or strip for root lang).
+		url.pathname = locale
+			? url.pathname.replace(baseSegment, locale)
+			: url.pathname.replace('/' + baseSegment, '');
+	} else if (locale) {
+		// We’re in the root language. Inject the new locale if we have one.
+		url.pathname = '/' + locale + url.pathname;
+	}
+	// Restore base
+	if (hasBase) url.pathname = base + url.pathname;
+	return url;
 }