starlight-sidebar-topics-dropdown 0.2.1 → 0.2.2

package/index.ts

@@ -1,82 +1,82 @@
-import type { StarlightPlugin, StarlightUserConfig } from "@astrojs/starlight/types";
-
-import {
-    StarlightSidebarTopicsDropdownConfigSchema,
-    type StarlightSidebarTopicsDropdownUserConfig,
-} from "./lib/config";
-import { overrideStarlightComponent, throwPluginError } from "./lib/plugin";
-import { vitePluginStarlightSidebarTopicsDropdown } from "./lib/vite";
-
-export type {
-    StarlightSidebarTopicsDropdownConfig,
-    StarlightSidebarTopicsDropdownUserConfig,
-} from "./lib/config";
-
-export default function starlightSidebarTopicsDropdownPlugin(
-    userConfig: StarlightSidebarTopicsDropdownUserConfig
-): StarlightPlugin {
-    const parsedConfig = StarlightSidebarTopicsDropdownConfigSchema.safeParse(userConfig);
-
-    if (!parsedConfig.success) {
-        throwPluginError(
-            `The provided plugin configuration is invalid.\n${parsedConfig.error.issues
-                .map((issue) => issue.message)
-                .join("\n")}`
-        );
-    }
-
-    const config = parsedConfig.data;
-
-    return {
-        name: "starlight-sidebar-topics-dropdown-plugin",
-        hooks: {
-            setup({ addIntegration, command, config: starlightConfig, logger, updateConfig }) {
-                if (command !== "dev" && command !== "build") return;
-
-                if (starlightConfig.sidebar) {
-                    throwPluginError(
-                        "It looks like you have a `sidebar` configured in your Starlight configuration. To use `starlight-sidebar-topics-dropdown`, create a new topic with your sidebar items.",
-                        "Learn more about topic configuration at https://starlight-sidebar-topics-dropdown.netlify.app/docs/configuration/"
-                    );
-                }
-
-                const sidebar: StarlightUserConfig["sidebar"] = [];
-
-                for (const [index, topic] of config.entries()) {
-                    if ("items" in topic) {
-                        sidebar.push({ label: String(index), items: topic.items });
-                    }
-                }
-                updateConfig({
-                    components: {
-                        ...starlightConfig.components,
-                        ...overrideStarlightComponent(
-                            starlightConfig.components,
-                            logger,
-                            "Sidebar"
-                        ),
-                        ...overrideStarlightComponent(
-                            starlightConfig.components,
-                            logger,
-                            "Pagination"
-                        ),
-                    },
-                    sidebar,
-                });
-
-                addIntegration({
-                    name: "starlight-sidebar-topics-dropdown-integration",
-                    hooks: {
-                        "astro:config:setup": ({ updateConfig }) => {
-                            updateConfig({
-                                vite: {
-                                    plugins: [vitePluginStarlightSidebarTopicsDropdown(config)],
-                                },
-                            });
-                        },
-                    },
-                });
-            },
-        },
-    };
-}
+import type { StarlightPlugin, StarlightUserConfig } from "@astrojs/starlight/types";
+
+import {
+    StarlightSidebarTopicsDropdownConfigSchema,
+    type StarlightSidebarTopicsDropdownUserConfig,
+} from "./lib/config";
+import { overrideStarlightComponent, throwPluginError } from "./lib/plugin";
+import { vitePluginStarlightSidebarTopicsDropdown } from "./lib/vite";
+
+export type {
+    StarlightSidebarTopicsDropdownConfig,
+    StarlightSidebarTopicsDropdownUserConfig,
+} from "./lib/config";
+
+export default function starlightSidebarTopicsDropdownPlugin(
+    userConfig: StarlightSidebarTopicsDropdownUserConfig
+): StarlightPlugin {
+    const parsedConfig = StarlightSidebarTopicsDropdownConfigSchema.safeParse(userConfig);
+
+    if (!parsedConfig.success) {
+        throwPluginError(
+            `The provided plugin configuration is invalid.\n${parsedConfig.error.issues
+                .map((issue) => issue.message)
+                .join("\n")}`
+        );
+    }
+
+    const config = parsedConfig.data;
+
+    return {
+        name: "starlight-sidebar-topics-dropdown-plugin",
+        hooks: {
+            setup({ addIntegration, command, config: starlightConfig, logger, updateConfig }) {
+                if (command !== "dev" && command !== "build") return;
+
+                if (starlightConfig.sidebar) {
+                    throwPluginError(
+                        "It looks like you have a `sidebar` configured in your Starlight configuration. To use `starlight-sidebar-topics-dropdown`, create a new topic with your sidebar items.",
+                        "Learn more about topic configuration at https://starlight-sidebar-topics-dropdown.netlify.app/docs/configuration/"
+                    );
+                }
+
+                const sidebar: StarlightUserConfig["sidebar"] = [];
+
+                for (const [index, topic] of config.entries()) {
+                    if ("items" in topic) {
+                        sidebar.push({ label: String(index), items: topic.items });
+                    }
+                }
+                updateConfig({
+                    components: {
+                        ...starlightConfig.components,
+                        ...overrideStarlightComponent(
+                            starlightConfig.components,
+                            logger,
+                            "Sidebar"
+                        ),
+                        ...overrideStarlightComponent(
+                            starlightConfig.components,
+                            logger,
+                            "Pagination"
+                        ),
+                    },
+                    sidebar,
+                });
+
+                addIntegration({
+                    name: "starlight-sidebar-topics-dropdown-integration",
+                    hooks: {
+                        "astro:config:setup": ({ updateConfig }) => {
+                            updateConfig({
+                                vite: {
+                                    plugins: [vitePluginStarlightSidebarTopicsDropdown(config)],
+                                },
+                            });
+                        },
+                    },
+                });
+            },
+        },
+    };
+}

