create-zudo-doc 3.2.0 → 3.3.0

package/templates/base/src/utils/github.ts

@@ -1,22 +0,0 @@
-// Host thin-stub — see @takazudo/zudo-doc/github-helpers (epic #2344, S7).
-//
-// `buildGitHubRepoUrl` and `buildGitHubSourceUrl` are now parameterized pure
-// functions in the package; this module wraps them with the host's
-// `settings.githubUrl` singleton.
-
-import { settings } from "@/config/settings";
-import {
-  buildGitHubRepoUrl as _buildGitHubRepoUrl,
-  buildGitHubSourceUrl as _buildGitHubSourceUrl,
-} from "@takazudo/zudo-doc/github-helpers";
-
-export function buildGitHubRepoUrl(): string | null {
-  return _buildGitHubRepoUrl(settings.githubUrl);
-}
-
-export function buildGitHubSourceUrl(
-  contentDir: string,
-  entryId: string,
-): string | null {
-  return _buildGitHubSourceUrl(settings.githubUrl, contentDir, entryId);
-}

package/templates/base/src/utils/nav-scope.ts

@@ -1,34 +0,0 @@
-// Host thin-stub for nav-scope utilities (epic #2344, S5).
-// Core logic lives in @takazudo/zudo-doc/nav-scope; this stub wires
-// the host's `settings.headerNav` singleton.
-import { settings } from "@/config/settings";
-import type { NavNode } from "@/utils/docs";
-export type { HeaderNavItem } from "@/config/settings";
-
-import {
-  getCategoryOrder as _getCategoryOrder,
-  getNavSectionForSlug as _getNavSectionForSlug,
-  getNavSubtree as _getNavSubtree,
-} from "@takazudo/zudo-doc/nav-scope";
-
-/** Collect all categoryMatch strings from headerNav, including children (ordered). */
-export function getCategoryOrder(): string[] {
-  return _getCategoryOrder(settings.headerNav);
-}
-
-/**
- * Given a doc's slug, return the categoryMatch value of the headerNav item it belongs to.
- */
-export function getNavSectionForSlug(slug: string): string | undefined {
-  return _getNavSectionForSlug(slug, settings.headerNav);
-}
-
-/**
- * Filter top-level NavNodes by a headerNav categoryMatch value.
- */
-export function getNavSubtree(
-  tree: NavNode[],
-  categoryMatch?: string,
-): NavNode[] {
-  return _getNavSubtree(tree, categoryMatch, settings.headerNav);
-}

package/templates/base/src/utils/sidebar.ts

@@ -1,36 +0,0 @@
-// Host thin-stub for sidebar utilities (epic #2344, S5).
-// Core logic lives in @takazudo/zudo-doc/sidebar-utils; this stub wires
-// the host's singletons (sidebars config, getCategoryOrder for the "!" filter).
-import sidebars from "@/config/sidebars";
-import type { SidebarItem } from "@/config/sidebars";
-import type { NavNode, CategoryMeta } from "@/utils/docs";
-import { buildNavTree } from "@/utils/docs";
-import { getCategoryOrder } from "@/utils/nav-scope";
-import type { Locale } from "@/config/i18n";
-import type { DocsEntry } from "@/types/docs-entry";
-import { buildSidebarForSection as _buildSidebarForSection } from "@takazudo/zudo-doc/sidebar-utils";
-
-export type { SidebarItem };
-
-/**
- * Build sidebar nodes for a given nav section.
- * If sidebar config exists for this section, use it.
- * Otherwise fall back to auto-generated tree.
- */
-export function buildSidebarForSection(
-  docs: DocsEntry[],
-  lang: Locale,
-  categoryMatch?: string,
-  categoryMeta?: Map<string, CategoryMeta>,
-): NavNode[] {
-  const explicitPrefixes = getCategoryOrder().filter((cm) => cm !== "!");
-  return _buildSidebarForSection(
-    docs,
-    lang,
-    categoryMatch,
-    categoryMeta,
-    sidebars,
-    (d, l, meta) => buildNavTree(d as DocsEntry[], l as Locale, meta as Map<string, CategoryMeta>),
-    explicitPrefixes,
-  ) as NavNode[];
-}

