@lakindu_perera/toren 1.0.4 → 1.0.5

package/README.md

@@ -67,6 +67,8 @@ toren --project-type
 toren --frameworks
 toren --entry-points
 toren --structure
+toren --configs
+toren --scripts
 
 # Lifecycle & Help Commands
 toren --help
@@ -84,6 +86,8 @@ toren --uninstall
 | `--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. |
 | `--format <type>` | Output format: `console` (default), `json`, `markdown`, `html`. |
 | `--include-hidden` | Include hidden files and dot-directories in the scan. |
 | `--max-files <N>` | Override the default 50,000-file scan limit. |
@@ -93,7 +97,7 @@ toren --uninstall
 | `--uninstall` | Safely remove Toren from the global npm environment. |
 
 > **Note:** `--format md` is not a valid alias. Use `--format markdown` in full.
-> **Note:** Focused output flags (`--project-type`, `--frameworks`, `--entry-points`, `--structure`) are mutually exclusive.
+> **Note:** Focused output flags (`--project-type`, `--frameworks`, `--entry-points`, `--structure`, `--configs`, `--scripts`) are mutually exclusive.
 
 ---
 
@@ -113,6 +117,19 @@ Frameworks:
 $ toren --entry-points
 Entry Points:
 - src/main.tsx
+
+$ toren --configs
+Configuration Files
+───────────────────
+
+✓ package.json
+✓ vite.config.ts
+
+$ toren --scripts
+Available Scripts
+
+start      node bin/toren.js
+test       node --test
 ```
 
 ### Console Output Example
@@ -121,7 +138,7 @@ The default `console` format renders a beautiful summary directly in your termin
 ```text
   Toren v1.0.4  —  Codebase Onboarding Intelligence
 
-🔍  Project Summary
+ Project Summary
 ────────────────────────────────────────────────────────────────────────────────
   Path:          ./my-react-app
   Project type:  React
@@ -129,11 +146,11 @@ The default `console` format renders a beautiful summary directly in your termin
   Total folders: 6
   Scan duration: 4 ms
 
-🚪  Entry Points
+ Entry Points
 ────────────────────────────────────────────────────────────────────────────────
   →  src/main.tsx
 
-📁  Folder Structure  (first 20 files)
+ Folder Structure  (first 20 files)
 ────────────────────────────────────────────────────────────────────────────────
 my-react-app/
 ├── public/
@@ -151,7 +168,7 @@ my-react-app/
   … and 21 more file(s) not shown
 
 ────────────────────────────────────────────────────────────────────────────────
-  ✅  Scan complete.
+  Scan complete.
 ```
 
 ### JSON Output Example
@@ -236,12 +253,12 @@ Contributions to improve this codebase analyzer CLI are always welcome!
 
 ---
 
-## 📄 License
+## License
 
 Distributed under the MIT License. See `LICENSE` for more information.
 
 ---
 
