@lakindu_perera/toren 1.0.7 → 1.0.9

package/src/lifecycle.js

@@ -1,124 +0,0 @@
-import fs from 'node:fs';
-import { execSync } from 'node:child_process';
-import readline from 'node:readline';
-
-const C = {
-  reset:   '\x1b[0m',
-  cyan:    '\x1b[36m',
-  green:   '\x1b[32m',
-  yellow:  '\x1b[33m',
-  red:     '\x1b[31m',
-};
-
-function paint(text, ...codes) {
-  return `${codes.join('')}${text}${C.reset}`;
-}
-
-function getGlobalNpmRoot() {
-  try {
-    return execSync('npm root -g', { encoding: 'utf8', stdio: 'pipe' }).trim();
-  } catch {
-    return null;
-  }
-}
-
-function getInstallStatus() {
-  const status = {
-    isGlobal: false,
-    method: 'unknown',
-    binaryPath: process.argv[1] || 'unknown',
-    isBroken: false,
-  };
-
-  try {
-    if (!status.binaryPath || !fs.existsSync(status.binaryPath)) {
-      status.isBroken = true;
-      return status;
-    }
-
-    const realPath = fs.realpathSync(status.binaryPath);
-    const globalRoot = getGlobalNpmRoot();
-
-    if (globalRoot) {
-      if (realPath.includes(globalRoot)) {
-        status.isGlobal = true;
-        status.method = 'npm install -g';
-      } else if (status.binaryPath !== realPath) {
-        status.isGlobal = true;
-        status.method = 'npm link';
-      } else {
-        status.isGlobal = false;
-        status.method = 'local';
-      }
-    } else {
-      if (status.binaryPath !== realPath) {
-        status.isGlobal = true;
-        status.method = 'npm link';
-      } else {
-        status.isGlobal = false;
-      }
-    }
-  } catch (err) {
-    status.isBroken = true;
-  }
-
-  return status;
-}
-
-export function runDoctor(pkgVersion) {
-  const status = getInstallStatus();
-
-  if (status.isBroken) {
-    console.log(paint('⚠ Broken installation detected', C.red));
-    console.log(`→ Run: ${paint('npm uninstall -g toren', C.cyan)}`);
-    console.log('');
-    return;
-  }
-
-  if (status.isGlobal) {
-    console.log(`${paint('✔', C.green)} Toren installed globally`);
-  } else {
-    console.log(`${paint('✔', C.green)} Toren installed locally`);
-  }
-  
-  console.log(`${paint('✔', C.green)} Binary path valid`);
-  console.log(`${paint('✔', C.green)} Version match confirmed`);
-  console.log('');
-}
-
-export function runUninstall() {
-  const status = getInstallStatus();
-
-  if (status.isBroken) {
-    console.log(paint('⚠ Toren installation is corrupted. Please reinstall using npm install -g toren', C.yellow));
-    process.exit(0);
-  }
-
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout
-  });
-
-  rl.question('Are you sure you want to remove Toren from global environment? (y/n) ', (answer) => {
-    rl.close();
-    if (answer.toLowerCase() !== 'y' && answer.toLowerCase() !== 'yes') {
-      process.exit(0);
-    }
-
-    console.log('');
-    console.log('Uninstalling Toren...');
-    
-    try {
-      execSync('npm uninstall -g toren', { stdio: 'inherit' });
-      console.log('');
-      console.log(paint('✔ Successfully removed Toren from the global environment.', C.green));
-    } catch (err) {
-      console.log('');
-      console.log(paint('❌ Failed to uninstall Toren.', C.red));
-      console.log('Please try manually: npm uninstall -g toren');
-    }
-    
-    console.log('');
-    process.exit(0);
-  });
-}

package/src/renderers/console-renderer.js

