feat: add package manager detection

Author: JomsCode21

README.md

@@ -7,19 +7,19 @@
 
 > CLI tool that scans JavaScript and TypeScript projects and automatically generates clean README.md files with installation, usage, scripts, environment variables, and publishing checklist.
 
-## ✨ Features
+## Features
 
-- 🔍 **Smart Project Detection** — Automatically detects project types (Node.js, React, Vue, Next.js, Vite, Express, TypeScript, CLI packages)
-- 📦 **Package.json Analysis** — Extracts metadata, scripts, dependencies, exports, and repository info
-- 📝 **Auto-Generated Documentation** — Creates professional README sections with proper formatting
-- 🌍 **Environment Variables** — Parses `.env.example` and includes variable tables
-- 🎯 **NPM Scripts Table** — Generates markdown tables with human-readable script descriptions
-- 🛡️ **Safe by Default** — Won't overwrite existing files without `--force` flag
-- 🔧 **CLI & Library Support** — Handles both CLI packages and regular npm libraries
-- 📁 **Project Structure** — Optional file tree with `--include-tree`
-- ✅ **Publishing Checklist** — Built-in checklist for npm package releases
+- **Smart Project Detection** — Automatically detects project types (Node.js, React, Vue, Next.js, Vite, Express, TypeScript, CLI packages)
+- **Package.json Analysis** — Extracts metadata, scripts, dependencies, exports, and repository info
+- **Auto-Generated Documentation** — Creates professional README sections with proper formatting
+- **Environment Variables** — Parses `.env.example` and includes variable tables
+- **NPM Scripts Table** — Generates markdown tables with human-readable script descriptions
+- **Safe by Default** — Won't overwrite existing files without `--force` flag
+- **CLI & Library Support** — Handles both CLI packages and regular npm libraries
+- **Project Structure** — Optional file tree with `--include-tree`
+- **Publishing Checklist** — Built-in checklist for npm package releases
 
-## 📦 Installation
+## Installation
 
 ### Global Installation
 
@@ -42,7 +42,7 @@ npm install
 npm run build
 ```
 
-## 🚀 Usage
+## Usage
 
 Generate a README.md in the current directory:
 
@@ -91,7 +91,7 @@ readme-autoscan --include-tree
 readme-autoscan --no-checklist
 ```
 
-## 📋 CLI Options
+## CLI Options
 
 | Option            | Description                                        |
 | ----------------- | -------------------------------------------------- |
@@ -103,7 +103,7 @@ readme-autoscan --no-checklist
 | `-v, --version`   | Show package version                               |
 | `-h, --help`      | Show help message                                  |
 
-## 🎯 Example Output
+## Example Output
 
 Here's what a generated README looks like:
 
@@ -147,7 +147,7 @@ myawesomepackage.someFunction();
 This project is licensed under the MIT License.
 ```
 
-## 🔍 Project Type Detection
+## Project Type Detection
 
 README Auto Scan automatically detects these project types:
 
@@ -161,7 +161,28 @@ README Auto Scan automatically detects these project types:
 | Vite        | Has `vite` dependency or `vite.config.*`       |
 | Express     | Has `express` dependency                       |
 
-## 🧪 Development
+## Package Manager Detection
+
+README Auto Scan automatically detects your package manager from lock files and generates matching commands in Installation, Available Scripts, and Development sections.
+
+| Lock File                      | Package Manager |
+| ------------------------------ | --------------- |
+| `package-lock.json`            | npm             |
+| `pnpm-lock.yaml`               | pnpm            |
+| `yarn.lock`                    | yarn            |
+| `bun.lockb` or `bun.lock`      | bun             |
+
+If no supported lock file is found, it falls back to npm.
+
+Example: if your project contains `pnpm-lock.yaml`, generated commands use:
+
+```bash
+pnpm install
+pnpm dev
+pnpm build
+```
+
+## Development
 
 ```bash
 # Install dependencies
@@ -180,19 +201,25 @@ npm test
 npm run dev
 ```
 
-## 📁 Project Structure
+## Project Structure
 
 ```text
 readme-autoscan/
 ├─ src/
