@dunkinfrunkin/mdcat 0.1.12 → 0.1.14

package/README.md

@@ -2,7 +2,9 @@
 
 [![npm](https://img.shields.io/npm/v/@dunkinfrunkin/mdcat?color=61afef&label=npm)](https://www.npmjs.com/package/@dunkinfrunkin/mdcat)
 [![license](https://img.shields.io/badge/license-MIT-98c379)](LICENSE)
-[![node](https://img.shields.io/badge/node-%3E%3D18-e5c07b)](package.json)
+[![node](https://img.shields.io/badge/node-%3E%3D20-e5c07b)](package.json)
+[![CI](https://github.com/dunkinfrunkin/mdcat/actions/workflows/ci.yml/badge.svg)](https://github.com/dunkinfrunkin/mdcat/actions/workflows/ci.yml)
+[![site](https://img.shields.io/badge/site-mdcat.frankchan.dev-61afef)](https://mdcat.frankchan.dev)
 
 **Terminal pager for Markdown.** Full colour, syntax highlighting, incremental search, mouse support — zero config.
 
@@ -10,7 +12,7 @@
 npm install -g @dunkinfrunkin/mdcat
 ```
 
-<video src="https://github.com/dunkinfrunkin/mdcat/releases/download/v0.1.2/demo.mp4" autoplay loop muted playsinline width="100%"></video>
+![mdcat demo](https://github.com/dunkinfrunkin/mdcat/releases/download/v0.1.12/demo.gif)
 
 ---
 
@@ -32,6 +34,7 @@ npx @dunkinfrunkin/mdcat README.md
 ```sh
 mdcat README.md                  # open a file
 mdcat --web README.md            # render and open in browser
+mdcat -n README.md               # show line numbers
 mdcat --light README.md          # force light theme
 mdcat --dark README.md           # force dark theme
 cat CHANGELOG.md | mdcat         # pipe from stdin
@@ -46,6 +49,7 @@ mdcat --version                  # show version
 |-----|--------|
 | `q` | Quit |
 | `y` | Copy visible page to clipboard |
+| `L` | Toggle line numbers |
 | `M` | Toggle mouse (off = free text selection) |
 | `j` / `k` | Scroll down / up |
 | `Space` / `b` | Page down / up |
@@ -104,10 +108,16 @@ npm install
 npm test
 ```
 
-All PRs must pass `npm test` (68 tests).
+All PRs must pass `npm test` (85 tests).
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
 
+## Links
+
+- [mdcat.frankchan.dev](https://mdcat.frankchan.dev) -- landing page
+- [npm package](https://www.npmjs.com/package/@dunkinfrunkin/mdcat)
+- [GitHub](https://github.com/dunkinfrunkin/mdcat)
+
 ## License
 
 [MIT](LICENSE) © Frank Chan

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dunkinfrunkin/mdcat",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "View markdown files beautifully in your terminal",
   "type": "module",
   "bin": {
@@ -21,7 +21,7 @@
     "wrap-ansi": "^10.0.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "keywords": [
     "markdown",

package/src/cli.js

@@ -32,6 +32,7 @@ if (args[0] === "--help" || args[0] === "-h") {
   console.log(`  mdcat ${dim("--doc <file.md>")}   ${dim("# export to .docx")}`);
   console.log(`  mdcat ${dim("--light")}           ${dim("# force light theme")}`);
   console.log(`  mdcat ${dim("--dark")}            ${dim("# force dark theme")}`);
+  console.log(`  mdcat ${dim("-n, --number")}      ${dim("# show line numbers")}`);
   console.log(`  cat file.md ${dim("|")} mdcat\n`);
   console.log(`${bold("Theme:")}`);
   console.log(`  Auto-detects terminal theme. Override with ${blue("--light")} / ${blue("--dark")}`);
@@ -40,7 +41,7 @@ if (args[0] === "--help" || args[0] === "-h") {
   console.log(`  ${blue("/")}          search          ${blue("n/N")}   next/prev match`);
   console.log(`  ${blue("j/k")} ${dim("↑↓")}    scroll line     ${blue("space/b")} page down/up`);
   console.log(`  ${blue("d/u")}        half page       ${blue("g/G")}   top/bottom`);
-  console.log(`  ${blue("q")}          quit\n`);
+  console.log(`  ${blue("L")}          line numbers    ${blue("q")}     quit\n`);
   process.exit(0);
 }
 
@@ -49,6 +50,10 @@ const activeTheme = themeFromArgs(args) ?? detectTheme();
 args = stripThemeArgs(args);
 setTheme(activeTheme);
 
+// Line numbers flag
+const showLineNumbers = args.includes("-n") || args.includes("--number");
+args = args.filter(a => a !== "-n" && a !== "--number");
+
 if (args[0] === "--version" || args[0] === "-v") {
   console.log(`${CAT}  ${bold("mdcat")} ${dim(`v${pkg.version}`)}`);
   process.exit(0);
@@ -128,7 +133,7 @@ function runTUI(title, content) {
   const cols = Math.min(termCols, MAX_COLS);
   const tokens = marked.lexer(content);
   const lines = renderTokens(tokens, cols, termCols > MAX_COLS ? termCols : undefined);
-  launch(title, lines, activeTheme);
+  launch(title, lines, activeTheme, { lineNumbers: showLineNumbers });
 }
 
 // --web / --doc flags

package/src/tui.js

@@ -129,7 +129,7 @@ function copyText(text) {
   catch { /* not on macOS or pbcopy unavailable */ }
 }
 
-export function launch(title, lines, theme) {
+export function launch(title, lines, theme, opts = {}) {
   // Apply theme to TUI chrome
   if (theme === "light") {
     const pal = LIGHT;
@@ -137,6 +137,12 @@ export function launch(title, lines, theme) {
     HL_MATCH = pal.hlMatch;
     HL_CURRENT = pal.hlCurrent;
   }
+
+  // Line numbers
+  let lineNumbers = opts.lineNumbers ?? false;
+  const totalDigits = String(lines.length).length;
+  const gutterW = totalDigits + 2; // "  N " width
+
   // Viewport state
   let offset = 0;
 
@@ -225,10 +231,16 @@ export function launch(title, lines, theme) {
   }
 
   function gutterFor(absLine) {
-    if (mode === "normal" || !searchQuery) return "  ";
-    if (matchLines[matchIdx] === absLine)   return `${C.matchFg}▶${RESET} `;
-    if (matchSet.has(absLine))              return `${C.otherMatchFg}›${RESET} `;
-    return "  ";
+    let prefix = "";
+    if (lineNumbers) {
+      const num = String(absLine + 1).padStart(totalDigits);
+      prefix = `${C.dimFg}${num}${RESET} `;
+    }
+
+    if (mode === "normal" || !searchQuery) return prefix || "  ";
+    if (matchLines[matchIdx] === absLine)   return `${prefix}${C.matchFg}▶${RESET} `;
+    if (matchSet.has(absLine))              return `${prefix}${C.otherMatchFg}›${RESET} `;
+    return prefix || "  ";
   }
 
   function statusBar(w) {
@@ -274,9 +286,9 @@ export function launch(title, lines, theme) {
 
     const mouseHint = mouseEnabled ? "" : `${C.matchFg} [select mode]${RESET}`;
     const mouseW    = mouseEnabled ? 0 : " [select mode]".length;
-    const hints  = `${C.dim} q  y  /  j k  ↑↓  space  g G  M${RESET}`;
+    const hints  = `${C.dim} q  y  /  j k  ↑↓  space  g G  L  M${RESET}`;
     const right  = `${C.dimFg} ${pct} ${RESET}`;
-    const hintsW = " q  y  /  j k  ↑↓  space  g G  M".length;
+    const hintsW = " q  y  /  j k  ↑↓  space  g G  L  M".length;
     const rightW = ` ${pct} `.length;
     const gap    = Math.max(0, w - hintsW - mouseW - rightW);
     return `${C.chromeBg}${hints}${mouseHint}${" ".repeat(gap)}${right}${RESET}`;
@@ -368,6 +380,10 @@ export function launch(title, lines, theme) {
         showToast("Copied to clipboard"); return;
       }
 
+      case "L":
+        lineNumbers = !lineNumbers;
+        showToast(lineNumbers ? "Line numbers on" : "Line numbers off"); return;
+
       case "M":
         mouseEnabled = !mouseEnabled;
         process.stdout.write(mouseEnabled ? MOUSE_ON : MOUSE_OFF);