package/templates/base/src/utils/slug.ts

@@ -1,10 +0,0 @@
-// Thin re-export shim. The canonical slug rules moved into the package
-// (`@takazudo/zudo-doc/slug`) as part of the package-first migration (#2344,
-// S1a). Host code keeps importing from `@/utils/slug`; the implementation —
-// including the canonical-root rule (#1891 / #1873) — lives once in the package.
-export {
-  toRouteSlug,
-  toHistorySlug,
-  toSlugParams,
-  toTitleCase,
-} from "@takazudo/zudo-doc/slug";

package/templates/base/src/utils/smart-break.tsx

@@ -1,12 +0,0 @@
-// Thin re-export shim. The smart-break helpers moved into the package
-// (`@takazudo/zudo-doc/smart-break`) as part of the package-first migration
-// (#2344, S1a) — consolidating with the former toc-local copy. Host code keeps
-// importing from `@/utils/smart-break`; the implementation lives once in the
-// package.
-export {
-  isPathLike,
-  smartBreak,
-  SmartBreak,
-  escapeAndInjectWbr,
-  smartBreakToHtml,
-} from "@takazudo/zudo-doc/smart-break";

package/templates/base/src/utils/tags.ts

@@ -1,83 +0,0 @@
-// Host thin-stub — see @takazudo/zudo-doc/tag-helpers (epic #2344, S7).
-//
-// `resolveTag` and `resolvePageTags` are now parameterized pure functions in the
-// package; this module remains backward-compatible by wrapping them with the
-// host's `settings.tagVocabulary` / `settings.tagGovernance` + the
-// `tagVocabulary` entries from `@/config/tag-vocabulary`.
-//
-// `collectTags` stays host-side because it depends on `DocsEntry` from the
-// host's content collections. It calls the local `resolveTag` wrapper which
-// in turn delegates to the package.
-
-import type { DocsEntry } from "@/types/docs-entry";
-import { settings } from "@/config/settings";
-import { tagVocabulary } from "@/config/tag-vocabulary";
-import {
-  resolveTag as _resolveTag,
-  resolvePageTags as _resolvePageTags,
-} from "@takazudo/zudo-doc/tag-helpers";
-
-export type { ResolvedTag } from "@takazudo/zudo-doc/tag-helpers";
-
-export interface TagInfo {
-  tag: string;
-  count: number;
-  docs: { slug: string; title: string; description?: string }[];
-}
-
-// Helpers that pass the host's settings + vocabulary entries to the package fns.
-function getVocab() {
-  return settings.tagVocabulary ? tagVocabulary : false;
-}
-
-/**
- * Resolve a raw tag string to its canonical form.
- *
- * Thin wrapper around `@takazudo/zudo-doc/tag-helpers` `resolveTag` that
- * injects the host's tag vocabulary and governance settings.
- */
-export function resolveTag(raw: string) {
-  return _resolveTag(raw, getVocab(), settings.tagGovernance);
-}
-
-/**
- * Resolve a list of raw tag strings (e.g. from frontmatter) to canonical ids,
- * dropping deprecated-without-redirect entries and preserving order. Duplicates
- * produced by alias collapse are removed.
- */
-export function resolvePageTags(rawTags: readonly string[]): string[] {
-  return _resolvePageTags(rawTags, getVocab(), settings.tagGovernance);
-}
-
-export function collectTags(
-  entries: DocsEntry[],
-  slugFn: (id: string, data: { slug?: string }) => string,
-): Map<string, TagInfo> {
-  const tagMap = new Map<string, TagInfo>();
-
-  for (const entry of entries) {
-    const rawTags = entry.data.tags ?? [];
-    const slug = slugFn(entry.id, entry.data);
-
-    const seen = new Set<string>();
-    for (const raw of rawTags) {
-      const resolved = resolveTag(raw);
-      if (resolved.deprecated) continue;
-      if (seen.has(resolved.canonical)) continue;
-      seen.add(resolved.canonical);
-
-      if (!tagMap.has(resolved.canonical)) {
-        tagMap.set(resolved.canonical, { tag: resolved.canonical, count: 0, docs: [] });
-      }
-      const info = tagMap.get(resolved.canonical)!;
-      info.count++;
-      info.docs.push({
-        slug,
-        title: entry.data.title,
-        description: entry.data.description,
-      });
-    }
-  }
-
-  return tagMap;
-}

