@lakindu_perera/toren 1.0.7 → 1.0.8

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.7] - 2026-08-29
+### Added
+- **Project Intelligence Upgrade**: Added Package Manager detection, project metadata extraction (name, language, runtime, architecture), and important file detection.
+- **Project Health Checks**: New `--health` flag to evaluate repository health (checking for README, License, linting, tests, docker files).
+- **Richer Output Formats**: Expanded HTML and Markdown renderers to include the newly extracted project details, ensuring a highly readable and comprehensive project overview.
+- **Enhanced JSON schema**: Output JSON schema has been substantially updated to support these rich data properties in a deterministic order.
+- **New CLI flags**: `--summary`, `--important-files`, and `--health`.
+
+### Changed
+- Refactored `ScanResult` object with `packageManager`, `projectInfo`, `health`, and `importantFiles`.
+- Updated test suite for new CLI flags and deterministic JSON output.
+

package/README.md

@@ -1,8 +1,8 @@
-# Toren — Codebase Analyzer CLI
+# Toren — Fast Repository Discovery CLI
 
 > The fastest way to understand any project structure. A zero-dependency codebase scanner CLI for modern developers.
 
-[![npm version](https://img.shields.io/npm/v/@lakindu_perera/toren.svg)](https://www.npmjs.com/package/@lakindu_perera/toren)
+[![npm version](https://img.shields.io/npm/v/@lakindudev/toren.svg)](https://www.npmjs.com/package/@lakindudev/toren)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org)
 [![Zero Dependencies](https://img.shields.io/badge/dependencies-zero-success.svg)](package.json)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
@@ -23,6 +23,8 @@ Built with zero external dependencies, this **Node.js repository explorer** is t
 - **Framework Detection**: Instantly identifies Node.js, React, Next.js, Vue, Nuxt, Angular, Svelte, Python, Go, Rust, Spring Boot, Ruby, PHP, Elixir and more.
 - **Entry Point Detection**: Automatically pinpoints where execution begins (e.g., `index.js`, `main.ts`, `App.tsx`, `main.go`).
 - **Project Structure Visualizer**: Generates clean, hierarchical file trees.
+- **Project Health Diagnostics**: Provides observations and warnings for common project health issues.
+- **Package Manager Detection**: Identifies whether a project uses npm, pnpm, yarn, bun, etc.
 - **Multiple Output Formats**: Choose between `console` (default), `json`, `markdown`, or `html` reports.
 - **Zero Dependencies**: A pure Node.js CLI tool with no external runtime packages. Lightning fast install, infinitely secure.
 - **CLI Lifecycle Tools**: Native diagnostic and uninstallation tools (`--doctor`, `--uninstall`).
@@ -34,7 +36,7 @@ Built with zero external dependencies, this **Node.js repository explorer** is t
 Install Toren globally via npm to make the **repository inspection CLI** available anywhere on your machine:
 
 ```bash
-npm install -g @lakindu_perera/toren
+npm install -g @lakindudev/toren
 ```
 
 **Requirements:** Node.js 18.0.0 or higher.
@@ -69,6 +71,9 @@ toren --entry-points
 toren --structure
 toren --configs
 toren --scripts
+toren --summary
+toren --important-files
+toren --health
 
 # Lifecycle & Help Commands
 toren --help
@@ -88,6 +93,9 @@ toren --uninstall
 | `--structure` | Show repository structure only. |
 | `--configs` | Show detected project configuration files. |
 | `--scripts` | Show available package scripts only. |
+| `--summary` | Show project summary only. |
+| `--important-files` | Show important files only. |
+| `--health` | Show project health observations 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. |
@@ -97,7 +105,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`, `--configs`, `--scripts`) are mutually exclusive.
+> **Note:** Focused output flags are mutually exclusive.
 
 ---
 
@@ -107,7 +115,7 @@ toren --uninstall
 The default `console` format renders a beautiful summary directly in your terminal:
 
 ```text
-Toren v1.0.6  —  Codebase Onboarding Intelligence
+Toren v1.0.7  —  Fast Repository Discovery CLI
 
 Project Summary
 ───────────────
@@ -153,25 +161,6 @@ Project Type
 
 Node.js / JavaScript
 
-$ toren --frameworks
-Frameworks
-──────────
-
-React
-
-$ toren --entry-points
-Entry Points
-────────────
-
-src/main.tsx
-
-$ toren --configs
-Configuration Files
-───────────────────
-
-package.json
-vite.config.ts
-
 $ toren --scripts
 Package Scripts
 ───────────────
@@ -185,19 +174,54 @@ Generate machine-readable output for scripts, toolchains, or AI context windows
 
 ```json
 {
+  "meta": {
+    "version": "1.0.7",
+    "scanDurationMs": 4,
+    "timestamp": "2026-08-29T23:51:00.000Z"
+  },
   "project": {
+    "name": "my-react-app",
     "path": "./my-react-app",
     "type": "React",
-    "framework": "React"
-  },
-  "summary": {
-    "totalFiles": 32,
-    "totalFolders": 6,
-    "scanDurationMs": 4
+    "framework": "React",
+    "packageManager": "npm"
   },
+  "frameworks": [
+    "React"
+  ],
   "entryPoints": [
     "src/main.tsx"
   ],
+  "configs": [
+    "package.json",
+    "vite.config.ts"
+  ],
+  "scripts": [
+    {
+      "name": "start",
+      "command": "vite",
+      "description": "Start the development server",
+      "category": "development",
+      "usage": "npm start"
+    }
+  ],
+  "importantFiles": [
+    {
+      "path": "package.json",
+      "reason": "Defines dependencies"
+    }
+  ],
+  "health": [
+    {
+      "id": "readme",
+      "status": "pass",
+      "message": "README file is present"
+    }
+  ],
+  "statistics": {
+    "totalFiles": 32,
+    "totalFolders": 6
+  },
   "structure": [
     {
       "type": "folder",
@@ -208,7 +232,12 @@ Generate machine-readable output for scripts, toolchains, or AI context windows
       ]
     },
     { "type": "file", "name": "package.json" }
-  ]
+  ],
+  "summary": {
+    "totalFiles": 32,
+    "totalFolders": 6,
+    "scanDurationMs": 4
+  }
 }
 ```
 
@@ -218,6 +247,12 @@ Generate machine-readable output for scripts, toolchains, or AI context windows
 
 ## Release Notes
 
+### v1.0.7 - Intelligence Upgrade
+- **Project Intelligence Upgrade**: Added Package Manager detection, project metadata extraction (name, language, runtime, architecture), and important file detection.
+- **Project Health Checks**: New `--health` flag to evaluate repository health (checking for README, License, linting, tests, docker files).
+- **Richer Output Formats**: Expanded HTML and Markdown renderers to include the newly extracted project details, ensuring a highly readable and comprehensive project overview.
+- **Enhanced JSON schema**: Output JSON schema has been substantially updated to support these rich data properties in a deterministic order.
+
 ### v1.0.6 - CLI Experience Update
 - **Redesigned CLI Output**: Completely revamped the console layout to use minimal typography, bold section titles, and dynamic divider lines matching the title width.
 - **Improved Error Handling**: Transformed raw exceptions into user-friendly error messages outlining the issue and potential fixes, ensuring consistent exit codes.
@@ -273,6 +308,60 @@ Contributions to improve this codebase analyzer CLI are always welcome!
 
 ---
 
+## Maintainer: Releasing a New Version
+
+Toren uses **automated npm publishing via GitHub Actions** and [npm Trusted Publishing (OIDC)](https://docs.npmjs.com/generating-provenance-statements).  
+**Do not run `npm publish` manually** — GitHub Actions owns the publish step.
+
+### Release checklist
+
+```text
+1. Implement changes on a feature branch.
+
+2. Update the version in package.json:
+       "version": "1.0.8"
+
+3. Run tests and lint locally:
+       npm test
+       npm run lint
+
+4. Commit the version bump and any other changes:
+       git commit -m "chore: release v1.0.8"
+
+5. Open a Pull Request → merge to main.
+
+6. On GitHub, create a new Release:
+       Tag:   v1.0.8        ← must match package.json exactly (with leading v)
+       Title: v1.0.8
+       Body:  paste CHANGELOG.md entry
+
+7. Click "Publish Release".
+
+8. GitHub Actions runs automatically:
+       ✔ npm ci
+       ✔ npm test  (all 233+ tests must pass)
+       ✔ npm run lint
+       ✔ tag format validated  (vX.Y.Z)
+       ✔ tag v1.0.8 == package.json 1.0.8
+       ✔ npm pack --dry-run
+       ✔ npm publish --access public --provenance
+
+9. @lakindudev/toren@1.0.8 is live on npmjs.com.
+```
+
+### If the workflow fails
+
+| Failure step | Cause | Fix |
+|---|---|---|
+| Run tests | A test is failing | Fix the test, push, re-create release |
+| Run lint | Syntax error in source | Fix lint error, push, re-create release |
+| Validate tag format | Tag is not `vX.Y.Z` | Delete the release, re-create with correct tag |
+| Verify version matches | `package.json` not bumped | Update `package.json`, push, re-create release |
+| Verify package contents | `files` array misconfigured | Fix `package.json`, push, re-create release |
+| Publish to npm | Trusted Publisher not configured | Follow the npm Trusted Publisher setup in `.github/workflows/publish.yml` header |
+
+---
+
 ## License
 
 Distributed under the MIT License. See `LICENSE` for more information.

package/bin/toren.js

@@ -70,6 +70,9 @@ Fast Repository Discovery CLI
   --structure         Show repository structure only
   --configs           Show detected project configuration files
   --scripts           Show available package scripts only
+  --summary           Show project summary only
+  --important-files   Show important files only
+  --health            Show project health observations only
   --include-hidden    Include hidden files and folders
   --max-files <n>     Set scan file limit
   --doctor            Run CLI diagnostics

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lakindu_perera/toren",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "A powerful codebase scanner CLI tool for project analysis, framework detection, and understanding repository structure instantly.",
   "type": "module",
   "bin": {
@@ -10,12 +10,16 @@
     "bin",
     "src",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "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"
+    "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 src/detectors/config-detector.js src/detectors/script-detector.js src/detectors/package-manager-detector.js"
   },
   "keywords": [
     "cli tool",

package/src/detectors/health-detector.js

@@ -0,0 +1,72 @@
+/**
+ * Detect project health observations.
+ */
+export function detectHealth({
+  flatFiles,
+  configs,
+  importantFiles,
+  scripts,
+  projectType
+}) {
+  const health = [];
+  const fileSet = new Set(flatFiles);
+
+  // README
+  if (fileSet.has('README.md') || fileSet.has('README') || fileSet.has('readme.md')) {
+    health.push({ id: 'readme', status: 'pass', message: 'README found' });
+  } else {
+    health.push({ id: 'readme', status: 'warning', message: 'README not found' });
+  }
+
+  // LICENSE
+  if (fileSet.has('LICENSE') || fileSet.has('LICENSE.md') || fileSet.has('LICENSE.txt')) {
+    health.push({ id: 'license', status: 'pass', message: 'LICENSE found' });
+  } else {
+    health.push({ id: 'license', status: 'warning', message: 'LICENSE not found' });
+  }
+
+  // ENVIRONMENT EXAMPLE
+  if (fileSet.has('.env.example') || fileSet.has('.env.sample')) {
+    health.push({ id: 'env-example', status: 'pass', message: 'Environment example found' });
+  }
+
+  // TESTS
+  const hasTestFiles = flatFiles.some(f => 
+    f.startsWith('test/') || 
+    f.startsWith('tests/') || 
+    f.startsWith('__tests__/') || 
+    f.includes('.test.') || 
+    f.includes('.spec.')
+  );
+  const hasTestScripts = (scripts || []).some(s => s.category === 'testing' || s.name === 'test');
+  if (hasTestFiles || hasTestScripts) {
+    health.push({ id: 'tests', status: 'pass', message: 'Tests detected' });
+  }
+
+  // LINTER
+  const hasLinter = (configs || []).some(c => 
+    c.includes('eslint') || 
+    c.includes('biome') || 
+    c.includes('stylelint')
+  ) || (scripts || []).some(s => s.category === 'quality' || s.name === 'lint');
+  if (hasLinter) {
+    health.push({ id: 'lint', status: 'pass', message: 'Linter detected' });
+  }
+
+  // TYPESCRIPT
+  if (fileSet.has('tsconfig.json')) {
+    health.push({ id: 'typescript', status: 'pass', message: 'TypeScript configuration found' });
+  }
+
+  // GIT
+  if (fileSet.has('.gitignore')) {
+    health.push({ id: 'git', status: 'info', message: '.gitignore found' });
+  }
+
+  // DOCKER
+  if (fileSet.has('Dockerfile') || fileSet.has('docker-compose.yml') || fileSet.has('compose.yml')) {
+    health.push({ id: 'docker', status: 'info', message: 'Docker configuration found' });
+  }
+
+  return { health };
+}