@lakindu_perera/toren 1.0.5 → 1.0.8

package/src/renderers/console-renderer.js

@@ -4,7 +4,9 @@
  * Consumes a {@link ScanResult} and produces styled terminal output.
  *
  * Design contract:
- *  - No business logic. Every value rendered is taken directly from ScanResult.
+ *  - Presentation-only. Every value rendered comes from ScanResult.
+ *    Presentation-level derivations (e.g. frameworks list from projectType) are
+ *    permitted here; business logic is not.
  *  - No imports from the scanner or any domain module.
  *  - Stateless: render() may be called multiple times safely.
  *  - The shape expected here matches the ScanResult typedef in scan.js.
@@ -42,6 +44,47 @@ const C = {
 /** Maximum files shown in the structure preview. */
 const PREVIEW_LIMIT = 20;
 
+// ---------------------------------------------------------------------------
+// Cross-platform capability detection
+// ---------------------------------------------------------------------------
+
+function shouldEnableColors() {
+  if ('FORCE_COLOR' in process.env) {
+    return process.env.FORCE_COLOR !== '0' && process.env.FORCE_COLOR !== 'false';
+  }
+  if ('NO_COLOR' in process.env) return false;
+  if (!process.stdout || !process.stdout.isTTY) return false;
+  if (process.env.TERM === 'dumb') return false;
+  return true;
+}
+
+function isUnicodeSupported() {
+  if (process.platform !== 'win32') {
+    return process.env.TERM !== 'linux';
+  }
+  return Boolean(
+    process.env.CI ||
+    process.env.WT_SESSION ||
+    process.env.TERMINUS_SUBLIME ||
+    process.env.ConEmuTask === '{cmd::Cmder}' ||
+    process.env.TERM_PROGRAM === 'Terminus-Sublime' ||
+    process.env.TERM_PROGRAM === 'vscode' ||
+    process.env.TERM === 'xterm-256color' ||
+    process.env.TERM === 'alacritty' ||
+    process.env.TERMINAL_EMULATOR === 'JetBrains-JediTerm'
+  );
+}
+
+const useColors  = shouldEnableColors();
+const useUnicode = isUnicodeSupported();
+
+const CHARS = {
+  dash:   useUnicode ? '─'    : '-',
+  corner: useUnicode ? '└── ' : '\\-- ',
+  tee:    useUnicode ? '├── ' : '+-- ',
+  pipe:   useUnicode ? '│   ' : '|   ',
+};
+
 // ---------------------------------------------------------------------------
 // Low-level paint / layout helpers  (private to this module)
 // ---------------------------------------------------------------------------
@@ -53,27 +96,19 @@ const PREVIEW_LIMIT = 20;
  * @returns {string}
  */
 function paint(text, ...codes) {
+  if (!useColors) return text;
   return `${codes.join('')}${text}${C.reset}`;
 }
 
 /**
- * Print a full-width horizontal rule (≤ 80 chars).
- * @param {string} [char='─']
- */
-function divider(char = '─') {
-  const width = Math.min(process.stdout.columns ?? 72, 80);
-  console.log(paint(char.repeat(width), C.dim));
-}
-
-/**
- * Print a titled section header followed by a divider.
- * @param {string} emoji
+ * Print a titled section header followed by a matched-length divider.
  * @param {string} title
  */
-function section(emoji, title) {
+function section(title) {
+  const cleanTitle = title.replace(/\x1b\[[0-9;]*m/g, '');
+  console.log(paint(title, C.bold, C.white));
+  console.log(paint(CHARS.dash.repeat(cleanTitle.length), C.dim));
   console.log('');
-  console.log(`${emoji}  ${paint(title, C.bold, C.white)}`);
-  divider();
 }
 
 /**
@@ -84,7 +119,32 @@ function section(emoji, title) {
  */
 function row(label, value, ...valueCodes) {
   const coloured = valueCodes.length ? paint(value, ...valueCodes) : value;
-  console.log(`  ${paint(label, C.dim)}  ${coloured}`);
+  console.log(`${paint(label, C.dim)} ${coloured}`);
+}
+
+/**
+ * Format a scan duration into a human-readable string.
+ * Mirrors the formatDuration helpers in markdown-renderer and html-renderer.
+ * @param {number} ms
+ * @returns {string}
+ */
+function formatDuration(ms) {
+  if (ms < 1)     return '< 1 ms';
+  if (ms >= 1000) return `${(ms / 1000).toFixed(2)} s`;
+  return `${Math.round(ms)} ms`;
+}
+
+/**
+ * Derive a frameworks array from the projectType string.
+ * Returns [] when no specific framework is detected (projectType is falsy or 'Unknown').
+ * Mirrors the identical derivation in json-renderer.js — both must stay in sync.
+ *
+ * @param {string} projectType
+ * @returns {string[]}
+ */
+function deriveFrameworks(projectType) {
+  if (!projectType || projectType === 'Unknown') return [];
+  return [projectType];
 }
 
 // ---------------------------------------------------------------------------
@@ -107,21 +167,21 @@ function renderTree(node, prefix, isLast, counter, limit = PREVIEW_LIMIT, depth
   if (counter.maxReached) return;
   if (depth >= maxDepth) return;
 
-  const connector = isLast ? '└── ' : '├── ';
-  const extension = isLast ? '    ' : '│   ';
+  const connector = isLast ? CHARS.corner : CHARS.tee;
+  const extension = isLast ? '    ' : CHARS.pipe;
 
   if (node.type === 'directory') {
-    console.log(`${prefix}${connector}${paint(`${node.name}/`, C.bold, C.blue)}`);
+    console.log(`${prefix}${connector}${paint(`${node.name}${path.sep}`, C.bold, C.blue)}`);
     const children = node.children ?? [];
     
     if (depth === maxDepth - 1 && children.length > 0) {
-       console.log(`${prefix}${extension}└── ${paint('...', C.dim)}`);
+       console.log(`${prefix}${extension}${CHARS.corner}${paint('...', C.dim)}`);
        return;
     }
 
     for (let i = 0; i < children.length; i++) {
       if (counter.count >= limit) {
-        console.log(`${prefix}${extension}└── ${paint('...', C.dim)}`);
+        console.log(`${prefix}${extension}${CHARS.corner}${paint('...', C.dim)}`);
         counter.maxReached = true;
         break;
       }
@@ -137,11 +197,6 @@ function renderTree(node, prefix, isLast, counter, limit = PREVIEW_LIMIT, depth
   }
 }
 
-function formatDuration(ms) {
-  if (ms < 1) return '< 1 ms';
-  if (ms >= 1000) return `${(ms / 1000).toFixed(2)} s`;
-  return `${Math.round(ms)} ms`;
-}
 
 // ---------------------------------------------------------------------------
 // Banner  (private)
@@ -151,8 +206,7 @@ function printBanner() {
   const name    = paint('Toren', C.bold, C.cyan);
   const version = paint(`v${pkg.version}`, C.dim);
   const tagline = paint('Codebase Onboarding Intelligence', C.dim);
-  console.log('');
-  console.log(`  ${name} ${version}  —  ${tagline}`);
+  console.log(`${name} ${version}  —  ${tagline}`);
 }
 
 // ---------------------------------------------------------------------------
@@ -162,8 +216,8 @@ function printBanner() {
 /**
  * Render a ScanResult to the terminal.
  *
- * All sections read exclusively from the ScanResult; no derivations or
- * business decisions are made here.
+ * All sections read from the ScanResult. Presentation-level derivations
+ * (e.g. frameworks list) are computed here; no business logic is added.
  *
  * @param {import('../scanner/scan.js').ScanResult} result
  * @param {{ cwd?: string }} [options]
@@ -175,6 +229,10 @@ export function render(result, options = {}) {
     entryPoints,
     configs = [],
     scripts = [],
+    packageManager,
+    importantFiles = [],
+    projectInfo = null,
+    health = [],
     tree,
     flatFiles,
     totalFolders,
@@ -189,55 +247,115 @@ export function render(result, options = {}) {
   console.log('');
 
   // ── Summary ───────────────────────────────────────────────────────────────
-  section('🔍', 'Project Summary');
+  section('Project Summary');
   row('Path:         ', paint(relRoot, C.cyan));
+  if (projectInfo && projectInfo.name) {
+    row('Name:         ', paint(projectInfo.name, C.white));
+  }
   row('Project type: ', paint(projectType, C.bold, C.green));
+  if (packageManager) {
+    row('Pkg manager:  ', paint(packageManager, C.white));
+  }
   row('Total files:  ', paint(String(flatFiles.length), C.yellow));
   row('Total folders:', paint(String(totalFolders), C.yellow));
-  row('Scan duration:', paint(formatDuration(scanDurationMs), C.magenta));
+  console.log('');
+
+  // ── Project Health ────────────────────────────────────────────────────────
+  section('Project Health');
+  if (health.length === 0) {
+    console.log(paint('No project health observations available.', C.dim));
+  } else {
+    for (const h of health) {
+      let icon = 'ℹ';
+      let color = C.white;
+      if (h.status === 'pass') {
+        icon = '✓';
+        color = C.green;
+      } else if (h.status === 'warning') {
+        icon = '⚠';
+        color = C.yellow;
+      }
+      console.log(`${paint(icon, color)} ${h.message}`);
+    }
+  }
+  console.log('');
+
+  // ── Important Files ───────────────────────────────────────────────────────
+  section('Important Files');
+  if (importantFiles.length === 0) {
+    console.log(paint('No important files detected.', C.dim));
+  } else {
+    importantFiles.forEach((f, idx) => {
+      console.log(`${idx + 1}. ${paint(f.path, C.white)}`);
+      console.log(`   ${paint(f.reason, C.dim)}`);
+      if (idx < importantFiles.length - 1) console.log('');
+    });
+  }
+  console.log('');
+
+  // ── Frameworks ────────────────────────────────────────────────────────────
+  section('Frameworks');
+  const frameworks = deriveFrameworks(projectType);
+  if (frameworks.length === 0) {
+    console.log(paint('No frameworks detected.', C.dim));
+  } else {
+    for (const fw of frameworks) {
+      console.log(paint(fw, C.white));
+    }
+  }
+  console.log('');
 
   // ── Entry Points ──────────────────────────────────────────────────────────
-  section('🚪', 'Entry Points');
+  section('Entry Points');
   if (entryPoints.length === 0) {
-    console.log(paint('  ⚠ No entry points detected (this may be a library or utility project)', C.yellow));
+    console.log(paint('No entry points detected.', C.dim));
   } else {
     for (const ep of entryPoints) {
-      console.log(`  ${paint('→', C.cyan)}  ${paint(ep, C.white)}`);
+      console.log(paint(ep, C.white));
     }
   }
+  console.log('');
 
   // ── Configuration Files ───────────────────────────────────────────────────
-  section('⚙️', 'Configuration Files');
+  section('Configuration Files');
   if (configs.length === 0) {
-    console.log(paint('  No configuration files detected', C.dim));
+    console.log(paint('No configuration files detected.', C.dim));
   } else {
     for (const c of configs) {
-      console.log(`  ${paint(c, C.white)}`);
+      console.log(paint(c, C.white));
     }
   }
+  console.log('');
 
   // ── Package Scripts ───────────────────────────────────────────────────────
-  section('📜', 'Package Scripts');
+  section('Package Scripts');
   if (scripts.length === 0) {
-    console.log(paint('  No package scripts detected', C.dim));
+    console.log(paint('No package scripts detected.', C.dim));
   } else {
-    const maxNameLen = Math.max(...scripts.map(s => s.name.length));
-    for (const s of scripts) {
-      const paddedName = s.name.padEnd(maxNameLen, ' ');
-      console.log(`  ${paint(paddedName, C.white)}  ${paint(s.command, C.dim)}`);
+    for (let i = 0; i < scripts.length; i++) {
+      const s = scripts[i];
+      const usage = s.usage || `npm run ${s.name}`;
+      console.log(paint(usage, C.white));
+      if (s.description) {
+        console.log(`  ${paint(s.description, C.dim)}`);
+      } else {
+        console.log(`  ${paint(s.command, C.dim)}`);
+      }
+      if (i < scripts.length - 1) console.log('');
     }
   }
+  console.log('');
 
   // ── Structure Preview ─────────────────────────────────────────────────────
-  section('📁', `Folder Structure  ${paint(`(first ${PREVIEW_LIMIT} files)`, C.dim)}`);
+  section('Folder Structure');
 
-  console.log(paint(`${tree.name || '.'}/`, C.bold, C.blue));
+  console.log(paint(`${tree.name || '.'}${path.sep}`, C.bold, C.blue));
 
   const counter  = { count: 0, maxReached: false };
   const children = tree.children ?? [];
   for (let i = 0; i < children.length; i++) {
     if (counter.count >= PREVIEW_LIMIT) {
-      console.log(`└── ${paint('...', C.dim)}`);
+      console.log(`${CHARS.corner}${paint('...', C.dim)}`);
       break;
     }
     renderTree(children[i], '', i === children.length - 1, counter);
@@ -246,13 +364,12 @@ export function render(result, options = {}) {
 
   if (flatFiles.length > PREVIEW_LIMIT) {
     const hidden = flatFiles.length - PREVIEW_LIMIT;
-    console.log(paint(`  … and ${hidden} more file(s) not shown`, C.dim));
+    console.log(paint(`… ${hidden} more file(s) not shown`, C.dim));
   }
 
   // ── Footer ────────────────────────────────────────────────────────────────
   console.log('');
-  divider();
-  console.log(paint('  ✅  Scan complete.', C.green));
+  console.log(paint(`Scan completed in ${formatDuration(scanDurationMs)}`, C.green));
   console.log('');
 }
 
@@ -264,8 +381,8 @@ export function render(result, options = {}) {
 export function renderStructure(result) {
   const { tree, flatFiles } = result;
 
-  console.log(paint('Project Structure:', C.bold, C.white));
-  console.log(paint(`${tree.name || '.'}/`, C.bold, C.blue));
+  section('Folder Structure');
+  console.log(paint(`${tree.name || '.'}${path.sep}`, C.bold, C.blue));
 
   const counter  = { count: 0, maxReached: false };
   const children = tree.children ?? [];
@@ -273,7 +390,7 @@ export function renderStructure(result) {
 
   for (let i = 0; i < children.length; i++) {
     if (counter.count >= limit) {
-      console.log(`└── ${paint('...', C.dim)}`);
+      console.log(`${CHARS.corner}${paint('...', C.dim)}`);
       break;
     }
     renderTree(children[i], '', i === children.length - 1, counter, limit, 0, Infinity);