github-search-cli 9.1.1 → 9.3.0

package/src/help.ts

@@ -1,142 +1,142 @@
-/** Help screen — structured sections rendered by OpenTUI components. */
-export interface HelpRow {
-  keys: string;
-  action: string;
-}
-export interface HelpSection {
-  title: string;
-  /** Theme color key or hex — used for Box title color */
-  titleColor: string;
-  rows: HelpRow[];
-  note?: string;
-}
-export function buildHelpSections(): HelpSection[] {
-  return [
-    {
-      title: " Landing ",
-      titleColor: "blue",
-      rows: [
-        { keys: "↑ ↓ / j k", action: "Navigate menu cards" },
-        { keys: "Enter", action: "Select mode" },
-        { keys: "? / h", action: "Toggle this help screen" },
-        { keys: "q", action: "Quit" },
-      ],
-    },
-    {
-      title: " Navigation ",
-      titleColor: "blue",
-      rows: [
-        { keys: "↑ ↓ / j k", action: "Move selection" },
-        { keys: "Enter", action: "Open repo in browser" },
-        { keys: "/", action: "Focus search input" },
-        { keys: "Space", action: "Open command menu" },
-        { keys: "? / Ctrl+H", action: "Toggle this help screen" },
-        { keys: "q", action: "Quit" },
-      ],
-    },
-    {
-      title: " Main View ",
-      titleColor: "green",
-      rows: [
-        { keys: "Tab", action: "Auto-complete qualifier" },
-        { keys: "PageDown", action: "Next page of results" },
-        { keys: "PageUp", action: "Scroll to top of results" },
-      ],
-    },
-    {
-      title: " Trending Mode ",
-      titleColor: "yellow",
-      rows: [
-        { keys: "1-5", action: "Switch tab: Today → Week → Month → …" },
-        { keys: "← → / h l", action: "Navigate tabs" },
-      ],
-    },
-    {
-      title: " Packages Mode ",
-      titleColor: "cyan",
-      rows: [
-        { keys: "/", action: "Search npm packages" },
-        { keys: "↑ ↓ / j k", action: "Move selection" },
-        { keys: "Enter", action: "View package details" },
-        { keys: "Space", action: "Open command menu" },
-      ],
-      note: "Search by name, description, or tags. Sort by downloads or score.",
-    },
-    {
-      title: " Command Menu (Space)",
-      titleColor: "purple",
-      rows: [
-        { keys: "Sort", action: "Cycle sort: best-match → stars → …" },
-        { keys: "Limit", action: "Cycle limit: 10 → 25 → 50 → 100" },
-        { keys: "Refresh", action: "Re-run current search" },
-        { keys: "Graph", action: "Toggle commit activity chart" },
-        { keys: "Readme", action: "Full README viewer" },
-        { keys: "Deep-dive", action: "Languages + contributors + excerpt" },
-        { keys: "Bookmark", action: "Save / unsave selected repo" },
-        { keys: "Compare", action: "Add to / remove from comparison" },
-        { keys: "Trending", action: "Switch to trending browser" },
-        { keys: "Packages", action: "Switch to npm packages" },
-        { keys: "Export", action: "Export results to file" },
-        { keys: "Share", action: "Share repo as text" },
-        { keys: "Topics", action: "Browse GitHub topics" },
-        { keys: "Saved", action: "View saved searches" },
-        { keys: "Notifs", action: "Check GitHub notifications" },
-        { keys: "History", action: "View search history" },
-        { keys: "Help", action: "Show this help screen" },
-      ],
-      note: "Navigate menu with ↑ ↓, select with Enter, back with ← / Esc",
-    },
-    {
-      title: " Overlay Keys ",
-      titleColor: "teal",
-      rows: [
-        { keys: "Esc / q", action: "Close any overlay" },
-        { keys: "Enter", action: "Confirm selection / run action" },
-        { keys: "d", action: "Delete entry (history, bookmarks, saved)" },
-        { keys: "↑ ↓ / j k", action: "Navigate overlay list" },
-        { keys: "← → / h l", action: "Navigate tabs / panels" },
-      ],
-    },
-    {
-      title: " Search Syntax ",
-      titleColor: "teal",
-      rows: [
-        { keys: "keywords", action: "Free-text search" },
-        { keys: "key:value", action: "Qualifier filter" },
-        { keys: "-key:value", action: "Negated qualifier" },
-        { keys: '"phrase"', action: "Exact phrase match" },
-        { keys: "language:TypeScript", action: "Filter by language" },
-        { keys: "stars:>1000", action: "Minimum stars" },
-        { keys: "fork:true", action: "Include forks" },
-        { keys: "user:octocat", action: "User's repos" },
-        { keys: "org:facebook", action: "Organization repos" },
-        { keys: "repo:facebook/react", action: "Specific repo" },
-        { keys: "topic:react", action: "Filter by topic" },
-        { keys: "license:mit", action: "License type" },
-        { keys: "pushed:>2024-01-01", action: "Last push date" },
-        { keys: "archived:false", action: "Exclude archived" },
-      ],
-    },
-    {
-      title: " Utility Keys ",
-      titleColor: "muted",
-      rows: [
-        { keys: "t", action: "Cycle theme (light / dark / solarized)" },
-        { keys: "Ctrl+X", action: "Copy repo URL to clipboard" },
-        { keys: "Ctrl+C", action: "Copy search query to clipboard" },
-      ],
-    },
-    {
-      title: " Rate Limits ",
-      titleColor: "orange",
-      rows: [
-        { keys: "No token", action: "10 req / min" },
-        { keys: "GITHUB_TOKEN", action: "30 req / min (or your plan limit)" },
-      ],
-      note: "Set GITHUB_TOKEN in your environment or add to config.",
-    },
-  ];
-}
-
-/** Column at which the action description starts (right-aligns keys). */
-export const HELP_KEYS_COLUMN = 24;
+/** Help screen — structured sections rendered by OpenTUI components. */
+export interface HelpRow {
+  keys: string;
+  action: string;
+}
+export interface HelpSection {
+  title: string;
+  /** Theme color key or hex — used for Box title color */
+  titleColor: string;
+  rows: HelpRow[];
+  note?: string;
+}
+export function buildHelpSections(): HelpSection[] {
+  return [
+    {
+      title: " Landing ",
+      titleColor: "blue",
+      rows: [
+        { keys: "↑ ↓ / j k", action: "Navigate menu cards" },
+        { keys: "Enter", action: "Select mode" },
+        { keys: "? / h", action: "Toggle this help screen" },
+        { keys: "q", action: "Quit" },
+      ],
+    },
+    {
+      title: " Navigation ",
+      titleColor: "blue",
+      rows: [
+        { keys: "↑ ↓ / j k", action: "Move selection" },
+        { keys: "Enter", action: "Open repo in browser" },
+        { keys: "/", action: "Focus search input" },
+        { keys: "Space", action: "Open command menu" },
+        { keys: "? / Ctrl+H", action: "Toggle this help screen" },
+        { keys: "q", action: "Quit" },
+      ],
+    },
+    {
+      title: " Main View ",
+      titleColor: "green",
+      rows: [
+        { keys: "Tab", action: "Auto-complete qualifier" },
+        { keys: "PageDown", action: "Next page of results" },
+        { keys: "PageUp", action: "Scroll to top of results" },
+      ],
+    },
+    {
+      title: " Trending Mode ",
+      titleColor: "yellow",
+      rows: [
+        { keys: "1-5", action: "Switch tab: Today → Week → Month → …" },
+        { keys: "← → / h l", action: "Navigate tabs" },
+      ],
+    },
+    {
+      title: " Packages Mode ",
+      titleColor: "cyan",
+      rows: [
+        { keys: "/", action: "Search npm packages" },
+        { keys: "↑ ↓ / j k", action: "Move selection" },
+        { keys: "Enter", action: "View package details" },
+        { keys: "Space", action: "Open command menu" },
+      ],
+      note: "Search by name, description, or tags. Sort by downloads or score.",
+    },
+    {
+      title: " Command Menu (Space)",
+      titleColor: "purple",
+      rows: [
+        { keys: "Sort", action: "Cycle sort: best-match → stars → …" },
+        { keys: "Limit", action: "Cycle limit: 10 → 25 → 50 → 100" },
+        { keys: "Refresh", action: "Re-run current search" },
+        { keys: "Graph", action: "Toggle commit activity chart" },
+        { keys: "Readme", action: "Full README viewer" },
+        { keys: "Deep-dive", action: "Languages + contributors + excerpt" },
+        { keys: "Bookmark", action: "Save / unsave selected repo" },
+        { keys: "Compare", action: "Add to / remove from comparison" },
+        { keys: "Trending", action: "Switch to trending browser" },
+        { keys: "Packages", action: "Switch to npm packages" },
+        { keys: "Export", action: "Export results to file" },
+        { keys: "Share", action: "Share repo as text" },
+        { keys: "Topics", action: "Browse GitHub topics" },
+        { keys: "Saved", action: "View saved searches" },
+        { keys: "Notifs", action: "Check GitHub notifications" },
+        { keys: "History", action: "View search history" },
+        { keys: "Help", action: "Show this help screen" },
+      ],
+      note: "Navigate menu with ↑ ↓, select with Enter, back with ← / Esc",
+    },
+    {
+      title: " Overlay Keys ",
+      titleColor: "teal",
+      rows: [
+        { keys: "Esc / q", action: "Close any overlay" },
+        { keys: "Enter", action: "Confirm selection / run action" },
+        { keys: "d", action: "Delete entry (history, bookmarks, saved)" },
+        { keys: "↑ ↓ / j k", action: "Navigate overlay list" },
+        { keys: "← → / h l", action: "Navigate tabs / panels" },
+      ],
+    },
+    {
+      title: " Search Syntax ",
+      titleColor: "teal",
+      rows: [
+        { keys: "keywords", action: "Free-text search" },
+        { keys: "key:value", action: "Qualifier filter" },
+        { keys: "-key:value", action: "Negated qualifier" },
+        { keys: '"phrase"', action: "Exact phrase match" },
+        { keys: "language:TypeScript", action: "Filter by language" },
+        { keys: "stars:>1000", action: "Minimum stars" },
+        { keys: "fork:true", action: "Include forks" },
+        { keys: "user:octocat", action: "User's repos" },
+        { keys: "org:facebook", action: "Organization repos" },
+        { keys: "repo:facebook/react", action: "Specific repo" },
+        { keys: "topic:react", action: "Filter by topic" },
+        { keys: "license:mit", action: "License type" },
+        { keys: "pushed:>2024-01-01", action: "Last push date" },
+        { keys: "archived:false", action: "Exclude archived" },
+      ],
+    },
+    {
+      title: " Utility Keys ",
+      titleColor: "muted",
+      rows: [
+        { keys: "t", action: "Cycle theme (light / dark / solarized)" },
+        { keys: "Ctrl+X", action: "Copy repo URL to clipboard" },
+        { keys: "Ctrl+C", action: "Copy search query to clipboard" },
+      ],
+    },
+    {
+      title: " Rate Limits ",
+      titleColor: "orange",
+      rows: [
+        { keys: "No token", action: "10 req / min" },
+        { keys: "GITHUB_TOKEN", action: "30 req / min (or your plan limit)" },
+      ],
+      note: "Set GITHUB_TOKEN in your environment or add to config.",
+    },
+  ];
+}
+
+/** Column at which the action description starts (right-aligns keys). */
+export const HELP_KEYS_COLUMN = 24;

