zero-doc 1.0.4 → 1.0.6

package/dist/cli.js

@@ -34,7 +34,6 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-require("dotenv/config");
 const commander_1 = require("commander");
 const ai_analyzer_1 = require("./ai-analyzer");
 const fs = __importStar(require("fs"));
@@ -42,7 +41,6 @@ const path = __importStar(require("path"));
 const child_process_1 = require("child_process");
 const tmp = __importStar(require("tmp"));
 const fse = __importStar(require("fs-extra"));
-// Simple progress bar
 function updateProgress(current, total, label = '') {
     const percentage = Math.min(100, Math.round((current / total) * 100));
     const barLength = 30;
@@ -51,26 +49,24 @@ function updateProgress(current, total, label = '') {
     const bar = '█'.repeat(filled) + '░'.repeat(empty);
     process.stdout.write(`\r${label} [${bar}] ${percentage}%`);
     if (percentage === 100) {
-        // Clear the progress bar line
         process.stdout.write('\r' + ' '.repeat(process.stdout.columns || 80) + '\r');
     }
 }
-// Display final URL with formatting
+function clearProgress() {
+    process.stdout.write('\r' + ' '.repeat(process.stdout.columns || 80) + '\r');
+}
 function displayUrl(url) {
-    // ANSI color codes
     const reset = '\x1b[0m';
     const red = '\x1b[31m';
     const blue = '\x1b[34m';
     const bold = '\x1b[1m';
     const underline = '\x1b[4m';
-    // ➜ in red, "Local:" in bold, URL in blue with underline
     process.stdout.write(`${red}➜${reset}  ${bold}Local:${reset}   ${blue}${underline}${url}${reset}\n`);
 }
 commander_1.program
     .name('zero-doc')
     .description('Zero-Config API Documentation Generator')
     .version('1.0.0');
-// Init command
 commander_1.program
     .command('init')
     .description('Initialize zero-doc in your project')
@@ -92,7 +88,6 @@ commander_1.program
     console.log('✅ Created zero-doc.config.json');
     console.log('💡 Run: zero-doc generate');
 });
-// Generate command
 commander_1.program
     .command('generate')
     .description('Generate API inventory from project using AI')
@@ -102,41 +97,28 @@ commander_1.program
     .option('--ai-provider <provider>', 'AI provider: gemini', 'gemini')
     .action(async (options) => {
     console.log('🤖 Analyzing project with AI...\n');
-    // Load config if exists
     const configPath = path.join(process.cwd(), 'zero-doc.config.json');
     let config = {};
     if (fs.existsSync(configPath)) {
         config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
     }
     try {
-        // Get AI API key - try multiple sources in order of priority
-        const provider = options.aiProvider || config.ai?.provider || 'gemini';
-        // 1. Try built-in config (from dist/config.json - set during build)
-        let aiApiKey;
-        const builtInConfigPath = path.join(__dirname, 'config.json');
-        if (fs.existsSync(builtInConfigPath)) {
+        let generateApiUrl;
+        const generateConfigPath = path.join(__dirname, 'config.json');
+        if (fs.existsSync(generateConfigPath)) {
             try {
-                const builtInConfig = JSON.parse(fs.readFileSync(builtInConfigPath, 'utf-8'));
-                aiApiKey = builtInConfig.apiKey;
+                const generateConfig = JSON.parse(fs.readFileSync(generateConfigPath, 'utf-8'));
+                generateApiUrl = generateConfig.apiUrl;
             }
             catch (error) {
-                // Ignore errors reading built-in config
             }
         }
-        // 2. Fallback to environment variable (for development/testing)
-        if (!aiApiKey) {
-            aiApiKey = process.env.GEMINI_API_KEY;
-        }
-        // 3. Last resort: config file (not recommended, but kept for backward compatibility)
-        if (!aiApiKey) {
-            aiApiKey = config.ai?.apiKey;
-        }
-        if (!aiApiKey) {
-            console.error('❌ Error: API key not configured');
-            console.error('💡 This should not happen. Please contact support.');
+        if (!generateApiUrl || generateApiUrl.trim() === '') {
+            console.error('❌ Error: API configuration not found');
+            console.error('💡 This should not happen. The package should include the configuration.');
+            console.error('💡 Please reinstall: npm install -g zero-doc');
             process.exit(1);
         }
-        // Read package.json for project info
         let projectName = options.name || config.name;
         let projectVersion;
         let projectDescription;
@@ -149,31 +131,25 @@ commander_1.program
                 projectDescription = packageJson.description;
             }
             catch (error) {
-                // Ignore errors reading package.json
             }
         }
-        // Analyze with AI
         const inputPattern = options.input || config.input || 'src/**/*.{ts,js}';
-        // Handle glob patterns with braces - don't split if pattern contains {}
         const patterns = inputPattern.includes('{') && inputPattern.includes('}')
-            ? [inputPattern] // Single pattern with braces
-            : inputPattern.split(',').map(p => p.trim()); // Multiple patterns separated by comma
+            ? [inputPattern]
+            : inputPattern.split(',').map(p => p.trim());
         console.log(`📋 Using patterns: ${patterns.join(', ')}\n`);
         const analyzer = new ai_analyzer_1.AIAnalyzer({
-            apiKey: aiApiKey,
+            apiUrl: generateApiUrl,
             projectRoot: process.cwd(),
             filePatterns: patterns,
         });
         const inventory = await analyzer.analyzeProject();
-        // Set project info
         inventory.project.name = inventory.project.name || projectName;
         inventory.project.version = inventory.project.version || projectVersion;
         inventory.project.description = inventory.project.description || projectDescription;
-        // Set baseUrl default
         if (!inventory.baseUrl) {
             inventory.baseUrl = 'https://api.example.com';
         }
-        // Save to file
         const outputPath = options.output || config.output || 'api-inventory.json';
         const json = JSON.stringify(inventory, null, 2);
         const dir = path.dirname(outputPath);
@@ -196,45 +172,89 @@ commander_1.program
         process.exit(1);
     }
 });
