SimpleMDG Dev CLI Guide

import http from "node:http"; import path from "node:path"; import { spawn } from "node:child_process"; import fs from "fs-extra"; import chalk from "chalk"; import prompts from "prompts"; import { getDirname } from "./esm-paths"; const GUIDE_FILE_NAME = "USER_GUIDE.md"; type TGuideMode = "terminal" | "web" | "commander-help"; const __dirname = getDirname(import.meta.url); function getPackageRootPath(): string { return path.resolve(__dirname, "..", ".."); } async function readGuideMarkdown(): Promise { const packageRootPath = getPackageRootPath(); const guidePath = path.join(packageRootPath, GUIDE_FILE_NAME); if (await fs.pathExists(guidePath)) { return fs.readFile(guidePath, "utf8"); } const readmePath = path.join(packageRootPath, "README.md"); if (await fs.pathExists(readmePath)) { return fs.readFile(readmePath, "utf8"); } return `# SimpleMDG Dev CLI\n\nGuide file was not found. Run smdg --help to see command help.`; } function escapeHtml(value: string): string { return value .replaceAll("&", "&") .replaceAll("<", "<") .replaceAll(">", ">") .replaceAll('"', """) .replaceAll("'", "'"); } function inlineMarkdown(value: string): string { return escapeHtml(value) .replace(/`([^`]+)`/g, "$1") .replace(/\*\*([^*]+)\*\*/g, "$1"); } function markdownToHtml(markdown: string): string { const lines = markdown.replace(/\r\n/g, "\n").split("\n"); const htmlLines: string[] = []; let inCodeBlock = false; let codeLines: string[] = []; let inList = false; function closeList(): void { if (inList) { htmlLines.push(""); inList = false; } } function closeCodeBlock(): void { if (inCodeBlock) { htmlLines.push(`

${escapeHtml(codeLines.join("\n"))}

`); codeLines = []; inCodeBlock = false; } } for (const line of lines) { if (line.trim().startsWith("```")) { if (inCodeBlock) { closeCodeBlock(); } else { closeList(); inCodeBlock = true; codeLines = []; } continue; } if (inCodeBlock) { codeLines.push(line); continue; } const trimmedLine = line.trim(); if (!trimmedLine) { closeList(); continue; } const headingMatch = /^(#{1,4})\s+(.+)$/.exec(trimmedLine); if (headingMatch) { closeList(); const level = headingMatch[1].length; htmlLines.push(`${inlineMarkdown(headingMatch[2])}`); continue; } const bulletMatch = /^[-*]\s+(.+)$/.exec(trimmedLine); if (bulletMatch) { if (!inList) { htmlLines.push("

${inlineMarkdown(bulletMatch[1])}

${inlineMarkdown(trimmedLine)}

SimpleMDG Dev CLI Guide

Local visual guide. Keep this terminal open. Press Ctrl + C to stop the guide server.

${markdownToHtml(markdown)}

{ const markdown = await readGuideMarkdown(); console.log(markdown); } export async function openUserGuideInBrowser(port?: string): Promise { const markdown = await readGuideMarkdown(); const html = buildGuideHtml(markdown); const requestedPort = port?.trim() ? Number(port.trim()) : 0; if (port?.trim() && (!Number.isInteger(requestedPort) || requestedPort < 1 || requestedPort > 65535)) { throw new Error("Guide port must be a number from 1 to 65535"); } const server = http.createServer((request, response) => { if (request.url === "/" || request.url === "/index.html") { response.writeHead(200, { "content-type": "text/html; charset=utf-8" }); response.end(html); return; } response.writeHead(404, { "content-type": "text/plain; charset=utf-8" }); response.end("Not found"); }); await new Promise((resolve, reject) => { server.once("error", reject); server.listen(requestedPort, "127.0.0.1", () => resolve()); }); const address = server.address(); const actualPort = typeof address === "object" && address ? address.port : requestedPort; const url = `http://127.0.0.1:${actualPort}`; console.log(chalk.green(`SimpleMDG Dev CLI guide: ${url}`)); console.log(chalk.gray("Press Ctrl + C to stop the guide server.")); openBrowser(url); } export async function askRootHelpMode(): Promise { const response = await prompts({ type: "select", name: "mode", message: "How do you want to view SimpleMDG CLI help?", choices: [ { title: "View quick guide in terminal", value: "terminal" }, { title: "Open visual guide in browser", value: "web" }, { title: "Show command help", value: "commander-help" }, ], initial: 0, }); return (response.mode ?? "commander-help") as TGuideMode; }