rvlib-shipkit 0.30.0 → 0.32.0

package/src/wiki/run-wiki.ts

@@ -6,7 +6,15 @@ import { lintMd } from './lint-md.ts'
 import { scanMdGraph } from './scan-md.ts'
 import { serveMdGraph } from './serve-graph.ts'
 
-export type WikiScanOpts = { root: string; index?: string; skip?: string }
+export type WikiScanOpts = {
+    root: string
+    index?: string
+    skip?: string
+    /** where the verdict goes. The command passes its own stream, so the
+     *  output is capturable: a console.log inside a command bypasses the
+     *  stream clipanion hands it, and nothing downstream can read it */
+    print?: (line: string) => void
+}
 
 const scanConfig = (o: WikiScanOpts): { root: string; index?: string; skipDirs?: string[] } => ({
     root: resolve(process.cwd(), o.root),
@@ -15,18 +23,19 @@ const scanConfig = (o: WikiScanOpts): { root: string; index?: string; skipDirs?:
 })
 
 export async function runWikiServe(o: WikiScanOpts & { port: number; title?: string }): Promise<number> {
+    const say = o.print ?? console.log
     const cfg = scanConfig(o)
     const rel = relative(process.cwd(), cfg.root)
     const title = o.title ?? (rel === '' ? basename(cfg.root) : `${basename(process.cwd())} ${rel}`)
     try {
         serveMdGraph({ port: o.port, title, load: () => scanMdGraph(cfg) })
-        console.log(`wiki graph → http://localhost:${o.port} (open in browser, or VSCode "Simple Browser: Show")`)
+        say(`wiki graph → http://localhost:${o.port} (open in browser, or VSCode "Simple Browser: Show")`)
         // keep the server alive — the command must not resolve
         await new Promise(() => {})
         return 0
     } catch (e) {
         if (e instanceof Error && e.message.includes('in use')) {
-            console.log(`wiki graph already served → http://localhost:${o.port} (another window owns it)`)
+            say(`wiki graph already served → http://localhost:${o.port} (another window owns it)`)
             return 0
         }
         throw e
@@ -34,17 +43,18 @@ export async function runWikiServe(o: WikiScanOpts & { port: number; title?: str
 }
 
 export function runWikiLint(o: WikiScanOpts): number {
+    const say = o.print ?? console.log
     const cfg = scanConfig(o)
     const r = lintMd(cfg)
     if (r.index == null) {
-        console.log(o.index != null
+        say(o.index != null
             ? `FAIL entrypoint '${o.index}' not found in ${cfg.root}`
             : `FAIL no entrypoint: neither index.md nor README.md in ${cfg.root} — pass --index <entry.md>`)
         return 1
     }
-    for (const f of r.orphans) console.log(`FAIL orphan: ${f} — unreachable from ${r.index}; link it or delete it`)
-    for (const d of r.dangling) console.log(`FAIL dangling: ${d.from} → ${d.token} — target not found`)
-    if (!r.ok) { console.log(`FAIL mdwiki lint: ${r.orphans.length} orphan(s), ${r.dangling.length} dangling ref(s) in ${cfg.root}`); return 1 }
-    console.log(`ok mdwiki lint: ${r.files} files, all reachable from ${r.index}, no dangling refs`)
+    for (const f of r.orphans) say(`FAIL orphan: ${f} — unreachable from ${r.index}; link it or delete it`)
+    for (const d of r.dangling) say(`FAIL dangling: ${d.from} → ${d.token} — target not found`)
+    if (!r.ok) { say(`FAIL mdwiki lint: ${r.orphans.length} orphan(s), ${r.dangling.length} dangling ref(s) in ${cfg.root}`); return 1 }
+    say(`ok mdwiki lint: ${r.files} files, all reachable from ${r.index}, no dangling refs`)
     return 0
 }