package/templates/base/zfb-shim.d.ts

@@ -1,183 +0,0 @@
-// Local type shim for the bare `zfb/config` specifier.
-//
-// `@takazudo/zfb` is consumed as a published npm package (version pinned
-// in the root `package.json`). The package exposes its real config types
-// under the *scoped* subpath `@takazudo/zfb/config` → `dist/config.d.ts`.
-// But `zfb.config.ts` imports from the *bare* specifier `zfb/config`,
-// which zfb's build tool aliases to a runtime-only stub at parse time
-// (`zfb-config-stub.mjs` — `defineConfig` is identity, carrying no types).
-// No real file backs `zfb/config` in `node_modules`, so this ambient
-// declaration is what supplies the `ZfbConfig` type to `zfb.config.ts`.
-//
-// IMPORTANT — this block is the source of truth for the type `zfb check`
-// (plain `tsc --noEmit`) binds against the config. An ambient `declare
-// module` wins over node resolution AND over tsconfig `paths`, so it must
-// be kept in sync BY HAND with the published `@takazudo/zfb/config`
-// (`dist/config.d.ts`). When it lags the engine, valid config fields fail
-// `pnpm check` with TS2353 (see Takazudo/zudo-front-builder#678 +
-// zudolab/zudo-doc#1834 — `bundle` was missing here, blocking next.22's
-// `bundle.exclude`).
-
-declare module "zfb/config" {
-  /** JSX framework runtime. */
-  export type Framework = "preact" | "react";
-
-  /** A content collection registered with the zfb engine. */
-  export interface CollectionDef {
-    /** Identifier used at the call site (e.g. `"docs"`). */
-    name: string;
-    /** Directory (relative to the project root) holding the entries. */
-    path: string;
-    /**
-     * Optional schema. Reserved for v1.1 — accepted but not enforced
-     * today. Authored as zod and converted to JSON Schema via
-     * `z.toJSONSchema()` at the boundary.
-     */
-    schema?: Record<string, unknown>;
-  }
-
-  /** Tailwind options; absent = defaults. */
-  export interface TailwindConfig {
-    enabled?: boolean;
-  }
-
-  /** User-supplied plugin configuration entry. */
-  export interface PluginConfig {
-    name: string;
-    options?: Record<string, unknown>;
-  }
-
-  /**
-   * Bundler options. Mirrors `BundleConfig` in crates/zfb/src/config.rs
-   * and the published `@takazudo/zfb/config` (`dist/config.d.ts`). Added
-   * in next.22 (`bundle.exclude`, #664) and extended in next.23
-   * (`mainFields` / `external`, #676).
-   */
-  export interface BundleConfig {
-    /**
-     * Project-relative, gitignore-style globs for source files the bundler
-     * must NOT pull into the esbuild graph (e.g. test fixtures or
-     * `*.stories.tsx`). Matched files are skipped from the shadow-tree walk
-     * and dropped from any eager `import.meta.glob(...)` expansion.
-     */
-    exclude?: string[];
-    /**
-     * Explicit esbuild `main-fields` for the `--platform=neutral` page/SSR
-     * pass (empty by default under `neutral`), letting CJS-`main`-only deps
-     * resolve. Mirrors `BundleConfig::main_fields`.
-     */
-    mainFields?: string[];
-    /**
-     * Bare specifiers to mark external in the `--platform=neutral` pass so
-     * esbuild leaves them unbundled. Mirrors `BundleConfig::external`.
-     */
-    external?: string[];
-  }
-
-  /** Mirrors the Rust `Config` struct one-for-one. */
-  export interface ZfbConfig {
-    outDir?: string;
-    publicDir?: string;
-    host?: string;
-    port?: number;
-    framework?: Framework;
-    collections?: CollectionDef[];
-    tailwind?: TailwindConfig;
-    /**
-     * Bundler options. `bundle.exclude` keeps project-relative globs out of
-     * the esbuild graph — used here to skip `packages/md-plugins/__fixtures__/**`
-     * so the MDX link resolver no longer walks the test fixtures (silences
-     * ~15 pre-existing broken-link warnings). Mirrors `Config::bundle`.
-     */
-    bundle?: BundleConfig;
-    plugins?: PluginConfig[];
-    adapter?: string;
-    /**
-     * Strip `.md` / `.mdx` from in-page `<a href>` paths and append a
-     * trailing `/` so author-written `[label](other.mdx)` references
-     * resolve to the rendered route URL. Mirrors Config::strip_md_ext
-     * in crates/zfb/src/config.rs (zudolab/zfb#131).
-     */
-    stripMdExt?: boolean;
-    /**
-     * Site base path. Prefixed onto stable HTML asset URLs (CSS / JS
-     * `<link>` and `<script>` tags). Normalised to start AND end with
-     * `/`; `undefined` / `""` / `"/"` all behave identically (no
-     * prefix). Mirrors Config::base in crates/zfb/src/config.rs
-     * (Takazudo/zudo-front-builder#154).
-     */
-    base?: string;
-    /**
-     * Configures the syntect-based syntax highlighter shipped with zfb.
-     * Mirrors `CodeHighlightConfig` / `code_highlight` in crates/zfb/src/config.rs
-     * (single-theme: Takazudo/zudo-front-builder#188 / sub #194, commit 339e30f;
-     * dual-theme themeLight/themeDark added in the follow-up shipped in
-     * zfb 0.1.0-next.45+).
-     * When omitted, the engine falls back to the hardcoded default theme `base16-ocean.dark`.
-     *
-     * Single-theme mode: set `theme` — tokens get inline `style="color:#hex"`.
-     * Dual-theme mode: set BOTH `themeLight` and `themeDark` (mutually exclusive
-     * with `theme`) — tokens get `--shiki-light`/`--shiki-dark` CSS custom
-     * properties and the `<pre>` gains `class="syntect-dual"` + `--shiki-*-bg`.
-     * All names are SYNTECT theme names, not Shiki names.
-     */
-    codeHighlight?: {
-      theme?: string;
-      themesDir?: string;
-      themeLight?: string;
-      themeDark?: string;
-    };
-    /**
-     * Markdown link resolver (port of `remarkResolveMarkdownLinks`).
-     * Mirrors `Config::resolve_markdown_links` in crates/zfb/src/config.rs
-     * (Takazudo/zudo-front-builder PR #234 / zudolab/zudo-doc#1577).
-     * When `enabled: true`, the build appends `ResolveLinksPlugin` to the
-     * mdast pipeline so author-written `[label](./other.mdx)` links are
-     * rewritten to the corresponding rendered route URL — bypassing the
-     * file→directory transformation that breaks relative paths in dist
-     * HTML when `foo.mdx` becomes `foo/index.html`.
-     */
-    resolveMarkdownLinks?: {
-      enabled?: boolean;
-      docsDir?: string;
-      dirs?: Array<{ dir: string; routePrefix: string }>;
-      onBrokenLinks?: "warn" | "error" | "ignore";
-    };
-    /**
-     * Whether the basePath rewriter should append a trailing `/` to
-     * extensionless absolute hrefs. Mirrors `Config::trailing_slash` in
-     * crates/zfb/src/config.rs (Takazudo/zudo-front-builder PR #234 /
-     * zudolab/zudo-doc#1579). Off by default — preserves byte-for-byte
-     * parity with the pre-`trailingSlash` build for projects that
-     * haven't opted in.
-     */
-    trailingSlash?: boolean;
-    /**
-     * Minify production HTML output from `zfb build`.
-     * Mirrors `Config::minify_html` in crates/zfb/src/config.rs.
-     */
-    minifyHtml?: boolean;
-    /**
-     * Markdown / MDX pipeline options. Mirrors `Config::markdown` →
-     * `MarkdownConfig` in crates/zfb/src/config.rs. zfb next.12 moved the
-     * former-Core features under `markdown.features` and next.13 ships the
-     * rest as opt-in; zudo-doc uses `markdown.features` to opt back into the
-     * former-Core four plus the additional opt-in features (#1804). Each
-     * `features` value is per-feature: `true` for boolean-shorthand features,
-     * or an options object for object-typed features.
-     */
-    markdown?: {
-      gfm?: boolean | Record<string, boolean>;
-      toc?: Record<string, unknown>;
-      externalLinks?: Record<string, unknown>;
-      cjkFriendly?: boolean;
-      features?: Record<string, boolean | Record<string, unknown>>;
-    };
-  }
-
-  /**
-   * Identity helper: returns the supplied config as-is, but typed
-   * against `ZfbConfig`. Use as the default export of `zfb.config.ts`.
-   */
-  export function defineConfig(config: ZfbConfig): ZfbConfig;
-}

