scanorepo 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Benjamin Onyia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,263 @@
+# 🔍 ScanoRepo
+
+> **AI-powered CLI tool for instant project scanning and documentation generation.**
+
+ScanoRepo is a cross-platform command-line tool built with Node.js and TypeScript that scans your JavaScript/TypeScript projects for common issues and generates documentation using AI-powered insights.
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Node](https://img.shields.io/badge/node-%3E%3D16.0.0-green.svg)
+![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)
+
+---
+
+## ✨ Features
+
+- **🔎 Project Scanning** - Detects missing npm scripts, environment variables, dependencies, and TypeScript configuration issues.
+- **🤖 AI-Powered Insights** - Uses Groq's ultra-fast AI inference to explain _why_ each issue matters and how to fix it.
+- **📄 Auto Documentation** - Generates a `SCANNED.md` file summarizing your project structure, components, and getting started guide.
+- **📦 Dependency Management** - Interactive CLI to install, update, or check outdated packages.
+- **🌐 Cross-Platform** - Works on Windows, macOS, and Linux.
+
+---
+
+## 📦 Installation
+
+### Global Installation (Recommended)
+
+```bash
+npm install -g scanorepo
+```
+
+### Local Development
+
+```bash
+git clone https://github.com/classicManCode/ScanoRepo.git
+cd ScanoRepo
+npm install
+npm run build
+npm link
+```
+
+---
+
+## 🔑 Zero Configuration
+
+ScanoRepo works **instantly**!
+
+Unlike other CLI tools, you don't need to sign up for API keys or set up environment variables. AI-powered insights are delivered through a secure proxy server maintained by the developer.
+
+### How it works:
+
+1. You run a command.
+2. ScanoRepo sends the project metadata to a secure backend.
+3. The backend processes the request using Groq's high-performance models.
+4. You receive instant insights in your terminal.
+
+---
+
+## 🚀 Usage
+
+Navigate to any Node.js project and run:
+
+```bash
+cd /path/to/your/project
+scanorepo <command>
+```
+
+### Available Commands
+
+| Command               | Description                                  |
+| --------------------- | -------------------------------------------- |
+| `scanorepo scan`      | Scan project for issues with AI explanations |
+| `scanorepo doc`       | Generate `SCANNED.md` documentation using AI |
+| `scanorepo deps`      | Interactive dependency management            |
+| `scanorepo check`     | Run full health check (scan + doc)           |
+| `scanorepo --help`    | Display help information                     |
+| `scanorepo --version` | Display version number                       |
+
+---
+
+## 📋 Command Details
+
+### `scanorepo scan`
+
+Scans your project for common issues:
+
+- **Missing npm scripts** - Checks for `start`, `dev`, `build`, `test`
+- **Environment issues** - Detects missing `.env` files
+- **TypeScript errors** - Flags `.ts` files without `tsconfig.json`
+- **Dependency issues** - Checks if `node_modules` exists
+
+**Example Output:**
+
+```
+  ____                        ____
+ / ___|  ___ __ _ _ __   ___ |  _ \ ___ _ __   ___
+ \___ \ / __/ _` | '_ \ / _ \| |_) / _ \ '_ \ / _ \
+  ___) | (_| (_| | | | | (_) |  _ <  __/ |_) | (_) |
+ |____/ \___\__,_|_| |_|\___/|_| \_\___| .__/ \___/
+                                       |_|
+✔ Scan complete!
+
+--- Scan Results ---
+
+[!] Missing Scripts:
+ - test
+
+AI Insight:
+**`npm test`** is essential because it automates verification,
+integrates with CI/CD pipelines, and standardizes testing workflow...
+```
+
+### `scanorepo doc`
+
+Analyzes your project structure and generates a comprehensive `SCANNED.md` file containing:
+
+- Project overview
+- Key components and their purposes
+- Getting started instructions
+
+### `scanorepo deps`
+
+Opens an interactive menu:
+
+```
+? What would you like to do with dependencies?
+❯ Install missing dependencies
+  Update dependencies
+  Check outdated packages
+  Cancel
+```
+
+- Automatically detects npm vs yarn
+- Handles all package manager commands
+
+### `scanorepo check`
+
+Runs both `scan` and `doc` commands in sequence for a complete project audit.
+
+---
+
+## 📁 Project Structure
+
+```
+scanorepo/
+├── src/
+│   ├── index.ts           # CLI entry point
+│   ├── commands/
+│   │   ├── scan.ts        # Scan command
+│   │   ├── doc.ts         # Documentation command
+│   │   ├── deps.ts        # Dependencies command
+│   │   └── check.ts       # Full check command
+│   ├── services/
+│   │   ├── ai.ts          # Groq AI integration
+│   │   ├── scanner.ts     # Project scanning logic
+│   │   ├── summarizer.ts  # Project structure summarizer
+│   │   └── updater.ts     # Version update checker
+│   └── utils/
+│       └── logger.ts      # Colored console output
+├── dist/                   # Compiled JavaScript
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+---
+
+## ⚠️ What NOT To Do
+
+### ❌ Don't commit your API key
+
+Never commit your `.env` file or hardcode API keys in source code.
+
+```bash
+# Add to .gitignore
+.env
+```
+
+### ❌ Don't run on non-Node.js projects
+
+ScanoRepo is designed for JavaScript/TypeScript projects with `package.json`.
+
+### ❌ Don't expect deterministic AI outputs
+
+AI responses may vary between runs. The insights are meant to be helpful, not definitive.
+
+### ❌ Don't skip the build step
+
+After making changes, always rebuild:
+
+```bash
+npm run build
+```
+
+---
+
+## 🛠️ Development
+
+### Build the project
+
+```bash
+npm run build
+```
+
+### Run in development mode
+
+```bash
+npm run dev
+```
+
+### Test locally without publishing
+
+```bash
+npm link
+scanorepo scan
+```
+
+### Unlink when done
+
+```bash
+npm unlink -g scanorepo
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 👤 Author
+
+**Benjamin Onyia**
+
+- 🌐 Portfolio: [benjamin-onyia.vercel.app](https://benjamin-onyia.vercel.app/)
+- 💻 GitHub: [@classicManCode](https://github.com/classicManCode)
+
+---
+
+## 🙏 Acknowledgments
+
+- [Groq](https://groq.com/) for ultra-fast AI inference
+- [Commander.js](https://github.com/tj/commander.js) for CLI framework
+- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) for interactive prompts
+- [Chalk](https://github.com/chalk/chalk) & [Ora](https://github.com/sindresorhus/ora) for beautiful terminal output
+
+---
+
+<p align="center">
+  Made with ❤️ by <a href="https://benjamin-onyia.vercel.app/">Benjamin Onyia</a>
+</p>

package/dist/commands/check.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkCommand = void 0;
+const commander_1 = require("commander");
+const scan_1 = require("./scan"); // Imported directly
+const doc_1 = require("./doc"); // Imported directly
+const logger_1 = require("../utils/logger");
+exports.checkCommand = new commander_1.Command("check")
+    .description("Runs full health check (scan + doc generation)")
+    .action(async () => {
+    logger_1.logger.info("Starting full health check...");
+    logger_1.logger.general("\n--- Step 1: Scanning ---");
+    await (0, scan_1.runScan)();
+    logger_1.logger.general("\n--- Step 2: Documentation ---");
+    await (0, doc_1.runDoc)();
+    logger_1.logger.success("\nFull check complete!");
+    logger_1.logger.footer();
+});

package/dist/commands/deps.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.depsCommand = void 0;
+const commander_1 = require("commander");
+const inquirer_1 = __importDefault(require("inquirer"));
+const cross_spawn_1 = __importDefault(require("cross-spawn"));
+const logger_1 = require("../utils/logger");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+exports.depsCommand = new commander_1.Command("deps")
+    .description("Manage project dependencies")
+    .action(async () => {
+    const projectPath = process.cwd();
+    const pkgPath = path_1.default.join(projectPath, "package.json");
+    if (!fs_1.default.existsSync(pkgPath)) {
+        logger_1.logger.error("No package.json found.");
+        return;
+    }
+    const { action } = await inquirer_1.default.prompt([
+        {
+            type: "list",
+            name: "action",
+            message: "What would you like to do with dependencies?",
+            choices: [
+                { name: "Install missing dependencies", value: "install" },
+                { name: "Update dependencies", value: "update" },
+                { name: "Check outdated packages", value: "outdated" },
+                { name: "Cancel", value: "cancel" },
+            ],
+        },
+    ]);
+    if (action === "cancel")
+        return;
+    logger_1.logger.info(`Running npm ${action}...`);
+    // Determine package manager (simple check for yarn.lock)
+    let pm = "npm";
+    if (fs_1.default.existsSync(path_1.default.join(projectPath, "yarn.lock"))) {
+        pm = "yarn";
+    }
+    const cmd = pm;
+    const args = [action];
+    // 'npm outdated' returns exit code 1 if there are outdated variables, which can throw error if not handled.
+    // 'npm install' and 'npm update' should be fine.
+    try {
+        const child = cross_spawn_1.default.sync(cmd, args, {
+            stdio: "inherit",
+            cwd: projectPath,
+        });
+        if (child.status === 0) {
+            logger_1.logger.success(`Successfully ran ${action}.`);
+        }
+        else {
+            // npm outdated exits with 1 if outdated stuff found, which is "success" in this context
+            if (action === "outdated" && child.status === 1) {
+                logger_1.logger.info("Outdated packages found (see above).");
+            }
+            else {
+                logger_1.logger.error(`Command failed with status code ${child.status}`);
+            }
+        }
+    }
+    catch (e) {
+        logger_1.logger.error(`Failed to run command: ${e.message}`);
+    }
+    logger_1.logger.footer();
+});

package/dist/commands/doc.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.docCommand = exports.runDoc = void 0;
+const commander_1 = require("commander");
+const summarizer_1 = require("../services/summarizer");
+const ai_1 = require("../services/ai");
+const logger_1 = require("../utils/logger");
+const ora_1 = __importDefault(require("ora"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const runDoc = async () => {
+    const spinner = (0, ora_1.default)("Generating documentation...").start();
+    const projectPath = process.cwd();
+    try {
+        const structure = (0, summarizer_1.summarizeProject)(projectPath);
+        const prompt = `
+        You are a technical documenter. 
+        Analyze the following project structure and snippets:
+        
+        ${structure}
+        
+        Generate a "SCANNED.md" file content in Markdown format.
+        Include:
+        1. Project Overview (infer from filenames and snippets).
+        2. Key Components (guess what the directories do).
+        3. Getting Started (how to install/run based on package.json).
+        
+        Keep it professional and concise.
+      `;
+        const documentation = await (0, ai_1.generateExplanation)(prompt);
+        fs_1.default.writeFileSync(path_1.default.join(projectPath, "SCANNED.md"), documentation);
+        spinner.succeed("SCANNED.md generated successfully!");
+        logger_1.logger.info("\nCheck SCANNED.md for the result.");
+    }
+    catch (error) {
+        spinner.fail("Documentation generation failed.");
+        logger_1.logger.error(error.message);
+    }
+    logger_1.logger.footer();
+};
+exports.runDoc = runDoc;
+exports.docCommand = new commander_1.Command("doc")
+    .description("Generate SCANNED.md information file using AI")
+    .action(exports.runDoc);

package/dist/commands/scan.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanCommand = exports.runScan = void 0;
+const commander_1 = require("commander");
+const scanner_1 = require("../services/scanner");
+const ai_1 = require("../services/ai");
+const logger_1 = require("../utils/logger");
+const ora_1 = __importDefault(require("ora"));
+const runScan = async () => {
+    const spinner = (0, ora_1.default)("Scanning project...").start();
+    const projectPath = process.cwd();
+    try {
+        const issues = await (0, scanner_1.scanProject)(projectPath);
+        spinner.succeed("Scan complete!");
+        if (issues.framework === "unknown") {
+            logger_1.logger.warn("Could not detect a Node.js project (missing package.json).");
+            return;
+        }
+        logger_1.logger.general("\n--- Scan Results ---");
+        // Helper to explain issues
+        const explain = async (title, items, promptContext) => {
+            if (items.length > 0) {
+                logger_1.logger.warn(`\n[!] ${title}:`);
+                items.forEach((item) => logger_1.logger.general(` - ${item}`));
+                const prompt = `Explain why these ${promptContext} are important in a Node.js project: ${items.join(", ")}. Keep it brief.`;
+                const aiExplanation = await (0, ai_1.generateExplanation)(prompt);
+                logger_1.logger.info(`\nAI Insight:\n${aiExplanation}\n`);
+            }
+        };
+        await explain("Missing Scripts", issues.missingScripts, "npm scripts");
+        await explain("Environment Issues", issues.missingEnvVars, "env configurations");
+        if (issues.missingDeps.length > 0) {
+            logger_1.logger.warn(`\n[!] Dependency Issues:`);
+            issues.missingDeps.forEach((d) => logger_1.logger.general(` - ${d}`));
+        }
+        if (issues.typescriptError) {
+            logger_1.logger.error(`\n[!] TypeScript Config Missing: Found .ts files but no tsconfig.json.`);
+            const aiExplanation = await (0, ai_1.generateExplanation)("Why is tsconfig.json required for TypeScript projects?");
+            logger_1.logger.info(`\nAI Insight:\n${aiExplanation}\n`);
+        }
+        if (issues.missingScripts.length === 0 &&
+            issues.missingEnvVars.length === 0 &&
+            !issues.typescriptError &&
+            issues.missingDeps.length === 0) {
+            logger_1.logger.success("\n✅ No obvious issues found! Good job.");
+        }
+    }
+    catch (error) {
+        spinner.fail("Scan failed.");
+        logger_1.logger.error(error.message);
+    }
+    logger_1.logger.footer();
+};
+exports.runScan = runScan;
+exports.scanCommand = new commander_1.Command("scan")
+    .description("Scan the current project for issues")
+    .action(exports.runScan);

package/dist/index.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const figlet_1 = __importDefault(require("figlet"));
+const scan_1 = require("./commands/scan");
+const deps_1 = require("./commands/deps");
+const doc_1 = require("./commands/doc");
+const check_1 = require("./commands/check");
+const updater_1 = require("./services/updater");
+const package_json_1 = __importDefault(require("../package.json"));
+// Display ASCII banner
+console.log(figlet_1.default.textSync("ScanoRepo"));
+const program = new commander_1.Command();
+program
+    .name("scanorepo")
+    .description("AI-powered CLI tool for project scanning and documentation")
+    .version(package_json_1.default.version)
+    .hook("preAction", async () => {
+    // Check for updates before running any command
+    await (0, updater_1.checkForUpdates)(package_json_1.default.version);
+});
+program.addCommand(scan_1.scanCommand);
+program.addCommand(deps_1.depsCommand);
+program.addCommand(doc_1.docCommand);
+program.addCommand(check_1.checkCommand);
+program.parse(process.argv);

package/dist/services/ai.js

@@ -0,0 +1,80 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateExplanation = void 0;
+const axios_1 = __importDefault(require("axios"));
+const dotenv = __importStar(require("dotenv"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("../utils/logger");
+// Load .env from the ScanoRepo installation directory (for developer testing)
+dotenv.config({ path: path_1.default.join(__dirname, "../../.env") });
+// ⚠️ YOUR PROXY SERVER URL (e.g. your Vercel deployment URL)
+const PROXY_SERVER_URL = "https://scano-repo.vercel.app/api/explain";
+/**
+ * Generate an AI explanation by calling a secure proxy server.
+ * This ensures the Groq API key is NEVER exposed to the client terminal.
+ */
+const generateExplanation = async (prompt) => {
+    try {
+        // 1. Check if user provided their own key (local override)
+        const localApiKey = process.env.GROQ_API_KEY;
+        if (localApiKey) {
+            // If developer has a local key, we could use Groq SDK directly,
+            // but for consistency we'll use the proxy or prompt them.
+            // To keep it simple and secure, we'll try the proxy first.
+        }
+        const response = await axios_1.default.post(PROXY_SERVER_URL, {
+            prompt: prompt,
+            // You could add an optional secret key here to prevent unauthorized API use
+            token: "optional-cli-secret",
+        });
+        return response.data.explanation || "No explanation generated.";
+    }
+    catch (error) {
+        if (error.response) {
+            // Server responded with an error status
+            logger_1.logger.error(`AI Proxy Error: ${error.response.data.message || "Server error"}`);
+        }
+        else {
+            // Network error or timeout
+            logger_1.logger.error(`AI Proxy Connection failed. Ensure you are online.`);
+        }
+        return "Failed to generate AI explanation.";
+    }
+};
+exports.generateExplanation = generateExplanation;

package/dist/services/gemini.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateExplanation = void 0;
+const genai_1 = require("@google/genai");
+const dotenv = __importStar(require("dotenv"));
+const logger_1 = require("../utils/logger");
+dotenv.config();
+const apiKey = process.env.GEMINI_API_KEY;
+if (!apiKey) {
+    logger_1.logger.warn("Warning: GEMINI_API_KEY is not set in environment variables. AI features will not work.");
+}
+const client = apiKey ? new genai_1.GoogleGenAI({ apiKey }) : null;
+const generateExplanation = async (prompt) => {
+    if (!client)
+        return "AI features disabled: Missing API Key.";
+    try {
+        const result = await client.models.generateContent({
+            model: "gemini-2.0-flash",
+            contents: prompt,
+        });
+        // The new SDK exposes text as a getter property, not a method
+        return result.text || "No explanation generated.";
+    }
+    catch (error) {
+        logger_1.logger.error(`Gemini API Error: ${error.message}`);
+        return "Failed to generate AI explanation.";
+    }
+};
+exports.generateExplanation = generateExplanation;

package/dist/services/scanner.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanProject = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const scanProject = async (projectPath) => {
+    const result = {
+        missingEnvVars: [],
+        missingDeps: [],
+        typescriptError: false,
+        missingScripts: [],
+        portConflicts: [],
+        framework: "unknown",
+    };
+    // Check package.json
+    const pkgPath = path_1.default.join(projectPath, "package.json");
+    if (fs_1.default.existsSync(pkgPath)) {
+        result.framework = "node";
+        const pkg = JSON.parse(fs_1.default.readFileSync(pkgPath, "utf-8"));
+        // Check Scripts
+        const requiredScripts = ["start", "dev", "build", "test"];
+        const scripts = pkg.scripts || {};
+        requiredScripts.forEach((script) => {
+            if (!scripts[script]) {
+                result.missingScripts.push(script);
+            }
+        });
+        // Simple dependency check (just consistency, real check needs npm audit or similar logic if needed,
+        // but here we might just check if node_modules exists or if deps are installed)
+        if (!fs_1.default.existsSync(path_1.default.join(projectPath, "node_modules"))) {
+            result.missingDeps.push("node_modules folder missing (run npm install)");
+        }
+    }
+    // Check .env
+    if (!fs_1.default.existsSync(path_1.default.join(projectPath, ".env"))) {
+        if (fs_1.default.existsSync(path_1.default.join(projectPath, ".env.example"))) {
+            result.missingEnvVars.push(".env missing (copy .env.example)");
+        }
+        else {
+            result.missingEnvVars.push(".env missing");
+        }
+    }
+    // Check TypeScript
+    if (fs_1.default.existsSync(path_1.default.join(projectPath, "tsconfig.json"))) {
+        // Could try to dry-run tsc or just check presence
+        // For now, let's assume if tsconfig exists, it's a TS project.
+    }
+    else if (result.framework === "node" &&
+        fs_1.default.existsSync(path_1.default.join(projectPath, "src", "index.ts"))) {
+        result.typescriptError = true; // TS file but no config
+    }
+    return result;
+};
+exports.scanProject = scanProject;

package/dist/services/summarizer.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summarizeProject = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+// Ignore list for summarization
+const IGNORE_DIRS = [
+    "node_modules",
+    ".git",
+    "dist",
+    "coverage",
+    ".idea",
+    ".vscode",
+];
+const IGNORE_FILES = ["package-lock.json", "yarn.lock", ".DS_Store"];
+const summarizeProject = (dir, depth = 0, maxDepth = 2) => {
+    if (depth > maxDepth)
+        return "";
+    let summary = "";
+    const files = fs_1.default.readdirSync(dir);
+    for (const file of files) {
+        if (IGNORE_DIRS.includes(file) || IGNORE_FILES.includes(file))
+            continue;
+        const fullPath = path_1.default.join(dir, file);
+        const stat = fs_1.default.statSync(fullPath);
+        if (stat.isDirectory()) {
+            summary += `${"  ".repeat(depth)}- [DIR] ${file}\n`;
+            summary += (0, exports.summarizeProject)(fullPath, depth + 1, maxDepth);
+        }
+        else {
+            summary += `${"  ".repeat(depth)}- [FILE] ${file}\n`;
+            // Read critical files content for better context
+            if (["package.json", "tsconfig.json", "README.md"].includes(file)) {
+                try {
+                    const content = fs_1.default.readFileSync(fullPath, "utf-8").slice(0, 500); // Limit to 500 chars
+                    summary += `${"  ".repeat(depth + 1)}Content snippet: ${content.replace(/\n/g, " ")}...\n`;
+                }
+                catch (e) { }
+            }
+        }
+    }
+    return summary;
+};
+exports.summarizeProject = summarizeProject;

package/dist/services/updater.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkForUpdates = void 0;
+const axios_1 = __importDefault(require("axios"));
+const semver_1 = __importDefault(require("semver"));
+const logger_1 = require("../utils/logger");
+// import packageJson from '../../package.json'; // Importing outside src might be tricky with generic resolve, but let's try relative
+const checkForUpdates = async (currentVersion) => {
+    try {
+        // For now, scanorepo is not published, so this will likely 404.
+        // We'll mock it or handle the error gracefully.
+        // Replace with actual package name if different.
+        const pkgName = "scanorepo";
+        const registryUrl = `https://registry.npmjs.org/${pkgName}/latest`;
+        // specific timeout to avoid blocking CLI
+        const response = await axios_1.default.get(registryUrl, { timeout: 1500 });
+        const latestVersion = response.data.version;
+        if (semver_1.default.gt(latestVersion, currentVersion)) {
+            logger_1.logger.warn(`
+      \n*************************************************
+      Update available: ${latestVersion} (current: ${currentVersion})
+      Run: npm install -g ${pkgName}
+      *************************************************\n`);
+        }
+    }
+    catch (error) {
+        // Silent fail or debug log
+        // logger.error("Failed to check for updates.");
+    }
+};
+exports.checkForUpdates = checkForUpdates;