-│  ├─ cli.ts           # CLI entry point and argument parsing
-│  ├─ scanner.ts       # Project scanning and analysis
-│  ├─ detector.ts      # Project type detection
-│  ├─ generator.ts     # README markdown generation
-│  ├─ env.ts           # .env.example parsing
-│  ├─ scripts.ts       # NPM script descriptions
-│  ├─ utils.ts         # Utility functions
-│  └─ *.test.ts        # Test files
+│  ├─ cli.ts              # CLI entry point and argument parsing
+│  ├─ scanner.ts          # Project scanning and analysis
+│  ├─ detector.ts         # Project type detection
+│  ├─ generator.ts        # README markdown generation
+│  ├─ env.ts              # .env.example parsing
+│  ├─ scripts.ts          # NPM script descriptions
+│  ├─ package-manager.ts  # Package manager detection
+│  └─ utils.ts            # Utility functions
+├─ tests/
+│  ├─ generator.test.ts
+│  ├─ package-manager.test.ts
+│  ├─ scripts.test.ts
+│  ├─ utils.test.ts
+│  └─ env.test.ts
 ├─ bin/
 │  └─ readme-autoscan.js  # Executable entry point
 ├─ package.json
@@ -201,7 +228,7 @@ readme-autoscan/
 └─ LICENSE
 ```
 
-## 🏗️ Generated README Sections
+## Generated README Sections
 
 The tool generates these sections based on your project:
 
@@ -219,7 +246,7 @@ The tool generates these sections based on your project:
 12. **License** — From package.json
 13. **Contributing** — Standard contribution message
 
-## 🤝 Contributing
+## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
@@ -229,18 +256,18 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
-## 📄 License
+## License
 
 This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
 
 Copyright (c) 2026 JomsCode21
 
-## 🔗 Links
+## Links
 
 - **Repository:** [github.com/JomsCode21/README-auto-scan](https://github.com/JomsCode21/README-auto-scan)
 - **Issues:** [github.com/JomsCode21/README-auto-scan/issues](https://github.com/JomsCode21/README-auto-scan/issues)
 - **NPM Package:** [npmjs.com/package/readme-autoscan](https://www.npmjs.com/package/readme-autoscan)
 
 ---
 
-Made with ❤️ for the JavaScript/TypeScript community
+Made for the JavaScript/TypeScript community

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "readme-autoscan",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "CLI tool that scans JavaScript/TypeScript projects and automatically generates clean, professional README.md files with installation, usage, scripts, environment variables, and publishing checklist.",
   "main": "dist/cli.js",
   "types": "dist/cli.d.ts",

package.json

@@ -79,6 +79,7 @@ async function run(options: CliOptions): Promise<void> {
   });
 
   if (options.dryRun) {
+    console.log(pc.cyan(`Detected package manager: ${scan.packageManager}`));
     console.log(markdown);
     console.log(
       pc.cyan(
@@ -104,6 +105,7 @@ async function run(options: CliOptions): Promise<void> {
   }
 
   const relativePath = path.relative(rootDir, targetPath);
+  console.log(pc.cyan(`Detected package manager: ${scan.packageManager}`));
   console.log(
     pc.green(`✓ README.md generated successfully at ${relativePath}`),
   );

src/cli.ts

@@ -1,4 +1,5 @@
 import type { ScanResult } from "./scanner";
+import { getPackageManager } from "./package-manager";
 
 export interface GenerateOptions {
   includeChecklist: boolean;
@@ -69,35 +70,27 @@ function getFeatureBullets(scan: ScanResult): string[] {
 }
 
 function getInstallationSection(scan: ScanResult): string {
+  const pm = getPackageManager(scan.packageManager);
   const lines = ["## Installation"];
 
+  lines.push("");
+  lines.push("Install dependencies:");
+  lines.push(["```bash", pm.install, "```"].join("\n"));
+
   if (scan.hasBin) {
     lines.push("");
-    lines.push("Install globally (optional):");
-    lines.push(
-      ["```bash", `npm install -g ${scan.packageName}`, "```"].join("\n"),
-    );
-    lines.push("");
-    lines.push("Or use with npx (no installation):");
-    lines.push(["```bash", `npx ${scan.packageName}`, "```"].join("\n"));
-  } else {
-    lines.push("");
-    lines.push(
-      ["```bash", `npm install ${scan.packageName}`, "```"].join("\n"),
-    );
-    lines.push("");
-    lines.push("Or with yarn:");
-    lines.push(["```bash", `yarn add ${scan.packageName}`, "```"].join("\n"));
+    lines.push("Run the CLI (if installed globally or linked):");
+    lines.push(["```bash", scan.binCommands[0] ?? scan.packageName, "```"].join("\n"));
   }
 
   lines.push("");
-  lines.push("For local development:");
+  lines.push("For local setup from repository:");
   lines.push(
     [
       "```bash",
       "git clone <repository-url>",
       "cd " + scan.packageName,
