starlight-sidebar-topics-dropdown 0.2.0 → 0.2.2

package/lib/sidebar.ts

@@ -1,173 +1,173 @@
-import type { Props } from "@astrojs/starlight/props";
-
-import type { StarlightSidebarTopicsDropdownSharedConfig } from "./config";
-import { isStarlightEntryWithTopic, type StarlightEntry } from "./content";
-import { getLocaleFromSlug, getLocalizedSlug } from "./i18n";
-import { arePathnamesEqual, stripLeadingAndTrailingSlashes } from "./pathname";
-
-const absoluteLinkRegex = /^https?:\/\//;
-
-export function getCurrentTopic(
-    config: StarlightSidebarTopicsDropdownSharedConfig,
-    sidebar: SidebarEntry[],
-    currentSlug: string,
-    entry: StarlightEntry
-): Topic | undefined {
-    // If the current page has a topic ID, use it to find the topic.
-    const topicId = getTopicIdFromEntry(entry);
-    if (topicId) return getTopicById(config, sidebar, topicId);
-
-    // Start by checking if the current page is a topic root.
-    const topicFromSlug = getTopicFromSlug(config, sidebar, currentSlug);
-    if (topicFromSlug) return topicFromSlug;
-
-    // Otherwise, find the current topic by looking for the current page in the sidebar.
-    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
-    if (!currentSidebarTopic) return;
-
-    const currentTopicConfig = config[Number.parseInt(currentSidebarTopic.label, 10)];
-    if (!currentTopicConfig) return;
-
-    return { config: currentTopicConfig, sidebar: currentSidebarTopic.entries };
-}
-
-export function isTopicFirstPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
-    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
-    if (!currentSidebarTopic) return false;
-
-    const firstPage = getSidebarFirstPage(currentSidebarTopic.entries);
-    if (!firstPage) return false;
-
-    return arePathnamesEqual(stripLeadingAndTrailingSlashes(firstPage.href), currentSlug);
-}
-
-export function isTopicLastPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
-    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
-    if (!currentSidebarTopic) return false;
-
-    const lastPage = getSidebarLastPage(currentSidebarTopic.entries);
-    if (!lastPage) return false;
-
-    return arePathnamesEqual(stripLeadingAndTrailingSlashes(lastPage.href), currentSlug);
-}
-
-function getSidebarFirstPage(sidebar: SidebarEntry[]) {
-    const entry = sidebar[0];
-    if (!entry) return;
-    if (entry.type === "link") return entry;
-
-    return getSidebarFirstPage(entry.entries);
-}
-
-function getSidebarLastPage(sidebar: SidebarEntry[]) {
-    const entry = sidebar.at(-1);
-    if (!entry) return;
-    if (entry.type === "link") return entry;
-
-    return getSidebarLastPage(entry.entries);
-}
-
-function getTopicFromSlug(
-    config: StarlightSidebarTopicsDropdownSharedConfig,
-    sidebar: SidebarEntry[],
-    slug: string
-): Topic | undefined {
-    let topicConfig: Topic["config"] | undefined;
-    let topicSidebar: Topic["sidebar"] | undefined;
-
-    // Start by checking if the current page is a topic homepage.
-    let groupTopicIndex = -1;
-    const slugLocale = getLocaleFromSlug(slug);
-
-    for (const topic of config) {
-        if (topic.type === "group") groupTopicIndex++;
-
-        if (
-            !absoluteLinkRegex.test(topic.link) &&
-            arePathnamesEqual(
-                getLocalizedSlug(stripLeadingAndTrailingSlashes(topic.link), slugLocale),
-                slug
-            ) &&
-            groupTopicIndex !== -1
-        ) {
-            const sidebarTopic = sidebar[groupTopicIndex];
-
-            if (sidebarTopic?.type === "group") {
-                topicConfig = topic;
-                topicSidebar = sidebarTopic.entries;
-            }
-
-            break;
-        }
-    }
-
-    if (!topicConfig || !topicSidebar) return;
-
-    return { config: topicConfig, sidebar: topicSidebar };
-}
-
-function getTopicById(
-    config: StarlightSidebarTopicsDropdownSharedConfig,
-    sidebar: SidebarEntry[],
-    id: string
-): Topic | undefined {
-    let topicConfig: Topic["config"] | undefined;
-    let topicSidebar: Topic["sidebar"] | undefined;
-    let groupTopicIndex = -1;
-    for (const topic of config) {
-        if (topic.type === "group") groupTopicIndex++;
-        if (topic.type === "group" && topic.id === id) {
-            const sidebarTopic = sidebar[groupTopicIndex];
-            if (sidebarTopic?.type === "group") {
-                topicConfig = topic;
-                topicSidebar = sidebarTopic.entries;
-            }
-            break;
-        }
-    }
-    if (!topicConfig || !topicSidebar) return;
-    return { config: topicConfig, sidebar: topicSidebar };
-}
-
-function getCurrentSidebarTopic(sidebar: SidebarEntry[]): SidebarTopic | undefined {
-    let currentSidebarTopic: SidebarTopic | undefined;
-
-    for (const topic of sidebar) {
-        if (topic.type === "link") continue;
-
-        const currentSidebarEntry = getCurrentSidebarEntry(topic.entries);
-
-        if (currentSidebarEntry) {
-            currentSidebarTopic = topic;
-            break;
-        }
-    }
-
-    return currentSidebarTopic;
-}
-
-function getCurrentSidebarEntry(sidebar: SidebarEntry[]): SidebarEntry | undefined {
-    return sidebar.find((entry) => {
-        if (entry.type === "link") {
-            return entry.isCurrent;
-        }
-
-        return getCurrentSidebarEntry(entry.entries);
-    });
-}
-
-function getTopicIdFromEntry(entry: StarlightEntry): string | undefined {
-    return isStarlightEntryWithTopic(entry) ? entry.data.topic : undefined;
-}
-
-type SidebarEntry = Props["sidebar"][number];
-
-interface SidebarTopic {
-    label: string;
-    entries: SidebarEntry[];
-}
-
-export interface Topic {
-    config: StarlightSidebarTopicsDropdownSharedConfig[number];
-    sidebar: SidebarEntry[];
-}
+import type { Props } from "@astrojs/starlight/props";
+
+import type { StarlightSidebarTopicsDropdownSharedConfig } from "./config";
+import { isStarlightEntryWithTopic, type StarlightEntry } from "./content";
+import { getLocaleFromSlug, getLocalizedSlug } from "./i18n";
+import { arePathnamesEqual, stripLeadingAndTrailingSlashes } from "./pathname";
+
+const absoluteLinkRegex = /^https?:\/\//;
+
+export function getCurrentTopic(
+    config: StarlightSidebarTopicsDropdownSharedConfig,
+    sidebar: SidebarEntry[],
+    currentSlug: string,
+    entry: StarlightEntry
+): Topic | undefined {
+    // If the current page has a topic ID, use it to find the topic.
+    const topicId = getTopicIdFromEntry(entry);
+    if (topicId) return getTopicById(config, sidebar, topicId);
+
+    // Start by checking if the current page is a topic root.
+    const topicFromSlug = getTopicFromSlug(config, sidebar, currentSlug);
+    if (topicFromSlug) return topicFromSlug;
+
+    // Otherwise, find the current topic by looking for the current page in the sidebar.
+    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
+    if (!currentSidebarTopic) return;
+
+    const currentTopicConfig = config[Number.parseInt(currentSidebarTopic.label, 10)];
+    if (!currentTopicConfig) return;
+
+    return { config: currentTopicConfig, sidebar: currentSidebarTopic.entries };
+}
+
+export function isTopicFirstPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
+    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
+    if (!currentSidebarTopic) return false;
+
+    const firstPage = getSidebarFirstPage(currentSidebarTopic.entries);
+    if (!firstPage) return false;
+
+    return arePathnamesEqual(stripLeadingAndTrailingSlashes(firstPage.href), currentSlug);
+}
+
+export function isTopicLastPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
+    const currentSidebarTopic = getCurrentSidebarTopic(sidebar);
+    if (!currentSidebarTopic) return false;
+
+    const lastPage = getSidebarLastPage(currentSidebarTopic.entries);
+    if (!lastPage) return false;
+
+    return arePathnamesEqual(stripLeadingAndTrailingSlashes(lastPage.href), currentSlug);
+}
+
+function getSidebarFirstPage(sidebar: SidebarEntry[]) {
+    const entry = sidebar[0];
+    if (!entry) return;
+    if (entry.type === "link") return entry;
+
+    return getSidebarFirstPage(entry.entries);
+}
+
+function getSidebarLastPage(sidebar: SidebarEntry[]) {
+    const entry = sidebar.at(-1);
+    if (!entry) return;
+    if (entry.type === "link") return entry;
+
+    return getSidebarLastPage(entry.entries);
+}
+
+function getTopicFromSlug(
+    config: StarlightSidebarTopicsDropdownSharedConfig,
+    sidebar: SidebarEntry[],
+    slug: string
+): Topic | undefined {
+    let topicConfig: Topic["config"] | undefined;
+    let topicSidebar: Topic["sidebar"] | undefined;
+
+    // Start by checking if the current page is a topic homepage.
+    let groupTopicIndex = -1;
+    const slugLocale = getLocaleFromSlug(slug);
+
+    for (const topic of config) {
+        if (topic.type === "group") groupTopicIndex++;
+
+        if (
+            !absoluteLinkRegex.test(topic.link) &&
+            arePathnamesEqual(
+                getLocalizedSlug(stripLeadingAndTrailingSlashes(topic.link), slugLocale),
+                slug
+            ) &&
+            groupTopicIndex !== -1
+        ) {
+            const sidebarTopic = sidebar[groupTopicIndex];
+
+            if (sidebarTopic?.type === "group") {
+                topicConfig = topic;
+                topicSidebar = sidebarTopic.entries;
+            }
+
+            break;
+        }
+    }
+
+    if (!topicConfig || !topicSidebar) return;
+
+    return { config: topicConfig, sidebar: topicSidebar };
+}
+
+function getTopicById(
+    config: StarlightSidebarTopicsDropdownSharedConfig,
+    sidebar: SidebarEntry[],
+    id: string
+): Topic | undefined {
+    let topicConfig: Topic["config"] | undefined;
+    let topicSidebar: Topic["sidebar"] | undefined;
+    let groupTopicIndex = -1;
+    for (const topic of config) {
+        if (topic.type === "group") groupTopicIndex++;
+        if (topic.type === "group" && topic.id === id) {
+            const sidebarTopic = sidebar[groupTopicIndex];
+            if (sidebarTopic?.type === "group") {
+                topicConfig = topic;
+                topicSidebar = sidebarTopic.entries;
+            }
+            break;
+        }
+    }
+    if (!topicConfig || !topicSidebar) return;
+    return { config: topicConfig, sidebar: topicSidebar };
+}
+
+function getCurrentSidebarTopic(sidebar: SidebarEntry[]): SidebarTopic | undefined {
+    let currentSidebarTopic: SidebarTopic | undefined;
+
+    for (const topic of sidebar) {
+        if (topic.type === "link") continue;
+
+        const currentSidebarEntry = getCurrentSidebarEntry(topic.entries);
+
+        if (currentSidebarEntry) {
+            currentSidebarTopic = topic;
+            break;
+        }
+    }
+
+    return currentSidebarTopic;
+}
+
+function getCurrentSidebarEntry(sidebar: SidebarEntry[]): SidebarEntry | undefined {
+    return sidebar.find((entry) => {
+        if (entry.type === "link") {
+            return entry.isCurrent;
+        }
+
+        return getCurrentSidebarEntry(entry.entries);
+    });
+}
+
+function getTopicIdFromEntry(entry: StarlightEntry): string | undefined {
+    return isStarlightEntryWithTopic(entry) ? entry.data.topic : undefined;
+}
+
+type SidebarEntry = Props["sidebar"][number];
+
+interface SidebarTopic {
+    label: string;
+    entries: SidebarEntry[];
+}
+
+export interface Topic {
+    config: StarlightSidebarTopicsDropdownSharedConfig[number];
+    sidebar: SidebarEntry[];
+}

