@orbytes/astrolab 0.3.0 → 0.4.0-next.1

package/src/chrome/site-data.ts

@@ -0,0 +1,230 @@
+// The site's own pages and images, read off disk for the Pages and Assets views. Server-side only.
+//
+// Pages come from the same walk the live derivation uses (../shell/live-files.mjs), so the Pages
+// tree and the live pills can never disagree about what a page is or what it mounts.
+import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { root } from "astro:config/server";
+import { pageComponentFiles, pageRoute, sitePages, templateOf } from "../shell/live-files.mjs";
+import type { TreeNode } from "./model";
+import { hrefs } from "./model";
+
+export const rootDir = fileURLToPath(root);
+
+export interface SitePage {
+  /** repo-relative, e.g. src/pages/legal/terms.astro */
+  file: string;
+  /** "/", "/legal/terms", "/blog/[slug]" */
+  route: string;
+  /** the lab URL that shows it */
+  href: string;
+  label: string;
+  /** the first `title="…"` in its template — usually the layout's title prop */
+  title: string | null;
+  /** a route with a parameter cannot be shown without one of its generated paths */
+  dynamic: boolean;
+  /** the components it mounts, in document order (repo-relative) */
+  mounts: string[];
+}
+
+/** "terms-and-conditions" → "Terms and conditions"; the home page is "Home". */
+const labelOf = (route: string) => {
+  if (route === "/") return "Home";
+  const last = route.split("/").filter(Boolean).pop() ?? route;
+  if (last.startsWith("[")) return last;
+  const words = last.replace(/[-_]+/g, " ").trim();
+  return words.charAt(0).toUpperCase() + words.slice(1);
+};
+
+const titleOf = (file: string): string | null => {
+  try {
+    const template = templateOf(readFileSync(path.join(rootDir, file), "utf8"));
+    const m = template.match(/\btitle=["']([^"']{1,160})["']/);
+    return m ? m[1]! : null;
+  } catch {
+    return null;
+  }
+};
+
+export const sitePagesModel = (): SitePage[] =>
+  sitePages(rootDir).map((file) => {
+    const route = pageRoute(file);
+    return {
+      file,
+      route,
+      href: hrefs.page(route),
+      label: labelOf(route),
+      title: titleOf(file),
+      dynamic: route.includes("["),
+      mounts: pageComponentFiles(rootDir, file),
+    };
+  });
+
+/**
+ * The Pages tree, nested by folder the way the routes nest. A folder that has its own index page
+ * is both a group and a link (Figma: `Services` with `Page 1` and `Page 2` under it).
+ */
+export const pagesTree = (pages: SitePage[], currentRoute?: string): TreeNode[] => {
+  interface Branch {
+    node: TreeNode;
+    kids: Map<string, Branch>;
+  }
+  const top: Branch = { node: { id: "pages", label: "" }, kids: new Map() };
+  const nodeFor = (page: SitePage): TreeNode => ({
+    id: `page:${page.route}`,
+    label: page.label,
+    href: page.dynamic ? undefined : page.href,
+    icon: "page",
+    current: page.route === currentRoute,
+    disabled: page.dynamic,
+    title: page.dynamic
+      ? "A dynamic route — the lab needs one of its generated paths to show it"
+      : (page.title ?? page.route),
+    search: `${page.route} ${page.title ?? ""} ${page.file}`.toLowerCase(),
+    facets: page.dynamic ? "dynamic" : page.mounts.length ? "mounts" : "static",
+  });
+
+  const home = pages.find((page) => page.route === "/");
+  if (home) top.kids.set("", { node: nodeFor(home), kids: new Map() });
+
+  for (const page of pages) {
+    if (page.route === "/") continue;
+    const segments = page.route.split("/").filter(Boolean);
+    let branch = top;
+    let prefix = "";
+    for (const [i, segment] of segments.entries()) {
+      prefix += `/${segment}`;
+      let next = branch.kids.get(segment);
+      const isPage = i === segments.length - 1;
+      if (!next) {
+        next = {
+          node: isPage
+            ? nodeFor(page)
+            : { id: `dir:${prefix}`, label: labelOf(prefix), icon: "folder", search: prefix.toLowerCase() },
+          kids: new Map(),
+        };
+        branch.kids.set(segment, next);
+      } else if (isPage) {
+        // A folder we already made turns out to have its own index page: it becomes that page.
+        next.node = { ...nodeFor(page), id: next.node.id };
+      }
+      branch = next;
+    }
+  }
+
+  const build = (branch: Branch): TreeNode[] =>
+    [...branch.kids.values()].map(({ node, kids }) => {
+      if (!kids.size) return node;
+      const children = build({ node, kids });
+      return { ...node, icon: node.href ? "page" : "folder", children };
+    });
+  return build(top);
+};
+
+// ---- assets -------------------------------------------------------------------------------------
+
+export interface SiteAsset {
+  /** repo-relative */
+  file: string;
+  /** for anchors: `asset-src-assets-images-hero-aurora-webp` */
+  id: string;
+  name: string;
+  folder: string;
+  where: "src" | "public";
+  bytes: number;
+  ext: string;
+  /** repo-relative files that reference it */
+  usedBy: string[];
+}
+
+const IMAGE = /\.(png|jpe?g|webp|avif|gif|svg)$/i;
+const SOURCE = /\.(astro|[cm]?[jt]sx?|mdx?|css|scss|sass|less|json|html|ya?ml)$/i;
+const SKIP_DIRS = new Set(["node_modules", "dist", ".git", ".astro"]);
+
+const walk = (dir: string, test: RegExp, out: string[] = []): string[] => {
+  const abs = path.join(rootDir, dir);
+  if (!existsSync(abs)) return out;
+  for (const entry of readdirSync(abs, { withFileTypes: true })) {
+    if (entry.name.startsWith(".") || SKIP_DIRS.has(entry.name)) continue;
+    const rel = `${dir}/${entry.name}`;
+    if (entry.isDirectory()) walk(rel, test, out);
+    else if (test.test(entry.name)) out.push(rel);
+  }
+  return out;
+};
+
+/**
+ * Every image under src/ and public/, with who references it. "References" is textual: a source
+ * file under src/ that contains the image's `folder/name` (or, for a file at the top of its tree,
+ * its name). That covers an `import` of an src/ asset and a `/images/x.png` string for a public one,
+ * and it is exactly as good as a grep — a name built at runtime from parts is not seen. Good enough
+ * to find what nothing uses, which is the question this view answers.
+ */
+export const siteAssetsModel = (): SiteAsset[] => {
+  const files = [...walk("src", IMAGE), ...walk("public", IMAGE)];
+  const sources = walk("src", SOURCE).map((file) => ({
+    file,
+    text: (() => {
+      try {
+        return readFileSync(path.join(rootDir, file), "utf8");
+      } catch {
+        return "";
+      }
+    })(),
+  }));
+  return files
+    .map((file) => {
+      const name = path.posix.basename(file);
+      const parent = path.posix.basename(path.posix.dirname(file));
+      const where = file.startsWith("public/") ? "public" : "src";
+      const needle = parent && parent !== "src" && parent !== "public" ? `${parent}/${name}` : name;
+      let bytes = 0;
+      try {
+        bytes = statSync(path.join(rootDir, file)).size;
+      } catch {
+        /* vanished between the walk and the stat */
+      }
+      return {
+        file,
+        id: `asset-${file.replace(/[^a-z0-9]+/gi, "-").toLowerCase()}`,
+        name,
+        folder: path.posix.dirname(file),
+        where: where as SiteAsset["where"],
+        bytes,
+        ext: path.posix.extname(name).slice(1).toLowerCase(),
+        usedBy: sources.filter((s) => s.file !== file && s.text.includes(needle)).map((s) => s.file),
+      };
+    })
+    .sort((a, b) => a.file.localeCompare(b.file));
+};
+
+export const assetsTree = (assets: SiteAsset[]): TreeNode[] => {
+  const folders = new Map<string, SiteAsset[]>();
+  for (const asset of assets) {
+    const list = folders.get(asset.folder) ?? [];
+    list.push(asset);
+    folders.set(asset.folder, list);
+  }
+  return [...folders.entries()].map(([folder, list]) => ({
+    id: `assets:${folder}`,
+    label: folder.replace(/^(src|public)\/(assets\/)?/, "") || folder,
+    icon: "folder" as const,
+    title: folder,
+    count: list.length,
+    search: folder.toLowerCase(),
+    children: list.map((asset) => ({
+      id: asset.id,
+      label: asset.name,
+      href: `#${asset.id}`,
+      icon: "assets" as const,
+      dot: asset.usedBy.length ? undefined : ("muted" as const),
+      dotTitle: asset.usedBy.length ? undefined : "nothing references it",
+      facets: asset.usedBy.length ? "used" : "unused",
+      search: `${asset.file} ${asset.ext}`.toLowerCase(),
+    })),
+  }));
+};
+
+export const formatBytes = (bytes: number) =>
+  bytes < 1024 ? `${bytes} B` : bytes < 1024 * 1024 ? `${(bytes / 1024).toFixed(0)} KB` : `${(bytes / 1048576).toFixed(1)} MB`;

