@knowcode/doc-builder 1.1.2 → 1.1.4

package/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.4] - 2025-01-19
+
+### Fixed
+- Removed deprecated --no-clipboard option
+- Fixed 404 errors with better index.html handling
+- Added fallback index.html when README.html doesn't exist
+- Production deployment now correctly uses --prod flag
+
+### Added
+- Auto-generated index.html with file listing if no README
+- Better logging during deployment preparation
+- Console messages when creating index.html
+
+### Changed
+- Simplified deployment arguments
+- Cleaner deployment command without unnecessary flags
+
+## [1.1.3] - 2025-01-19
+
+### Fixed
+- Real-time output from Vercel CLI during deployment
+- Fixed 404 errors by adding cleanUrls configuration
+- Deployment now shows progress as it happens
+
+### Added
+- cleanUrls: true in vercel.json for proper URL handling
+- trailingSlash: false to prevent redirect issues
+- Real-time streaming of Vercel deployment output
+
+### Changed
+- Switched from execSync to spawn for live deployment output
+- Better URL extraction from deployment output
+
 ## [1.1.2] - 2025-01-19
 
 ### Changed

package/lib/deploy.js

@@ -64,7 +64,9 @@ async function setupVercelProject(config) {
     "outputDirectory": ".",
     "devCommand": "",
     "installCommand": "",
-    "framework": null
+    "framework": null,
+    "cleanUrls": true,
+    "trailingSlash": false
   };
   
   fs.writeJsonSync(vercelConfigPath, vercelConfig, { spaces: 2 });
@@ -177,17 +179,15 @@ async function deployToVercel(config, isProd = false) {
       "outputDirectory": ".",
       "devCommand": "",
       "installCommand": "",
-      "framework": null
+      "framework": null,
+      "cleanUrls": true,
+      "trailingSlash": false
     };
     fs.writeJsonSync(vercelConfigPath, vercelConfig, { spaces: 2 });
   }
   
   // Deploy command with explicit build settings
-  // Override any project settings that might be causing issues
-  const deployArgs = [
-    '--build-env', 'VERCEL_BUILD_OUTPUT_DIRECTORY=.',
-    '--no-clipboard'
-  ];
+  const deployArgs = [];
   
   if (isProd) {
     deployArgs.push('--prod');
@@ -196,22 +196,51 @@ async function deployToVercel(config, isProd = false) {
   const deployCmd = `vercel ${deployArgs.join(' ')}`;
   
   try {
-    // Run deployment from the output directory
-    const output = execSync(deployCmd, { 
-      cwd: outputPath,
-      encoding: 'utf8',
-      env: {
-        ...process.env,
-        // Force Vercel to skip build
-        VERCEL_BUILD_SKIP: '1'
-      }
-    });
-    
-    // Extract URL from output
-    const urlMatch = output.match(/https:\/\/[^\s]+/);
-    const deployUrl = urlMatch ? urlMatch[0] : 'Check Vercel dashboard';
+    // Run deployment from the output directory with real-time output
+    const { spawn } = require('child_process');
     
-    return deployUrl;
+    return new Promise((resolve, reject) => {
+      const vercelProcess = spawn('vercel', deployArgs, {
+        cwd: outputPath,
+        env: {
+          ...process.env,
+          // Force Vercel to skip build
+          VERCEL_BUILD_SKIP: '1'
+        },
+        shell: true
+      });
+      
+      let deployUrl = '';
+      
+      // Capture stdout in real-time
+      vercelProcess.stdout.on('data', (data) => {
+        const output = data.toString();
+        process.stdout.write(output); // Show output in real-time
+        
+        // Try to extract URL from output
+        const urlMatch = output.match(/https:\/\/[^\s]+/);
+        if (urlMatch) {
+          deployUrl = urlMatch[0];
+        }
+      });
+      
+      // Capture stderr
+      vercelProcess.stderr.on('data', (data) => {
+        process.stderr.write(data.toString());
+      });
+      
+      vercelProcess.on('close', (code) => {
+        if (code === 0) {
+          resolve(deployUrl || 'Check Vercel dashboard');
+        } else {
+          reject(new Error(`Vercel deployment failed with code ${code}`));
+        }
+      });
+      
+      vercelProcess.on('error', (err) => {
+        reject(new Error(`Failed to start Vercel process: ${err.message}`));
+      });
+    });
   } catch (error) {
     // Check if this is the common "html/html" path error
     if (error.message && error.message.includes('html/html') && error.message.includes('does not exist')) {
@@ -266,7 +295,7 @@ async function prepareDeployment(config) {
   if (!fs.existsSync(indexPath)) {
     const readmePath = path.join(outputDir, 'README.html');
     if (fs.existsSync(readmePath)) {
-      // Create redirect
+      // Create redirect to README.html
       const redirectHtml = `<!DOCTYPE html>
 <html>
 <head>
@@ -278,6 +307,37 @@ async function prepareDeployment(config) {
 </body>
 </html>`;
       fs.writeFileSync(indexPath, redirectHtml);
+      console.log(chalk.green('✅ Created index.html redirect to README.html'));
+    } else {
+      // If no README.html, create a basic index listing all HTML files
+      const htmlFiles = fs.readdirSync(outputDir)
+        .filter(file => file.endsWith('.html') && file !== 'index.html')
+        .sort();
+      
+      if (htmlFiles.length > 0) {
+        const indexHtml = `<!DOCTYPE html>
+<html>
+<head>
+  <title>Documentation</title>
+  <style>
+    body { font-family: -apple-system, sans-serif; max-width: 800px; margin: 40px auto; padding: 0 20px; }
+    h1 { color: #333; }
+    ul { list-style: none; padding: 0; }
+    li { margin: 10px 0; }
+    a { color: #0066cc; text-decoration: none; }
+    a:hover { text-decoration: underline; }
+  </style>
+</head>
+<body>
+  <h1>Documentation</h1>
+  <ul>
+    ${htmlFiles.map(file => `<li><a href="${file}">${file.replace('.html', '')}</a></li>`).join('\n    ')}
+  </ul>
+</body>
+</html>`;
+        fs.writeFileSync(indexPath, indexHtml);
+        console.log(chalk.green('✅ Created index.html with file listing'));
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {