dependency-docs-generator 1.0.1 → 1.0.2

package/index.js

@@ -1,25 +1,33 @@
 #!/usr/bin/env node
 const fs = require('fs');
 const axios = require('axios');
+const path = require('path'); // Added for path handling
 
 async function generateDocs() {
   try {
-    // 1. Read the local package.json
-    const packageData = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
+    // 1. Get the path of the package.json in the user's current folder
+    const targetPath = path.join(process.cwd(), 'package.json');
+
+    // Check if the file actually exists before trying to read it
+    if (!fs.existsSync(targetPath)) {
+      console.error("❌ Error: No package.json found in this directory. Are you in the right folder?");
+      return;
+    }
+
+    const packageData = JSON.parse(fs.readFileSync(targetPath, 'utf8'));
     const dependencies = packageData.dependencies || {};
     const depNames = Object.keys(dependencies);
 
     if (depNames.length === 0) {
-      console.log("No dependencies found!");
+      console.log("No dependencies found in package.json!");
       return;
     }
 
     let markdownContent = "# Project Dependency Guide\n\n";
     markdownContent += "| Package | Description | Version |\n| --- | --- | --- |\n";
 
-    console.log(`Found ${depNames.length} packages. Fetching data...`);
+    console.log(`🔍 Found ${depNames.length} packages. Fetching data from npm...`);
 
-    // 2. Fetch data for each package
     for (const name of depNames) {
       try {
         const response = await axios.get(`https://registry.npmjs.org/${name}`);
@@ -32,12 +40,14 @@ async function generateDocs() {
       }
     }
 
-    // 3. Write to DEPENDENCIES.md
-    fs.writeFileSync('DEPENDENCIES.md', markdownContent);
-    console.log("✅ DEPENDENCIES.md has been generated!");
+    // 3. Write to DEPENDENCIES.md in the user's current folder
+    const outputPath = path.join(process.cwd(), 'DEPENDENCIES.md');
+    fs.writeFileSync(outputPath, markdownContent);
+    
+    console.log("✅ DEPENDENCIES.md has been generated successfully!");
 
   } catch (err) {
-    console.error("Error reading package.json:", err.message);
+    console.error("Error:", err.message);
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-docs-generator",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Automatically generates a README guide for your project dependencies",
   "license": "ISC",
   "author": "purushothaman",