-// Preview command
 commander_1.program
     .command('preview')
     .description('Generate docs and start local preview server')
     .action(async () => {
-    // Load config if exists
     const configPath = path.join(process.cwd(), 'zero-doc.config.json');
     let config = {};
     if (fs.existsSync(configPath)) {
         config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
     }
+    let vite = null;
+    let tmpDir = null;
+    const cleanup = async () => {
+        clearProgress();
+        process.stdout.write('\n');
+        console.log('Finalizing project...');
+        if (vite && !vite.killed && vite.pid) {
+            try {
+                if (process.platform === 'win32') {
+                    const killProcess = (0, child_process_1.spawn)('taskkill', ['/F', '/T', '/PID', vite.pid.toString()], {
+                        stdio: 'pipe',
+                        shell: false,
+                        windowsHide: true
+                    });
+                    killProcess.stdout?.on('data', () => { });
+                    killProcess.stderr?.on('data', () => { });
+                    await new Promise((resolve) => {
+                        killProcess.on('close', () => resolve());
+                        killProcess.on('error', () => resolve());
+                        setTimeout(() => resolve(), 2000);
+                    });
+                }
+                else {
+                    vite.kill('SIGTERM');
+                }
+                await new Promise(resolve => setTimeout(resolve, 1500));
+            }
+            catch (error) {
+            }
+        }
+        if (tmpDir) {
+            let retries = 5;
+            while (retries > 0) {
+                try {
+                    tmpDir.removeCallback();
+                    break;
+                }
+                catch (error) {
+                    if ((error.code === 'EBUSY' || error.code === 'ENOENT') && retries > 1) {
+                        const waitTime = process.platform === 'win32' ? 1000 : 500;
+                        await new Promise(resolve => setTimeout(resolve, waitTime));
+                        retries--;
+                    }
+                    else {
+                        break;
+                    }
+                }
+            }
+        }
+        process.exit(0);
+    };
+    process.on('SIGINT', cleanup);
+    process.on('SIGTERM', cleanup);
     try {
         updateProgress(0, 100, 'Analyzing project');
-        // Get AI API key - try multiple sources in order of priority
-        const provider = config.ai?.provider || 'gemini';
-        // 1. Try built-in config (from dist/config.json - set during build)
-        let aiApiKey;
+        let apiUrl;
         const builtInConfigPath = path.join(__dirname, 'config.json');
         if (fs.existsSync(builtInConfigPath)) {
             try {
                 const builtInConfig = JSON.parse(fs.readFileSync(builtInConfigPath, 'utf-8'));
-                aiApiKey = builtInConfig.apiKey;
+                apiUrl = builtInConfig.apiUrl;
             }
             catch (error) {
-                // Ignore errors reading built-in config
             }
         }
-        // 2. Fallback to environment variable (for development/testing)
-        if (!aiApiKey) {
-            aiApiKey = process.env.GEMINI_API_KEY;
-        }
-        if (!aiApiKey) {
+        if (!apiUrl || apiUrl.trim() === '') {
+            clearProgress();
             process.stdout.write('\n');
-            console.error('❌ Error: API key not configured');
-            console.error('💡 This should not happen. Please contact support.');
+            console.error('❌ Error: API configuration not found');
+            console.error('💡 This should not happen. The package should include the configuration.');
+            console.error('💡 Please reinstall: npm install -g zero-doc');
             process.exit(1);
         }
         updateProgress(10, 100, 'Analyzing project');
-        // Read package.json for project info
         let projectName = config.name;
         let projectVersion;
         let projectDescription;
@@ -247,52 +267,43 @@ commander_1.program
                 projectDescription = packageJson.description;
             }
             catch (error) {
-                // Ignore errors reading package.json
             }
         }
-        // Analyze with AI - use config or default pattern
         const inputPattern = config.input || 'src/**/*.{ts,js,py,java,go,rs,php,rb}';
-        // Handle glob patterns with braces - don't split if pattern contains {}
         const patterns = inputPattern.includes('{') && inputPattern.includes('}')
-            ? [inputPattern] // Single pattern with braces
-            : inputPattern.split(',').map(p => p.trim()); // Multiple patterns separated by comma
+            ? [inputPattern]
+            : inputPattern.split(',').map(p => p.trim());
         const analyzer = new ai_analyzer_1.AIAnalyzer({
-            apiKey: aiApiKey,
+            apiUrl: apiUrl,
             projectRoot: process.cwd(),
             filePatterns: patterns,
         });
         updateProgress(20, 100, 'Analyzing project');
         const inventory = await analyzer.analyzeProject();
-        // Set project info
         inventory.project.name = inventory.project.name || projectName;
         inventory.project.version = inventory.project.version || projectVersion;
         inventory.project.description = inventory.project.description || projectDescription;
-        // Set baseUrl default
         if (!inventory.baseUrl) {
             inventory.baseUrl = 'https://api.example.com';
         }
         updateProgress(40, 100, 'Setting up viewer');
-        // Step 2: Create temporary directory
-        const tmpDir = tmp.dirSync({
+        tmpDir = tmp.dirSync({
             prefix: 'zero-doc-',
             unsafeCleanup: true
         });
         const tempViewerPath = path.join(tmpDir.name, 'viewer');
-        // Step 3: Find viewer source (works when installed or in development)
         let viewerSourcePath;
-        // Try installed package path first (when installed globally)
-        // __dirname will be dist/ when compiled, so ../viewer is correct
         const installedViewerPath = path.join(__dirname, '../viewer');
         if (fs.existsSync(installedViewerPath)) {
             viewerSourcePath = installedViewerPath;
         }
         else {
-            // Try development path (when running from src/)
             const devViewerPath = path.join(__dirname, '../viewer');
             if (fs.existsSync(devViewerPath)) {
                 viewerSourcePath = devViewerPath;
             }
             else {
+                clearProgress();
                 process.stdout.write('\n');
                 console.error('❌ Error: Viewer app not found');
                 console.error('💡 Expected viewer at:', installedViewerPath);
@@ -301,10 +312,8 @@ commander_1.program
             }
         }
         updateProgress(50, 100, 'Setting up viewer');
-        // Step 4: Copy viewer files to temp directory
         await fse.copy(viewerSourcePath, tempViewerPath, {
             filter: (src) => {
-                // Skip node_modules, dist, and other build artifacts
                 const relativePath = path.relative(viewerSourcePath, src);
                 return !relativePath.includes('node_modules') &&
                     !relativePath.includes('dist') &&
@@ -312,12 +321,10 @@ commander_1.program
             }
         });
         updateProgress(60, 100, 'Preparing files');
-        // Step 5: Copy generated JSON to temp viewer public folder
         const tempPublicPath = path.join(tempViewerPath, 'public');
         if (!fs.existsSync(tempPublicPath)) {
             fs.mkdirSync(tempPublicPath, { recursive: true });
         }
-        // Validate inventory before saving
         if (!inventory.endpoints || !Array.isArray(inventory.endpoints)) {
             inventory.endpoints = [];
         }
@@ -327,11 +334,9 @@ commander_1.program
                 byMethod: {},
             };
         }
-        // Ensure baseUrl exists
         if (!inventory.baseUrl) {
             inventory.baseUrl = 'https://api.example.com';
         }
-        // Validate JSON before saving
         try {
             const jsonContent = JSON.stringify(inventory, null, 2);
             JSON.parse(jsonContent);
@@ -347,11 +352,11 @@ commander_1.program
             }
         }
         catch (error) {
+            clearProgress();
             process.stdout.write('\n');
             console.error('❌ Error saving JSON:', error);
             throw error;
         }
-        // Verify JSON file exists and is valid before proceeding
         const jsonPath = path.join(tempPublicPath, 'api-inventory.json');
         if (!fs.existsSync(jsonPath)) {
             throw new Error('JSON file was not created successfully');
@@ -360,7 +365,6 @@ commander_1.program
         if (fileStats.size === 0) {
             throw new Error('JSON file is empty');
         }
-        // Verify JSON is valid
         try {
             const testContent = fs.readFileSync(jsonPath, 'utf-8');
             const testParsed = JSON.parse(testContent);
@@ -369,12 +373,12 @@ commander_1.program
             }
         }
         catch (error) {
+            clearProgress();
             process.stdout.write('\n');
             console.error('❌ JSON validation failed:', error);
             throw error;
         }
         updateProgress(70, 100, 'Installing dependencies');
-        // Step 6: Install dependencies in temp directory
         const installProcess = (0, child_process_1.spawn)('npm', ['install'], {
             cwd: tempViewerPath,
             stdio: 'ignore',
@@ -392,17 +396,14 @@ commander_1.program
             installProcess.on('error', reject);
         });
         updateProgress(90, 100, 'Starting server');
-        // Step 7: Start Vite dev server (suppress Vite output)
-        const vite = (0, child_process_1.spawn)('npm', ['run', 'dev'], {
+        vite = (0, child_process_1.spawn)('npm', ['run', 'dev'], {
             cwd: tempViewerPath,
             stdio: ['ignore', 'pipe', 'pipe'],
             shell: true
         });
         let serverReady = false;
-        // Intercept and filter Vite output
         vite.stdout?.on('data', (data) => {
             const output = data.toString();
-            // Filter out Vite-specific messages completely
             if (output.includes('Local:') || output.includes('Network:') || output.includes('➜')) {
                 return;
             }
@@ -412,14 +413,12 @@ commander_1.program
                 displayUrl('http://localhost:7777/');
             }
             else if (!output.includes('VITE') && !output.includes('vite') && !output.trim().startsWith('➜')) {
-                // Only show non-Vite messages (errors, etc.)
                 if (!serverReady) {
                     process.stderr.write(data);
                 }
             }
         });
         vite.stderr?.on('data', (data) => {
-            // Show errors but filter Vite branding
             if (!serverReady) {
                 const output = data.toString();
                 if (!output.includes('VITE') && !output.includes('vite')) {
@@ -427,69 +426,8 @@ commander_1.program
                 }
             }
         });
-        // Cleanup on exit
-        const cleanup = async () => {
-            process.stdout.write('\n');
-            // Kill Vite process first (and all child processes on Windows)
-            if (vite && !vite.killed && vite.pid) {
-                try {
-                    if (process.platform === 'win32') {
-                        // On Windows, kill the entire process tree without confirmation
-                        // Use /F to force kill and /T to kill child processes
-                        const killProcess = (0, child_process_1.spawn)('taskkill', ['/F', '/T', '/PID', vite.pid.toString()], {
-                            stdio: 'pipe',
-                            shell: false, // Don't use shell to avoid confirmation prompts
-                            windowsHide: true
-                        });
-                        // Consume output to prevent any prompts
-                        killProcess.stdout?.on('data', () => { });
-                        killProcess.stderr?.on('data', () => { });
-                        // Wait for kill command to complete
-                        await new Promise((resolve) => {
-                            killProcess.on('close', () => resolve());
-                            killProcess.on('error', () => resolve());
-                            // Timeout after 2 seconds
-                            setTimeout(() => resolve(), 2000);
-                        });
-                    }
-                    else {
-                        vite.kill('SIGTERM');
-                    }
-                    // Wait for process to close and files to be released
-                    await new Promise(resolve => setTimeout(resolve, 1500));
-                }
-                catch (error) {
-                    // Ignore errors when killing
-                }
-            }
-            // Try to remove temp directory with retries
-            let retries = 5;
-            let lastError = null;
-            while (retries > 0) {
-                try {
-                    tmpDir.removeCallback();
-                    break;
-                }
-                catch (error) {
-                    lastError = error;
-                    if ((error.code === 'EBUSY' || error.code === 'ENOENT') && retries > 1) {
-                        // Wait a bit more and retry (longer wait on Windows)
-                        const waitTime = process.platform === 'win32' ? 1000 : 500;
-                        await new Promise(resolve => setTimeout(resolve, waitTime));
-                        retries--;
-                    }
-                    else {
-                        // If it's the last retry or different error, just log and continue
-                        break;
-                    }
-                }
-            }
-            // Silently handle cleanup errors
-            process.exit(0);
-        };
-        process.on('SIGINT', cleanup);
-        process.on('SIGTERM', cleanup);
         vite.on('error', (error) => {
+            clearProgress();
             process.stdout.write('\n');
             console.error('❌ Error starting preview server:', error);
             cleanup();
@@ -499,11 +437,12 @@ commander_1.program
         });
     }
     catch (error) {
+        clearProgress();
+        process.stdout.write('\n');
         console.error('❌ Error:', error instanceof Error ? error.message : error);
         process.exit(1);
     }
 });
