@grove-dev/starlight 0.7.0 → 0.8.0

package/core/config/vite.ts

@@ -2,19 +2,19 @@ import type { ViteUserConfig } from 'astro';
 import type { GroveStarlightConfig } from './schemas';
 
 export function vitePlugin(config: GroveStarlightConfig): VitePlugin {
-    const moduleId = 'virtual:grove-starlight-config';
-    const resolvedModuleId = `\0${moduleId}`;
-    const moduleContent = `export default ${JSON.stringify(config)}`;
+  const moduleId = 'virtual:grove-starlight-config';
+  const resolvedModuleId = `\0${moduleId}`;
+  const moduleContent = `export default ${JSON.stringify(config)}`;
 
-    return {
-        name: 'vite-plugin-grove-starlight',
-        load(id) {
-            return id === resolvedModuleId ? moduleContent : undefined;
-        },
-        resolveId(id) {
-            return id === moduleId ? resolvedModuleId : undefined;
-        },
-    };
+  return {
+    name: 'vite-plugin-grove-starlight',
+    load(id) {
+      return id === resolvedModuleId ? moduleContent : undefined;
+    },
+    resolveId(id) {
+      return id === moduleId ? resolvedModuleId : undefined;
+    },
+  };
 }
 
 type VitePlugin = NonNullable<ViteUserConfig['plugins']>[number];

package/core/i18n.ts

