@lakindu_perera/toren 1.0.7 → 1.0.9

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@lakindu_perera/toren",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A powerful codebase scanner CLI tool for project analysis, framework detection, and understanding repository structure instantly.",
   "type": "module",
   "bin": {
-    "toren": "bin/toren.js"
+    "toren": "dist/cli/toren.js"
   },
   "files": [
-    "bin",
-    "src",
+    "dist",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "start": "node bin/toren.js",
+    "start": "node dist/cli/toren.js",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc",
     "test": "node --test",
-    "lint": "node --check bin/toren.js src/scanner/scan.js src/lifecycle.js src/renderers/index.js src/renderers/console-renderer.js src/renderers/json-renderer.js src/renderers/markdown-renderer.js src/renderers/html-renderer.js"
+    "lint": "node --check dist/cli/toren.js dist/scanner/scan.js dist/lifecycle.js dist/renderers/index.js dist/renderers/console-renderer.js dist/renderers/json-renderer.js dist/renderers/markdown-renderer.js dist/renderers/html-renderer.js dist/detectors/config-detector.js dist/detectors/script-detector.js dist/detectors/package-manager-detector.js"
   },
   "keywords": [
     "cli tool",
@@ -40,5 +45,9 @@
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.4.0",
+    "typescript": "^7.0.2"
   }
 }

package/bin/toren.js

