blume 0.5.2 → 0.5.4

package/src/migrate/fumadocs/meta.ts

@@ -1,244 +0,0 @@
-import type { FolderMeta } from "../../core/schema.ts";
-
-/**
- * Translate a Fumadocs folder `meta.json` into a Blume `FolderMeta` (`meta.ts`).
- * Unlike Nextra, Fumadocs declares a folder's own title/icon/ordering in *that
- * folder's* `meta.json`, so the mapping is self-contained. Fumadocs-only
- * concepts with no Blume equivalent are dropped and reported:
- *
- * - `defaultOpen` -> `collapsed` (inverted) + `display: "group"` (collapsible).
- * - `root: true` -> `display: "page"` (the closest analogue to a page-tree root).
- * - `description` -> dropped (folders carry no description in Blume).
- * - `pages` entries: plain slugs are kept as ordering; `"..."` (the rest marker,
- *   already Blume's default) is dropped silently; `"...folder"` (the *extract*
- *   operator, which inlines a folder's children) keeps the folder's place in the
- *   ordering as a plain `"folder"` key and warns that it renders as a normal
- *   group rather than flattened; `"---Section---"` separators and `"[Text](url)"`
- *   links have no folder-meta home and are dropped with a warning.
- *
- * When a `pages` array carries `---Section---` separators, the migrator instead
- * takes the *structural* path ({@link parseFumadocsPages} + the group-folder
- * reshape in `index.ts`), which rebuilds each section as a Blume group folder
- * rather than flattening it through `filterPages`.
- */
-
-interface FumadocsMeta {
-  defaultOpen?: unknown;
-  description?: unknown;
-  icon?: unknown;
-  pages?: unknown;
-  root?: unknown;
-  title?: unknown;
-}
-
-const SEPARATOR = /^---(?<label>.*)---$/u;
-const LINK = /^(?:\[[^\]]*\])?\[(?<text>[^\]]*)\]\((?<href>[^)]*)\)$/u;
-const REST = "...";
-/** Fumadocs *extract* operator: `...folder` inlines that folder's children. */
-const EXTRACT = /^\.\.\.(?<folder>.+)$/u;
-
-interface PagesResult {
-  pages: string[];
-  warnings: string[];
-}
-
-const filterPages = (raw: unknown): PagesResult => {
-  if (!Array.isArray(raw)) {
-    return { pages: [], warnings: [] };
-  }
-
-  const pages: string[] = [];
-  const warnings: string[] = [];
-  for (const entry of raw) {
-    if (typeof entry !== "string") {
-      continue;
-    }
-    const value = entry.trim();
-    if (value === REST || value === "") {
-      continue;
-    }
-    const extract = EXTRACT.exec(value);
-    if (extract) {
-      // Blume has no "flatten a folder's children inline" sidebar primitive, but
-      // the folder is a sibling here, so keep its position in the ordering and
-      // let it render as a normal group.
-      const folder = extract.groups?.folder?.trim() ?? "";
-      if (folder) {
-        pages.push(folder);
-        warnings.push(
-          `Sidebar extract "...${folder}" became a normal "${folder}" group (its pages are not flattened into the parent).`
-        );
-      }
-      continue;
-    }
-    const separator = SEPARATOR.exec(value);
-    if (separator) {
-      const label = separator.groups?.label?.trim();
-      warnings.push(
-        `Dropped sidebar separator "${label || value}" — recreate it with a sidebar group if needed.`
-      );
-      continue;
-    }
-    const link = LINK.exec(value);
-    if (link) {
-      warnings.push(
-        `Dropped sidebar link "${link.groups?.text}" (${link.groups?.href}) — add it to navbar.links manually.`
-      );
-      continue;
-    }
-    pages.push(value);
-  }
-
-  return { pages, warnings };
-};
-
-export interface FumadocsMetaConversion {
-  meta: FolderMeta;
-  warnings: string[];
-}
-
-/** Render a Blume `meta.ts` module source for a `FolderMeta`. */
-export const renderMetaModule = (meta: FolderMeta): string =>
-  `import { defineMeta } from "blume";\n\nexport default defineMeta(${JSON.stringify(meta, null, 2)});\n`;
-
-/**
- * Translate a folder's own title/icon/display fields — everything in a Fumadocs
- * `meta.json` *except* the `pages` ordering. Split out from
- * {@link translateFumadocsMeta} so the structural path (which reshapes `pages`
- * into group folders) can reuse the self fields without the flat `pages` array.
- */
-export const translateFumadocsSelfMeta = (
-  value: unknown
-): FumadocsMetaConversion => {
-  if (!value || typeof value !== "object" || Array.isArray(value)) {
-    return { meta: {}, warnings: [] };
-  }
-
-  const source = value as FumadocsMeta;
-  const meta: FolderMeta = {};
-  const warnings: string[] = [];
-
-  if (typeof source.title === "string") {
-    meta.title = source.title;
-  }
-  if (typeof source.icon === "string") {
-    meta.icon = source.icon;
-  }
-  if (source.root === true) {
-    meta.display = "page";
-  } else if (typeof source.defaultOpen === "boolean") {
-    meta.display = "group";
-    meta.collapsed = !source.defaultOpen;
-  }
-  if (typeof source.description === "string") {
-    warnings.push(
-      "Dropped folder `description` — Blume folders have no description field."
-    );
-  }
-
-  return { meta, warnings };
-};
-
-/** Map a parsed Fumadocs `meta.json` object onto a Blume `FolderMeta`. */
-export const translateFumadocsMeta = (
-  value: unknown
-): FumadocsMetaConversion => {
-  const { meta, warnings } = translateFumadocsSelfMeta(value);
-  if (value && typeof value === "object" && !Array.isArray(value)) {
-    const { pages, warnings: pageWarnings } = filterPages(
-      (value as FumadocsMeta).pages
-    );
-    if (pages.length > 0) {
-      meta.pages = pages;
-    }
-    warnings.push(...pageWarnings);
-  }
-  return { meta, warnings };
-};
-
-// ---------------------------------------------------------------------------
-// Structural pages (separators -> sections)
-// ---------------------------------------------------------------------------
-
-/**
- * One entry in a Fumadocs `pages` array, after classification: a `ref` (a plain
- * page or folder name), an `extract` (`...folder`, whose children Fumadocs
- * inlines), or a `link` (`[Text](url)`).
- */
-export type FumadocsPageItem =
-  | { kind: "extract"; name: string }
-  | { kind: "link"; href: string; text: string }
-  | { kind: "ref"; name: string };
-
-/** A run of items under one `---Label---` separator. */
-export interface FumadocsSection {
-  items: FumadocsPageItem[];
-  label: string;
-}
-
-export interface FumadocsPagesStructure {
-  /** Whether any `---Section---` separator was present. */
-  hasSections: boolean;
-  /** Items before the first separator; they stay at the folder's top level. */
-  lead: FumadocsPageItem[];
-  sections: FumadocsSection[];
-}
-
-/**
- * Parse a Fumadocs `pages` array into its structural shape: the lead items
- * (before any separator) and the sections each `---Label---` introduces. Unlike
- * {@link filterPages}, separators are preserved (as section boundaries) so the
- * migrator can rebuild them as Blume group folders. The rest marker (`"..."`) is
- * dropped — Blume appends unlisted pages by default.
- */
-export const parseFumadocsPages = (raw: unknown): FumadocsPagesStructure => {
-  const lead: FumadocsPageItem[] = [];
-  const sections: FumadocsSection[] = [];
-  if (!Array.isArray(raw)) {
-    return { hasSections: false, lead, sections };
-  }
-
-  let current: FumadocsSection | null = null;
-  const push = (item: FumadocsPageItem): void => {
-    (current ? current.items : lead).push(item);
-  };
-
-  for (const entry of raw) {
-    if (typeof entry !== "string") {
-      continue;
-    }
-    const value = entry.trim();
-    if (value === REST || value === "") {
-      continue;
-    }
-    const separator = SEPARATOR.exec(value);
-    if (separator) {
-      current = {
-        items: [],
-        label: separator.groups?.label?.trim() || "Section",
-      };
-      sections.push(current);
-      continue;
-    }
-    const extract = EXTRACT.exec(value);
-    if (extract) {
-      const name = extract.groups?.folder?.trim();
-      if (name) {
-        push({ kind: "extract", name });
-      }
-      continue;
-    }
-    const link = LINK.exec(value);
-    if (link) {
-      push({
-        href: link.groups?.href ?? "",
-        kind: "link",
-        text: link.groups?.text ?? "",
-      });
-      continue;
-    }
-    push({ kind: "ref", name: value });
-  }
-
-  return { hasSections: sections.length > 0, lead, sections };
-};