package/dist/utils/logger.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+exports.logger = {
+    info: (msg) => console.log(chalk_1.default.blue(msg)),
+    success: (msg) => console.log(chalk_1.default.green(msg)),
+    warn: (msg) => console.log(chalk_1.default.yellow(msg)),
+    error: (msg) => console.log(chalk_1.default.red(msg)),
+    general: (msg) => console.log(msg),
+    footer: () => {
+        console.log(chalk_1.default.gray("\n---"));
+        console.log(chalk_1.default.gray("Built by Benjamin Onyia"));
+        console.log(chalk_1.default.cyan("🌐 https://benjamin-onyia.vercel.app/"));
+        console.log(chalk_1.default.cyan("💻 https://github.com/classicManCode"));
+    },
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "scanorepo",
+  "version": "1.0.0",
+  "description": "Cross-platform AI-powered CLI tool for project scanning and documentation",
+  "main": "dist/index.js",
+  "bin": {
+    "scanorepo": "./dist/index.js"
+  },
+  "author": "Benjamin Onyia <classicManCode>",
+  "license": "MIT",
+  "keywords": [
+    "cli",
+    "ai",
+    "scanner",
+    "documentation",
+    "groq",
+    "typescript",
+    "nodejs",
+    "developer-tools",
+    "code-analysis"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/classicManCode/ScanoRepo.git"
+  },
+  "homepage": "https://github.com/classicManCode/ScanoRepo#readme",
+  "bugs": {
+    "url": "https://github.com/classicManCode/ScanoRepo/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "ts-node-dev src/index.ts",
+    "scanorepo": "ts-node src/index.ts"
+  },
+  "dependencies": {
+    "axios": "^1.13.2",
+    "chalk": "^4.1.2",
+    "commander": "^12.0.0",
+    "cross-spawn": "^7.0.3",
+    "dotenv": "^16.4.1",
+    "figlet": "^1.7.0",
+    "groq-sdk": "^0.37.0",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1",
+    "semver": "^7.6.0"
+  },
+  "devDependencies": {
+    "@types/cross-spawn": "^6.0.6",
+    "@types/figlet": "^1.5.8",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^20.11.16",
+    "@types/semver": "^7.5.7",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.3.3"
+  }
+}