package/lib/vite.ts

@@ -1,34 +1,34 @@
-import type { ViteUserConfig } from "astro";
-
-import type {
-    StarlightSidebarTopicsDropdownConfig,
-    StarlightSidebarTopicsDropdownSharedConfig,
-} from "./config";
-
-const moduleId = "virtual:starlight-sidebar-topics-dropdown/config";
-
-export function vitePluginStarlightSidebarTopicsDropdown(
-    config: StarlightSidebarTopicsDropdownConfig
-): VitePlugin {
-    const resolvedModuleId = `\0${moduleId}`;
-
-    const sharedConfig: StarlightSidebarTopicsDropdownSharedConfig = config.map((topic) => {
-        if (!("items" in topic)) return { ...topic, type: "link" };
-        const { items, ...topicWithoutItems } = topic;
-        return { ...topicWithoutItems, type: "group" };
-    });
-
-    const moduleContent = `export default ${JSON.stringify(sharedConfig)}`;
-
-    return {
-        name: "vite-plugin-starlight-sidebar-topics-dropdown",
-        load(id) {
-            return id === resolvedModuleId ? moduleContent : undefined;
-        },
-        resolveId(id) {
-            return id === moduleId ? resolvedModuleId : undefined;
-        },
-    };
-}
-
-type VitePlugin = NonNullable<ViteUserConfig["plugins"]>[number];
+import type { ViteUserConfig } from "astro";
+
+import type {
+    StarlightSidebarTopicsDropdownConfig,
+    StarlightSidebarTopicsDropdownSharedConfig,
+} from "./config";
+
+const moduleId = "virtual:starlight-sidebar-topics-dropdown/config";
+
+export function vitePluginStarlightSidebarTopicsDropdown(
+    config: StarlightSidebarTopicsDropdownConfig
+): VitePlugin {
+    const resolvedModuleId = `\0${moduleId}`;
+
+    const sharedConfig: StarlightSidebarTopicsDropdownSharedConfig = config.map((topic) => {
+        if (!("items" in topic)) return { ...topic, type: "link" };
+        const { items, ...topicWithoutItems } = topic;
+        return { ...topicWithoutItems, type: "group" };
+    });
+
+    const moduleContent = `export default ${JSON.stringify(sharedConfig)}`;
+
+    return {
+        name: "vite-plugin-starlight-sidebar-topics-dropdown",
+        load(id) {
+            return id === resolvedModuleId ? moduleContent : undefined;
+        },
+        resolveId(id) {
+            return id === moduleId ? resolvedModuleId : undefined;
+        },
+    };
+}
+
+type VitePlugin = NonNullable<ViteUserConfig["plugins"]>[number];