@@ -1,350 +0,0 @@
-/**
- * @fileoverview Toren — Console Renderer
- *
- * Consumes a {@link ScanResult} and produces styled terminal output.
- *
- * Design contract:
- *  - 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.
- *    When ScanResult grows new fields, add new render sections; never mutate data.
- *
- * Adding a new output format (JSON, Markdown, HTML …):
- *  - Create src/renderers/<format>-renderer.js
- *  - Export a render(result, options?) function with the same signature
- *  - Import and call it from bin/toren.js based on a --format flag
- */
-
-import path from 'node:path';
-import { createRequire } from 'node:module';
-
-const require = createRequire(import.meta.url);
-const pkg     = require('../../package.json');
-
-// ---------------------------------------------------------------------------
-// ANSI palette — zero external dependencies
-// ---------------------------------------------------------------------------
-
-const C = {
-  reset:   '\x1b[0m',
-  bold:    '\x1b[1m',
-  dim:     '\x1b[2m',
-  cyan:    '\x1b[36m',
-  green:   '\x1b[32m',
-  yellow:  '\x1b[33m',
-  blue:    '\x1b[34m',
-  magenta: '\x1b[35m',
-  red:     '\x1b[31m',
-  white:   '\x1b[97m',
-};
-
-/** 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)
-// ---------------------------------------------------------------------------
-
-/**
- * Wrap `text` with one or more ANSI codes, resetting after.
- * @param {string} text
- * @param {...string} codes
- * @returns {string}
- */
-function paint(text, ...codes) {
-  if (!useColors) return text;
-  return `${codes.join('')}${text}${C.reset}`;
-}
-
-/**
- * Print a titled section header followed by a matched-length divider.
- * @param {string} 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('');
-}
-
-/**
- * Print a single labelled key-value row.
- * @param {string} label  - Left-hand label (dim)
- * @param {string} value  - Right-hand value
- * @param {string} [valueColor] - Optional ANSI code(s) for the value
- */
-function row(label, value, ...valueCodes) {
-  const coloured = valueCodes.length ? paint(value, ...valueCodes) : value;
-  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];
-}
-
-// ---------------------------------------------------------------------------
-// File-tree renderer  (private)
-// ---------------------------------------------------------------------------
-
-/**
- * Recursively print a file tree with classic tree connectors.
- * Stops after PREVIEW_LIMIT files have been printed.
- *
- * @param {import('../scanner/scan.js').DirNode | import('../scanner/scan.js').FileNode} node
- * @param {string}            prefix   - Accumulated indentation
- * @param {boolean}           isLast   - Whether this is the last sibling
- * @param {{ count: number, maxReached: boolean }} counter  - Shared mutable file counter
- * @param {number}            limit    - Max files to render
- * @param {number}            depth    - Current depth
- * @param {number}            maxDepth - Max recursion depth
- */
-function renderTree(node, prefix, isLast, counter, limit = PREVIEW_LIMIT, depth = 0, maxDepth = 4) {
-  if (counter.maxReached) return;
-  if (depth >= maxDepth) return;
-
-  const connector = isLast ? CHARS.corner : CHARS.tee;
-  const extension = isLast ? '    ' : CHARS.pipe;
-
-  if (node.type === 'directory') {
-    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}${CHARS.corner}${paint('...', C.dim)}`);
-       return;
-    }
-
-    for (let i = 0; i < children.length; i++) {
-      if (counter.count >= limit) {
-        console.log(`${prefix}${extension}${CHARS.corner}${paint('...', C.dim)}`);
-        counter.maxReached = true;
-        break;
-      }
-      // Check if this child will be the last one we render due to limits
-      let willBeLast = i === children.length - 1;
-      
-      renderTree(children[i], prefix + extension, willBeLast, counter, limit, depth + 1, maxDepth);
-      if (counter.maxReached) break;
-    }
-  } else {
-    console.log(`${prefix}${connector}${paint(node.name, C.white)}`);
-    counter.count += 1;
-  }
-}
-
-
-// ---------------------------------------------------------------------------
-// Banner  (private)
-// ---------------------------------------------------------------------------
-
-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(`${name} ${version}  —  ${tagline}`);
-}
-
-// ---------------------------------------------------------------------------
-// Public API
-// ---------------------------------------------------------------------------
-
-/**
- * Render a ScanResult to the terminal.
- *
- * 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]
- */
-export function render(result, options = {}) {
-  const {
-    rootPath,
-    projectType,
-    entryPoints,
-    configs = [],
-    scripts = [],
-    tree,
-    flatFiles,
-    totalFolders,
-    scanDurationMs,
-  } = result;
-
-  const cwd    = options.cwd ?? process.cwd();
-  const relRoot = path.relative(cwd, rootPath) || '.';
-
-  // ── Banner ────────────────────────────────────────────────────────────────
-  printBanner();
-  console.log('');
-
-  // ── Summary ───────────────────────────────────────────────────────────────
-  section('Project Summary');
-  row('Path:         ', paint(relRoot, C.cyan));
-  row('Project type: ', paint(projectType, C.bold, C.green));
-  row('Total files:  ', paint(String(flatFiles.length), C.yellow));
-  row('Total folders:', paint(String(totalFolders), C.yellow));
-  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');
-  if (entryPoints.length === 0) {
-    console.log(paint('No entry points detected.', C.dim));
-  } else {
-    for (const ep of entryPoints) {
-      console.log(paint(ep, C.white));
-    }
-  }
-  console.log('');
-
-  // ── Configuration Files ───────────────────────────────────────────────────
-  section('Configuration Files');
-  if (configs.length === 0) {
-    console.log(paint('No configuration files detected.', C.dim));
-  } else {
-    for (const c of configs) {
-      console.log(paint(c, C.white));
-    }
-  }
-  console.log('');
-
-  // ── Package Scripts ───────────────────────────────────────────────────────
-  section('Package Scripts');
-  if (scripts.length === 0) {
-    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)}`);
-    }
-  }
-  console.log('');
-
-  // ── Structure Preview ─────────────────────────────────────────────────────
-  section('Folder Structure');
-
-  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(`${CHARS.corner}${paint('...', C.dim)}`);
-      break;
-    }
-    renderTree(children[i], '', i === children.length - 1, counter);
-    if (counter.maxReached) break;
-  }
-
-  if (flatFiles.length > PREVIEW_LIMIT) {
-    const hidden = flatFiles.length - PREVIEW_LIMIT;
-    console.log(paint(`… ${hidden} more file(s) not shown`, C.dim));
-  }
-
-  // ── Footer ────────────────────────────────────────────────────────────────
-  console.log('');
-  console.log(paint(`Scan completed in ${formatDuration(scanDurationMs)}`, C.green));
-  console.log('');
-}
-
-/**
- * Render only the project structure for the --structure flag.
- * 
- * @param {import('../scanner/scan.js').ScanResult} result
- */
-export function renderStructure(result) {
-  const { tree, flatFiles } = result;
-
-  section('Folder Structure');
-  console.log(paint(`${tree.name || '.'}${path.sep}`, C.bold, C.blue));
-
-  const counter  = { count: 0, maxReached: false };
-  const children = tree.children ?? [];
-  const limit = flatFiles.length; // No preview limit for focused --structure
-
-  for (let i = 0; i < children.length; i++) {
-    if (counter.count >= limit) {
-      console.log(`${CHARS.corner}${paint('...', C.dim)}`);
-      break;
-    }
-    renderTree(children[i], '', i === children.length - 1, counter, limit, 0, Infinity);
-    if (counter.maxReached) break;
-  }
-}