package/src/chrome/trees.ts

@@ -0,0 +1,152 @@
+// Level 2's trees, built from the lab index and the site's files. Server-side only.
+//
+// THE TREE STOPS AT THE COMPONENT (decided 2026-09-24). A component's stories are tabs in the
+// navbar, not rows here, so a leaf is one stories module and links to its first story. Folders
+// above it are the directories under the tier, with one fold: a directory holding exactly one
+// module and nothing else IS that module, so `Section01Hero › V1 › Section01Hero` reads
+// `Section01Hero › V1`.
+import type { LabItem, LabIndex } from "../shell/lab-index";
+import { livePillText } from "../shell/lab-index";
+import type { TreeNode } from "./model";
+
+/** One stories module — a component — with its stories in file order. */
+export interface LabComponent {
+  moduleId: string;
+  moduleName: string;
+  moduleFile: string;
+  componentFile: string | null;
+  directory: string;
+  tier: string;
+  section: string | null;
+  version: string | null;
+  stories: LabItem[];
+  live: boolean;
+  usedBy: string[];
+  responsive: LabItem["responsive"];
+  tags: string[];
+  summary: string | null;
+}
+
+export const componentsOf = (index: LabIndex): LabComponent[] => {
+  const byModule = new Map<string, LabComponent>();
+  for (const item of index.items) {
+    let mod = byModule.get(item.moduleId);
+    if (!mod) {
+      mod = {
+        moduleId: item.moduleId,
+        moduleName: item.moduleName,
+        moduleFile: item.moduleFile,
+        componentFile: item.componentFile,
+        directory: item.directory,
+        tier: item.tier,
+        section: item.section,
+        version: item.version,
+        stories: [],
+        live: false,
+        usedBy: item.usedBy,
+        responsive: item.responsive,
+        tags: item.tags,
+        summary: item.summary,
+      };
+      byModule.set(item.moduleId, mod);
+    }
+    mod.stories.push(item);
+    if (item.live) mod.live = true;
+  }
+  return [...byModule.values()];
+};
+
+/** What the dot, the filter and the search know about a component. */
+export const componentState = (mod: LabComponent) => {
+  const first = mod.stories[0]!;
+  const live = mod.live ? livePillText(mod.stories.find((s) => s.live) ?? first) : null;
+  const facets = [
+    mod.live ? "live" : mod.usedBy.length ? "used" : "unused",
+    mod.responsive ? (mod.responsive.done ? "responsive" : "unresponsive") : "",
+  ].filter(Boolean);
+  return {
+    dot: mod.live ? ("live" as const) : mod.usedBy.length ? ("used" as const) : undefined,
+    dotTitle: live ?? (mod.usedBy.length ? `used by ${mod.usedBy.length}` : undefined),
+    facets: facets.join(" "),
+    search: [
+      mod.moduleName,
+      mod.section,
+      mod.version,
+      mod.tier,
+      first.livePage,
+      ...facets,
+      ...mod.tags,
+      ...mod.stories.map((s) => s.storyName),
+    ]
+      .filter(Boolean)
+      .join(" ")
+      .toLowerCase(),
+  };
+};
+
+interface Dir {
+  name: string;
+  path: string;
+  dirs: Map<string, Dir>;
+  mods: LabComponent[];
+}
+
+/** The tree for one tier: its directories, folded, down to its components. */
+export const tierTree = (index: LabIndex, tier: string, currentModuleId?: string): TreeNode[] => {
+  const mods = componentsOf(index).filter((mod) => mod.tier === tier);
+  const top: Dir = { name: tier, path: tier, dirs: new Map(), mods: [] };
+  for (const mod of mods) {
+    const segments = mod.directory.split("/").slice(1);
+    let dir = top;
+    for (const segment of segments) {
+      let next = dir.dirs.get(segment);
+      if (!next) {
+        next = { name: segment, path: `${dir.path}/${segment}`, dirs: new Map(), mods: [] };
+        dir.dirs.set(segment, next);
+      }
+      dir = next;
+    }
+    dir.mods.push(mod);
+  }
+
+  const leaf = (mod: LabComponent, label = mod.moduleName): TreeNode => {
+    const state = componentState(mod);
+    return {
+      id: `mod:${mod.moduleId}`,
+      label,
+      href: mod.stories[0]!.dashboardUrl,
+      icon: "component",
+      current: mod.moduleId === currentModuleId,
+      dot: state.dot,
+      dotTitle: state.dotTitle,
+      facets: state.facets,
+      search: state.search,
+      title: label === mod.moduleName ? undefined : mod.moduleName,
+    };
+  };
+
+  const nodesOf = (dir: Dir): TreeNode[] => {
+    const out: TreeNode[] = [];
+    for (const child of [...dir.dirs.values()].sort((a, b) => a.name.localeCompare(b.name))) {
+      if (child.dirs.size === 0 && child.mods.length === 1) {
+        out.push(leaf(child.mods[0]!, child.name));
+        continue;
+      }
+      const children = nodesOf(child);
+      const liveCount = children.filter((c) => c.dot === "live").length;
+      out.push({
+        id: `dir:${child.path}`,
+        label: child.name,
+        icon: "folder",
+        children,
+        dot: liveCount ? "live" : undefined,
+        dotTitle: liveCount ? `${liveCount} live` : undefined,
+        search: child.name.toLowerCase(),
+      });
+    }
+    for (const mod of dir.mods) out.push(leaf(mod));
+    return out;
+  };
+
+  return nodesOf(top);
+};