package/overrides/Pagination.astro

@@ -1,19 +1,19 @@
----
-import Default from '@astrojs/starlight/components/Pagination.astro'
-import type { Props } from '@astrojs/starlight/props'
-
-import { isTopicFirstPage, isTopicLastPage } from '../lib/sidebar'
-
-const { pagination, sidebar, slug } = Astro.props
-let { prev, next } = pagination
-
-if (isTopicFirstPage(sidebar, slug)) {
-  prev = undefined
-}
-
-if (isTopicLastPage(sidebar, slug)) {
-  next = undefined
-}
----
-
+---
+import Default from '@astrojs/starlight/components/Pagination.astro'
+import type { Props } from '@astrojs/starlight/props'
+
+import { isTopicFirstPage, isTopicLastPage } from '../lib/sidebar'
+
+const { pagination, sidebar, slug } = Astro.props
+let { prev, next } = pagination
+
+if (isTopicFirstPage(sidebar, slug)) {
+  prev = undefined
+}
+
+if (isTopicLastPage(sidebar, slug)) {
+  next = undefined
+}
+---
+
 <Default {...Astro.props} pagination={{ prev, next }}><slot /></Default>

package/overrides/Sidebar.astro

@@ -1,28 +1,28 @@
----
-import Default from '@astrojs/starlight/components/Sidebar.astro'
-import type { Props } from '@astrojs/starlight/props'
-import config from 'virtual:starlight-sidebar-topics-dropdown/config'
-
-import Topics from '../components/Topics.astro'
-import { throwPluginError } from '../lib/plugin'
-import { getCurrentTopic, type Topic } from '../lib/sidebar'
-
-const { entry, sidebar, slug } = Astro.props
-
-let currentSidebar = sidebar
-let currentTopic: Topic | undefined = undefined
-
-if (entry['data'].template !== 'splash') {
-  currentTopic = getCurrentTopic(config, sidebar, slug, entry)
-  if (!currentTopic)
-    throwPluginError(
-      'Failed to find the topic for the current page.',
-      `Either include the page in the sidebar configuration of the desired topic using the \`items\` property or to associate an unlisted page with a topic, use the \`topic\` frontmatter property and set it to the desired topic ID.
-Learn more about unlisted pages in the ["Unlisted pages"](https://starlight-sidebar-topics.netlify.app/docs/guides/unlisted-pages/) guide.`,
-    )
-  currentSidebar = currentTopic.sidebar
-}
----
-
-{entry['data'].template !== 'splash' && currentTopic && <Topics current={currentTopic.config} />}
+---
+import Default from '@astrojs/starlight/components/Sidebar.astro'
+import type { Props } from '@astrojs/starlight/props'
+import config from 'virtual:starlight-sidebar-topics-dropdown/config'
+
+import Topics from '../components/Topics.astro'
+import { throwPluginError } from '../lib/plugin'
+import { getCurrentTopic, type Topic } from '../lib/sidebar'
+
+const { entry, sidebar, slug } = Astro.props
+
+let currentSidebar = sidebar
+let currentTopic: Topic | undefined = undefined
+
+if (entry['data'].template !== 'splash') {
+  currentTopic = getCurrentTopic(config, sidebar, slug, entry)
+  if (!currentTopic)
+    throwPluginError(
+      `Failed to find the topic for the \`${slug}\` page.`,
+      `Either include this page in the sidebar configuration of the desired topic using the \`items\` property or to associate an unlisted page with a topic, use the \`topic\` frontmatter property and set it to the desired topic ID.
+Learn more about unlisted pages in the ["Unlisted pages"](https://starlight-sidebar-topics.netlify.app/docs/guides/unlisted-pages/) guide.`,
+    )
+  currentSidebar = currentTopic.sidebar
+}
+---
+
+{entry['data'].template !== 'splash' && currentTopic && <Topics current={currentTopic.config} />}
 <Default {...Astro.props} sidebar={currentSidebar}><slot /></Default>