-      "npm install",
+      pm.install,
       "```",
     ].join("\n"),
   );
@@ -106,6 +99,7 @@ function getInstallationSection(scan: ScanResult): string {
 }
 
 function getUsageSection(scan: ScanResult): string {
+  const pm = getPackageManager(scan.packageManager);
   const lines = ["## Usage"];
 
   if (scan.hasBin && scan.binCommands.length > 0) {
@@ -139,14 +133,14 @@ function getUsageSection(scan: ScanResult): string {
     );
   }
 
-  // Add npm script usage if available
+  // Add package manager script usage if available
   const devScript = scan.scripts.find(
     (s) => s.name === "dev" || s.name === "start",
   );
   if (devScript) {
     lines.push("");
     lines.push("For development:");
-    lines.push(["```bash", `npm run ${devScript.name}`, "```"].join("\n"));
+    lines.push(["```bash", pm.run(devScript.name), "```"].join("\n"));
   }
 
   return lines.join("\n");
@@ -192,18 +186,15 @@ export function generateReadme(
 
   // Available Scripts
   if (scan.scripts.length > 0) {
+    const pm = getPackageManager(scan.packageManager);
     sections.push("## Available Scripts");
     sections.push("");
     sections.push("| Script | Description | Command |");
     sections.push("|--------|-------------|---------|");
     scan.scripts.forEach((script) => {
-      const cleanCommand = script.command
-        .replace(/\|/g, "\\|")
-        .substring(0, 40);
-      const displayCmd =
-        script.command.length > 40 ? cleanCommand + "..." : cleanCommand;
+      const runCommand = pm.run(script.name);
       sections.push(
-        `| \`${script.name}\` | ${script.description} | \`${displayCmd}\` |`,
+        `| \`${script.name}\` | ${script.description} | \`${runCommand}\` |`,
       );
     });
   }
@@ -255,24 +246,30 @@ export function generateReadme(
   }
 
   // Development
-  const devScript = scan.scripts.find((s) => s.name === "dev");
-  const hasDevScript = !!devScript;
+  const hasCheckScript = scan.scripts.some((s) => s.name === "check");
+  const hasBuildScript = scan.scripts.some((s) => s.name === "build");
+  const hasDevScript = scan.scripts.some((s) => s.name === "dev");
+  const pm = getPackageManager(scan.packageManager);
 
   sections.push("## Development");
   sections.push("");
   sections.push("```bash");
   sections.push("# Install dependencies");
-  sections.push("npm install");
-  sections.push("");
-  sections.push("# Run type checking");
-  sections.push("npm run check");
-  sections.push("");
-  sections.push("# Build the project");
-  sections.push("npm run build");
+  sections.push(pm.install);
+  if (hasCheckScript) {
+    sections.push("");
+    sections.push("# Run type checking");
+    sections.push(pm.run("check"));
+  }
+  if (hasBuildScript) {
+    sections.push("");
+    sections.push("# Build the project");
+    sections.push(pm.run("build"));
+  }
   if (hasDevScript) {
     sections.push("");
     sections.push("# Start development mode");
-    sections.push("npm run dev");
+    sections.push(pm.run("dev"));
   }
   sections.push("```");