-// Deploy command (placeholder)
 commander_1.program
     .command('deploy')
     .description('Deploy documentation to zero-doc cloud')
@@ -518,9 +457,5 @@ commander_1.program
     console.log('🚀 Deploying documentation...\n');
     console.log('⚠️  Deploy feature coming soon!');
     console.log('💡 For now, you can serve the viewer locally with: zero-doc preview');
-    // TODO: Implement actual deployment
-    // - Upload JSON to backend
-    // - Get unique URL
-    // - Return docs.zerodoc.com/user/project
 });
 commander_1.program.parse();

package/dist/config.json

@@ -1,3 +1,3 @@
 {
-  "apiKey": null
+  "apiUrl": ""
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zero-doc",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Zero-Config API Documentation Generator - Generate beautiful API docs from your code automatically",
   "main": "dist/index.js",
   "bin": {
@@ -30,6 +30,9 @@
     "viewer",
     "scripts"
   ],
+  ".npmignore": [
+    "dist/config.json"
+  ],
   "scripts": {
     "build": "tsc && npm run inject-config && npm run copy-viewer",
     "inject-config": "node scripts/inject-config.js",

package/scripts/inject-config.js

@@ -1,40 +1,46 @@
 #!/usr/bin/env node
 /**
- * Script to inject API key into a config file during build
- * This file is NOT committed to the repository
+ * Script to inject API URL and Client Key into config.json during build
+ * Reads from .env file in project root OR environment variables (CI/CD)
+ * This config will be included in the npm package
  */
 
 const fs = require('fs');
 const path = require('path');
+const dotenv = require('dotenv');
 
-const distDir = path.join(__dirname, '..', 'dist');
+// Project root (where package.json is)
+const projectRoot = path.join(__dirname, '..');
+const distDir = path.join(projectRoot, 'dist');
 const configPath = path.join(distDir, 'config.json');
+const envPath = path.join(projectRoot, '.env');
 
-// Get API key from environment variable
-const apiKey = process.env.ZERO_DOC_API_KEY || process.env.GEMINI_API_KEY;
-
-if (!apiKey) {
-  console.warn('⚠️  Warning: ZERO_DOC_API_KEY not set. Build will continue but API key must be set at runtime.');
-  // Create empty config file
-  if (!fs.existsSync(distDir)) {
-    fs.mkdirSync(distDir, { recursive: true });
-  }
-  fs.writeFileSync(configPath, JSON.stringify({ apiKey: null }, null, 2));
-  process.exit(0);
+// Load .env from project root (if exists)
+if (fs.existsSync(envPath)) {
+  dotenv.config({ path: envPath });
+  console.log('📁 Loaded .env from project root');
 }
 
+// Get API URL and Client Key from environment variables
+// Priority: Environment variable (CI/CD) > .env file
+const apiUrl = process.env.ZERO_DOC_API_URL;
+
 // Ensure dist directory exists
 if (!fs.existsSync(distDir)) {
   fs.mkdirSync(distDir, { recursive: true });
 }
 
-// Create config file with API key
+// Create config file with API URL and Client Key
 const config = {
-  apiKey: apiKey,
-  provider: 'gemini',
-  model: 'gemini-3-pro-preview'
+  apiUrl: apiUrl || ''
 };
 
 fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
-console.log('✅ Config file created successfully');
+
+if (apiUrl) {
+  console.log('✅ Config file created with API URL');
+} else {
+  console.warn('⚠️  Warning: ZERO_DOC_API_URL not found. Config file created but empty.');
+  console.warn('   Set ZERO_DOC_API_URL in .env or CI/CD environment variables.');
+}