@lakindu_perera/toren 1.0.7 → 1.0.8

package/src/renderers/html-renderer.js

@@ -804,6 +804,118 @@ function renderConfigurationFiles(configs) {
  * @param {Array<{name: string, command: string}>} scripts
  * @returns {string}
  */
+function renderProjectInfo(projectInfo, packageManager) {
+  const rows = [];
+  if (projectInfo?.name) rows.push(['Name', projectInfo.name]);
+  if (packageManager) rows.push(['Package Manager', packageManager]);
+  if (projectInfo?.runtime) rows.push(['Runtime', projectInfo.runtime]);
+  if (projectInfo?.language) rows.push(['Language', projectInfo.language]);
+  if (projectInfo?.architecture) rows.push(['Architecture', projectInfo.architecture]);
+  if (projectInfo?.framework) rows.push(['Framework', projectInfo.framework]);
+  if (projectInfo?.entryPoint) rows.push(['Entry Point', projectInfo.entryPoint]);
+  if (projectInfo?.sourceDirectory) rows.push(['Source Directory', projectInfo.sourceDirectory]);
+
+  if (rows.length === 0) return '';
+
+  const rowsHTML = rows.map(([prop, value]) => `
+    <tr>
+      <td>${esc(prop)}</td>
+      <td class="val-plain">${esc(value)}</td>
+    </tr>`).join('');
+
+  return `
+  <section class="section">
+    <div class="section-header">
+      <div class="section-icon">${icon.info()}</div>
+      <h2 class="section-title">Project Info</h2>
+    </div>
+    <div class="section-body" style="padding:0">
+      <table class="data-table">
+        <thead>
+          <tr>
+            <th>Property</th>
+            <th style="text-align:right">Value</th>
+          </tr>
+        </thead>
+        <tbody>${rowsHTML}</tbody>
+      </table>
+    </div>
+  </section>`;
+}
+
+function renderImportantFiles(importantFiles) {
+  const count = importantFiles.length;
+
+  const body = count === 0
+    ? `<p class="empty-msg" style="padding: 1.5rem">No important files detected.</p>`
+    : `<table class="data-table">
+        <thead>
+          <tr>
+            <th>Path</th>
+            <th>Reason</th>
+          </tr>
+        </thead>
+        <tbody>
+          ${importantFiles.map(f => `
+            <tr>
+              <td><code>${esc(f.path)}</code></td>
+              <td class="val-plain">${esc(f.reason)}</td>
+            </tr>`).join('')}
+        </tbody>
+       </table>`;
+
+  const countBadge = count > 0
+    ? `<span class="section-count">${count} found</span>`
+    : '';
+
+  return `
+  <section class="section">
+    <div class="section-header">
+      <div class="section-icon">${icon.file()}</div>
+      <h2 class="section-title">Important Files</h2>
+      ${countBadge}
+    </div>
+    <div class="section-body" style="padding:0">
+      ${body}
+    </div>
+  </section>`;
+}
+
+function renderProjectHealth(health) {
+  const count = health.length;
+
+  const body = count === 0
+    ? `<p class="empty-msg" style="padding: 1.5rem">No project health observations available.</p>`
+    : `<ul class="entry-list">
+        ${health.map(h => {
+          let emoji = 'ℹ';
+          if (h.status === 'pass') emoji = '✓';
+          else if (h.status === 'warning') emoji = '⚠';
+          return `
+          <li class="entry-item">
+            <span>${esc(emoji)}</span>
+            ${esc(h.message)}
+          </li>`;
+        }).join('')}
+       </ul>`;
+
+  const countBadge = count > 0
+    ? `<span class="section-count">${count} observations</span>`
+    : '';
+
+  return `
+  <section class="section">
+    <div class="section-header">
+      <div class="section-icon">${icon.info()}</div>
+      <h2 class="section-title">Project Health</h2>
+      ${countBadge}
+    </div>
+    <div class="section-body">
+      ${body}
+    </div>
+  </section>`;
+}
+
 function renderPackageScripts(scripts) {
   const count = scripts.length;
 
@@ -812,16 +924,21 @@ function renderPackageScripts(scripts) {
     : `<table class="data-table">
         <thead>
           <tr>
-            <th>Script</th>
+            <th>Usage</th>
+            <th>Description</th>
             <th>Command</th>
           </tr>
         </thead>
         <tbody>
-          ${scripts.map(s => `
+          ${scripts.map(s => {
+            const usage = s.usage || `npm run ${s.name}`;
+            return `
             <tr>
-              <td><code>${esc(s.name)}</code></td>
+              <td><code>${esc(usage)}</code></td>
+              <td class="val-plain">${esc(s.description || '')}</td>
               <td class="val-plain"><code>${esc(s.command)}</code></td>
-            </tr>`).join('')}
+            </tr>`;
+          }).join('')}
         </tbody>
        </table>`;
 
@@ -836,7 +953,9 @@ function renderPackageScripts(scripts) {
       <h2 class="section-title">Package Scripts</h2>
       ${countBadge}
     </div>
-    <div class="section-body" style="padding:0">${body}</div>
+    <div class="section-body" style="padding:0">
+      ${body}
+    </div>
   </section>`;
 }
 
@@ -966,7 +1085,7 @@ function renderFooter() {
  * @param {{ cwd?: string }} [options]
  */
 export function render(result, options = {}) {
-  const { rootPath, projectType, entryPoints, configs = [], scripts = [], flatFiles, tree } = result;
+  const { rootPath, projectType, entryPoints, configs = [], scripts = [], flatFiles, tree, importantFiles = [], health = [], projectInfo, packageManager } = result;
 
   const cwd      = options.cwd ?? process.cwd();
   const relRoot  = path.relative(cwd, rootPath) || '.';
@@ -990,6 +1109,9 @@ export function render(result, options = {}) {
 
     <main>
       ${renderSummaryCards(result)}
+      ${renderProjectInfo(projectInfo, packageManager)}
+      ${renderProjectHealth(health)}
+      ${renderImportantFiles(importantFiles)}
       ${renderFrameworks(projectType)}
       ${renderEntryPoints(entryPoints)}
       ${renderConfigurationFiles(configs)}

package/src/renderers/json-renderer.js

@@ -88,6 +88,10 @@ export function render(result, options = {}) {
     entryPoints   = [],
     configs       = [],
     scripts       = [],
+    packageManager,
+    importantFiles = [],
+    projectInfo = null,
+    health        = [],
     tree,
     flatFiles     = [],
     totalFolders  = 0,
@@ -116,9 +120,16 @@ export function render(result, options = {}) {
     // 2. Project identity — name is the human-readable basename; path is the
     //    relative path used for filesystem resolution.
     project: {
-      name: rootName,
+      name: (projectInfo && projectInfo.name) ? projectInfo.name : rootName,
       path: relRoot,
       type: projectType,
+      packageManager: packageManager || null,
+      runtime: projectInfo ? projectInfo.runtime : null,
+      language: projectInfo ? projectInfo.language : null,
+      framework: projectInfo ? projectInfo.framework : null,
+      architecture: projectInfo ? projectInfo.architecture : null,
+      entryPoint: projectInfo ? projectInfo.entryPoint : null,
+      sourceDirectory: projectInfo ? projectInfo.sourceDirectory : null,
     },
 
     // 3. Detected frameworks — always an array.
@@ -128,6 +139,9 @@ export function render(result, options = {}) {
     entryPoints: Array.isArray(entryPoints) ? entryPoints : [],
     configs:     Array.isArray(configs)     ? configs     : [],
     scripts:     Array.isArray(scripts)     ? scripts     : [],
+    
+    importantFiles: Array.isArray(importantFiles) ? importantFiles : [],
+    health:         Array.isArray(health)         ? health         : [],
 
     // 7. Structured statistics — always a complete object with numeric values.
     //    durationMs is rounded to the nearest millisecond (integer).

package/src/renderers/markdown-renderer.js

@@ -177,17 +177,28 @@ function sectionTitle(out) {
  * @param {string} relRoot
  */
 function sectionSummary(out, result, relRoot) {
-  const { projectType, flatFiles, totalFolders } = result;
+  const { projectType, flatFiles, totalFolders, packageManager, projectInfo } = result;
 
   out.push('');
   out.push('## Project');
   out.push('');
-  out.push(markdownTable([
-    ['Project Type', projectType],
-    ['Scan Path',    relRoot],
-    ['Total Files',  String(flatFiles.length)],
-    ['Total Folders', String(totalFolders)],
-  ]));
+  
+  const rows = [];
+  if (projectInfo && projectInfo.name) rows.push(['Name', projectInfo.name]);
+  rows.push(['Project Type', projectType]);
+  if (packageManager) rows.push(['Package Manager', packageManager]);
+  if (projectInfo && projectInfo.runtime) rows.push(['Runtime', projectInfo.runtime]);
+  if (projectInfo && projectInfo.language) rows.push(['Language', projectInfo.language]);
+  if (projectInfo && projectInfo.architecture) rows.push(['Architecture', projectInfo.architecture]);
+  if (projectInfo && projectInfo.framework) rows.push(['Framework', projectInfo.framework]);
+  if (projectInfo && projectInfo.entryPoint) rows.push(['Entry Point', projectInfo.entryPoint]);
+  if (projectInfo && projectInfo.sourceDirectory) rows.push(['Source Directory', projectInfo.sourceDirectory]);
+
+  rows.push(['Scan Path', relRoot]);
+  rows.push(['Total Files', String(flatFiles.length)]);
+  rows.push(['Total Folders', String(totalFolders)]);
+
+  out.push(markdownTable(rows));
 }
 
 /**
@@ -230,7 +241,7 @@ function sectionConfigurationFiles(out, configs) {
 
 /**
  * @param {string[]} out
- * @param {Array<{name: string, command: string}>} scripts
+ * @param {Array<{name: string, command: string, description: string, usage: string}>} scripts
  */
 function sectionPackageScripts(out, scripts) {
   out.push('');
@@ -241,7 +252,54 @@ function sectionPackageScripts(out, scripts) {
     out.push('No package scripts detected.');
   } else {
     for (const s of scripts) {
-      out.push(`- ${s.name}: ${s.command}`);
+      const usage = s.usage || `npm run ${s.name}`;
+      out.push(`- **${usage}**`);
+      if (s.description) {
+        out.push(`  ${s.description}  `);
+        out.push(`  \`${s.command}\``);
+      } else {
+        out.push(`  \`${s.command}\``);
+      }
+    }
+  }
+}
+
+/**
+ * @param {string[]} out
+ * @param {Array<{path: string, reason: string}>} importantFiles
+ */
+function sectionImportantFiles(out, importantFiles) {
+  out.push('');
+  out.push('## Important Files');
+  out.push('');
+
+  if (importantFiles.length === 0) {
+    out.push('No important files detected.');
+  } else {
+    for (const f of importantFiles) {
+      out.push(`- **${f.path}**  `);
+      out.push(`  ${f.reason}`);
+    }
+  }
+}
+
+/**
+ * @param {string[]} out
+ * @param {Array<{id: string, status: string, message: string}>} health
+ */
+function sectionProjectHealth(out, health) {
+  out.push('');
+  out.push('## Project Health');
+  out.push('');
+
+  if (health.length === 0) {
+    out.push('No project health observations available.');
+  } else {
+    for (const h of health) {
+      let icon = 'ℹ';
+      if (h.status === 'pass') icon = '✓';
+      else if (h.status === 'warning') icon = '⚠';
+      out.push(`- ${icon} ${h.message}`);
     }
   }
 }