package/package.json

@@ -1,46 +1,46 @@
-{
-    "name": "starlight-sidebar-topics-dropdown",
-    "version": "0.2.0",
-    "license": "MIT",
-    "description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
-    "author": "trueberryless (https://trueberryless.org)",
-    "type": "module",
-    "exports": {
-        ".": "./index.ts",
-        "./overrides/Pagination.astro": "./overrides/Pagination.astro",
-        "./overrides/Sidebar.astro": "./overrides/Sidebar.astro",
-        "./schema": "./schema.ts",
-        "./package.json": "./package.json"
-    },
-    "devDependencies": {
-        "@astrojs/starlight": "^0.28.3",
-        "astro": "^4.16.6"
-    },
-    "peerDependencies": {
-        "@astrojs/starlight": ">=0.28"
-    },
-    "engines": {
-        "node": "^18.17.1 || ^20.3.0 || >=21.0.0"
-    },
-    "packageManager": "pnpm@9.3.0",
-    "publishConfig": {
-        "access": "public"
-    },
-    "keywords": [
-        "starlight",
-        "plugin",
-        "sidebar",
-        "subpages",
-        "sections",
-        "dropdown",
-        "documentation",
-        "astro"
-    ],
-    "homepage": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown.git",
-        "directory": "packages/starlight-sidebar-topics-dropdown"
-    },
-    "bugs": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/issues"
-}
+{
+    "name": "starlight-sidebar-topics-dropdown",
+    "version": "0.2.2",
+    "license": "MIT",
+    "description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
+    "author": "trueberryless (https://trueberryless.org)",
+    "type": "module",
+    "exports": {
+        ".": "./index.ts",
+        "./overrides/Pagination.astro": "./overrides/Pagination.astro",
+        "./overrides/Sidebar.astro": "./overrides/Sidebar.astro",
+        "./schema": "./schema.ts",
+        "./package.json": "./package.json"
+    },
+    "devDependencies": {
+        "@astrojs/starlight": "^0.28.3",
+        "astro": "^4.16.6"
+    },
+    "peerDependencies": {
+        "@astrojs/starlight": ">=0.28"
+    },
+    "engines": {
+        "node": "^18.17.1 || ^20.3.0 || >=21.0.0"
+    },
+    "packageManager": "pnpm@9.3.0",
+    "publishConfig": {
+        "access": "public"
+    },
+    "keywords": [
+        "starlight",
+        "plugin",
+        "sidebar",
+        "subpages",
+        "sections",
+        "dropdown",
+        "documentation",
+        "astro"
+    ],
+    "homepage": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown.git",
+        "directory": "packages/starlight-sidebar-topics-dropdown"
+    },
+    "bugs": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/issues"
+}

