@khiem_enhance/ai-doc-agent 0.1.0

package/README.md

@@ -0,0 +1,32 @@
+# ai-doc-agent
+
+AI-powered documentation generator that analyzes your source code and generates
+technical documentation directly from it.
+
+> The codebase is the single source of truth.
+
+---
+
+## ✨ Features
+
+- Generate **Architecture Overview**
+- Generate **Module / Feature documentation**
+- Generate **API documentation** (from FE usage or BE code)
+- Generate **Component / Service documentation**
+- Output structured **Markdown docs**
+
+---
+
+## 📦 Requirements
+
+- Node.js >= 18
+- An OpenAI API key
+
+---
+
+## 🔐 Setup
+
+Set your OpenAI API key as an environment variable:
+
+```bash
+export OPENAI_API_KEY=sk-xxxxxxxx

package/dist/analyzers/architecture.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateArchitectureDoc = generateArchitectureDoc;
+const openaiClient_1 = require("../llm/openaiClient");
+async function generateArchitectureDoc(tree, files) {
+    const prompt = `
+You are an AI Documentation Agent.
+
+RULES:
+- Code is the single source of truth
+- Do NOT invent features
+- If unclear, mark assumptions clearly
+
+GOAL:
+Generate Architecture Overview documentation.
+
+PROJECT STRUCTURE:
+${tree}
+
+SOURCE CODE:
+${files}
+
+OUTPUT:
+Markdown only.
+`;
+    return (0, openaiClient_1.askLLM)(prompt);
+}

package/dist/analyzers/modules.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateModuleDocs = generateModuleDocs;
+const openaiClient_1 = require("../llm/openaiClient");
+async function generateModuleDocs(moduleName, fileList, sourceCode) {
+    const prompt = `
+You are an AI Documentation Agent.
+
+RULES:
+- Code is the single source of truth
+- Do NOT invent features
+- If unclear, explicitly mark assumptions
+
+GOAL:
+Generate documentation for ONE module / feature.
+
+MODULE NAME:
+${moduleName}
+
+FILES:
+${fileList}
+
+SOURCE CODE:
+${sourceCode}
+
+DOCUMENT STRUCTURE:
+# ${moduleName}
+
+## Purpose
+## Responsibilities
+## Main Files
+## Execution Flow
+## Edge Cases / Constraints
+
+OUTPUT:
+Markdown only.
+`;
+    return (0, openaiClient_1.askLLM)(prompt);
+}

package/dist/cli.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const generate_1 = require("./commands/generate");
+const program = new commander_1.Command();
+program
+    .name("ai-doc-agent")
+    .description("AI-powered documentation generator")
+    .version("0.1.0");
+program
+    .command("generate")
+    .option("--since <commit>", "Only analyze changes since commit")
+    .option("--output <dir>", "Docs output directory", "docs")
+    .action(generate_1.generateDocs);
+program.parse();

package/dist/commands/generate.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateDocs = generateDocs;
+const path_1 = __importDefault(require("path"));
+const fileScanner_1 = require("../scanner/fileScanner");
+const contentReader_1 = require("../scanner/contentReader");
+const architecture_1 = require("../analyzers/architecture");
+const modules_1 = require("../analyzers/modules");
+const markdownWriter_1 = require("../writers/markdownWriter");
+const gitUtils_1 = require("../git/gitUtils");
+const moduleDetector_1 = require("../scanner/moduleDetector");
+async function generateDocs(options) {
+    const root = process.cwd();
+    const files = options.since
+        ? (0, gitUtils_1.getChangedFiles)(options.since).map(f => path_1.default.join(root, f))
+        : await (0, fileScanner_1.scanProject)(root);
+    // ---------- Architecture ----------
+    const tree = files
+        .map(f => path_1.default.relative(root, f))
+        .join("\n");
+    const architectureSource = files
+        .slice(0, 25)
+        .map(f => `FILE: ${f}\n${(0, contentReader_1.readFile)(f)}`)
+        .join("\n\n");
+    const architecture = await (0, architecture_1.generateArchitectureDoc)(tree, architectureSource);
+    (0, markdownWriter_1.writeDoc)(options.output, "architecture.md", architecture);
+    // ---------- Modules ----------
+    const modules = (0, moduleDetector_1.detectModules)(files, root);
+    for (const [moduleName, moduleFiles] of Object.entries(modules)) {
+        const fileList = moduleFiles
+            .map(f => path_1.default.relative(root, f))
+            .join("\n");
+        const source = moduleFiles
+            .slice(0, 20)
+            .map(f => `FILE: ${f}\n${(0, contentReader_1.readFile)(f)}`)
+            .join("\n\n");
+        const doc = await (0, modules_1.generateModuleDocs)(moduleName, fileList, source);
+        (0, markdownWriter_1.writeDoc)(path_1.default.join(options.output, "modules"), `${moduleName}.md`, doc);
+        console.log(`📄 Module doc generated: ${moduleName}`);
+    }
+    console.log("✅ Docs generation completed");
+}

package/dist/config/env.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.env = void 0;
+require("dotenv/config");
+exports.env = {
+    openaiKey: process.env.OPENAI_API_KEY,
+    model: process.env.MODEL || "gpt-4.1-mini"
+};

package/dist/git/gitUtils.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getChangedFiles = getChangedFiles;
+const child_process_1 = require("child_process");
+function getChangedFiles(since) {
+    if (!since)
+        return [];
+    const output = (0, child_process_1.execSync)(`git diff --name-only ${since}`, { encoding: "utf-8" });
+    return output
+        .split("\n")
+        .filter(Boolean)
+        .filter(f => /\.(ts|tsx|js|jsx)$/.test(f));
+}

package/dist/llm/openaiClient.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openai = void 0;
+exports.askLLM = askLLM;
+const openai_1 = __importDefault(require("openai"));
+const env_1 = require("../config/env");
+exports.openai = new openai_1.default({
+    apiKey: env_1.env.openaiKey
+});
+async function askLLM(prompt) {
+    const res = await exports.openai.chat.completions.create({
+        model: env_1.env.model,
+        messages: [{ role: "user", content: prompt }]
+    });
+    return res.choices[0].message.content;
+}

package/dist/scanner/contentReader.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = readFile;
+const fs_1 = __importDefault(require("fs"));
+function readFile(file) {
+    return fs_1.default.readFileSync(file, "utf-8");
+}

package/dist/scanner/fileScanner.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanProject = scanProject;
+const fast_glob_1 = __importDefault(require("fast-glob"));
+async function scanProject(root) {
+    return (0, fast_glob_1.default)([
+        "**/*.{ts,tsx,js,jsx}",
+        "!**/node_modules/**",
+        "!**/dist/**"
+    ], {
+        cwd: root,
+        absolute: true
+    });
+}

package/dist/scanner/moduleDetector.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectModules = detectModules;
+const path_1 = __importDefault(require("path"));
+function detectModules(files, root) {
+    const modules = {};
+    for (const file of files) {
+        const relative = path_1.default.relative(root, file);
+        const parts = relative.split(path_1.default.sep);
+        // src/<module>/...
+        const moduleName = parts[0] === "src" && parts[1]
+            ? parts[1]
+            : "shared";
+        if (!modules[moduleName]) {
+            modules[moduleName] = [];
+        }
+        modules[moduleName].push(file);
+    }
+    return modules;
+}

package/dist/writers/markdownWriter.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeDoc = writeDoc;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function writeDoc(dir, fileName, content) {
+    fs_1.default.mkdirSync(dir, { recursive: true });
+    fs_1.default.writeFileSync(path_1.default.join(dir, fileName), content);
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@khiem_enhance/ai-doc-agent",
+  "version": "0.1.0",
+  "description": "AI-powered documentation generator from source code",
+  "license": "MIT",
+  "bin": {
+    "ai-doc-agent": "dist/cli.js"
+  },
+  "main": "dist/cli.js",
+  "files": ["dist", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "commander": "^11.0.0",
+    "dotenv": "^16.0.0",
+    "fast-glob": "^3.3.0",
+    "openai": "^4.0.0"
+  }
+}