@@ -315,7 +373,7 @@ function sectionStatistics(out, result) {
  * @param {{ cwd?: string }} [options]
  */
 export function render(result, options = {}) {
-  const { rootPath, projectType, entryPoints, configs = [], scripts = [], flatFiles, tree } = result;
+  const { rootPath, projectType, entryPoints, configs = [], scripts = [], flatFiles, tree, importantFiles = [], health = [] } = result;
 
   const cwd     = options.cwd ?? process.cwd();
   const relRoot  = path.relative(cwd, rootPath) || '.';
@@ -326,6 +384,8 @@ export function render(result, options = {}) {
 
   sectionTitle(out);
   sectionSummary(out, result, relRoot);
+  sectionProjectHealth(out, health);
+  sectionImportantFiles(out, importantFiles);
   sectionFrameworks(out, projectType);
   sectionEntryPoints(out, entryPoints);
   sectionConfigurationFiles(out, configs);

package/src/scanner/scan.js

@@ -20,8 +20,12 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { detectConfigs } from '../detectors/config-detector.js';
-import { detectScripts } from '../detectors/script-detector.js';
+import { detectConfigs }         from '../detectors/config-detector.js';
+import { detectScripts }         from '../detectors/script-detector.js';
+import { detectPackageManager }  from '../detectors/package-manager-detector.js';
+import { detectImportantFiles }  from '../detectors/important-files-detector.js';
+import { detectProjectInfo }     from '../detectors/project-info-detector.js';
+import { detectHealth }          from '../detectors/health-detector.js';
 
 // ---------------------------------------------------------------------------
 // Constants
@@ -99,7 +103,8 @@ const PROJECT_TYPE_MARKERS = [
  * @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 {Array<{name: string, command: string, category: string|null, description: string|null, usage: string}>} scripts - Parsed and enriched package scripts
+ * @property {string|null}         packageManager - Detected package manager, or null if none/ambiguous
  * @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
@@ -475,12 +480,17 @@ export function scan(targetPath, options = {}) {
   let configs = [];
   /** @type {Array<{name: string, command: string}>} */
   let scripts = [];
+  /** @type {string|null} */
+  let packageManager = null;
+  let importantFiles = [];
+  let projectInfo = null;
+  let health = [];
 
   const startTime   = performance.now();
   let tree;
   let projectType = 'Unknown';
   let totalFolders = 0;
-
+  
   if (stat.isDirectory()) {
     tree = walkDirectory(rootPath, rootPath, flatFiles, includeHidden, maxFiles);
     projectType = detectProjectType(rootPath);
@@ -488,7 +498,11 @@ export function scan(targetPath, options = {}) {
     totalFolders = countFolders(tree) - 1;
     entryPoints = findEntryPoints(projectType, flatFiles, rootPath);
     configs = detectConfigs(flatFiles).configs;
-    scripts = detectScripts(rootPath).scripts;
+    packageManager = detectPackageManager(flatFiles).packageManager;
+    scripts = detectScripts(rootPath, packageManager).scripts;
+    importantFiles = detectImportantFiles({ flatFiles, projectType, entryPoints, configs }).importantFiles;
+    projectInfo = detectProjectInfo({ rootPath, projectType, flatFiles, entryPoints, packageManager, scripts }).projectInfo;
+    health = detectHealth({ flatFiles, configs, importantFiles, scripts, projectType }).health;
   } else if (stat.isFile()) {
     const relFilePath = toPosix(path.basename(rootPath));
     tree = {
@@ -506,7 +520,11 @@ 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;
+    packageManager = detectPackageManager(flatFiles).packageManager;
+    scripts = detectScripts(path.dirname(rootPath), packageManager).scripts;
+    importantFiles = detectImportantFiles({ flatFiles, projectType, entryPoints, configs }).importantFiles;
+    projectInfo = detectProjectInfo({ rootPath, projectType, flatFiles, entryPoints, packageManager, scripts }).projectInfo;
+    health = detectHealth({ flatFiles, configs, importantFiles, scripts, projectType }).health;
   } else {
     const err = new Error(`Path is neither a file nor a directory: ${rootPath}`);
     err.title = 'Unsupported path type';
@@ -524,6 +542,10 @@ export function scan(targetPath, options = {}) {
     entryPoints,
     configs,
     scripts,
+    packageManager,
+    importantFiles,
+    projectInfo,
+    health,
     tree,
     flatFiles,
     totalFolders,