readme-author 0.1.2

package/README.md

@@ -0,0 +1,11 @@
+# readme-author
+
+## Description
+
+
+## Installation
+npm install
+
+## Available Scripts
+- npm run test
+- npm run build

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const path = require("path");
+const readline = require("readline");
+const chalk_1 = require("chalk");
+const ora_1 = require("ora");
+const commander_1 = require("commander");
+const stack_detector_1 = require("./core/stack-detector");
+const package_parser_1 = require("./core/package-parser");
+const markdown_generator_1 = require("./generator/markdown-generator");
+const nodeFiglet = require("figlet");
+const gradient_string_1 = require("gradient-string");
+const program = new commander_1.Command();
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+program
+    .name("readme-author")
+    .description("Auto generate README.md from project")
+    .version("1.0.0");
+console.log(gradient_string_1.default.rainbow(nodeFiglet.textSync("README AUTHOR", {
+    horizontalLayout: "default",
+})));
+function askOverwrite(filePath) {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        rl.question(`A README.md already exists at "${filePath}". Overwrite? (y/n) `, (answer) => {
+            rl.close();
+            const normalized = answer.trim().toLowerCase();
+            resolve(normalized === "y" || normalized === "yes");
+        });
+    });
+}
+program
+    .argument("[projectPath]", "Path to project directory", ".")
+    .action(async (projectPathArg) => {
+    const projectPath = path.resolve(process.cwd(), projectPathArg);
+    let spinner = null;
+    try {
+        spinner = (0, ora_1.default)(chalk_1.default.cyan("Analyzing project...")).start();
+        await sleep(500);
+        if (!(0, stack_detector_1.detectNodeProject)(projectPath)) {
+            spinner.fail(chalk_1.default.yellow("No supported project detected in the provided directory."));
+            return;
+        }
+        spinner.succeed(chalk_1.default.green("Project detected."));
+        spinner = (0, ora_1.default)(chalk_1.default.cyan("Reading package.json...")).start();
+        await sleep(500);
+        const pkg = (0, package_parser_1.parsePackageJson)(projectPath);
+        spinner.succeed(chalk_1.default.green("package.json read successfully."));
+        spinner = (0, ora_1.default)(chalk_1.default.cyan("Generating README content...")).start();
+        await sleep(500);
+        const markdown = (0, markdown_generator_1.generateReadmeMarkdown)(pkg);
+        spinner.succeed(chalk_1.default.green("README content generated."));
+        const readmePath = path.join(projectPath, "README.md");
+        const creatingNew = !fs.existsSync(readmePath);
+        if (!creatingNew) {
+            if (spinner)
+                spinner.stop();
+            const shouldOverwrite = await askOverwrite(readmePath);
+            if (!shouldOverwrite) {
+                console.log(chalk_1.default.yellow("Aborted. Existing README.md was not overwritten."));
+                return;
+            }
+            spinner = (0, ora_1.default)(chalk_1.default.cyan("Updating existing README.md...")).start();
+        }
+        else {
+            spinner = (0, ora_1.default)(chalk_1.default.cyan("Creating README.md...")).start();
+        }
+        await sleep(500);
+        fs.writeFileSync(readmePath, markdown, "utf8");
+        spinner.succeed(chalk_1.default.green(creatingNew
+            ? "README.md created successfully!"
+            : "README.md updated successfully!"));
+    }
+    catch (error) {
+        if (spinner) {
+            spinner.fail(chalk_1.default.red("Failed to generate README.md."));
+        }
+        else {
+            console.error(chalk_1.default.red("Failed to generate README.md."));
+        }
+        if (error instanceof Error) {
+            console.error(chalk_1.default.red(error.message));
+        }
+        process.exitCode = 1;
+    }
+});
+program.parse(process.argv);
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yBAAyB;AACzB,6BAA6B;AAC7B,qCAAqC;AACrC,iCAA0B;AAC1B,6BAA+B;AAC/B,yCAAoC;AACpC,0DAA0D;AAC1D,0DAAyD;AACzD,uEAAwE;AACxE,qCAAsC;AACtC,qDAAuC;AAEvC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,eAAe,CAAC;KACrB,WAAW,CAAC,sCAAsC,CAAC;KACnD,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO,CAAC,GAAG,CACP,yBAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,eAAe,EAAE;IAClD,gBAAgB,EAAE,SAAS;CAC5B,CAAC,CACH,CAAC,CAAA;AAGN,SAAS,YAAY,CAAC,QAAgB;IACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,EAAE,GAAG,QAAQ,CAAC,eAAe,CAAC;YAClC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QAEH,EAAE,CAAC,QAAQ,CACT,kCAAkC,QAAQ,sBAAsB,EAChE,CAAC,MAAM,EAAE,EAAE;YACT,EAAE,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC/C,OAAO,CAAC,UAAU,KAAK,GAAG,IAAI,UAAU,KAAK,KAAK,CAAC,CAAC;QACtD,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,OAAO;KACJ,QAAQ,CAAC,eAAe,EAAE,2BAA2B,EAAE,GAAG,CAAC;KAC3D,MAAM,CAAC,KAAK,EAAE,cAAsB,EAAE,EAAE;IACvC,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;IAEhE,IAAI,OAAO,GAAe,IAAI,CAAC;IAE/B,IAAI,CAAC;QACH,OAAO,GAAG,IAAA,aAAG,EAAC,eAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAC1D,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjB,IAAI,CAAC,IAAA,kCAAiB,EAAC,WAAW,CAAC,EAAE,CAAC;YACpC,OAAO,CAAC,IAAI,CACV,eAAK,CAAC,MAAM,CAAC,0DAA0D,CAAC,CACzE,CAAC;YACF,OAAO;QACT,CAAC;QAED,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAElD,OAAO,GAAG,IAAA,aAAG,EAAC,eAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7D,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjB,MAAM,GAAG,GAAG,IAAA,iCAAgB,EAAC,WAAW,CAAC,CAAC;QAE1C,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC,CAAC;QAEhE,OAAO,GAAG,IAAA,aAAG,EAAC,eAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAClE,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAEjB,MAAM,QAAQ,GAAG,IAAA,2CAAsB,EAAC,GAAG,CAAC,CAAC;QAE7C,OAAO,CAAC,OAAO,CAAC,eAAK,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;QAE1D,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,IAAI,OAAO;gBAAE,OAAO,CAAC,IAAI,EAAE,CAAC;YAE5B,MAAM,eAAe,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC;YAEvD,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,MAAM,CAAC,kDAAkD,CAAC,CACjE,CAAC;gBACF,OAAO;YACT,CAAC;YAED,OAAO,GAAG,IAAA,aAAG,EAAC,eAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QACtE,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,IAAA,aAAG,EAAC,eAAK,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7D,CAAC;QAED,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QACjB,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE/C,OAAO,CAAC,OAAO,CACb,eAAK,CAAC,KAAK,CACT,WAAW;YACT,CAAC,CAAC,iCAAiC;YACnC,CAAC,CAAC,iCAAiC,CACtC,CACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,eAAK,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/core/package-parser.d.ts

