@knowcode/doc-builder 1.1.1 → 1.1.3

package/CHANGELOG.md

@@ -5,6 +5,34 @@ 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.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
+- Simplified deployment output - removed Root Directory warnings
+- Cleaner deployment experience with just essential information
+- Shows simple "Starting deployment" message instead of warnings
+
+### Removed
+- Pre-deployment Root Directory check and warnings
+- Project ID display during deployment
+- Verbose deployment preparation messages
+
 ## [1.1.1] - 2025-01-19
 
 ### Added

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 });
@@ -164,35 +166,9 @@ async function deployToVercel(config, isProd = false) {
     throw new Error(`Output directory ${outputPath} does not exist. Run 'doc-builder build' first.`);
   }
   
-  // Check for existing project link and warn about common issues
-  const vercelProjectPath = path.join(outputPath, '.vercel', 'project.json');
-  if (fs.existsSync(vercelProjectPath)) {
-    try {
-      const projectInfo = fs.readJsonSync(vercelProjectPath);
-      const projectId = projectInfo.projectId || 'unknown';
-      
-      console.log(chalk.blue('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
-      console.log(chalk.yellow('📦 Deploying to existing Vercel project'));
-      console.log(chalk.blue('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
-      
-      console.log(chalk.white('Project ID: ') + chalk.cyan(projectId));
-      
-      // Check if .vercel/project.json has rootDirectory set
-      if (projectInfo.settings && projectInfo.settings.rootDirectory) {
-        console.log(chalk.red.bold('\n⚠️  WARNING: Root Directory is set to: ') + chalk.yellow(projectInfo.settings.rootDirectory));
-        console.log(chalk.red('This may cause deployment to fail!\n'));
-      }
-      
-      console.log(chalk.yellow.bold('\n⚡ BEFORE CONTINUING:'));
-      console.log(chalk.white('1. Check your Root Directory setting at:'));
-      console.log(chalk.cyan(`   https://vercel.com/dashboard/project/${projectId}`));
-      console.log(chalk.white('2. Root Directory should be ') + chalk.green.bold('EMPTY (blank)'));
-      console.log(chalk.white('3. If it says "html", ') + chalk.red.bold('DELETE IT NOW!\n'));
-      
-    } catch (e) {
-      // Ignore read errors
-    }
-  }
+  // Simple deployment message
+  console.log(chalk.blue('\n🚀 Starting deployment to Vercel...'));
+  console.log(chalk.gray('This will take a few seconds...\n'));
   
   // Create vercel.json in output directory for deployment
   const vercelConfigPath = path.join(outputPath, 'vercel.json');
@@ -203,7 +179,9 @@ async function deployToVercel(config, isProd = false) {
       "outputDirectory": ".",
       "devCommand": "",
       "installCommand": "",
-      "framework": null
+      "framework": null,
+      "cleanUrls": true,
+      "trailingSlash": false
     };
     fs.writeJsonSync(vercelConfigPath, vercelConfig, { spaces: 2 });
   }
@@ -222,22 +200,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'
-      }
-    });
+    // Run deployment from the output directory with real-time output
+    const { spawn } = require('child_process');
     
-    // Extract URL from output
-    const urlMatch = output.match(/https:\/\/[^\s]+/);
-    const deployUrl = urlMatch ? urlMatch[0] : 'Check Vercel dashboard';
-    
-    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')) {

package/package.json

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