package/lib/config.ts

@@ -1,74 +1,74 @@
-import type { StarlightUserConfig } from "@astrojs/starlight/types";
-import { z } from "astro/zod";
-
-const sidebarTopicBadgeSchema = z.object({
-    text: z.union([z.string(), z.record(z.string())]),
-    variant: z.enum(["note", "danger", "success", "caution", "tip", "default"]).default("default"),
-});
-
-const sidebarTopicBaseSchema = z.object({
-    /**
-     * An optional badge to display next to the topic label.
-     *
-     * This option accepts the same configuration as the Starlight badge sidebar item configuration.
-     * @see https://starlight.astro.build/guides/sidebar/#badges
-     */
-    badge: z
-        .union([z.string(), sidebarTopicBadgeSchema])
-        .transform((badge) =>
-            typeof badge === "string" ? { variant: "default" as const, text: badge } : badge
-        )
-        .optional(),
-    /**
-     * The name of an optional icon to display before the topic label set to one of Starlight’s built-in icons.
-     * @see https://starlight.astro.build/reference/icons/#all-icons
-     */
-    icon: z.string().optional(),
-    /**
-     * The topic label visible at the top of the sidebar.
-     *
-     * The value can be a string, or for multilingual sites, an object with values for each different locale. When using
-     * the object form, the keys must be BCP-47 tags (e.g. en, fr, or zh-CN).
-     */
-    label: z.union([z.string(), z.record(z.string())]),
-    /**
-     * The link to the topic’s content which an be a relative link to local files or the full URL of an external page.
-     *
-     * For internal links, the link can either be a page included in the items array or a different page acting as the
-     * topic’s landing page.
-     */
-    link: z.string(),
-});
-
-const sidebarTopicLinkSchema = sidebarTopicBaseSchema;
-
-const sidebarTopicGroupSchema = sidebarTopicBaseSchema.extend({
-    /**
-     * An optional unique identifier for the topic that can be used to associate content pages that are not listed in any
-     * topic sidebar configuration with this topic.
-     */
-    id: z.string().optional(),
-    /**
-     * The sidebar items (links and subcategories) to display for this topic.
-     *
-     * The topic’s sidebar navigation items. This represents the sidebar displayed when the topic `link` page or any of
-     * the pages configured in the `items` array is the current page.
-     */
-    items: z.any().array() as z.Schema<NonNullable<StarlightUserConfig["sidebar"]>>,
-});
-
-export const StarlightSidebarTopicsDropdownConfigSchema = z
-    .union([sidebarTopicGroupSchema, sidebarTopicLinkSchema])
-    .array();
-
-export type StarlightSidebarTopicsDropdownUserConfig = z.input<
-    typeof StarlightSidebarTopicsDropdownConfigSchema
->;
-export type StarlightSidebarTopicsDropdownConfig = z.output<
-    typeof StarlightSidebarTopicsDropdownConfigSchema
->;
-
-export type StarlightSidebarTopicsDropdownSharedConfig = (
-    | (z.output<typeof sidebarTopicLinkSchema> & { type: "link" })
-    | (Omit<z.output<typeof sidebarTopicGroupSchema>, "items"> & { type: "group" })
-)[];
+import type { StarlightUserConfig } from "@astrojs/starlight/types";
+import { z } from "astro/zod";
+
+const sidebarTopicBadgeSchema = z.object({
+    text: z.union([z.string(), z.record(z.string())]),
+    variant: z.enum(["note", "danger", "success", "caution", "tip", "default"]).default("default"),
+});
+
+const sidebarTopicBaseSchema = z.object({
+    /**
+     * An optional badge to display next to the topic label.
+     *
+     * This option accepts the same configuration as the Starlight badge sidebar item configuration.
+     * @see https://starlight.astro.build/guides/sidebar/#badges
+     */
+    badge: z
+        .union([z.string(), sidebarTopicBadgeSchema])
+        .transform((badge) =>
+            typeof badge === "string" ? { variant: "default" as const, text: badge } : badge
+        )
+        .optional(),
+    /**
+     * The name of an optional icon to display before the topic label set to one of Starlight’s built-in icons.
+     * @see https://starlight.astro.build/reference/icons/#all-icons
+     */
+    icon: z.string().optional(),
+    /**
+     * The topic label visible at the top of the sidebar.
+     *
+     * The value can be a string, or for multilingual sites, an object with values for each different locale. When using
+     * the object form, the keys must be BCP-47 tags (e.g. en, fr, or zh-CN).
+     */
+    label: z.union([z.string(), z.record(z.string())]),
+    /**
+     * The link to the topic’s content which an be a relative link to local files or the full URL of an external page.
+     *
+     * For internal links, the link can either be a page included in the items array or a different page acting as the
+     * topic’s landing page.
+     */
+    link: z.string(),
+});
+
+const sidebarTopicLinkSchema = sidebarTopicBaseSchema;
+
+const sidebarTopicGroupSchema = sidebarTopicBaseSchema.extend({
+    /**
+     * An optional unique identifier for the topic that can be used to associate content pages that are not listed in any
+     * topic sidebar configuration with this topic.
+     */
+    id: z.string().optional(),
+    /**
+     * The sidebar items (links and subcategories) to display for this topic.
+     *
+     * The topic’s sidebar navigation items. This represents the sidebar displayed when the topic `link` page or any of
+     * the pages configured in the `items` array is the current page.
+     */
+    items: z.any().array() as z.Schema<NonNullable<StarlightUserConfig["sidebar"]>>,
+});
+
+export const StarlightSidebarTopicsDropdownConfigSchema = z
+    .union([sidebarTopicGroupSchema, sidebarTopicLinkSchema])
+    .array();
+
+export type StarlightSidebarTopicsDropdownUserConfig = z.input<
+    typeof StarlightSidebarTopicsDropdownConfigSchema
+>;
+export type StarlightSidebarTopicsDropdownConfig = z.output<
+    typeof StarlightSidebarTopicsDropdownConfigSchema
+>;
+
+export type StarlightSidebarTopicsDropdownSharedConfig = (
+    | (z.output<typeof sidebarTopicLinkSchema> & { type: "link" })
+    | (Omit<z.output<typeof sidebarTopicGroupSchema>, "items"> & { type: "group" })
+)[];