@@ -0,0 +1,8 @@
+export type PackageJson = {
+    name: string;
+    description: string;
+    scripts: Record<string, string>;
+    dependencies: Record<string, string>;
+};
+export declare function parsePackageJson(projectPath: string): PackageJson;
+//# sourceMappingURL=package-parser.d.ts.map

package/dist/core/package-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-parser.d.ts","sourceRoot":"","sources":["../../src/core/package-parser.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,WAAW,CAUjE"}

package/dist/core/package-parser.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePackageJson = parsePackageJson;
+const fs = require("fs");
+const path = require("path");
+function parsePackageJson(projectPath) {
+    const packageJsonPath = path.join(projectPath, "package.json");
+    const packageJson = fs.readFileSync(packageJsonPath, "utf8");
+    const packageStructure = JSON.parse(packageJson);
+    return {
+        name: packageStructure.name,
+        description: packageStructure.description,
+        scripts: packageStructure.scripts,
+        dependencies: packageStructure.dependencies,
+    };
+}
+//# sourceMappingURL=package-parser.js.map

package/dist/core/package-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-parser.js","sourceRoot":"","sources":["../../src/core/package-parser.ts"],"names":[],"mappings":";;AAUA,4CAUC;AApBD,yBAAyB;AACzB,6BAA6B;AAS7B,SAAgB,gBAAgB,CAAC,WAAmB;IAClD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAC/D,MAAM,WAAW,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAgB,CAAC;IAChE,OAAO;QACL,IAAI,EAAE,gBAAgB,CAAC,IAAI;QAC3B,WAAW,EAAE,gBAAgB,CAAC,WAAW;QACzC,OAAO,EAAE,gBAAgB,CAAC,OAAO;QACjC,YAAY,EAAE,gBAAgB,CAAC,YAAY;KAC5C,CAAC;AACJ,CAAC"}