@@ -1,308 +0,0 @@
-#!/usr/bin/env node
-/**
- * @fileoverview Toren CLI — Entry Point
- *
- * Usage:
- *   toren [path]              Scan <path> (defaults to current directory)
- *   toren --format <type>     Select output format (default: console)
- *   toren --json              Legacy alias for --format json
- *   toren --version           Print version
- *   toren --help              Print usage
- *   toren --doctor            Check global installation health
- *   toren --uninstall         Safely remove global installation
- *   toren --include-hidden    Include hidden files (dot-files) in scan
- *   toren --max-files <N>     Override the max file scan limit
- *
- * Adding a new output format
- * ──────────────────────────
- *   1. Create src/renderers/<format>-renderer.js
- *      and export: render(result, options?) => void
- *   2. Register it in src/renderers/index.js
- *
- *   No changes to this file are required.
- */
-
-import { createRequire } from 'node:module';
-import { scan }          from '../src/scanner/scan.js';
-import renderers         from '../src/renderers/index.js';
-import { getFocusedModeInfo, renderFocusedMode, FOCUSED_FLAGS } from '../src/focused-output.js';
-import { runDoctor, runUninstall } from '../src/lifecycle.js';
-
-const require = createRequire(import.meta.url);
-const pkg     = require('../package.json');
-
-/** Format used when no --format flag is supplied. */
-const DEFAULT_FORMAT = 'console';
-
-/** Derived from the registry — always in sync with available renderers. */
-const SUPPORTED_FORMATS = Object.keys(renderers);
-
-// ---------------------------------------------------------------------------
-// Helpers
-// ---------------------------------------------------------------------------
-
-function printError(title, message, detailLabel, detailValue) {
-  console.error(`\x1b[31m✖ ${title}\x1b[0m\n`);
-  console.error(`${message}\n`);
-  if (detailLabel && detailValue) {
-    console.error(`${detailLabel}:\n`);
-    console.error(`${detailValue}\n`);
-  }
-}
-
-function printHelp() {
-  const formatList = SUPPORTED_FORMATS.map(f => {
-    const suffix = f === DEFAULT_FORMAT ? '  (default)' : '';
-    return `  --format ${f.padEnd(10)}${suffix}`;
-  }).join('\n');
-
-  console.log(`
-\x1b[1mToren\x1b[0m v${pkg.version}
-Fast Repository Discovery CLI
-
-\x1b[1mUSAGE\x1b[0m
-  toren [path] [options]
-
-\x1b[1mCOMMANDS\x1b[0m
-  --project-type      Show detected project type only
-  --frameworks        Show detected frameworks only
-  --entry-points      Show detected entry points only
-  --structure         Show repository structure only
-  --configs           Show detected project configuration files
-  --scripts           Show available package scripts only
-  --include-hidden    Include hidden files and folders
-  --max-files <n>     Set scan file limit
-  --doctor            Run CLI diagnostics
-  --uninstall         Remove Toren global installation
-  --help              Show this help message
-  --version           Show version number
-
-\x1b[1mOUTPUT FORMATS\x1b[0m
-${formatList}
-
-\x1b[1mEXAMPLES\x1b[0m
-  toren .                              Scan the current directory
-  toren ./my-project                   Scan a specific project folder
-  toren --format json .                Output results as JSON
-  toren --format markdown . > out.md   Save a Markdown report to a file
-  toren --format html . > out.html     Save an HTML report to a file
-  toren . --configs                    Show project configuration files
-  toren . --frameworks                 Show detected frameworks
-`);
-}
-
-// ---------------------------------------------------------------------------
-// Argument parsing
-// ---------------------------------------------------------------------------
-
-/**
- * @typedef {Object} ParsedArgs
- * @property {'exit'|'wait'|'scan'} action
- * @property {string}  [target]        - Resolved path to scan
- * @property {string}  [format]        - Renderer format name
- * @property {boolean} [includeHidden] - Whether to include hidden files
- * @property {number}  [maxFiles]      - Max files to scan
- */
-
-/**
- * Parse process.argv into a structured options object.
- *
- * Returns { action: 'exit' } when the process should exit immediately.
- * Returns { action: 'wait' } when an async interactive command is running.
- * Returns { action: 'scan', target, format } for normal scan operations.
- *
- * @returns {ParsedArgs}
- */
-function parseArgs() {
-  const args = process.argv.slice(2);
-
-  // ── Informational flags ─────────────────────────────────────────────────
-  if (args.includes('--help') || args.includes('-h')) {
-    printHelp();
-    return { action: 'exit', code: 0 };
-  }
-
-  if (args.includes('--version') || args.includes('-V') || args.includes('-v')) {
-    console.log(`Toren ${pkg.version}`);
-    return { action: 'exit', code: 0 };
-  }
-
-  // ── Lifecycle commands ──────────────────────────────────────────────────
-  if (args.includes('--doctor')) {
-    runDoctor(pkg.version);
-    return { action: 'exit', code: 0 };
-  }
-
-  if (args.includes('--uninstall')) {
-    runUninstall();
-    return { action: 'wait' };
-  }
-
-  // ── Output format ───────────────────────────────────────────────────────
-  // --json is a legacy alias for --format json, kept for backwards
-  // compatibility. It will be removed in a future major version.
-  let format = DEFAULT_FORMAT;
-
-  const formatIdx = args.indexOf('--format');
-  if (formatIdx !== -1) {
-    const nextToken = args[formatIdx + 1];
-    // If the next token is missing or starts with '-', the user omitted the value.
-    if (nextToken === undefined || nextToken.startsWith('-')) {
-      printError(
-        'Missing value',
-        'The --format flag requires a valid output format.',
-        'Supported formats',
-        SUPPORTED_FORMATS.join(', ')
-      );
-      return { action: 'exit', code: 1 };
-    }
-    format = nextToken;
-  } else if (args.includes('--json')) {
-    format = 'json';
-  }
-
-  // ── Focused Output Flags ────────────────────────────────────────────────
-  const focusedInfo = getFocusedModeInfo(args);
-  
-  if (focusedInfo.error) {
-    printError(focusedInfo.title, focusedInfo.message, focusedInfo.detailLabel, focusedInfo.detailValue);
-    return { action: 'exit', code: 1 };
-  }
-
-  const focusedMode = focusedInfo.mode;
-
-  // ── Hidden files ────────────────────────────────────────────────────────
-  const includeHidden = args.includes('--include-hidden');
-
-  // ── Target path ─────────────────────────────────────────────────────────
-  // Build the set of tokens that are consumed as values by named flags so
-  // we don't accidentally treat them as the positional path argument.
-  const consumedValues = new Set();
-  if (formatIdx !== -1 && args[formatIdx + 1] !== undefined && !args[formatIdx + 1].startsWith('-')) {
-    consumedValues.add(args[formatIdx + 1]);
-  }
-
-  // ── Max files ───────────────────────────────────────────────────────────
-  let maxFiles = undefined;
-  const maxFilesIdx = args.indexOf('--max-files');
-  if (maxFilesIdx !== -1) {
-    const rawVal = args[maxFilesIdx + 1];
-    if (rawVal === undefined || rawVal.startsWith('-')) {
-      printError(
-        'Missing value',
-        'The --max-files flag requires a numeric value.',
-        'Example',
-        'toren --max-files 100000'
-      );
-      return { action: 'exit', code: 1 };
-    }
-    maxFiles = parseInt(rawVal, 10);
-    if (isNaN(maxFiles) || maxFiles < 1) {
-      printError(
-        'Invalid value',
-        'The --max-files flag must be a positive integer.',
-        'Provided value',
-        rawVal
-      );
-      return { action: 'exit', code: 1 };
-    }
-    consumedValues.add(rawVal);
-  }
-
-  // First non-flag, non-consumed token is the target path; default to cwd.
-  const target = args.find(a => !a.startsWith('-') && !consumedValues.has(a)) ?? '.';
-
-  // ── Unknown flag check ──────────────────────────────────────────────────
-  const knownFlags = new Set([
-    '--help', '-h',
-    '--version', '-V', '-v',
-    '--doctor',
-    '--uninstall',
-    '--format',
-    '--json',
-    ...FOCUSED_FLAGS,
-    '--include-hidden',
-    '--max-files',
-  ]);
-
-  const unknownFlag = args.find(
-    a => a.startsWith('-') && !knownFlags.has(a) && !consumedValues.has(a),
-  );
-
-  if (unknownFlag) {
-    printError(
-      'Unknown option',
-      'An unrecognized flag was provided.',
-      'Flag',
-      unknownFlag
-    );
-    return { action: 'exit', code: 1 };
-  }
-
-  return { action: 'scan', target, format, includeHidden, maxFiles, focusedMode };
-}
-
-// ---------------------------------------------------------------------------
-// Format validation
-// ---------------------------------------------------------------------------
-
-/**
- * Assert that `format` has a registered renderer.
- * Prints a descriptive error message and exits with code 1 if not found.
- *
- * @param {string} format
- */
-function assertValidFormat(format) {
-  if (renderers[format]) return;
-
-  printError(
-    'Unsupported output format',
-    'The requested output format is not supported.',
-    'Format',
-    format
-  );
-  process.exit(1);
-}
-
-// ---------------------------------------------------------------------------
-// Main
-// ---------------------------------------------------------------------------
-
-(function main() {
-  const parsed = parseArgs();
-
-  if (parsed.action === 'exit') {
-    process.exit(parsed.code ?? 0);
-  }
-  if (parsed.action === 'wait') return;
-
-  // Validate before scanning — fail fast on bad format names.
-  assertValidFormat(parsed.format);
-
-  const render = renderers[parsed.format];
-
-  try {
-    const result = scan(parsed.target, {
-      includeHidden: parsed.includeHidden,
-      maxFiles:      parsed.maxFiles,
-    });
-    
-    if (parsed.focusedMode) {
-      renderFocusedMode(parsed.focusedMode, result);
-    } else {
-      render(result, { cwd: process.cwd() });
-    }
-  } catch (err) {
-    // Render errors in the requested format where possible.
-    if (parsed.format === 'json') {
-      console.error(JSON.stringify({ error: err.message }, null, 2));
-    } else {
-      if (err.title) {
-        printError(err.title, err.message, err.detailLabel, err.detailValue);
-      } else {
-        printError('Scan failed', err.message);
-      }
-    }
-    process.exit(1);
-  }
-})();

