terminfo.dev 0.7.0 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "terminfo.dev",
-  "version": "0.7.0",
+  "version": "1.1.0",
   "description": "Test your terminal's feature support and contribute to terminfo.dev",
   "keywords": [
     "ansi",
@@ -32,6 +32,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "commander": "^14.0.0"
+  },
   "engines": {
     "node": ">=23.6.0"
   }

package/src/index.ts

@@ -1,18 +1,18 @@
 #!/usr/bin/env bun
 /**
- * terminfo CLI — test your terminal's feature support.
+ * terminfo.dev CLI — can your terminal do that?
  *
- * Runs probes against the real terminal you're using (not a headless library),
- * shows results, and optionally submits them to terminfo.dev.
+ * Test your terminal's feature support and contribute results to terminfo.dev.
  *
  * @example
  * ```bash
- * npx terminfo          # Run all probes
- * npx terminfo --json   # Output JSON results
- * npx terminfo --submit # Submit results to terminfo.dev
+ * npx terminfo.dev           # Show terminal info + help
+ * npx terminfo.dev probe     # Run all probes
+ * npx terminfo.dev submit    # Run probes + submit results
  * ```
  */
 
+import { Command } from "commander"
 import { readFileSync } from "node:fs"
 import { dirname, join } from "node:path"
 import { fileURLToPath } from "node:url"