@@ -1,12 +1,12 @@
 export type LocaleLookup = {
-    /** BCP-47 tag from the active locale (`locales[x].lang`), e.g. `en`. */
-    lang?: string;
-    /** Locale path key (`Astro.currentLocale`), e.g. `en`. */
-    locale?: string;
-    /** Default locale BCP-47 tag or path used as fallback. */
-    defaultLang: string;
-    /** Default locale path key, e.g. `en`. */
-    defaultLocale?: string;
+  /** BCP-47 tag from the active locale (`locales[x].lang`), e.g. `en`. */
+  lang?: string;
+  /** Locale path key (`Astro.currentLocale`), e.g. `en`. */
+  locale?: string;
+  /** Default locale BCP-47 tag or path used as fallback. */
+  defaultLang: string;
+  /** Default locale path key, e.g. `en`. */
+  defaultLocale?: string;
 };
 
 /**
@@ -18,63 +18,63 @@ export type LocaleLookup = {
  * (`es-es`), without letting the default locale shadow an active case-insensitive hit.
  */
 export function pickLocalized(
-    dictionary: Record<string, string> | undefined,
-    candidates: Array<string | undefined>,
-    fallbacks: Array<string | undefined> = []
+  dictionary: Record<string, string> | undefined,
+  candidates: Array<string | undefined>,
+  fallbacks: Array<string | undefined> = [],
 ): string | undefined {
-    if (!dictionary) {
-        return undefined;
+  if (!dictionary) {
+    return undefined;
+  }
+
+  const lowerMap = Object.fromEntries(
+    Object.entries(dictionary).map(([key, value]) => [key.toLowerCase(), value]),
+  );
+
+  const pickExact = (keys: Array<string | undefined>) => {
+    for (const key of keys) {
+      if (key && dictionary[key]) {
+        return dictionary[key];
+      }
     }
-
-    const lowerMap = Object.fromEntries(
-        Object.entries(dictionary).map(([key, value]) => [key.toLowerCase(), value])
-    );
-
-    const pickExact = (keys: Array<string | undefined>) => {
-        for (const key of keys) {
-            if (key && dictionary[key]) {
-                return dictionary[key];
-            }
-        }
-        return undefined;
-    };
-
-    const pickCaseInsensitive = (keys: Array<string | undefined>) => {
-        for (const key of keys) {
-            if (!key) {
-                continue;
-            }
-
-            const match = lowerMap[key.toLowerCase()];
-            if (match) {
-                return match;
-            }
-        }
-        return undefined;
-    };
-
-    return (
-        pickExact(candidates) ??
-        pickCaseInsensitive(candidates) ??
-        pickExact(fallbacks) ??
-        pickCaseInsensitive(fallbacks)
-    );
+    return undefined;
+  };
+
+  const pickCaseInsensitive = (keys: Array<string | undefined>) => {
+    for (const key of keys) {
+      if (!key) {
+        continue;
+      }
+
+      const match = lowerMap[key.toLowerCase()];
+      if (match) {
+        return match;
+      }
+    }
+    return undefined;
+  };
+
+  return (
+    pickExact(candidates) ??
+    pickCaseInsensitive(candidates) ??
+    pickExact(fallbacks) ??
+    pickCaseInsensitive(fallbacks)
+  );
 }
 
 /** @deprecated Prefer `pickLocalized`. Kept for existing call sites/tests. */
 export function pickLang(
-    dictionary: Record<string, string> | undefined,
-    lang: string
+  dictionary: Record<string, string> | undefined,
+  lang: string,
 ): string | undefined {
-    return pickLocalized(dictionary, [lang]);
+  return pickLocalized(dictionary, [lang]);
 }
 
 function activeKeys({ lang, locale }: LocaleLookup): Array<string | undefined> {
-    return [lang, locale];
+  return [lang, locale];
 }
 
 function fallbackKeys({ defaultLang, defaultLocale }: LocaleLookup): Array<string | undefined> {
-    return [defaultLang, defaultLocale];
+  return [defaultLang, defaultLocale];
 }
 
 /**
@@ -85,25 +85,25 @@ function fallbackKeys({ defaultLang, defaultLocale }: LocaleLookup): Array<strin
  * - Locale map style: `label: Record<BCP-47 | locale-path, string>`
  */
 export function resolveNavLabel(
-    label: string | Record<string, string>,
-    translations: Record<string, string> | undefined,
-    keys: LocaleLookup
+  label: string | Record<string, string>,
+  translations: Record<string, string> | undefined,
+  keys: LocaleLookup,
 ): string {
-    const primary = activeKeys(keys);
-    const fallback = fallbackKeys(keys);
+  const primary = activeKeys(keys);
+  const fallback = fallbackKeys(keys);
 
-    if (typeof label === 'string') {
-        return pickLocalized(translations, primary, fallback) || label;
-    }
+  if (typeof label === 'string') {
+    return pickLocalized(translations, primary, fallback) || label;
+  }
 
-    const resolved = pickLocalized(label, primary, fallback);
-    if (resolved) {
-        return resolved;
-    }
+  const resolved = pickLocalized(label, primary, fallback);
+  if (resolved) {
+    return resolved;
+  }
 
-    throw new Error(
-        `Localized label must include a key for the default language "${keys.defaultLang}".`
-    );
+  throw new Error(
+    `Localized label must include a key for the default language "${keys.defaultLang}".`,
+  );
 }
 
 /**
@@ -111,15 +111,15 @@ export function resolveNavLabel(
  * Accepts a LocaleLookup or a bare lang string for convenience.
  */
 export function resolveLabel(
-    label: string,
-    translations: Record<string, string> | undefined,
-    langOrKeys: string | LocaleLookup
+  label: string,
+  translations: Record<string, string> | undefined,
+  langOrKeys: string | LocaleLookup,
 ): string {
-    if (typeof langOrKeys === 'string') {
-        return pickLocalized(translations, [langOrKeys]) || label;
-    }
+  if (typeof langOrKeys === 'string') {
+    return pickLocalized(translations, [langOrKeys]) || label;
+  }
 
-    return resolveNavLabel(label, translations, langOrKeys);
+  return resolveNavLabel(label, translations, langOrKeys);
 }
 
 /**
@@ -127,49 +127,49 @@ export function resolveLabel(
  * Prefers the active language/locale, then falls back to the default language.
  */
 export function resolveLocalizedString(
-    value: string | Record<string, string>,
-    langOrKeys: string | LocaleLookup,
-    defaultLang?: string
+  value: string | Record<string, string>,
+  langOrKeys: string | LocaleLookup,
+  defaultLang?: string,
 ): string {
-    if (typeof value === 'string') {
-        return value;
-    }
-
-    const keys: LocaleLookup =
-        typeof langOrKeys === 'string'
-            ? { lang: langOrKeys, defaultLang: defaultLang ?? langOrKeys }
-            : langOrKeys;
-
-    const resolved = pickLocalized(value, activeKeys(keys), fallbackKeys(keys));
-    if (resolved) {
-        return resolved;
-    }
-
-    throw new Error(
-        `Localized string must include a key for the default language "${keys.defaultLang}".`
-    );
+  if (typeof value === 'string') {
+    return value;
+  }
+
+  const keys: LocaleLookup =
+    typeof langOrKeys === 'string'
+      ? { lang: langOrKeys, defaultLang: defaultLang ?? langOrKeys }
+      : langOrKeys;
+
+  const resolved = pickLocalized(value, activeKeys(keys), fallbackKeys(keys));
+  if (resolved) {
+    return resolved;
+  }
+
+  throw new Error(
+    `Localized string must include a key for the default language "${keys.defaultLang}".`,
+  );
 }
 
 /** Build a LocaleLookup from Starlight + Astro locale values. */
 export function createLocaleLookup(options: {
-    lang?: string;
-    locale?: string;
-    defaultLang?: string;
-    defaultLocale?: string;
+  lang?: string;
+  locale?: string;
+  defaultLang?: string;
+  defaultLocale?: string;
 }): LocaleLookup {
-    const result: LocaleLookup = {
-        defaultLang: options.defaultLang || options.defaultLocale || 'en',
-    };
-
-    if (options.lang !== undefined) {
-        result.lang = options.lang;
-    }
-    if (options.locale !== undefined) {
-        result.locale = options.locale;
-    }
-    if (options.defaultLocale !== undefined) {
-        result.defaultLocale = options.defaultLocale;
-    }
-
-    return result;
+  const result: LocaleLookup = {
+    defaultLang: options.defaultLang || options.defaultLocale || 'en',
+  };
+
+  if (options.lang !== undefined) {
+    result.lang = options.lang;
+  }
+  if (options.locale !== undefined) {
+    result.locale = options.locale;
+  }
+  if (options.defaultLocale !== undefined) {
+    result.defaultLocale = options.defaultLocale;
+  }
+
+  return result;
 }

package/core/plugin.ts

@@ -1,58 +1,58 @@
 import type { StarlightPlugin } from '@astrojs/starlight/types';
-import { override, COMPONENT_OVERRIDES } from './config/override';
 import { expressiveCode } from './config/expresive-code';
-import { vitePlugin } from './config/vite';
+import { COMPONENT_OVERRIDES, override } from './config/override';
 import {
-    GroveStarlightConfigSchema,
-    type GroveStarlightConfig,
-    type GroveStarlightUserConfig,
+  type GroveStarlightConfig,
+  GroveStarlightConfigSchema,
+  type GroveStarlightUserConfig,
 } from './config/schemas';
+import { vitePlugin } from './config/vite';
 
 const parseConfig = (userConfig?: GroveStarlightUserConfig): GroveStarlightConfig => {
-    const parsedConfig = GroveStarlightConfigSchema.safeParse(userConfig ?? {});
+  const parsedConfig = GroveStarlightConfigSchema.safeParse(userConfig ?? {});
 
-    if (!parsedConfig.success) {
-        throw new Error(
-            `The provided plugin configuration for grove-starlight is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`
-        );
-    }
+  if (!parsedConfig.success) {
+    throw new Error(
+      `The provided plugin configuration for grove-starlight is invalid.\n${parsedConfig.error.issues.map((issue) => issue.message).join('\n')}`,
+    );
+  }
 
-    return parsedConfig.data;
+  return parsedConfig.data;
 };
 
 const plugin = (userConfig: GroveStarlightUserConfig = {}): StarlightPlugin =>
-    ({
-        name: 'grove-starlight',
-        hooks: {
-            'config:setup': ({ config, logger, updateConfig, addIntegration }) => {
-                const pluginConfig = parseConfig(userConfig);
+  ({
+    name: 'grove-starlight',
+    hooks: {
+      'config:setup': ({ config, logger, updateConfig, addIntegration }) => {
+        const pluginConfig = parseConfig(userConfig);
 
-                updateConfig({
-                    components: override(config, pluginConfig, COMPONENT_OVERRIDES, logger),
-                    customCss: [
-                        ...(config.customCss ?? []),
-                        '@grove-dev/starlight/styles/layers',
-                        '@grove-dev/starlight/styles/theme',
-                        '@grove-dev/starlight/styles/base',
-                    ],
-                    expressiveCode: expressiveCode(config),
-                });
+        updateConfig({
+          components: override(config, pluginConfig, COMPONENT_OVERRIDES, logger),
+          customCss: [
+            ...(config.customCss ?? []),
+            '@grove-dev/starlight/styles/layers',
+            '@grove-dev/starlight/styles/theme',
+            '@grove-dev/starlight/styles/base',
+          ],
+          expressiveCode: expressiveCode(config),
+        });
 
-                addIntegration({
-                    name: 'grove-starlight-integration',
-                    hooks: {
-                        'astro:config:setup': ({ updateConfig }) => {
-                            updateConfig({
-                                vite: { plugins: [vitePlugin(pluginConfig)] },
-                            });
-                        },
-                    },
-                });
+        addIntegration({
+          name: 'grove-starlight-integration',
+          hooks: {
+            'astro:config:setup': ({ updateConfig }) => {
+              updateConfig({
+                vite: { plugins: [vitePlugin(pluginConfig)] },
+              });
             },
-            // 'i18n:setup': function ({ injectTranslations }) {
-            //     injectTranslations(translations);
-            // },
-        },
-    }) satisfies StarlightPlugin;
+          },
+        });
+      },
+      // 'i18n:setup': function ({ injectTranslations }) {
+      //     injectTranslations(translations);
+      // },
+    },
+  }) satisfies StarlightPlugin;
 
 export { plugin };

package/core/sidebar.ts

@@ -6,9 +6,9 @@ export type SidebarLink = Extract<SidebarEntry, { type: 'link' }>;
 
 /** Every link reachable from `entries`, at any depth. */
 export function flattenSidebar(entries: SidebarEntry[]): SidebarLink[] {
-    return entries.flatMap((entry) =>
-        entry.type === 'group' ? flattenSidebar(entry.entries) : [entry]
-    );
+  return entries.flatMap((entry) =>
+    entry.type === 'group' ? flattenSidebar(entry.entries) : [entry],
+  );
 }
 
 /**
@@ -18,5 +18,5 @@ export function flattenSidebar(entries: SidebarEntry[]): SidebarLink[] {
  * the reader would land on a page with no idea where they are in the tree.
  */
 export function isSidebarGroupOpen(group: SidebarGroup): boolean {
-    return !group.collapsed || flattenSidebar(group.entries).some((link) => link.isCurrent);
+  return !group.collapsed || flattenSidebar(group.entries).some((link) => link.isCurrent);
 }

package/global.d.ts

@@ -1,5 +1,5 @@
 export declare global {
-    var StarlightThemeProvider: {
-        updatePickers(theme?: string): void;
-    };
+  var StarlightThemeProvider: {
+    updatePickers(theme?: string): void;
+  };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grove-dev/starlight",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "module",
   "description": "Grove's theme for Starlight (the Astro native documentation site generator)",
   "author": "grove-dev",

package/schema.ts

@@ -6,50 +6,50 @@ import { markDocsSchemaLoaded } from './core/config/docs-schema';
 markDocsSchemaLoaded();
 
 export const heroLayoutSchema = z
-    .enum(['centered', 'centered-top', 'split-left', 'split-right', 'banner'])
-    .default('centered')
-    .describe(
-        'The layout of the hero section. "centered" places the image below the text, "centered-top" places it above, "split-left" places text left and image right, "split-right" places text right and image left.'
-    );
+  .enum(['centered', 'centered-top', 'split-left', 'split-right', 'banner'])
+  .default('centered')
+  .describe(
+    'The layout of the hero section. "centered" places the image below the text, "centered-top" places it above, "split-left" places text left and image right, "split-right" places text right and image left.',
+  );
 
 export type HeroLayout = z.infer<typeof heroLayoutSchema>;
 
 export const ExtendDocsSchema = z.object({
-    hero: z
+  hero: z
+    .object({
+      layout: heroLayoutSchema,
+      announcement: z
         .object({
-            layout: heroLayoutSchema,
-            announcement: z
-                .object({
-                    text: z.string(),
-                    link: z.string(),
-                })
-                .optional(),
-            actions: z
-                .array(
-                    z.object({
-                        /**
-                         * Button style to use. Starlight's own `primary` and `minimal` are accepted
-                         * as aliases of `default` and `ghost` so existing frontmatter keeps working.
-                         *
-                         * Requires `@astrojs/starlight >= 0.41.4`, which is the first version whose
-                         * `docsSchema({ extend })` deep-merges instead of intersecting — an
-                         * intersection cannot widen an enum Starlight already declares.
-                         */
-                        variant: z
-                            .enum([
-                                'default',
-                                'link',
-                                'secondary',
-                                'outline',
-                                'ghost',
-                                'destructive',
-                                'primary',
-                                'minimal',
-                            ])
-                            .default('default'),
-                    })
-                )
-                .default([]),
+          text: z.string(),
+          link: z.string(),
         })
         .optional(),
+      actions: z
+        .array(
+          z.object({
+            /**
+             * Button style to use. Starlight's own `primary` and `minimal` are accepted
+             * as aliases of `default` and `ghost` so existing frontmatter keeps working.
+             *
+             * Requires `@astrojs/starlight >= 0.41.4`, which is the first version whose
+             * `docsSchema({ extend })` deep-merges instead of intersecting — an
+             * intersection cannot widen an enum Starlight already declares.
+             */
+            variant: z
+              .enum([
+                'default',
+                'link',
+                'secondary',
+                'outline',
+                'ghost',
+                'destructive',
+                'primary',
+                'minimal',
+              ])
+              .default('default'),
+          }),
+        )
+        .default([]),
+    })
+    .optional(),
 });