package/src/detectors/config-detector.js

@@ -1,81 +0,0 @@
-/**
- * @fileoverview Configuration file detector
- */
-
-/**
- * Detects common configuration files in the root of the repository.
- *
- * @param {string[]} flatFiles - Array of relative file paths from the scanner
- * @returns {{ configs: string[] }}
- */
-export function detectConfigs(flatFiles) {
-  const configPatterns = [
-    // Package
-    /^package\.json$/,
-    /^package-lock\.json$/,
-    /^pnpm-lock\.yaml$/,
-    /^yarn\.lock$/,
-    /^bun\.lockb$/,
-
-    // TypeScript
-    /^tsconfig\.json$/,
-    /^jsconfig\.json$/,
-
-    // Frontend
-    /^vite\.config\.[a-zA-Z0-9]+$/,
-    /^next\.config\.[a-zA-Z0-9]+$/,
-    /^nuxt\.config\.[a-zA-Z0-9]+$/,
-    /^astro\.config\.[a-zA-Z0-9]+$/,
-    /^angular\.json$/,
-
-    // Build
-    /^webpack\.config\.[a-zA-Z0-9]+$/,
-    /^rollup\.config\.[a-zA-Z0-9]+$/,
-    /^turbo\.json$/,
-    /^nx\.json$/,
-
-    // Styling
-    /^tailwind\.config\.[a-zA-Z0-9]+$/,
-    /^postcss\.config\.[a-zA-Z0-9]+$/,
-
-    // Lint
-    /^eslint\.config\.[a-zA-Z0-9]+$/,
-    /^\.eslintrc.*$/,
-    /^prettier\.config\.[a-zA-Z0-9]+$/,
-    /^\.prettierrc.*$/,
-
-    // Backend
-    /^pom\.xml$/,
-    /^build\.gradle$/,
-    /^build\.gradle\.kts$/,
-
-    // Languages
-    /^requirements\.txt$/,
-    /^pyproject\.toml$/,
-    /^Cargo\.toml$/,
-    /^go\.mod$/,
-
-    // Deployment
-    /^Dockerfile$/,
-    /^docker-compose\.ya?ml$/
-  ];
-
-  const matchedSet = new Set();
-
-  for (const file of flatFiles) {
-    // Ensure we only match files at the root of the repository
-    if (file.includes('/')) continue;
-
-    for (const pattern of configPatterns) {
-      if (pattern.test(file)) {
-        matchedSet.add(file);
-        break; // Stop checking patterns once a match is found
-      }
-    }
-  }
-
-  // Convert Set to Array and sort alphabetically
-  const configs = Array.from(matchedSet).sort();
-
-  return { configs };
-}