package/src/migrate/migrate.ts

@@ -1,53 +0,0 @@
-import { migrateFumadocsProject } from "./fumadocs/index.ts";
-import { migrateMintlifyProject } from "./mintlify/index.ts";
-import { migrateNextraProject } from "./nextra/index.ts";
-import { migrateStarlightProject } from "./starlight/index.ts";
-
-export interface MigrationResult {
-  moved: number;
-  warnings: string[];
-}
-
-/**
- * Migrate a Mintlify project (`docs.json`/`mint.json` + MDX). Translates the
- * config, rewrites pages to idiomatic Blume MDX in place, and relocates assets.
- * Unlike the other migrators, content stays at the project root.
- */
-export const migrateMintlify = (root: string): Promise<MigrationResult> =>
-  migrateMintlifyProject(root);
-
-/**
- * Migrate a Nextra project (`content/` or `pages/` + `_meta` files). Moves pages
- * into `docs/`, rewrites `<Callout>`s to directives, and converts every `_meta`
- * into a typed `meta.ts`, preserving navigation order and titles.
- */
-export const migrateNextra = (root: string): Promise<MigrationResult> =>
-  migrateNextraProject(root);
-
-/**
- * Migrate a Fumadocs project (`content/docs` + `meta.json`). Moves pages into
- * `docs/`, rewrites Fumadocs MDX (callouts, `<Cards>`/`<Accordions>`/`<Files>`,
- * `<Tabs items>`, `<include>`) to idiomatic Blume markup, converts every
- * `meta.json` into a typed `meta.ts`, and preserves the `/docs` route prefix.
- */
-export const migrateFumadocs = (root: string): Promise<MigrationResult> =>
-  migrateFumadocsProject(root);
-
-/**
- * Migrate a Starlight project (`src/content/docs` + `astro.config.*`). Translates
- * the `starlight({...})` options into `blume.config.ts` and rewrites each page to
- * idiomatic Blume MDX in place (asides → directives, component renames,
- * frontmatter mapping). Content stays under `src/content/docs`.
- */
-export const migrateStarlight = (root: string): Promise<MigrationResult> =>
-  migrateStarlightProject(root);
-
-export const migrators: Record<
-  string,
-  (root: string) => Promise<MigrationResult>
-> = {
-  fumadocs: migrateFumadocs,
-  mintlify: migrateMintlify,
-  nextra: migrateNextra,
-  starlight: migrateStarlight,
-};

