smartreadme 1.0.0

package/dist/src/generator.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateReadme = generateReadme;
+/**
+ * Generates a professional README.md from scanned project data.
+ */
+function generateReadme(data) {
+    const sections = [
+        buildHeader(data),
+        buildBadges(data),
+        buildDescription(data),
+        buildFeatures(),
+        buildStack(data),
+        buildPrerequisites(data),
+        buildInstallation(data),
+        buildEnvSection(data),
+        buildUsage(data),
+        buildScripts(data),
+        buildDocker(data),
+        buildApiReference(data),
+        buildContributing(),
+        buildLicense(data),
+    ].filter((s) => s.length > 0);
+    return sections.join("\n\n---\n\n");
+}
+// ── Section builders ──────────────────────────────────────────────────────────
+function buildHeader(data) {
+    const topThree = data.stack.slice(0, 3).join(", ") || "Node.js";
+    const subtitle = data.description
+        ? `> ${data.description}`
+        : `> A ${data.projectType} built with ${topThree}.`;
+    return [`# ${formatName(data.name)}`, "", subtitle].join("\n");
+}
+function buildBadges(data) {
+    var _a;
+    const badges = [];
+    if (((_a = data.pkg) === null || _a === void 0 ? void 0 : _a.name) && !data.pkg.private) {
+        const encoded = encodeURIComponent(data.name);
+        badges.push(`[![npm version](https://badge.fury.io/js/${encoded}.svg)](https://www.npmjs.com/package/${data.name})`, `[![npm downloads](https://img.shields.io/npm/dm/${data.name}.svg)](https://www.npmjs.com/package/${data.name})`);
+    }
+    badges.push(`[![License: ${data.license}](https://img.shields.io/badge/License-${encodeURIComponent(data.license)}-yellow.svg)](https://opensource.org/licenses/${data.license})`);
+    const stackBadges = {
+        React: "![React](https://img.shields.io/badge/React-20232A?style=flat&logo=react&logoColor=61DAFB)",
+        Vue: "![Vue](https://img.shields.io/badge/Vue.js-35495E?style=flat&logo=vue.js&logoColor=4FC08D)",
+        "Next.js": "![Next.js](https://img.shields.io/badge/Next.js-000000?style=flat&logo=next.js&logoColor=white)",
+        TypeScript: "![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)",
+        Express: "![Express](https://img.shields.io/badge/Express-000000?style=flat&logo=express&logoColor=white)",
+        MongoDB: "![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=flat&logo=mongodb&logoColor=white)",
+        PostgreSQL: "![PostgreSQL](https://img.shields.io/badge/PostgreSQL-316192?style=flat&logo=postgresql&logoColor=white)",
+        Tailwind: "![Tailwind](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=flat&logo=tailwind-css&logoColor=white)",
+        Redis: "![Redis](https://img.shields.io/badge/Redis-DC382D?style=flat&logo=redis&logoColor=white)",
+        NestJS: "![NestJS](https://img.shields.io/badge/NestJS-E0234E?style=flat&logo=nestjs&logoColor=white)",
+        GraphQL: "![GraphQL](https://img.shields.io/badge/GraphQL-E10098?style=flat&logo=graphql&logoColor=white)",
+        Docker: "![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white)",
+    };
+    for (const tech of data.stack) {
+        const badge = stackBadges[tech];
+        if (badge)
+            badges.push(badge);
+    }
+    if (data.configs.docker) {
+        const dockerBadge = stackBadges["Docker"];
+        if (dockerBadge && !data.stack.includes("Docker"))
+            badges.push(dockerBadge);
+    }
+    return badges.join(" ");
+}
+function buildDescription(data) {
+    var _a;
+    const topStack = data.stack.length > 0 ? ` built using ${data.stack.join(", ")}` : "";
+    const body = (_a = data.description) !== null && _a !== void 0 ? _a : `**${formatName(data.name)}** is a ${data.projectType.toLowerCase()}${topStack}. Add a more detailed description here.`;
+    return ["## 📋 About", "", body].join("\n");
+}
+function buildFeatures() {
+    return [
+        "## ✨ Features",
+        "",
+        "- ✅ Feature one — describe it here",
+        "- ✅ Feature two — describe it here",
+        "- ✅ Feature three — describe it here",
+        "- 🚧 Upcoming feature — coming soon",
+    ].join("\n");
+}
+function buildStack(data) {
+    if (data.stack.length === 0)
+        return "";
+    return [
+        "## 🛠️ Tech Stack",
+        "",
+        ...data.stack.map((t) => `- **${t}**`),
+    ].join("\n");
+}
+function buildPrerequisites(data) {
+    var _a, _b, _c, _d;
+    const deps = {
+        ...((_b = (_a = data.pkg) === null || _a === void 0 ? void 0 : _a.dependencies) !== null && _b !== void 0 ? _b : {}),
+        ...((_d = (_c = data.pkg) === null || _c === void 0 ? void 0 : _c.devDependencies) !== null && _d !== void 0 ? _d : {}),
+    };
+    const lines = [
+        "## 📦 Prerequisites",
+        "",
+        "Make sure you have the following installed:",
+        "",
+        "- [Node.js](https://nodejs.org/) v18 or higher",
+        "- [npm](https://www.npmjs.com/) v9 or higher",
+    ];
+    if (data.configs.docker)
+        lines.push("- [Docker](https://www.docker.com/) & Docker Compose");
+    if (deps["mongodb"] || deps["mongoose"])
+        lines.push("- [MongoDB](https://www.mongodb.com/) instance");
+    if (deps["pg"] || deps["postgres"])
+        lines.push("- [PostgreSQL](https://www.postgresql.org/) instance");
+    if (deps["mysql"] || deps["mysql2"])
+        lines.push("- [MySQL](https://www.mysql.com/) instance");
+    if (deps["redis"] || deps["ioredis"])
+        lines.push("- [Redis](https://redis.io/) instance");
+    return lines.join("\n");
+}
+function buildInstallation(data) {
+    var _a;
+    const repoUrl = data.repository
+        ? data.repository.replace("git+", "").replace(/\.git$/, "")
+        : `https://github.com/yourusername/${data.name}`;
+    const lines = [
+        "## 🚀 Getting Started",
+        "",
+        "### Installation",
+        "",
+        "```bash",
+        "# Clone the repository",
+        `git clone ${repoUrl}.git`,
+        `cd ${data.name}`,
+        "",
+        "# Install dependencies",
+        "npm install",
+        "```",
+    ];
+    if (data.projectType === "CLI Tool" && ((_a = data.pkg) === null || _a === void 0 ? void 0 : _a.name)) {
+        lines.push("", "### Or install globally via npm", "", "```bash", `npm install -g ${data.name}`, "```");
+    }
+    return lines.join("\n");
+}
+function buildEnvSection(data) {
+    if (!data.envInfo.found || !data.envInfo.content)
+        return "";
+    return [
+        "## 🔐 Environment Variables",
+        "",
+        "Copy the example environment file and fill in your values:",
+        "",
+        "```bash",
+        "cp .env.example .env",
+        "```",
+        "",
+        "Then edit `.env` with your configuration:",
+        "",
+        "```env",
+        data.envInfo.content,
+        "```",
+        "",
+        "> ⚠️ **Never commit your real `.env` file.** Make sure `.env` is in your `.gitignore`.",
+    ].join("\n");
+}
+function buildUsage(data) {
+    const devCmd = data.scripts["dev"]
+        ? "npm run dev"
+        : data.scripts["start"]
+            ? "npm start"
+            : "npm run serve";
+    const lines = ["## 💻 Usage", ""];
+    if (data.projectType === "CLI Tool") {
+        lines.push("```bash", `${data.name} [options]`, "", "# Show help", `${data.name} --help`, "```");
+    }
+    else if (data.projectType === "Backend API") {
+        lines.push("```bash", "# Start the server", devCmd, "```", "", "The server will be running at `http://localhost:3000`", "", "### Example API Request", "", "```bash", "curl -X GET http://localhost:3000/api/health", "```");
+    }
+    else if (data.projectType === "Node.js Library") {
+        const camel = camelCase(data.name);
+        lines.push("```typescript", `import ${camel} from '${data.name}';`, "", "// Example usage", `const result = ${camel}.doSomething();`, "console.log(result);", "```");
+    }
+    else {
+        lines.push("```bash", "# Start development server", devCmd, "```", "", "Open [http://localhost:3000](http://localhost:3000) in your browser.");
+    }
+    return lines.join("\n");
+}
+const SCRIPT_DESCRIPTIONS = {
+    dev: "Start development server with hot reload",
+    start: "Start the production server",
+    build: "Build the project for production",
+    test: "Run the test suite",
+    lint: "Lint and check code style",
+    format: "Format code with Prettier",
+    preview: "Preview the production build locally",
+    deploy: "Deploy to production",
+    seed: "Seed the database with sample data",
+    migrate: "Run database migrations",
+    generate: "Generate code / types",
+    typecheck: "Run TypeScript type checking",
+};
+function buildScripts(data) {
+    const entries = Object.entries(data.scripts);
+    if (entries.length === 0)
+        return "";
+    const rows = entries.map(([name, cmd]) => {
+        var _a;
+        const desc = (_a = SCRIPT_DESCRIPTIONS[name]) !== null && _a !== void 0 ? _a : "Run this script";
+        return `| \`npm run ${name}\` | \`${cmd}\` | ${desc} |`;
+    });
+    return [
+        "## 📜 Available Scripts",
+        "",
+        "| Script | Command | Description |",
+        "|--------|---------|-------------|",
+        ...rows,
+    ].join("\n");
+}
+function buildDocker(data) {
+    if (!data.configs.docker)
+        return "";
+    return [
+        "## 🐳 Docker",
+        "",
+        "```bash",
+        "# Build and start containers",
+        "docker-compose up --build",
+        "",
+        "# Run in detached mode",
+        "docker-compose up -d",
+        "",
+        "# Stop containers",
+        "docker-compose down",
+        "```",
+    ].join("\n");
+}
+function buildApiReference(data) {
+    const apiTypes = ["Backend API", "Node.js Library"];
+    if (!apiTypes.includes(data.projectType))
+        return "";
+    return [
+        "## 📡 API Reference",
+        "",
+        "### Base URL",
+        "",
+        "```",
+        "http://localhost:3000/api",
+        "```",
+        "",
+        "### Endpoints",
+        "",
+        "| Method | Endpoint | Description |",
+        "|--------|----------|-------------|",
+        "| `GET` | `/health` | Health check |",
+        "| `GET` | `/your-endpoint` | Add your endpoints here |",
+        "| `POST` | `/your-endpoint` | Add your endpoints here |",
+        "",
+        "> 📘 Expand this section as your API grows.",
+    ].join("\n");
+}
+function buildContributing() {
+    return [
+        "## 🤝 Contributing",
+        "",
+        "Contributions are welcome! Please follow these steps:",
+        "",
+        "1. Fork the repository",
+        "2. Create your feature branch: `git checkout -b feature/amazing-feature`",
+        '3. Commit your changes: `git commit -m "feat: add amazing feature"`',
+        "4. Push to the branch: `git push origin feature/amazing-feature`",
+        "5. Open a Pull Request",
+        "",
+        "Please make sure to update tests as appropriate.",
+    ].join("\n");
+}
+function buildLicense(data) {
+    var _a, _b;
+    const authorName = typeof data.author === "string"
+        ? data.author
+        : ((_b = (_a = data.author) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : null);
+    const lines = [
+        "## 📄 License",
+        "",
+        `This project is licensed under the **${data.license} License** — see the [LICENSE](LICENSE) file for details.`,
+    ];
+    if (authorName) {
+        lines.push("", `© ${new Date().getFullYear()} ${authorName}`);
+    }
+    return lines.join("\n");
+}
+// ── Helpers ───────────────────────────────────────────────────────────────────
+function formatName(name) {
+    return name.replace(/[-_]/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+}
+function camelCase(str) {
+    return str.replace(/[-_](.)/g, (_, c) => c.toUpperCase());
+}
+//# sourceMappingURL=generator.js.map

package/dist/src/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/generator.ts"],"names":[],"mappings":";;AAKA,wCAmBC;AAtBD;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAiB;IAC5C,MAAM,QAAQ,GAAa;QACvB,WAAW,CAAC,IAAI,CAAC;QACjB,WAAW,CAAC,IAAI,CAAC;QACjB,gBAAgB,CAAC,IAAI,CAAC;QACtB,aAAa,EAAE;QACf,UAAU,CAAC,IAAI,CAAC;QAChB,kBAAkB,CAAC,IAAI,CAAC;QACxB,iBAAiB,CAAC,IAAI,CAAC;QACvB,eAAe,CAAC,IAAI,CAAC;QACrB,UAAU,CAAC,IAAI,CAAC;QAChB,YAAY,CAAC,IAAI,CAAC;QAClB,WAAW,CAAC,IAAI,CAAC;QACjB,iBAAiB,CAAC,IAAI,CAAC;QACvB,iBAAiB,EAAE;QACnB,YAAY,CAAC,IAAI,CAAC;KACrB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE3C,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACxC,CAAC;AAED,iFAAiF;AAEjF,SAAS,WAAW,CAAC,IAAiB;IAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW;QAC7B,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE;QACzB,CAAC,CAAC,OAAO,IAAI,CAAC,WAAW,eAAe,QAAQ,GAAG,CAAC;IAExD,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,WAAW,CAAC,IAAiB;;IAClC,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,KAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,IAAI,CACP,4CAA4C,OAAO,wCAAwC,IAAI,CAAC,IAAI,GAAG,EACvG,mDAAmD,IAAI,CAAC,IAAI,wCAAwC,IAAI,CAAC,IAAI,GAAG,CACnH,CAAC;IACN,CAAC;IAED,MAAM,CAAC,IAAI,CACP,eAAe,IAAI,CAAC,OAAO,0CAA0C,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,iDAAiD,IAAI,CAAC,OAAO,GAAG,CACxK,CAAC;IAEF,MAAM,WAAW,GAA2B;QACxC,KAAK,EAAE,4FAA4F;QACnG,GAAG,EAAE,4FAA4F;QACjG,SAAS,EACL,iGAAiG;QACrG,UAAU,EACN,0GAA0G;QAC9G,OAAO,EACH,iGAAiG;QACrG,OAAO,EACH,iGAAiG;QACrG,UAAU,EACN,0GAA0G;QAC9G,QAAQ,EACJ,4GAA4G;QAChH,KAAK,EAAE,2FAA2F;QAClG,MAAM,EAAE,8FAA8F;QACtG,OAAO,EACH,iGAAiG;QACrG,MAAM,EAAE,8FAA8F;KACzG,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,WAAW,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAiB;;IACvC,MAAM,QAAQ,GACV,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,MAAM,IAAI,GACN,MAAA,IAAI,CAAC,WAAW,mCAChB,KAAK,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,GAAG,QAAQ,yCAAyC,CAAC;IAE5H,OAAO,CAAC,aAAa,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,aAAa;IAClB,OAAO;QACH,eAAe;QACf,EAAE;QACF,oCAAoC;QACpC,oCAAoC;QACpC,sCAAsC;QACtC,qCAAqC;KACxC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,IAAiB;IACjC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,OAAO;QACH,mBAAmB;QACnB,EAAE;QACF,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KACzC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB;;IACzC,MAAM,IAAI,GAA2B;QACjC,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,YAAY,mCAAI,EAAE,CAAC;QACjC,GAAG,CAAC,MAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,eAAe,mCAAI,EAAE,CAAC;KACvC,CAAC;IAEF,MAAM,KAAK,GAAG;QACV,qBAAqB;QACrB,EAAE;QACF,6CAA6C;QAC7C,EAAE;QACF,gDAAgD;QAChD,8CAA8C;KACjD,CAAC;IAEF,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM;QACnB,KAAK,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;IACjE,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAC;IAC7D,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IAExD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAiB;;IACxC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU;QAC3B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC3D,CAAC,CAAC,mCAAmC,IAAI,CAAC,IAAI,EAAE,CAAC;IAErD,MAAM,KAAK,GAAG;QACV,uBAAuB;QACvB,EAAE;QACF,kBAAkB;QAClB,EAAE;QACF,SAAS;QACT,wBAAwB;QACxB,aAAa,OAAO,MAAM;QAC1B,MAAM,IAAI,CAAC,IAAI,EAAE;QACjB,EAAE;QACF,wBAAwB;QACxB,aAAa;QACb,KAAK;KACR,CAAC;IAEF,IAAI,IAAI,CAAC,WAAW,KAAK,UAAU,KAAI,MAAA,IAAI,CAAC,GAAG,0CAAE,IAAI,CAAA,EAAE,CAAC;QACpD,KAAK,CAAC,IAAI,CACN,EAAE,EACF,iCAAiC,EACjC,EAAE,EACF,SAAS,EACT,kBAAkB,IAAI,CAAC,IAAI,EAAE,EAC7B,KAAK,CACR,CAAC;IACN,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB;IACtC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IAE5D,OAAO;QACH,6BAA6B;QAC7B,EAAE;QACF,4DAA4D;QAC5D,EAAE;QACF,SAAS;QACT,sBAAsB;QACtB,KAAK;QACL,EAAE;QACF,2CAA2C;QAC3C,EAAE;QACF,QAAQ;QACR,IAAI,CAAC,OAAO,CAAC,OAAO;QACpB,KAAK;QACL,EAAE;QACF,wFAAwF;KAC3F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,IAAiB;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9B,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YACrB,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,eAAe,CAAC;IAExB,MAAM,KAAK,GAAG,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IAElC,IAAI,IAAI,CAAC,WAAW,KAAK,UAAU,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CACN,SAAS,EACT,GAAG,IAAI,CAAC,IAAI,YAAY,EACxB,EAAE,EACF,aAAa,EACb,GAAG,IAAI,CAAC,IAAI,SAAS,EACrB,KAAK,CACR,CAAC;IACN,CAAC;SAAM,IAAI,IAAI,CAAC,WAAW,KAAK,aAAa,EAAE,CAAC;QAC5C,KAAK,CAAC,IAAI,CACN,SAAS,EACT,oBAAoB,EACpB,MAAM,EACN,KAAK,EACL,EAAE,EACF,uDAAuD,EACvD,EAAE,EACF,yBAAyB,EACzB,EAAE,EACF,SAAS,EACT,8CAA8C,EAC9C,KAAK,CACR,CAAC;IACN,CAAC;SAAM,IAAI,IAAI,CAAC,WAAW,KAAK,iBAAiB,EAAE,CAAC;QAChD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,CACN,eAAe,EACf,UAAU,KAAK,UAAU,IAAI,CAAC,IAAI,IAAI,EACtC,EAAE,EACF,kBAAkB,EAClB,kBAAkB,KAAK,iBAAiB,EACxC,sBAAsB,EACtB,KAAK,CACR,CAAC;IACN,CAAC;SAAM,CAAC;QACJ,KAAK,CAAC,IAAI,CACN,SAAS,EACT,4BAA4B,EAC5B,MAAM,EACN,KAAK,EACL,EAAE,EACF,sEAAsE,CACzE,CAAC;IACN,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,MAAM,mBAAmB,GAA2B;IAChD,GAAG,EAAE,0CAA0C;IAC/C,KAAK,EAAE,6BAA6B;IACpC,KAAK,EAAE,kCAAkC;IACzC,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,2BAA2B;IACjC,MAAM,EAAE,2BAA2B;IACnC,OAAO,EAAE,sCAAsC;IAC/C,MAAM,EAAE,sBAAsB;IAC9B,IAAI,EAAE,oCAAoC;IAC1C,OAAO,EAAE,yBAAyB;IAClC,QAAQ,EAAE,uBAAuB;IACjC,SAAS,EAAE,8BAA8B;CAC5C,CAAC;AAEF,SAAS,YAAY,CAAC,IAAiB;IACnC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC7C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE;;QACrC,MAAM,IAAI,GAAG,MAAA,mBAAmB,CAAC,IAAI,CAAC,mCAAI,iBAAiB,CAAC;QAC5D,OAAO,eAAe,IAAI,UAAU,GAAG,QAAQ,IAAI,IAAI,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,OAAO;QACH,yBAAyB;QACzB,EAAE;QACF,oCAAoC;QACpC,oCAAoC;QACpC,GAAG,IAAI;KACV,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,IAAiB;IAClC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEpC,OAAO;QACH,cAAc;QACd,EAAE;QACF,SAAS;QACT,8BAA8B;QAC9B,2BAA2B;QAC3B,EAAE;QACF,wBAAwB;QACxB,sBAAsB;QACtB,EAAE;QACF,mBAAmB;QACnB,qBAAqB;QACrB,KAAK;KACR,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAiB;IACxC,MAAM,QAAQ,GAAkB,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAC;IACnE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,CAAC;IAEpD,OAAO;QACH,qBAAqB;QACrB,EAAE;QACF,cAAc;QACd,EAAE;QACF,KAAK;QACL,2BAA2B;QAC3B,KAAK;QACL,EAAE;QACF,eAAe;QACf,EAAE;QACF,qCAAqC;QACrC,qCAAqC;QACrC,sCAAsC;QACtC,wDAAwD;QACxD,yDAAyD;QACzD,EAAE;QACF,6CAA6C;KAChD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB;IACtB,OAAO;QACH,oBAAoB;QACpB,EAAE;QACF,uDAAuD;QACvD,EAAE;QACF,wBAAwB;QACxB,0EAA0E;QAC1E,qEAAqE;QACrE,kEAAkE;QAClE,wBAAwB;QACxB,EAAE;QACF,kDAAkD;KACrD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,IAAiB;;IACnC,MAAM,UAAU,GACZ,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ;QAC3B,CAAC,CAAC,IAAI,CAAC,MAAM;QACb,CAAC,CAAC,CAAC,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,mCAAI,IAAI,CAAC,CAAC;IAEtC,MAAM,KAAK,GAAG;QACV,eAAe;QACf,EAAE;QACF,wCAAwC,IAAI,CAAC,OAAO,2DAA2D;KAClH,CAAC;IAEF,IAAI,UAAU,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,UAAU,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED,iFAAiF;AAEjF,SAAS,UAAU,CAAC,IAAY;IAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,SAAS,CAAC,GAAW;IAC1B,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACtE,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,26 @@
+import { scanProject } from "./scanner";
+import { generateReadme } from "./generator";
+import type { ProjectData, RunOptions, RunResult } from "./types";
+export type { ProjectData, RunOptions, RunResult };
+export type { PackageJson, EnvInfo, DetectedConfigs, ProjectType, } from "./types";
+export { scanProject, generateReadme };
+export { generateExampleValue, detectStack, scanEnvFile } from "./scanner";
+/**
+ * Scan a project directory and return structured project data.
+ * @param projectRoot - Root directory to scan (defaults to cwd)
+ */
+export declare function scan(projectRoot?: string): ProjectData;
+/**
+ * Generate README markdown string from project data.
+ * @param data - Project data returned by scan()
+ */
+export declare function generate(data: ProjectData): string;
+/**
+ * Scan a project and write README.md to disk.
+ * Backs up any existing README before overwriting.
+ *
+ * @param projectRoot - Root directory to scan (defaults to cwd)
+ * @param options     - { output, overwrite }
+ */
+export declare function run(projectRoot?: string, options?: RunOptions): RunResult;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnD,YAAY,EACR,WAAW,EACX,OAAO,EACP,eAAe,EACf,WAAW,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE3E;;;GAGG;AACH,wBAAgB,IAAI,CAAC,WAAW,GAAE,MAAsB,GAAG,WAAW,CAErE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,CAElD;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CACf,WAAW,GAAE,MAAsB,EACnC,OAAO,GAAE,UAAe,GACzB,SAAS,CAkBX"}

package/dist/src/index.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanEnvFile = exports.detectStack = exports.generateExampleValue = exports.generateReadme = exports.scanProject = void 0;
+exports.scan = scan;
+exports.generate = generate;
+exports.run = run;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const scanner_1 = require("./scanner");
+Object.defineProperty(exports, "scanProject", { enumerable: true, get: function () { return scanner_1.scanProject; } });
+const generator_1 = require("./generator");
+Object.defineProperty(exports, "generateReadme", { enumerable: true, get: function () { return generator_1.generateReadme; } });
+var scanner_2 = require("./scanner");
+Object.defineProperty(exports, "generateExampleValue", { enumerable: true, get: function () { return scanner_2.generateExampleValue; } });
+Object.defineProperty(exports, "detectStack", { enumerable: true, get: function () { return scanner_2.detectStack; } });
+Object.defineProperty(exports, "scanEnvFile", { enumerable: true, get: function () { return scanner_2.scanEnvFile; } });
+/**
+ * Scan a project directory and return structured project data.
+ * @param projectRoot - Root directory to scan (defaults to cwd)
+ */
+function scan(projectRoot = process.cwd()) {
+    return (0, scanner_1.scanProject)(projectRoot);
+}
+/**
+ * Generate README markdown string from project data.
+ * @param data - Project data returned by scan()
+ */
+function generate(data) {
+    return (0, generator_1.generateReadme)(data);
+}
+/**
+ * Scan a project and write README.md to disk.
+ * Backs up any existing README before overwriting.
+ *
+ * @param projectRoot - Root directory to scan (defaults to cwd)
+ * @param options     - { output, overwrite }
+ */
+function run(projectRoot = process.cwd(), options = {}) {
+    const { output = "README.md", overwrite = false } = options;
+    const data = scan(projectRoot);
+    const markdown = generate(data);
+    const outPath = path_1.default.join(projectRoot, output);
+    if (fs_1.default.existsSync(outPath) && !overwrite) {
+        const ts = Date.now();
+        const backup = outPath.replace(/\.md$/i, `.backup.${ts}.md`);
+        fs_1.default.renameSync(outPath, backup);
+        console.log(`📦 Existing README backed up to: ${path_1.default.basename(backup)}`);
+    }
+    fs_1.default.writeFileSync(outPath, markdown, "utf-8");
+    return { outPath, data, markdown };
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAoBA,oBAEC;AAMD,4BAEC;AASD,kBAqBC;AA5DD,4CAAoB;AACpB,gDAAwB;AACxB,uCAAwC;AAW/B,4FAXA,qBAAW,OAWA;AAVpB,2CAA6C;AAUvB,+FAVb,0BAAc,OAUa;AACpC,qCAA2E;AAAlE,+GAAA,oBAAoB,OAAA;AAAE,sGAAA,WAAW,OAAA;AAAE,sGAAA,WAAW,OAAA;AAEvD;;;GAGG;AACH,SAAgB,IAAI,CAAC,cAAsB,OAAO,CAAC,GAAG,EAAE;IACpD,OAAO,IAAA,qBAAW,EAAC,WAAW,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,IAAiB;IACtC,OAAO,IAAA,0BAAc,EAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,GAAG,CACf,cAAsB,OAAO,CAAC,GAAG,EAAE,EACnC,UAAsB,EAAE;IAExB,MAAM,EAAE,MAAM,GAAG,WAAW,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAE5D,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAE/C,IAAI,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;QAC7D,YAAE,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CACP,oCAAoC,cAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAC9D,CAAC;IACN,CAAC;IAED,YAAE,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AACvC,CAAC"}

package/dist/src/scanner.d.ts

@@ -0,0 +1,39 @@
+import type { PackageJson, EnvInfo, DetectedConfigs, ProjectType, ProjectData } from "./types";
+/**
+ * Reads and parses package.json from the target project root.
+ */
+export declare function readPackageJson(projectRoot: string): PackageJson | null;
+/**
+ * Detects the tech stack / frameworks used based on package.json dependencies.
+ */
+export declare function detectStack(pkg: PackageJson | null): string[];
+/**
+ * Generate a safe example value based on the env key name.
+ */
+export declare function generateExampleValue(key: string): string;
+/**
+ * Scans .env / .env.example and returns safe example env vars.
+ */
+export declare function scanEnvFile(projectRoot: string): EnvInfo;
+/**
+ * Detect the broad project type from package.json structure.
+ * Note: projectRoot param kept for future use (e.g. checking file structure).
+ */
+export declare function detectProjectType(_projectRoot: string, pkg: PackageJson | null): ProjectType;
+/**
+ * Extract non-internal scripts from package.json.
+ */
+export declare function extractScripts(pkg: PackageJson | null): Record<string, string>;
+/**
+ * Detect which config files exist in the project root.
+ */
+export declare function detectConfigs(projectRoot: string): DetectedConfigs;
+/**
+ * Resolve the repository URL from various package.json repository formats.
+ */
+export declare function resolveRepository(repository: PackageJson["repository"]): string | null;
+/**
+ * Main scanner — aggregates all project information.
+ */
+export declare function scanProject(projectRoot?: string): ProjectData;
+//# sourceMappingURL=scanner.d.ts.map

package/dist/src/scanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanner.d.ts","sourceRoot":"","sources":["../../src/scanner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,WAAW,EACX,OAAO,EACP,eAAe,EACf,WAAW,EACX,WAAW,EACd,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAQvE;AAsCD;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI,GAAG,MAAM,EAAE,CAW7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAqDxD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CA6BxD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC7B,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,WAAW,GAAG,IAAI,GACxB,WAAW,CAqCb;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC1B,GAAG,EAAE,WAAW,GAAG,IAAI,GACxB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAWxB;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,CA2BlE;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC7B,UAAU,EAAE,WAAW,CAAC,YAAY,CAAC,GACtC,MAAM,GAAG,IAAI,CAIf;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,WAAW,GAAE,MAAsB,GAAG,WAAW,CAwB5E"}