package/src/detectors/script-detector.js

@@ -1,32 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-/**
- * Detects npm/package scripts from package.json in the project root.
- *
- * @param {string} rootPath - The absolute path of the scanned root
- * @returns {{ scripts: Array<{name: string, command: string}> }}
- */
-export function detectScripts(rootPath) {
-  const scripts = [];
-  const pkgPath = path.join(rootPath, 'package.json');
-
-  try {
-    if (fs.existsSync(pkgPath)) {
-      const content = fs.readFileSync(pkgPath, 'utf8');
-      const pkg = JSON.parse(content);
-
-      if (pkg.scripts && typeof pkg.scripts === 'object') {
-        for (const [name, command] of Object.entries(pkg.scripts)) {
-          if (typeof command === 'string') {
-            scripts.push({ name, command });
-          }
-        }
-      }
-    }
-  } catch (error) {
-    // Return empty scripts on malformed or unreadable package.json
-  }
-
-  return { scripts };
-}

package/src/focused-output.js

@@ -1,146 +0,0 @@
-/**
- * @fileoverview Toren — Focused Output Mode Handler
- *
- * Handles the six focused output flags:
- *   --project-type  --frameworks  --entry-points
- *   --structure     --configs     --scripts
- *
- * Design contract:
- *  - Each flag renders exactly one section to stdout using the console visual
- *    style (ANSI colours, section header + divider).
- *  - Empty-state messages are canonical strings declared in EMPTY below.
- *    They must end with a period and stay in sync with console-renderer.js.
- *  - No business logic. All data comes from the ScanResult passed in.
- *  - Stateless: renderFocusedMode() may be called multiple times safely.
- */
-
-import { renderStructure } from './renderers/console-renderer.js';
-
-// ---------------------------------------------------------------------------
-// Canonical empty-state messages
-// Keep these in sync with the equivalent strings in console-renderer.js.
-// ---------------------------------------------------------------------------
-
-const EMPTY = {
-  frameworks:  'No frameworks detected.',
-  entryPoints: 'No entry points detected.',
-  configs:     'No configuration files detected.',
-  scripts:     'No package scripts detected.',
-};
-
-export const FOCUSED_FLAGS = [
-  '--project-type',
-  '--frameworks',
-  '--entry-points',
-  '--structure',
-  '--configs',
-  '--scripts'
-];
-
-/**
- * Validates focused flags in the provided arguments.
- * 
- * @param {string[]} args Process arguments
- * @returns {{ error: boolean, message?: string, mode?: string|null }}
- */
-export function getFocusedModeInfo(args) {
-  const activeFlags = FOCUSED_FLAGS.filter(flag => args.includes(flag));
-  
-  if (activeFlags.length > 1) {
-    return {
-      error: true,
-      title: 'Conflicting options',
-      message: 'Focused output flags are mutually exclusive.',
-      detailLabel: 'Provided flags',
-      detailValue: activeFlags.join(', ')
-    };
-  }
-
-  return {
-    error: false,
-    mode: activeFlags[0] || null
-  };
-}
-
-/**
- * Print a bold-white section title followed by a dim matched-length divider
- * and a blank line — same visual pattern as console-renderer.js's section().
- *
- * @param {string} title
- */
-function printSectionHeader(title) {
-  console.log(`\x1b[1m\x1b[97m${title}\x1b[0m`);
-  console.log(`\x1b[2m${'─'.repeat(title.length)}\x1b[0m`);
-  console.log('');
-}
-
-/**
- * Print a focused section: header, then items or an empty-state message.
- *
- * @param {string}   title    - Section heading
- * @param {string[]} items    - Pre-formatted lines to print
- * @param {string}   emptyMsg - Canonical empty-state message (ends with '.')
- */
-function section(title, items, emptyMsg) {
-  printSectionHeader(title);
-
-  if (!items || items.length === 0) {
-    console.log(`\x1b[2m${emptyMsg}\x1b[0m`);
-  } else {
-    for (const item of items) {
-      console.log(item);
-    }
-  }
-}
-
-/**
- * Renders the scan result based on the active focused mode.
- * 
- * @param {string} mode Active focused mode flag
- * @param {import('./scanner/scan.js').ScanResult} result 
- */
-export function renderFocusedMode(mode, result) {
-  switch (mode) {
-    case '--project-type': {
-      // projectType is always a string; 'Unknown' when undetected.
-      section('Project Type', [result.projectType], 'Unknown');
-      break;
-    }
-
-    case '--frameworks': {
-      const frameworks = (!result.projectType || result.projectType === 'Unknown')
-        ? []
-        : [result.projectType];
-      section('Frameworks', frameworks, EMPTY.frameworks);
-      break;
-    }
-
-    case '--entry-points': {
-      section('Entry Points', result.entryPoints || [], EMPTY.entryPoints);
-      break;
-    }
-
-    case '--structure': {
-      renderStructure(result);
-      break;
-    }
-
-    case '--configs': {
-      section('Configuration Files', result.configs || [], EMPTY.configs);
-      break;
-    }
-
-    case '--scripts': {
-      const scriptsList = [];
-      if (result.scripts && result.scripts.length > 0) {
-        const maxNameLen = Math.max(...result.scripts.map(s => s.name.length));
-        for (const s of result.scripts) {
-          const paddedName = s.name.padEnd(maxNameLen, ' ');
-          scriptsList.push(`\x1b[97m${paddedName}\x1b[0m  \x1b[2m${s.command}\x1b[0m`);
-        }
-      }
-      section('Package Scripts', scriptsList, EMPTY.scripts);
-      break;
-    }
-  }
-}