package/src/renderers/index.js

@@ -1,41 +0,0 @@
-/**
- * @fileoverview Toren — Renderer Registry
- *
- * Maps format-name strings to their render functions.
- *
- * ┌─────────────────────────────────────────────────────────┐
- * │  How to add a new output format:                        │
- * │                                                         │
- * │  1. Create src/renderers/<format>-renderer.js           │
- * │     and export:  render(result, options?) => void       │
- * │                                                         │
- * │  2. Import it here and add one line to RENDERERS.       │
- * │                                                         │
- * │  No changes to bin/toren.js or scan.js are needed.     │
- * └─────────────────────────────────────────────────────────┘
- *
- * @module renderers/index
- */
-
-import { render as renderConsole   } from './console-renderer.js';
-import { render as renderJson      } from './json-renderer.js';
-import { render as renderMarkdown  } from './markdown-renderer.js';
-import { render as renderHtml      } from './html-renderer.js';
-
-/**
- * Registry of all available output renderers.
- *
- * Keys   — format names accepted by the `--format` flag.
- * Values — render functions with the signature:
- *            render(result: ScanResult, options?: { cwd?: string }) => void
- *
- * @type {Record<string, function(import('../scanner/scan.js').ScanResult, object=): void>}
- */
-const renderers = {
-  console:  renderConsole,
-  json:     renderJson,
-  markdown: renderMarkdown,
-  html:     renderHtml,
-};
-
-export default renderers;

package/src/renderers/json-renderer.js

