dependency-docs-generator 1.0.0

package/index.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const axios = require('axios');
+
+async function generateDocs() {
+  try {
+    // 1. Read the local package.json
+    const packageData = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+    const dependencies = packageData.dependencies || {};
+    const depNames = Object.keys(dependencies);
+
+    if (depNames.length === 0) {
+      console.log("No dependencies found!");
+      return;
+    }
+
+    let markdownContent = "# Project Dependency Guide\n\n";
+    markdownContent += "| Package | Description | Version |\n| --- | --- | --- |\n";
+
+    console.log(`Found ${depNames.length} packages. Fetching data...`);
+
+    // 2. Fetch data for each package
+    for (const name of depNames) {
+      try {
+        const response = await axios.get(`https://registry.npmjs.org/${name}`);
+        const description = response.data.description || "No description available.";
+        const version = dependencies[name];
+
+        markdownContent += `| **${name}** | ${description} | \`${version}\` |\n`;
+      } catch (error) {
+        console.error(`Could not fetch data for ${name}`);
+      }
+    }
+
+    // 3. Write to DEPENDENCIES.md
+    fs.writeFileSync('DEPENDENCIES.md', markdownContent);
+    console.log("✅ DEPENDENCIES.md has been generated!");
+
+  } catch (err) {
+    console.error("Error reading package.json:", err.message);
+  }
+}
+
+generateDocs();

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "dependency-docs-generator",
+  "version": "1.0.0",
+  "description": "Automatically generates a README guide for your project dependencies",
+  "license": "ISC",
+  "author": "purushothaman",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "axios": "^1.13.5",
+    "dotenv": "^17.3.1",
+    "express": "^5.2.1",
+    "lodash": "^4.17.23"
+  },
+  "bin": {
+    "gen-docs": "index.js"
+  }
+}