package/dist/core/stack-detector.d.ts

@@ -0,0 +1,2 @@
+export declare function detectNodeProject(projectPath: string): boolean;
+//# sourceMappingURL=stack-detector.d.ts.map

package/dist/core/stack-detector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack-detector.d.ts","sourceRoot":"","sources":["../../src/core/stack-detector.ts"],"names":[],"mappings":"AAGA,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAE9D"}

package/dist/core/stack-detector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectNodeProject = detectNodeProject;
+const fs = require("fs");
+const path = require("path");
+function detectNodeProject(projectPath) {
+    return fs.existsSync(path.join(projectPath, "package.json"));
+}
+//# sourceMappingURL=stack-detector.js.map

package/dist/core/stack-detector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack-detector.js","sourceRoot":"","sources":["../../src/core/stack-detector.ts"],"names":[],"mappings":";;AAGA,8CAEC;AALD,yBAAyB;AACzB,6BAA6B;AAE7B,SAAgB,iBAAiB,CAAC,WAAmB;IACnD,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;AAC/D,CAAC"}

package/dist/generator/markdown-generator.d.ts

@@ -0,0 +1,3 @@
+import type { PackageJson } from "../core/package-parser";
+export declare function generateReadmeMarkdown(pkg: PackageJson): string;
+//# sourceMappingURL=markdown-generator.d.ts.map

package/dist/generator/markdown-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-generator.d.ts","sourceRoot":"","sources":["../../src/generator/markdown-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,WAAW,GAAG,MAAM,CA2B/D"}

package/dist/generator/markdown-generator.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateReadmeMarkdown = generateReadmeMarkdown;
+function generateReadmeMarkdown(pkg) {
+    const lines = [];
+    const projectName = pkg.name || "Project Name";
+    const description = pkg.description || "";
+    lines.push(`# ${projectName}`);
+    lines.push("");
+    lines.push("## Description");
+    lines.push(description);
+    lines.push("");
+    lines.push("## Installation");
+    lines.push("npm install");
+    lines.push("");
+    lines.push("## Available Scripts");
+    const scriptNames = Object.keys(pkg.scripts ?? {});
+    if (scriptNames.length === 0) {
+        lines.push("- (no npm scripts defined)");
+    }
+    else {
+        for (const name of scriptNames) {
+            lines.push(`- npm run ${name}`);
+        }
+    }
+    return lines.join("\n");
+}
+//# sourceMappingURL=markdown-generator.js.map

package/dist/generator/markdown-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-generator.js","sourceRoot":"","sources":["../../src/generator/markdown-generator.ts"],"names":[],"mappings":";;AAEA,wDA2BC;AA3BD,SAAgB,sBAAsB,CAAC,GAAgB;IACrD,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,WAAW,GAAG,GAAG,CAAC,IAAI,IAAI,cAAc,CAAC;IAC/C,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;IAE1C,KAAK,CAAC,IAAI,CAAC,KAAK,WAAW,EAAE,CAAC,CAAC;IAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC7B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC9B,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAEnC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAEnD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "readme-author",
+  "version": "0.1.2",
+  "description": "Zero-config CLI tool to auto-generate README.md from your project",
+  "main": "dist/cli.js",
+  "type": "commonjs",
+  "bin": {
+    "readme-author": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tallman1O/readme-author.git"
+  },
+  "keywords": [
+    "cli",
+    "readme",
+    "documentation",
+    "nodejs",
+    "developer-tools"
+  ],
+  "author": "Mehul Uttam",
+  "license": "ISC",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "figlet": "^1.10.0",
+    "fs-extra": "^11.3.3",
+    "gradient-string": "^3.0.0",
+    "ora": "^9.3.0"
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.7.0",
+    "@types/gradient-string": "^1.1.6",
+    "@types/node": "^25.3.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}