@@ -25,10 +25,9 @@ const __dirname = dirname(fileURLToPath(import.meta.url))
 
 /** Load feature slugs from features.json for OSC 8 hyperlinks */
 function loadFeatureSlugs(): Record<string, string> {
-  // Try repo-local path first, then npm-installed path
   const candidates = [
-    join(__dirname, "..", "..", "features.json"),       // repo: cli/src/ -> features.json
-    join(__dirname, "..", "..", "..", "features.json"),  // npm: node_modules/terminfo.dev/src/ -> features.json
+    join(__dirname, "..", "..", "features.json"),
+    join(__dirname, "..", "..", "..", "features.json"),
   ]
   for (const path of candidates) {
     try {
@@ -41,60 +40,33 @@ function loadFeatureSlugs(): Record<string, string> {
       return slugs
     } catch {}
   }
-  return {} // fallback: featureSlug() will use id.replaceAll(".", "-")
+  return {}
 }
 
-/** OSC 8 hyperlink — clickable link in supporting terminals */
+/** OSC 8 hyperlink */
 function link(url: string, text: string): string {
   return `\x1b]8;;${url}\x07${text}\x1b]8;;\x07`
 }
 
-interface ResultEntry {
-  terminal: string
-  terminalVersion: string
-  os: string
-  osVersion: string
-  source: "community"
-  generated: string
+interface ProbeResults {
+  terminal: ReturnType<typeof detectTerminal>
   results: Record<string, boolean>
   notes: Record<string, string>
   responses: Record<string, string>
+  passed: number
+  total: number
 }
 
-async function main() {
-  const args = process.argv.slice(2)
-  const jsonMode = args.includes("--json")
-  const submitMode = args.includes("--submit")
-
-  // Detect terminal
+async function runProbes(): Promise<ProbeResults> {
   const terminal = detectTerminal()
-
-  if (!jsonMode) {
-    console.log(`\x1b[1mterminfo.dev\x1b[0m — can your terminal do that?\n`)
-    console.log(`  Terminal:  \x1b[1m${terminal.name}\x1b[0m${terminal.version ? ` ${terminal.version}` : ""}`)
-    console.log(`  Platform:  ${terminal.os}${terminal.osVersion ? ` ${terminal.osVersion}` : ""}`)
-    console.log(`  Probes:    ${ALL_PROBES.length} features across ${new Set(ALL_PROBES.map(p => p.id.split(".")[0])).size} categories`)
-    console.log(`  Website:   https://terminfo.dev`)
-    console.log(``)
-    console.log(`\x1b[2mResults are compared against ${ALL_PROBES.length} terminal features from the`)
-    console.log(`ECMA-48, VT100/VT510, xterm, and Kitty specifications.`)
-    console.log(`Run with --submit to contribute your results to the database.\x1b[0m\n`)
-    console.log(`Running probes...`)
-  }
-
   const results: Record<string, boolean> = {}
   const notes: Record<string, string> = {}
   const responses: Record<string, string> = {}
   let passed = 0
-  let failed = 0
 
   await withRawMode(async () => {
-    // Enter alt screen inside raw mode so all probe output stays contained
-    process.stdout.write("\x1b[?1049h") // alt screen
-    process.stdout.write("\x1b[2J\x1b[H") // clear + home
-
+    process.stdout.write("\x1b[?1049h\x1b[2J\x1b[H")
     for (const probe of ALL_PROBES) {
-      // Clear screen before each probe to prevent leaking output
       process.stdout.write("\x1b[2J\x1b[H")
       try {
         const result = await probe.run()
@@ -102,43 +74,34 @@ async function main() {
         if (result.note) notes[probe.id] = result.note
         if (result.response) responses[probe.id] = result.response
         if (result.pass) passed++
-        else failed++
       } catch (err) {
         results[probe.id] = false
         notes[probe.id] = `error: ${err instanceof Error ? err.message : String(err)}`
-        failed++
       }
     }
-
-    // Exit alt screen while still in raw mode
     process.stdout.write("\x1b[?1049l")
   })
 
-  const total = ALL_PROBES.length
-  const pct = Math.round((passed / total) * 100)
+  return { terminal, results, notes, responses, passed, total: ALL_PROBES.length }
+}
 
-  const entry: ResultEntry = {
-    terminal: terminal.name,
-    terminalVersion: terminal.version,
-    os: terminal.os,
-    osVersion: terminal.osVersion,
-    source: "community",
-    generated: new Date().toISOString(),
-    results,
-    notes,
-    responses,
-  }
+function printHeader(terminal: ReturnType<typeof detectTerminal>) {
+  const siteLink = link("https://terminfo.dev", "terminfo.dev")
+  console.log(`\x1b[1m${siteLink}\x1b[0m — can your terminal do that?\n`)
+  console.log(`  Terminal:  \x1b[1m${terminal.name}\x1b[0m${terminal.version ? ` ${terminal.version}` : ""}`)
+  console.log(`  Platform:  ${terminal.os} ${terminal.osVersion}`)
+  console.log(`  Probes:    ${ALL_PROBES.length} features across ${new Set(ALL_PROBES.map(p => p.id.split(".")[0])).size} categories`)
+  console.log(`  Website:   ${link("https://terminfo.dev", "https://terminfo.dev")}`)
+}
 
-  if (jsonMode) {
-    console.log(JSON.stringify(entry, null, 2))
-    return
-  }
+function printResults(data: ProbeResults) {
+  const { passed, total } = data
+  const pct = Math.round((passed / total) * 100)
+  const slugs = loadFeatureSlugs()
 
-  // Display results
-  console.log(`\n\x1b[1mResults: ${passed}/${total} (${pct}%)\x1b[0m\n`)
+  printHeader(data.terminal)
+  console.log(`  Score:     \x1b[1m${passed}/${total} (${pct}%)\x1b[0m\n`)
 
-  // Show categories with OSC 8 hyperlinks
-  const slugs = loadFeatureSlugs()
   const categories = new Map<string, Array<{ id: string; name: string; pass: boolean; note?: string }>>()
   for (const probe of ALL_PROBES) {
     const cat = probe.id.split(".")[0]!
@@ -146,13 +109,13 @@ async function main() {
     categories.get(cat)!.push({
       id: probe.id,
       name: probe.name,
-      pass: results[probe.id] ?? false,
-      note: notes[probe.id],
+      pass: data.results[probe.id] ?? false,
+      note: data.notes[probe.id],
     })
   }
 
   for (const [cat, probes] of categories) {
-    const catPassed = probes.filter((p) => p.pass).length
+    const catPassed = probes.filter(p => p.pass).length
     const color = catPassed === probes.length ? "\x1b[32m" : catPassed > 0 ? "\x1b[33m" : "\x1b[31m"
     const catLink = link(`https://terminfo.dev/${cat}`, cat)
     console.log(`${color}${catLink}\x1b[0m (${catPassed}/${probes.length})`)
@@ -160,25 +123,84 @@ async function main() {
       const icon = p.pass ? "\x1b[32m✓\x1b[0m" : "\x1b[31m✗\x1b[0m"
       const note = p.note ? ` \x1b[2m— ${p.note}\x1b[0m` : ""
       const slug = slugs[p.id] ?? p.id.replaceAll(".", "-")
-      const cat = p.id.split(".")[0]!
-      const featureLink = link(`https://terminfo.dev/${cat}/${slug}`, p.name)
+      const fCat = p.id.split(".")[0]!
+      const featureLink = link(`https://terminfo.dev/${fCat}/${slug}`, p.name)
       console.log(`  ${icon} ${featureLink}${note}`)
     }
   }
+}
+
+// ── CLI ──
+
+const program = new Command()
+  .name("terminfo.dev")
+  .description("Can your terminal do that? — test terminal feature support and contribute to terminfo.dev")
+  .version("1.1.0")
+
+program
+  .command("probe")
+  .description("Run all probes against your terminal and display results")
+  .option("--json", "Output results as JSON")
+  .action(async (opts) => {
+    const data = await runProbes()
+
+    if (opts.json) {
+      console.log(JSON.stringify({
+        terminal: data.terminal.name,
+        terminalVersion: data.terminal.version,
+        os: data.terminal.os,
+        osVersion: data.terminal.osVersion,
+        source: "community",
+        generated: new Date().toISOString(),
+        results: data.results,
+        notes: data.notes,
+        responses: data.responses,
+      }, null, 2))
+      return
+    }
+
+    printResults(data)
+  })
+
+program
+  .command("submit")
+  .description("Run all probes and submit results to terminfo.dev via GitHub issue")
+  .action(async () => {
+    const data = await runProbes()
+    printResults(data)
 
-  if (submitMode) {
     console.log(`\nSubmitting results to terminfo.dev...`)
-    const url = await submitResults(entry)
+    const url = await submitResults({
+      terminal: data.terminal.name,
+      terminalVersion: data.terminal.version,
+      os: data.terminal.os,
+      osVersion: data.terminal.osVersion,
+      results: data.results,
+      notes: data.notes,
+      responses: data.responses,
+      generated: new Date().toISOString(),
+    })
     if (url) {
-      console.log(`\x1b[32m✓ Issue created:\x1b[0m ${url}`)
+      console.log(`\x1b[32m✓ Issue created:\x1b[0m ${link(url, url)}`)
     }
-  } else {
-    console.log(`\n\x1b[2mSubmit results to terminfo.dev: npx terminfo --submit\x1b[0m`)
-    console.log(`\x1b[2mJSON output: npx terminfo --json\x1b[0m`)
-  }
-}
+  })
 
-main().catch((err) => {
-  console.error(err)
-  process.exit(1)
+// Default action: show terminal info + help
+program.action(() => {
+  const terminal = detectTerminal()
+  printHeader(terminal)
+  console.log(``)
+  console.log(`\x1b[2mTest your terminal against ${ALL_PROBES.length} features from the ECMA-48,`)
+  console.log(`VT100/VT510, xterm, and Kitty specifications. Results can be`)
+  console.log(`submitted to the community database at terminfo.dev.\x1b[0m`)
+  console.log(``)
+  console.log(`Commands:`)
+  console.log(`  \x1b[1mprobe\x1b[0m    Run all probes and display results`)
+  console.log(`  \x1b[1msubmit\x1b[0m   Run probes and submit to terminfo.dev`)
+  console.log(``)
+  console.log(`Options:`)
+  console.log(`  \x1b[1m--json\x1b[0m   Output results as JSON (with probe command)`)
+  console.log(`  \x1b[1m--help\x1b[0m   Show this help`)
 })
+
+program.parse()

package/src/report.tsx

@@ -0,0 +1,113 @@
+/**
+ * Silvery-rendered CLI report for terminfo probe results.
+ */
+import React from "react"
+import { Box, Text } from "silvery"
+import { renderString } from "silvery"
+
+interface ProbeResult {
+  id: string
+  name: string
+  pass: boolean
+  note?: string
+}
+
+interface ReportProps {
+  terminal: string
+  terminalVersion: string
+  os: string
+  osVersion: string
+  probeCount: number
+  categoryCount: number
+  passed: number
+  total: number
+  categories: Map<string, ProbeResult[]>
+}
+
+/** OSC 8 hyperlink wrapper */
+function osc8(url: string, text: string): string {
+  return `\x1b]8;;${url}\x07${text}\x1b]8;;\x07`
+}
+
+function featureUrl(id: string, slug: string): string {
+  const cat = id.split(".")[0]!
+  return `https://terminfo.dev/${cat}/${slug}`
+}
+
+function Header({ terminal, terminalVersion, os, osVersion, probeCount, categoryCount, passed, total }: ReportProps) {
+  const pct = Math.round((passed / total) * 100)
+  return (
+    <Box flexDirection="column" marginBottom={1}>
+      <Text bold>{osc8("https://terminfo.dev", "terminfo.dev")}</Text>
+      <Text dimColor>Can your terminal do that?</Text>
+      <Text> </Text>
+      <Box flexDirection="row" gap={2}>
+        <Box flexDirection="column" width={12}>
+          <Text dimColor>Terminal</Text>
+          <Text dimColor>Platform</Text>
+          <Text dimColor>Probes</Text>
+          <Text dimColor>Score</Text>
+        </Box>
+        <Box flexDirection="column">
+          <Text bold>{terminal}{terminalVersion ? ` ${terminalVersion}` : ""}</Text>
+          <Text>{os} {osVersion}</Text>
+          <Text>{probeCount} features, {categoryCount} categories</Text>
+          <Text bold color={pct === 100 ? "green" : pct >= 90 ? "yellow" : "red"}>{passed}/{total} ({pct}%)</Text>
+        </Box>
+      </Box>
+    </Box>
+  )
+}
+
+function CategorySection({ name, probes, slugs }: { name: string; probes: ProbeResult[]; slugs: Record<string, string> }) {
+  const catPassed = probes.filter(p => p.pass).length
+  const allPassed = catPassed === probes.length
+  const catUrl = `https://terminfo.dev/${name}`
+
+  return (
+    <Box flexDirection="column">
+      <Text color={allPassed ? "green" : catPassed > 0 ? "yellow" : "red"}>
+        {osc8(catUrl, name)} ({catPassed}/{probes.length})
+      </Text>
+      {probes.map(p => {
+        const slug = slugs[p.id] ?? p.id.replaceAll(".", "-")
+        const url = featureUrl(p.id, slug)
+        const icon = p.pass ? "✓" : "✗"
+        return (
+          <Box key={p.id} flexDirection="row" paddingLeft={2}>
+            <Text color={p.pass ? "green" : "red"}>{icon} </Text>
+            <Text>{osc8(url, p.name)}</Text>
+            {p.note && <Text dimColor> — {p.note}</Text>}
+          </Box>
+        )
+      })}
+    </Box>
+  )
+}
+
+function Footer({ submitMode }: { submitMode: boolean }) {
+  if (submitMode) return null
+  return (
+    <Box flexDirection="column" marginTop={1}>
+      <Text dimColor>Submit: npx terminfo.dev --submit</Text>
+      <Text dimColor>JSON:   npx terminfo.dev --json</Text>
+    </Box>
+  )
+}
+
+function Report(props: ReportProps & { slugs: Record<string, string>; submitMode: boolean }) {
+  return (
+    <Box flexDirection="column">
+      <Header {...props} />
+      {[...props.categories.entries()].map(([name, probes]) => (
+        <CategorySection key={name} name={name} probes={probes} slugs={props.slugs} />
+      ))}
+      <Footer submitMode={props.submitMode} />
+    </Box>
+  )
+}
+
+export async function renderReport(props: ReportProps & { slugs: Record<string, string>; submitMode: boolean }): Promise<string> {
+  const width = process.stdout.columns ?? 80
+  return renderString(<Report {...props} />, { width })
+}

package/src/submit.ts

@@ -1,15 +1,15 @@
 /**
  * Submit results to terminfo.dev via GitHub issue.
- *
- * Creates an issue on beorn/terminfo.dev with the JSON results
- * attached as a code block. Maintainers review and merge into
- * the results database.
  */
 
+import { writeFileSync, unlinkSync } from "node:fs"
+import { tmpdir } from "node:os"
+import { join } from "node:path"
+import { execFileSync } from "node:child_process"
+
 const REPO = "beorn/terminfo.dev"
-const ISSUE_LABEL = "community-results"
 
-interface SubmitResult {
+interface SubmitData {
   terminal: string
   terminalVersion: string
   os: string
@@ -20,11 +20,7 @@ interface SubmitResult {
   generated: string
 }
 
-/**
- * Submit results by creating a GitHub issue.
- * Requires `gh` CLI to be installed and authenticated.
- */
-export async function submitResults(data: SubmitResult): Promise<string | null> {
+export async function submitResults(data: SubmitData): Promise<string | null> {
   const passed = Object.values(data.results).filter(Boolean).length
   const total = Object.keys(data.results).length
   const pct = Math.round((passed / total) * 100)
@@ -41,10 +37,12 @@ export async function submitResults(data: SubmitResult): Promise<string | null>
 | Score | ${passed}/${total} (${pct}%) |
 | Generated | ${data.generated} |
 
-### Results
+### Summary
+
+${formatSummary(data)}
 
 <details>
-<summary>Full JSON (click to expand)</summary>
+<summary>Full JSON</summary>
 
 \`\`\`json
 ${JSON.stringify(data, null, 2)}
@@ -52,55 +50,48 @@ ${JSON.stringify(data, null, 2)}
 
 </details>
 
-### Summary
-
-${formatSummary(data)}
-
 ---
-*Submitted via \`npx terminfo\`*`
-
-  // Try gh CLI first
-  if (await hasGhCli()) {
-    try {
-      const { execSync } = await import("node:child_process")
-      const result = execSync(
-        `gh issue create --repo ${REPO} --title ${JSON.stringify(title)} --body ${JSON.stringify(body)} --label ${ISSUE_LABEL}`,
-        { encoding: "utf-8", timeout: 30000 },
-      )
-      const url = result.trim()
-      return url
-    } catch (err) {
-      console.error(`\x1b[31mFailed to create issue via gh CLI\x1b[0m`)
-      console.error(err instanceof Error ? err.message : String(err))
-      return null
-    }
+*Submitted via \`npx terminfo.dev\`*`
+
+  if (!hasGhCli()) {
+    const filename = `terminfo-${data.terminal}-${data.os}-${Date.now()}.json`
+    writeFileSync(filename, JSON.stringify(data, null, 2))
+    console.log(`\n\x1b[33mgh CLI not found. Results saved to ${filename}\x1b[0m`)
+    console.log(`To submit: https://github.com/${REPO}/issues/new`)
+    return null
   }
 
-  // Fallback: write to file and give instructions
-  const { writeFileSync } = await import("node:fs")
-  const filename = `terminfo-${data.terminal}-${data.os}-${Date.now()}.json`
-  writeFileSync(filename, JSON.stringify(data, null, 2))
-  console.log(`\n\x1b[33mgh CLI not found. Results saved to ${filename}\x1b[0m`)
-  console.log(`To submit manually:`)
-  console.log(`  1. Go to https://github.com/${REPO}/issues/new`)
-  console.log(`  2. Title: ${title}`)
-  console.log(`  3. Paste the contents of ${filename}`)
-  return null
+  // Write body to temp file to avoid shell escaping issues
+  const bodyFile = join(tmpdir(), `terminfo-submit-${Date.now()}.md`)
+  try {
+    writeFileSync(bodyFile, body)
+    const result = execFileSync("gh", [
+      "issue", "create",
+      "--repo", REPO,
+      "--title", title,
+      "--body-file", bodyFile,
+    ], { encoding: "utf-8", timeout: 30000 })
+    return result.trim()
+  } catch (err) {
+    console.error(`\x1b[31mFailed to create issue\x1b[0m`)
+    console.error(err instanceof Error ? err.message : String(err))
+    return null
+  } finally {
+    try { unlinkSync(bodyFile) } catch {}
+  }
 }
 
-async function hasGhCli(): Promise<boolean> {
+function hasGhCli(): boolean {
   try {
-    const { execSync } = await import("node:child_process")
-    execSync("gh --version", { stdio: "ignore", timeout: 5000 })
+    execFileSync("gh", ["--version"], { stdio: "ignore", timeout: 5000 })
     return true
   } catch {
     return false
   }
 }
 
-function formatSummary(data: SubmitResult): string {
+function formatSummary(data: SubmitData): string {
   const categories = new Map<string, { pass: number; fail: number; failList: string[] }>()
-
   for (const [id, pass] of Object.entries(data.results)) {
     const cat = id.split(".")[0]!
     if (!categories.has(cat)) categories.set(cat, { pass: 0, fail: 0, failList: [] })
@@ -112,14 +103,11 @@ function formatSummary(data: SubmitResult): string {
       entry.failList.push(note ? `- \`${id}\`: ${note}` : `- \`${id}\``)
     }
   }
-
   const lines: string[] = []
   for (const [cat, { pass, fail, failList }] of categories) {
-    const total = pass + fail
     const icon = fail === 0 ? "✅" : "⚠️"
-    lines.push(`${icon} **${cat}**: ${pass}/${total}`)
+    lines.push(`${icon} **${cat}**: ${pass}/${pass + fail}`)
     if (failList.length > 0) lines.push(...failList)
   }
-
   return lines.join("\n")
 }