-## 👨‍💻 Author
+## Author
 
 Built with by **[Lakindu Perera](https://github.com/lakindudev)**.

package/bin/toren.js

@@ -52,6 +52,8 @@ function printHelp() {
   --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
   --format <type>     Output as console, json, markdown, or html
   --include-hidden    Include hidden files and folders
   --max-files <n>     Set scan file limit

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lakindu_perera/toren",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A powerful codebase scanner CLI tool for project analysis, framework detection, and understanding repository structure instantly.",
   "type": "module",
   "bin": {
@@ -14,6 +14,7 @@
   ],
   "scripts": {
     "start": "node bin/toren.js",
+    "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"
   },
   "keywords": [

package/src/detectors/config-detector.js

@@ -0,0 +1,81 @@
+/**
+ * @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

@@ -0,0 +1,32 @@
+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

@@ -8,7 +8,9 @@ export const FOCUSED_FLAGS = [
   '--project-type',
   '--frameworks',
   '--entry-points',
-  '--structure'
+  '--structure',
+  '--configs',
+  '--scripts'
 ];
 
 /**
@@ -67,5 +69,28 @@ export function renderFocusedMode(mode, result) {
     case '--structure':
       renderStructure(result);
       break;
+      
+    case '--configs':
+      console.log('Configuration Files');
+      console.log('───────────────────\n');
+      if (!result.configs || result.configs.length === 0) {
+        console.log('No configuration files detected.');
+      } else {
+        result.configs.forEach(c => console.log(`✓ ${c}`));
+      }
+      break;
+
+    case '--scripts':
+      console.log('Available Scripts\n');
+      if (!result.scripts || result.scripts.length === 0) {
+        console.log('No scripts found');
+      } else {
+        const maxNameLen = Math.max(...result.scripts.map(s => s.name.length));
+        result.scripts.forEach(s => {
+          const paddedName = s.name.padEnd(maxNameLen + 6, ' ');
+          console.log(`${paddedName}${s.command}`);
+        });
+      }
+      break;
   }
 }

package/src/renderers/console-renderer.js

@@ -173,6 +173,8 @@ export function render(result, options = {}) {
     rootPath,
     projectType,
     entryPoints,
+    configs = [],
+    scripts = [],
     tree,
     flatFiles,
     totalFolders,
@@ -204,6 +206,28 @@ export function render(result, options = {}) {
     }
   }
 
+  // ── 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)}`);
+    }
+  }
+
+  // ── 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)}`);
+    }
+  }
+
   // ── Structure Preview ─────────────────────────────────────────────────────
   section('📁', `Folder Structure  ${paint(`(first ${PREVIEW_LIMIT} files)`, C.dim)}`);
 

package/src/renderers/html-renderer.js

@@ -625,6 +625,7 @@ const icon = {
   tree:    () => `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/></svg>`,
   bar:     () => `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><line x1="18" y1="20" x2="18" y2="10"/><line x1="12" y1="20" x2="12" y2="4"/><line x1="6" y1="20" x2="6" y2="14"/></svg>`,
   info:    () => `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="10"/><line x1="12" y1="16" x2="12" y2="12"/><line x1="12" y1="8" x2="12.01" y2="8"/></svg>`,
+  terminal: () => `<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="4 17 10 11 4 5"/><line x1="12" y1="19" x2="20" y2="19"/></svg>`,
 };
 
 // ---------------------------------------------------------------------------
@@ -748,6 +749,82 @@ function renderEntryPoints(entryPoints) {
   </div>`;
 }
 
+/**
+ * Render the configuration files section.
+ *
+ * @param {string[]} configs
+ * @returns {string}
+ */
+function renderConfigurationFiles(configs) {
+  const count = configs.length;
+
+  const body = count === 0
+    ? `<p class="empty-msg">No configuration files detected.</p>`
+    : `<ul class="entry-list">
+        ${configs.map(c => `
+          <li class="entry-item">
+            <span class="entry-dot"></span>
+            ${esc(c)}
+          </li>`).join('')}
+       </ul>`;
+
+  const countBadge = count > 0
+    ? `<span class="section-count">${count} found</span>`
+    : '';
+
+  return `
+  <div class="section">
+    <div class="section-header">
+      <div class="section-icon">${icon.file()}</div>
+      <span class="section-title">Configuration Files</span>
+      ${countBadge}
+    </div>
+    <div class="section-body">${body}</div>
+  </div>`;
+}
+
+/**
+ * Render the package scripts section.
+ *
+ * @param {Array<{name: string, command: string}>} scripts
+ * @returns {string}
+ */
+function renderPackageScripts(scripts) {
+  const count = scripts.length;
+
+  const body = count === 0
+    ? `<p class="empty-msg" style="padding: 1.5rem">No package scripts detected.</p>`
+    : `<table class="data-table">
+        <thead>
+          <tr>
+            <th>Script</th>
+            <th>Command</th>
+          </tr>
+        </thead>
+        <tbody>
+          ${scripts.map(s => `
+            <tr>
+              <td><code>${esc(s.name)}</code></td>
+              <td class="val-plain"><code>${esc(s.command)}</code></td>
+            </tr>`).join('')}
+        </tbody>
+       </table>`;
+
+  const countBadge = count > 0
+    ? `<span class="section-count">${count} found</span>`
+    : '';
+
+  return `
+  <div class="section">
+    <div class="section-header">
+      <div class="section-icon">${icon.terminal()}</div>
+      <span class="section-title">Package Scripts</span>
+      ${countBadge}
+    </div>
+    <div class="section-body" style="padding:0">${body}</div>
+  </div>`;
+}
+
 /**
  * Render the folder structure section with a dark <pre><code> tree.
  *
@@ -873,7 +950,7 @@ function renderFooter() {
  * @param {{ cwd?: string }} [options]
  */
 export function render(result, options = {}) {
-  const { rootPath, projectType, entryPoints, flatFiles } = result;
+  const { rootPath, projectType, entryPoints, configs = [], scripts = [], flatFiles } = result;
 
   const cwd      = options.cwd ?? process.cwd();
   const relRoot  = path.relative(cwd, rootPath) || '.';
@@ -898,6 +975,8 @@ export function render(result, options = {}) {
     <main>
       ${renderSummaryCards(result)}
       ${renderEntryPoints(entryPoints)}
+      ${renderConfigurationFiles(configs)}
+      ${renderPackageScripts(scripts)}
       ${renderFolderStructure(flatFiles, rootName)}
       ${renderStats(result)}
       ${renderScanInfo()}

package/src/renderers/json-renderer.js

@@ -26,6 +26,8 @@ export function render(result, options = {}) {
     rootPath,
     projectType,
     entryPoints,
+    configs = [],
+    scripts = [],
     tree,
     flatFiles,
     totalFolders,
@@ -47,6 +49,8 @@ export function render(result, options = {}) {
       scanDurationMs: Math.round(scanDurationMs),
     },
     entryPoints,
+    configs,
+    scripts,
     structure: (tree.children || []).map(mapTree)
   };
 

package/src/renderers/markdown-renderer.js

@@ -218,6 +218,50 @@ function sectionSummary(out, result, relRoot) {
   out.push('---');
 }
 
+/**
+ * @param {string[]} out
+ * @param {string[]} configs
+ */
+function sectionConfigurationFiles(out, configs) {
+  out.push('');
+  out.push('## Configuration Files');
+  out.push('');
+
+  if (configs.length === 0) {
+    out.push('No configuration files detected.');
+  } else {
+    for (const c of configs) {
+      out.push(`- ${c}`);
+    }
+  }
+
+  out.push('');
+  out.push('---');
+}
+
+/**
+ * @param {string[]} out
+ * @param {Array<{name: string, command: string}>} scripts
+ */
+function sectionPackageScripts(out, scripts) {
+  out.push('');
+  out.push('## Package Scripts');
+  out.push('');
+
+  if (scripts.length === 0) {
+    out.push('No package scripts detected.');
+  } else {
+    out.push('| Script | Command |');
+    out.push('|--------|---------|');
+    for (const s of scripts) {
+      out.push(`| \`${s.name}\` | \`${s.command}\` |`);
+    }
+  }
+
+  out.push('');
+  out.push('---');
+}
+
 /**
  * @param {string[]} out
  * @param {string[]} entryPoints
@@ -308,7 +352,7 @@ function sectionScanInfo(out) {
  * @param {{ cwd?: string }} [options]
  */
 export function render(result, options = {}) {
-  const { rootPath, entryPoints, flatFiles } = result;
+  const { rootPath, entryPoints, configs = [], scripts = [], flatFiles } = result;
 
   const cwd     = options.cwd ?? process.cwd();
   const relRoot  = path.relative(cwd, rootPath) || '.';
@@ -320,6 +364,8 @@ export function render(result, options = {}) {
   sectionTitle(out);
   sectionSummary(out, result, relRoot);
   sectionEntryPoints(out, entryPoints);
+  sectionConfigurationFiles(out, configs);
+  sectionPackageScripts(out, scripts);
   sectionFolderStructure(out, flatFiles, rootName);
   sectionStatistics(out, result);
   sectionScanInfo(out);

package/src/scanner/scan.js

@@ -20,6 +20,8 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
+import { detectConfigs } from '../detectors/config-detector.js';
+import { detectScripts } from '../detectors/script-detector.js';
 
 // ---------------------------------------------------------------------------
 // Constants
@@ -96,6 +98,8 @@ const PROJECT_TYPE_MARKERS = [
  * @property {string}              rootPath       - Absolute path that was scanned
  * @property {string}              projectType    - Detected project type label
  * @property {Array<string>}       entryPoints    - Relative paths of detected entry points
+ * @property {Array<string>}       configs        - Relative paths of detected config files
+ * @property {Array<{name: string, command: string}>} scripts - Parsed package scripts
  * @property {DirNode}             tree           - Full in-memory file tree
  * @property {Array<string>}       flatFiles      - All relative file paths (flat list)
  * @property {number}              totalFolders   - Total number of directories walked
@@ -453,6 +457,10 @@ export function scan(targetPath, options = {}) {
   const flatFiles   = [];
   /** @type {Array<string>} */
   let entryPoints = [];
+  /** @type {Array<string>} */
+  let configs = [];
+  /** @type {Array<{name: string, command: string}>} */
+  let scripts = [];
 
   const startTime   = performance.now();
   let tree;
@@ -465,6 +473,8 @@ export function scan(targetPath, options = {}) {
     // Count all directory nodes in the tree (excluding root itself).
     totalFolders = countFolders(tree) - 1;
     entryPoints = findEntryPoints(projectType, flatFiles, rootPath);
+    configs = detectConfigs(flatFiles).configs;
+    scripts = detectScripts(rootPath).scripts;
   } else if (stat.isFile()) {
     const relFilePath = toPosix(path.basename(rootPath));
     tree = {
@@ -481,6 +491,8 @@ export function scan(targetPath, options = {}) {
     };
     flatFiles.push(relFilePath);
     entryPoints = [relFilePath]; // A single file is its own entry point
+    configs = detectConfigs(flatFiles).configs;
+    scripts = detectScripts(path.dirname(rootPath)).scripts;
   } else {
     throw new Error(`Path is neither a file nor a directory: ${rootPath}`);
   }
@@ -491,6 +503,8 @@ export function scan(targetPath, options = {}) {
     rootPath,
     projectType,
     entryPoints,
+    configs,
+    scripts,
     tree,
     flatFiles,
     totalFolders,