package/src/markdown-render.ts

@@ -0,0 +1,216 @@
+/**
+ * Minimal markdown-to-terminal-text renderer.
+ *
+ * Renders headings, code blocks, lists, tables, blockquotes, horizontal rules,
+ * bold/italic, and links into a plain-text representation suitable for a
+ * TextRenderable in the TUI.
+ */
+
+interface RenderOptions {
+  /** Terminal width for wrapping and table layout. Default: 80. */
+  width?: number;
+}
+
+/** Render markdown text to terminal-friendly plain text. */
+export function renderMarkdown(md: string, opts: RenderOptions = {}): string {
+  const width = opts.width ?? 80;
+  const lines = md.split("\n");
+  const out: string[] = [];
+  let inCodeBlock = false;
+  let codeLang = "";
+  let codeLines: string[] = [];
+  let inTable = false;
+  let tableRows: string[][] = [];
+
+  function flushCode() {
+    if (codeLines.length === 0) return;
+    const maxLen = Math.max(...codeLines.map((l) => l.length), codeLang.length);
+    const barW = Math.min(maxLen + 4, width - 2);
+    out.push("┌" + "─".repeat(barW) + "┐");
+    if (codeLang) out.push("│ " + codeLang.padEnd(barW - 1) + "│");
+    for (const cl of codeLines) {
+      out.push("│ " + cl.padEnd(barW - 1) + "│");
+    }
+    out.push("└" + "─".repeat(barW) + "┘");
+    out.push("");
+    codeLines = [];
+    codeLang = "";
+  }
+
+  function flushTable() {
+    if (tableRows.length === 0) return;
+    const dataRows = tableRows.filter(
+      (r) => !r.every((c) => /^[\s\-:|]+$/.test(c)),
+    );
+    if (dataRows.length === 0) {
+      tableRows = [];
+      return;
+    }
+    const colCount = Math.max(...dataRows.map((r) => r.length));
+    const colW: number[] = [];
+    for (let ci = 0; ci < colCount; ci++) {
+      colW.push(
+        Math.max(
+          3,
+          ...dataRows.map((r) => (r[ci] ?? "").length),
+        ),
+      );
+    }
+    const totalW = colW.reduce((a, b) => a + b, 0) + colCount * 3 - 1;
+    if (totalW > width) {
+      for (const row of dataRows) {
+        out.push("  " + row.map((c) => c.trim()).join(" │ "));
+      }
+    } else {
+      const sep = "┌" + colW.map((w) => "─".repeat(w + 2)).join("┬") + "┐";
+      const mid = "├" + colW.map((w) => "─".repeat(w + 2)).join("┼") + "┤";
+      const end = "└" + colW.map((w) => "─".repeat(w + 2)).join("┴") + "┘";
+      out.push(sep);
+      dataRows.forEach((row, i) => {
+        const cells = colW.map((w, ci) => (row[ci] ?? "").trim().padEnd(w));
+        out.push("│ " + cells.map((c) => ` ${c} `).join("│") + "│");
+        if (i === 0) out.push(mid);
+      });
+      out.push(end);
+    }
+    out.push("");
+    tableRows = [];
+  }
+
+  function renderInline(line: string): string {
+    // Bold
+    line = line.replace(/\*\*(.+?)\*\*/g, "$1");
+    // Italic (no asterisks)
+    line = line.replace(/\*([^*]+?)\*/g, "$1");
+    // Inline code
+    line = line.replace(/`([^`]+)`/g, "⟨$1⟩");
+    // Links [text](url)
+    line = line.replace(/\[([^\]]+)\]\(([^)]+)\)/g, "$1 ($2)");
+    // Images
+    line = line.replace(/!\[([^\]]*)\]\([^)]+\)/g, "🖼 $1");
+    return line;
+  }
+
+  function wrapLine(line: string, maxW: number): string[] {
+    if (line.length <= maxW) return [line];
+    const parts: string[] = [];
+    let remaining = line;
+    while (remaining.length > maxW) {
+      let breakAt = maxW;
+      const spaceIdx = remaining.lastIndexOf(" ", maxW);
+      if (spaceIdx > maxW / 2) breakAt = spaceIdx;
+      parts.push(remaining.slice(0, breakAt));
+      remaining = remaining.slice(breakAt).replace(/^ /, "");
+    }
+    if (remaining) parts.push(remaining);
+    return parts;
+  }
+
+  for (let i = 0; i < lines.length; i++) {
+    let line = lines[i];
+
+    // Code block boundaries
+    if (/^```/.test(line)) {
+      if (inCodeBlock) {
+        flushCode();
+        inCodeBlock = false;
+      } else {
+        inCodeBlock = true;
+        codeLang = line.slice(3).trim();
+      }
+      continue;
+    }
+    if (inCodeBlock) {
+      codeLines.push(line);
+      continue;
+    }
+
+    // Table row
+    if (line.includes("|")) {
+      const cells = line
+        .split("|")
+        .map((c) => c.trim())
+        .filter((_, idx, arr) => idx > 0 && idx < arr.length - 1);
+      if (cells.length >= 2) {
+        inTable = true;
+        tableRows.push(cells);
+        continue;
+      }
+    } else if (inTable) {
+      flushTable();
+      inTable = false;
+    }
+
+    // Horizontal rule
+    if (/^(\s*[-*_]){3,}\s*$/.test(line)) {
+      out.push("─".repeat(Math.min(width, 40)));
+      out.push("");
+      continue;
+    }
+
+    // Headings
+    const headingMatch = line.match(/^(#{1,6})\s+(.+)/);
+    if (headingMatch) {
+      const level = headingMatch[1].length;
+      const text = renderInline(headingMatch[2]);
+      const prefix = "█ ".repeat(level);
+      out.push("");
+      out.push(prefix + text);
+      out.push("");
+      continue;
+    }
+
+    // Blockquote
+    const bqMatch = line.match(/^>\s?(.*)/);
+    if (bqMatch) {
+      const inner = renderInline(bqMatch[1]);
+      for (const wl of wrapLine(inner, width - 4)) {
+        out.push("│ " + wl);
+      }
+      continue;
+    }
+
+    // Unordered list
+    const ulMatch = line.match(/^(\s*)[-*+]\s+(.*)/);
+    if (ulMatch) {
+      const indent = ulMatch[1].length;
+      const depth = Math.floor(indent / 2);
+      const prefix = "  ".repeat(depth) + "• ";
+      const inner = renderInline(ulMatch[2]);
+      for (const wl of wrapLine(inner, width - prefix.length)) {
+        out.push(prefix + wl);
+      }
+      continue;
+    }
+
+    // Ordered list
+    const olMatch = line.match(/^(\s*)\d+\.\s+(.*)/);
+    if (olMatch) {
+      const indent = olMatch[1].length;
+      const depth = Math.floor(indent / 2);
+      const prefix = "  ".repeat(depth) + "◦ ";
+      const inner = renderInline(olMatch[2]);
+      for (const wl of wrapLine(inner, width - prefix.length)) {
+        out.push(prefix + wl);
+      }
+      continue;
+    }
+
+    // Empty line
+    if (line.trim() === "") {
+      out.push("");
+      continue;
+    }
+
+    // Paragraph
+    const rendered = renderInline(line);
+    for (const wl of wrapLine(rendered, width)) {
+      out.push(wl);
+    }
+  }
+
+  if (inCodeBlock) flushCode();
+  if (inTable) flushTable();
+
+  return out.join("\n");
+}