package/lib/content.ts

@@ -1,11 +1,11 @@
-import type { Props } from "@astrojs/starlight/props";
-import type { TopicFrontmatterSchema } from "../schema";
-export function isStarlightEntryWithTopic(entry: StarlightEntry): entry is StarlightEntryWithTopic {
-    return (
-        "data" in entry &&
-        "topic" in (entry as StarlightEntryWithTopic).data &&
-        typeof (entry as StarlightEntryWithTopic).data.topic === "string"
-    );
-}
-export type StarlightEntry = Props["entry"];
-export type StarlightEntryWithTopic = StarlightEntry & { data: TopicFrontmatterSchema };
+import type { Props } from "@astrojs/starlight/props";
+import type { TopicFrontmatterSchema } from "../schema";
+export function isStarlightEntryWithTopic(entry: StarlightEntry): entry is StarlightEntryWithTopic {
+    return (
+        "data" in entry &&
+        "topic" in (entry as StarlightEntryWithTopic).data &&
+        typeof (entry as StarlightEntryWithTopic).data.topic === "string"
+    );
+}
+export type StarlightEntry = Props["entry"];
+export type StarlightEntryWithTopic = StarlightEntry & { data: TopicFrontmatterSchema };

package/lib/i18n.ts

@@ -1,22 +1,22 @@
-import starlightConfig from "virtual:starlight/user-config";
-
-import { stripTrailingSlash } from "./pathname";
-
-export function getLocalizedSlug(slug: string, locale: string | undefined): string {
-    const slugLocale = getLocaleFromSlug(slug);
-    if (slugLocale === locale) return slug;
-    locale ??= "";
-    if (slugLocale === slug) return locale;
-
-    if (slugLocale) {
-        return stripTrailingSlash(slug.replace(`${slugLocale}/`, locale ? `${locale}/` : ""));
-    }
-
-    return slug ? `${locale}/${slug}` : locale;
-}
-
-export function getLocaleFromSlug(slug: string): string | undefined {
-    const locales = Object.keys(starlightConfig.locales ?? {});
-    const baseSegment = slug.split("/")[0];
-    return baseSegment && locales.includes(baseSegment) ? baseSegment : undefined;
-}
+import starlightConfig from "virtual:starlight/user-config";
+
+import { stripTrailingSlash } from "./pathname";
+
+export function getLocalizedSlug(slug: string, locale: string | undefined): string {
+    const slugLocale = getLocaleFromSlug(slug);
+    if (slugLocale === locale) return slug;
+    locale ??= "";
+    if (slugLocale === slug) return locale;
+
+    if (slugLocale) {
+        return stripTrailingSlash(slug.replace(`${slugLocale}/`, locale ? `${locale}/` : ""));
+    }
+
+    return slug ? `${locale}/${slug}` : locale;
+}
+
+export function getLocaleFromSlug(slug: string): string | undefined {
+    const locales = Object.keys(starlightConfig.locales ?? {});
+    const baseSegment = slug.split("/")[0];
+    return baseSegment && locales.includes(baseSegment) ? baseSegment : undefined;
+}