package/templates/features/bodyFootUtil/files/src/utils/github.ts

@@ -1,22 +0,0 @@
-// Host thin-stub — see @takazudo/zudo-doc/github-helpers (epic #2344, S7).
-//
-// `buildGitHubRepoUrl` and `buildGitHubSourceUrl` are now parameterized pure
-// functions in the package; this module wraps them with the host's
-// `settings.githubUrl` singleton.
-
-import { settings } from "@/config/settings";
-import {
-  buildGitHubRepoUrl as _buildGitHubRepoUrl,
-  buildGitHubSourceUrl as _buildGitHubSourceUrl,
-} from "@takazudo/zudo-doc/github-helpers";
-
-export function buildGitHubRepoUrl(): string | null {
-  return _buildGitHubRepoUrl(settings.githubUrl);
-}
-
-export function buildGitHubSourceUrl(
-  contentDir: string,
-  entryId: string,
-): string | null {
-  return _buildGitHubSourceUrl(settings.githubUrl, contentDir, entryId);
-}

package/templates/features/claudeResources/files/src/integrations/claude-resources/__tests__/escape-for-mdx.test.ts

@@ -1,42 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { escapeForMdx } from "../escape-for-mdx";
-
-describe("escapeForMdx", () => {
-  // ---------------------------------------------------------------------------
-  // Path-like angle bracket sequences (not self-closing JSX)
-  // ---------------------------------------------------------------------------
-
-  it("escapes path-like <name>/suffix sequences", () => {
-    expect(escapeForMdx("<foo>/bar")).toBe("&lt;foo&gt;/bar");
-  });
-
-  it("escapes path-like angle brackets in prose", () => {
-    expect(escapeForMdx("binary at <repo>/target/release/zfb")).toBe(
-      "binary at &lt;repo&gt;/target/release/zfb",
-    );
-  });
-
-  // ---------------------------------------------------------------------------
-  // Allowlisted HTML tags must pass through unchanged
-  // ---------------------------------------------------------------------------
-
-  it("preserves allowlisted HTML tags followed by a path separator", () => {
-    expect(escapeForMdx("<div>/path")).toBe("<div>/path");
-  });
-
-  // ---------------------------------------------------------------------------
-  // Self-closing non-allowlisted tags must still be escaped
-  // ---------------------------------------------------------------------------
-
-  it("escapes self-closing non-allowlisted component tags", () => {
-    expect(escapeForMdx("<Component />")).toMatch(/&lt;Component\s*\/&gt;/);
-  });
-
-  it("escapes the compact self-closing form <Foo/> (no space before slash)", () => {
-    // Regression: the opening-tag regex only matches the spaced form <Foo />,
-    // so the compact <Foo/> needs the dedicated self-closing branch.
-    const out = escapeForMdx("<Foo/>");
-    expect(out).toBe("&lt;Foo/&gt;");
-    expect(out).not.toContain("<Foo/>");
-  });
-});