package/schema.ts

@@ -1,10 +1,10 @@
-import { z } from "astro/zod";
-export const topicSchema = z.object({
-    /**
-     * ID of the topic to associate with the current page if the page is not listed in any topic sidebar configuration.
-     *
-     * @see https://starlight-sidebar-topics.netlify.app/docs/guides/unlisted-pages/
-     */
-    topic: z.string().optional(),
-});
-export type TopicFrontmatterSchema = z.input<typeof topicSchema>;
+import { z } from "astro/zod";
+export const topicSchema = z.object({
+    /**
+     * ID of the topic to associate with the current page if the page is not listed in any topic sidebar configuration.
+     *
+     * @see https://starlight-sidebar-topics.netlify.app/docs/guides/unlisted-pages/
+     */
+    topic: z.string().optional(),
+});
+export type TopicFrontmatterSchema = z.input<typeof topicSchema>;

package/starlight.d.ts

@@ -1,5 +1,5 @@
-declare module "virtual:starlight/user-config" {
-    const Config: import("@astrojs/starlight/types").StarlightConfig;
-
-    export default Config;
-}
+declare module "virtual:starlight/user-config" {
+    const Config: import("@astrojs/starlight/types").StarlightConfig;
+
+    export default Config;
+}

package/virtual.d.ts

@@ -1,5 +1,5 @@
-declare module "virtual:starlight-sidebar-topics-dropdown/config" {
-    const StarlightSidebarTopicsDropdownConfig: import("./libs/config").StarlightSidebarTopicsDropdownSharedConfig;
-
-    export default StarlightSidebarTopicsDropdownConfig;
-}
+declare module "virtual:starlight-sidebar-topics-dropdown/config" {
+    const StarlightSidebarTopicsDropdownConfig: import("./libs/config").StarlightSidebarTopicsDropdownSharedConfig;
+
+    export default StarlightSidebarTopicsDropdownConfig;
+}