package/src/migrate/mintlify/assets.ts

@@ -1,46 +0,0 @@
-import type { BlumeConfig } from "../../core/schema.ts";
-
-/** Asset paths referenced by the resolved config (logo, favicon, backgrounds). */
-const assetRefs = (config: BlumeConfig): unknown[] => {
-  const refs: unknown[] = ["/images"];
-  const logo = config.logo as
-    | string
-    | { dark?: string; light?: string }
-    | undefined;
-  if (typeof logo === "string") {
-    refs.push(logo);
-  } else if (logo) {
-    refs.push(logo.light, logo.dark);
-  }
-  const favicon = config.favicon as
-    | string
-    | { dark?: string; light?: string }
-    | undefined;
-  if (typeof favicon === "string") {
-    refs.push(favicon);
-  } else if (favicon) {
-    refs.push(favicon.light, favicon.dark);
-  }
-  refs.push(config.theme?.backgroundImage, config.theme?.backgroundImageDark);
-  return refs;
-};
-
-/**
- * Top-level path segments referenced as static assets by a Mintlify config
- * (the conventional `/images`, plus logo/favicon/background paths). These are
- * the root-served folders Mintlify exposes at the site root; Blume serves them
- * via `content.assets` (bridge) or relocates them under `public/` (migrator).
- */
-export const assetSegments = (config: BlumeConfig): string[] => {
-  const segments = new Set<string>();
-  for (const ref of assetRefs(config)) {
-    if (typeof ref !== "string" || !ref.startsWith("/")) {
-      continue;
-    }
-    const [segment] = ref.replace(/^\/+/u, "").split("/");
-    if (segment) {
-      segments.add(segment);
-    }
-  }
-  return [...segments];
-};