package/lib/pathname.ts

@@ -1,17 +1,17 @@
-export function arePathnamesEqual(pathnameA: string, pathnameB: string) {
-    return stripLeadingAndTrailingSlashes(pathnameA) === stripLeadingAndTrailingSlashes(pathnameB);
-}
-
-export function stripLeadingAndTrailingSlashes(pathname: string): string {
-    return stripLeadingSlash(stripTrailingSlash(pathname));
-}
-
-export function stripLeadingSlash(pathname: string) {
-    if (pathname.startsWith("/")) pathname = pathname.slice(1);
-    return pathname;
-}
-
-export function stripTrailingSlash(pathname: string) {
-    if (pathname.endsWith("/")) pathname = pathname.slice(0, -1);
-    return pathname;
-}
+export function arePathnamesEqual(pathnameA: string, pathnameB: string) {
+    return stripLeadingAndTrailingSlashes(pathnameA) === stripLeadingAndTrailingSlashes(pathnameB);
+}
+
+export function stripLeadingAndTrailingSlashes(pathname: string): string {
+    return stripLeadingSlash(stripTrailingSlash(pathname));
+}
+
+export function stripLeadingSlash(pathname: string) {
+    if (pathname.startsWith("/")) pathname = pathname.slice(1);
+    return pathname;
+}
+
+export function stripTrailingSlash(pathname: string) {
+    if (pathname.endsWith("/")) pathname = pathname.slice(0, -1);
+    return pathname;
+}

package/lib/plugin.ts

@@ -1,32 +1,32 @@
-import type { StarlightUserConfig } from "@astrojs/starlight/types";
-import type { AstroIntegrationLogger } from "astro";
-import { AstroError } from "astro/errors";
-
-export function throwPluginError(message: string, hint?: string): never {
-    throw new AstroError(
-        message,
-        hint ??
-            `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-sidebar-topics-dropdown/issues/new/choose`
-    );
-}
-
-export function overrideStarlightComponent(
-    components: StarlightUserConfig["components"],
-    logger: AstroIntegrationLogger,
-    component: keyof NonNullable<StarlightUserConfig["components"]>
-) {
-    if (components?.[component]) {
-        logger.warn(
-            `It looks like you already have a \`${component}\` component override in your Starlight configuration.`
-        );
-        logger.warn(
-            `To use \`starlight-sidebar-topics-dropdown\`, either remove your override or update it to render the content from \`starlight-sidebar-topics-dropdown/overrides/${component}.astro\`.`
-        );
-
-        return {};
-    }
-
-    return {
-        [component]: `starlight-sidebar-topics-dropdown/overrides/${component}.astro`,
-    };
-}
+import type { StarlightUserConfig } from "@astrojs/starlight/types";
+import type { AstroIntegrationLogger } from "astro";
+import { AstroError } from "astro/errors";
+
+export function throwPluginError(message: string, hint?: string): never {
+    throw new AstroError(
+        message,
+        hint ??
+            `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-sidebar-topics-dropdown/issues/new/choose`
+    );
+}
+
+export function overrideStarlightComponent(
+    components: StarlightUserConfig["components"],
+    logger: AstroIntegrationLogger,
+    component: keyof NonNullable<StarlightUserConfig["components"]>
+) {
+    if (components?.[component]) {
+        logger.warn(
+            `It looks like you already have a \`${component}\` component override in your Starlight configuration.`
+        );
+        logger.warn(
+            `To use \`starlight-sidebar-topics-dropdown\`, either remove your override or update it to render the content from \`starlight-sidebar-topics-dropdown/overrides/${component}.astro\`.`
+        );
+
+        return {};
+    }
+
+    return {
+        [component]: `starlight-sidebar-topics-dropdown/overrides/${component}.astro`,
+    };
+}