prev-cli 0.5.0 → 0.6.0

package/dist/cli.js

@@ -71,13 +71,50 @@ async function ensureCacheDir(rootDir) {
 import fg from "fast-glob";
 import { readFile } from "fs/promises";
 import path2 from "path";
+function parseFrontmatter(content) {
+  const frontmatterRegex = /^---\r?\n([\s\S]*?)\r?\n---\r?\n?/;
+  const match = content.match(frontmatterRegex);
+  if (!match) {
+    return { frontmatter: {}, content };
+  }
+  const frontmatterStr = match[1];
+  const restContent = content.slice(match[0].length);
+  const frontmatter = {};
+  for (const line of frontmatterStr.split(`
+`)) {
+    const colonIndex = line.indexOf(":");
+    if (colonIndex === -1)
+      continue;
+    const key = line.slice(0, colonIndex).trim();
+    let value = line.slice(colonIndex + 1).trim();
+    if (value.startsWith('"') && value.endsWith('"') || value.startsWith("'") && value.endsWith("'")) {
+      value = value.slice(1, -1);
+    }
+    if (value === "true")
+      value = true;
+    else if (value === "false")
+      value = false;
+    else if (!isNaN(Number(value)) && value !== "")
+      value = Number(value);
+    if (key) {
+      frontmatter[key] = value;
+    }
+  }
+  return { frontmatter, content: restContent };
+}
+function isIndexFile(basename) {
+  const lower = basename.toLowerCase();
+  return lower === "index" || lower === "readme";
+}
 function fileToRoute(file) {
   const withoutExt = file.replace(/\.mdx?$/, "");
-  if (withoutExt === "index") {
-    return "/";
-  }
-  if (withoutExt.endsWith("/index")) {
-    return "/" + withoutExt.slice(0, -6);
+  const basename = path2.basename(withoutExt).toLowerCase();
+  if (basename === "index" || basename === "readme") {
+    const dir = path2.dirname(withoutExt);
+    if (dir === ".") {
+      return "/";
+    }
+    return "/" + dir;
   }
   return "/" + withoutExt;
 }
@@ -86,30 +123,51 @@ async function scanPages(rootDir) {
     cwd: rootDir,
     ignore: ["node_modules/**", "dist/**", ".cache/**"]
   });
-  const pages = [];
+  const routeMap = new Map;
   for (const file of files) {
+    const route = fileToRoute(file);
+    const basename = path2.basename(file, path2.extname(file)).toLowerCase();
+    const priority = basename === "index" ? 1 : basename === "readme" ? 2 : 0;
+    const existing = routeMap.get(route);
+    if (!existing || priority > 0 && priority < existing.priority) {
+      routeMap.set(route, { file, priority });
+    }
+  }
+  const pages = [];
+  for (const { file } of routeMap.values()) {
     const fullPath = path2.join(rootDir, file);
-    const content = await readFile(fullPath, "utf-8");
-    const title = extractTitle(content, file);
-    pages.push({
+    const rawContent = await readFile(fullPath, "utf-8");
+    const { frontmatter, content } = parseFrontmatter(rawContent);
+    const title = extractTitle(content, file, frontmatter);
+    const page = {
       route: fileToRoute(file),
       title,
       file
-    });
+    };
+    if (frontmatter.description) {
+      page.description = frontmatter.description;
+    }
+    if (Object.keys(frontmatter).length > 0) {
+      page.frontmatter = frontmatter;
+    }
+    pages.push(page);
   }
   return pages.sort((a, b) => a.route.localeCompare(b.route));
 }
-function extractTitle(content, file) {
+function extractTitle(content, file, frontmatter) {
+  if (frontmatter?.title && typeof frontmatter.title === "string") {
+    return frontmatter.title;
+  }
   const match = content.match(/^#\s+(.+)$/m);
   if (match) {
     return match[1].trim();
   }
-  const basename = path2.basename(file, path2.extname(file));
-  if (basename === "index") {
+  const basename = path2.basename(file, path2.extname(file)).toLowerCase();
+  if (isIndexFile(basename)) {
     const dirname = path2.dirname(file);
     return dirname === "." ? "Home" : capitalize(path2.basename(dirname));
   }
-  return capitalize(basename);
+  return capitalize(path2.basename(file, path2.extname(file)));
 }
 function capitalize(str) {
   return str.charAt(0).toUpperCase() + str.slice(1).replace(/-/g, " ");

package/dist/vite/pages.d.ts

@@ -1,13 +1,27 @@
+export interface Frontmatter {
+    title?: string;
+    description?: string;
+    [key: string]: unknown;
+}
 export interface Page {
     route: string;
     title: string;
     file: string;
+    description?: string;
+    frontmatter?: Frontmatter;
 }
 export interface SidebarItem {
     title: string;
     route?: string;
     children?: SidebarItem[];
 }
+/**
+ * Parse YAML frontmatter from markdown content
+ */
+export declare function parseFrontmatter(content: string): {
+    frontmatter: Frontmatter;
+    content: string;
+};
 export declare function fileToRoute(file: string): string;
 export declare function scanPages(rootDir: string): Promise<Page[]>;
 export declare function buildSidebarTree(pages: Page[]): SidebarItem[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prev-cli",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Transform MDX directories into beautiful documentation websites",
   "type": "module",
   "license": "MIT",