@@ -1,154 +0,0 @@
-/**
- * @fileoverview Toren — JSON Renderer
- *
- * Consumes a ScanResult and produces a stable, consistently-ordered JSON
- * object suitable for programmatic consumption.
- *
- * Design contract (mirrors all other renderers):
- *  - Accepts a ScanResult and an optional options object.
- *  - Never scans files or modifies the data it receives.
- *  - All arrays are always present — never undefined or missing.
- *  - Property order is fixed and documented below.
- *  - Backward compatible: no existing field is removed or renamed.
- *
- * Output property order:
- *  1. meta          — schema version + generator provenance
- *  2. project       — name (basename), path (relative), detected type
- *  3. frameworks    — derived array of detected frameworks ([] when none)
- *  4. entryPoints   — array of detected entry-point paths
- *  5. configs       — array of detected configuration file paths
- *  6. scripts       — array of { name, command } objects
- *  7. statistics    — file/folder counts and scan duration (structured)
- *  8. structure     — recursive file-tree array
- *  9. summary       — retained for backward compatibility (same data as statistics)
- */
-
-import path from 'node:path';
-import { createRequire } from 'node:module';
-
-const require = createRequire(import.meta.url);
-const pkg     = require('../../package.json');
-
-// ---------------------------------------------------------------------------
-// Tree mapper
-// ---------------------------------------------------------------------------
-
-/**
- * Recursively map an internal DirNode / FileNode to a clean JSON shape.
- * Directory nodes always include a `children` array (never undefined).
- *
- * @param {import('../scanner/scan.js').DirNode | import('../scanner/scan.js').FileNode} node
- * @returns {{ type: 'folder'|'file', name: string, children?: object[] }}
- */
-function mapTree(node) {
-  if (node.type === 'directory') {
-    return {
-      type:     'folder',
-      name:     node.name,
-      children: (node.children || []).map(mapTree),
-    };
-  }
-  return {
-    type: 'file',
-    name: node.name,
-  };
-}
-
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-
-/**
- * Derive a `frameworks` array from the scanner's `projectType` string.
- * Returns a single-element array when a framework is detected, empty otherwise.
- * This is a pure presentation decision — no business logic is added.
- *
- * @param {string} projectType
- * @returns {string[]}
- */
-function deriveFrameworks(projectType) {
-  if (!projectType || projectType === 'Unknown') return [];
-  return [projectType];
-}
-
-// ---------------------------------------------------------------------------
-// Public API
-// ---------------------------------------------------------------------------
-
-/**
- * Render a ScanResult as a stable JSON document to stdout.
- *
- * @param {import('../scanner/scan.js').ScanResult} result
- * @param {{ cwd?: string }} [options]
- */
-export function render(result, options = {}) {
-  const {
-    rootPath,
-    projectType,
-    entryPoints   = [],
-    configs       = [],
-    scripts       = [],
-    tree,
-    flatFiles     = [],
-    totalFolders  = 0,
-    scanDurationMs,
-  } = result;
-
-  const cwd      = options.cwd ?? process.cwd();
-  const relRoot   = path.relative(cwd, rootPath) || '.';
-  const rootName  = path.basename(rootPath) || relRoot;
-
-  // Shared statistics values — computed once, used in both `statistics` and
-  // the backward-compatible `summary` block.
-  // Guard against NaN/undefined: JSON.stringify(NaN) produces null, breaking
-  // the schema guarantee that durationMs is always a number.
-  const totalFiles = flatFiles.length;
-  const durationMs = Number.isFinite(scanDurationMs) ? Math.round(scanDurationMs) : 0;
-
-  const output = {
-    // 1. Provenance — lets consumers detect schema changes.
-    meta: {
-      generatedBy: 'Toren',
-      version:     pkg.version,
-      schema:      1,
-    },
-
-    // 2. Project identity — name is the human-readable basename; path is the
-    //    relative path used for filesystem resolution.
-    project: {
-      name: rootName,
-      path: relRoot,
-      type: projectType,
-    },
-
-    // 3. Detected frameworks — always an array.
-    frameworks: deriveFrameworks(projectType),
-
-    // 4–6. Discovery results — all arrays, always present, never null.
-    entryPoints: Array.isArray(entryPoints) ? entryPoints : [],
-    configs:     Array.isArray(configs)     ? configs     : [],
-    scripts:     Array.isArray(scripts)     ? scripts     : [],
-
-    // 7. Structured statistics — always a complete object with numeric values.
-    //    durationMs is rounded to the nearest millisecond (integer).
-    statistics: {
-      files:     totalFiles,
-      folders:   totalFolders,
-      durationMs,
-    },
-
-    // 8. File-tree — array of root-level nodes; always present.
-    //    Empty array when the scanned directory is empty.
-    structure: (tree?.children || []).map(mapTree),
-
-    // 9. Backward-compatible summary block — preserved for existing consumers.
-    //    Contains the same data under the original field names.
-    summary: {
-      totalFiles,
-      totalFolders,
-      scanDurationMs: durationMs,
-    },
-  };
-
-  console.log(JSON.stringify(output, null, 2));
-}