fix(cli): add 'skip' option and update defaults for hosting config

close #234

Author: RonithManikonda

package.json

@@ -17,8 +17,7 @@
     "demo:build": "pnpm run build && pnpm run --filter=demo.tutorialkit.dev build",
     "lint": "eslint \"{packages,docs,extensions,integration}/**/*\"",
     "test": "pnpm run --stream --filter='@tutorialkit/*' test --run",
-    "test:e2e": "pnpm run --filter='./e2e' test",
-    "postbuild": "cp _headers ./dist/"
+    "test:e2e": "pnpm run --filter='./e2e' test"
   },
   "license": "MIT",
   "packageManager": "[email protected]",

packages/cli/src/commands/create/generate-hosting-config.ts

@@ -1,79 +1,50 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import { fileURLToPath } from 'node:url';
+import * as prompts from '@clack/prompts';
+import chalk from 'chalk';
+import { warnLabel } from 'src/utils/messages.js';
+import { runTask } from 'src/utils/tasks.js';
 import cloudflareConfigRaw from './hosting-config/_headers.txt?raw';
 import netlifyConfigRaw from './hosting-config/netlify_toml.txt?raw';
 import vercelConfigRaw from './hosting-config/vercel.json?raw';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
+export async function generateHostingConfig(dest: string, provider: string, flags: { dryRun: boolean }) {
+  prompts.log.info(`${chalk.blue('Hosting Configuration')} Setting up configuration for ${provider}`);
 
-export async function generateHostingConfig(dest: string, provider: string) {
   const resolvedDest = path.resolve(dest);
 
   if (!fs.existsSync(resolvedDest)) {
-    console.log(`Directory does not exist. Creating directory: ${resolvedDest}`);
     fs.mkdirSync(resolvedDest, { recursive: true });
-  } else {
-    console.log(`Directory already exists: ${resolvedDest}`);
   }
 
-  if (provider.includes('Vercel')) {
-    const vercelConfigPath = path.join(resolvedDest, 'vercel.json');
-    console.log('Writing Vercel config file to:', vercelConfigPath);
-
-    try {
-      const vercelConfig = typeof vercelConfigRaw === 'string' ? JSON.parse(vercelConfigRaw) : vercelConfigRaw;
-      fs.writeFileSync(vercelConfigPath, JSON.stringify(vercelConfig, null, 2));
-    } catch (error) {
-      console.error('Failed to write Vercel config file:', error);
-    }
-  }
+  let config;
+  let filename;
 
-  if (provider.includes('Netlify')) {
-    const netlifyConfigPath = path.join(resolvedDest, 'netlify.toml');
-    console.log('Writing Netlify config file to:', netlifyConfigPath);
-
-    try {
-      if (typeof netlifyConfigRaw !== 'string') {
-        throw new Error('Netlify config must be a string.');
-      }
-
-      fs.writeFileSync(netlifyConfigPath, netlifyConfigRaw);
-    } catch (error) {
-      console.error('Failed to write Netlify config file:', error);
-    }
-  }
-
-  if (provider.includes('Cloudflare')) {
-    const cloudflareConfigPath = path.join(resolvedDest, '_headers');
-    console.log('Writing Cloudflare config file to:', cloudflareConfigPath);
-
-    try {
-      if (typeof cloudflareConfigRaw !== 'string') {
-        throw new Error('Cloudflare config must be a string.');
-      }
-
-      fs.writeFileSync(cloudflareConfigPath, cloudflareConfigRaw);
-    } catch (error) {
-      console.error('Failed to write Cloudflare config file:', error);
-    }
+  if (provider.includes('Vercel')) {
+    config = typeof vercelConfigRaw === 'string' ? vercelConfigRaw : JSON.stringify(vercelConfigRaw, null, 2);
+    filename = 'vercel.json';
+  } else if (provider.includes('Netlify')) {
+    config = netlifyConfigRaw;
+    filename = 'netlify.toml';
+  } else if (provider.includes('Cloudflare')) {
+    config = cloudflareConfigRaw;
+    filename = '_headers';
   }
 
-  const templateDir = path.resolve(__dirname, '_template');
-  console.log('Looking for template directory at:', templateDir);
-
-  if (fs.existsSync(templateDir)) {
-    const gitignoreTemplatePath = path.join(templateDir, '.gitignore');
-
-    if (fs.existsSync(gitignoreTemplatePath)) {
-      const gitignoreDestPath = path.join(resolvedDest, '.gitignore');
-      console.log('Copying .gitignore to:', gitignoreDestPath);
-      fs.copyFileSync(gitignoreTemplatePath, gitignoreDestPath);
-    } else {
-      console.warn('No .gitignore file found in template directory, skipping copy.');
-    }
+  if (config && filename) {
+    await runTask({
+      title: `Create hosting files for ${provider}`,
+      dryRun: flags.dryRun,
+      dryRunMessage: `${warnLabel('DRY RUN')} Skipped hosting provider config creation`,
+      task: async () => {
+        const filepath = path.join(resolvedDest, filename);
+        fs.writeFileSync(filepath, config);
+        return `Added ${filepath}`;
+      },
+    });
   } else {
-    console.warn('Template directory does not exist, skipping .gitignore copy.');
+    prompts.log.message(
+      `${chalk.blue('hosting provider config [skip]')} You can configure hosting provider settings manually later. For more information see https://tutorialkit.dev/guides/deployment/#headers-configuration`
+    );
   }
 }

packages/cli/src/commands/create/index.ts

@@ -150,16 +150,14 @@ async function _createTutorial(flags: CreateOptions): Promise<undefined> {
       { value: 'Vercel', label: 'Vercel' },
       { value: 'Netlify', label: 'Netlify' },
       { value: 'Cloudflare', label: 'Cloudflare' },
+      { value: 'skip', label: 'Skip hosting configuration' },
     ],
     initialValue: 'Vercel',
   });
 
-  assertNotCanceled(provider);
-  prompts.log.info(`Configuring for: ${provider}`);
+  await generateHostingConfig(resolvedDest, String(provider), { dryRun: flags.dryRun });
 
-  await generateHostingConfig(resolvedDest, provider);
-
-  updatePackageJson(resolvedDest, tutorialName, flags);
+  updatePackageJson(resolvedDest, tutorialName, flags, String(provider));
 
   const selectedPackageManager = await selectPackageManager(resolvedDest, flags);
 
@@ -264,7 +262,7 @@ function printNextSteps(dest: string, packageManager: PackageManager, dependenci
   }
 }
 
-function updatePackageJson(dest: string, projectName: string, flags: CreateOptions) {
+function updatePackageJson(dest: string, projectName: string, flags: CreateOptions, provider: string) {
   if (flags.dryRun) {
     return;
   }
@@ -277,7 +275,12 @@ function updatePackageJson(dest: string, projectName: string, flags: CreateOptio
   updateWorkspaceVersions(pkgJson.dependencies, TUTORIALKIT_VERSION);
   updateWorkspaceVersions(pkgJson.devDependencies, TUTORIALKIT_VERSION);
 
-  fs.writeFileSync(pkgPath, JSON.stringify(pkgJson, undefined, 2));
+  if (provider === 'Netlify' || provider === 'Cloudflare') {
+    pkgJson.scripts = pkgJson.scripts || {};
+    pkgJson.scripts.postbuild = "cp _headers ./dist/";
+  }
+
+  fs.writeFileSync(pkgPath, JSON.stringify(pkgJson, null, 2));
 
   try {
     const pkgLockPath = path.resolve(dest, 'package-lock.json');
@@ -290,7 +293,7 @@ function updatePackageJson(dest: string, projectName: string, flags: CreateOptio
       defaultPackage.name = projectName;
     }
 
-    fs.writeFileSync(pkgLockPath, JSON.stringify(pkgLockJson, undefined, 2));
+    fs.writeFileSync(pkgLockPath, JSON.stringify(pkgLockJson, null, 2));
   } catch {
     // ignore any errors
   }

packages/cli/src/commands/create/options.ts

@@ -25,6 +25,7 @@ export const DEFAULT_VALUES = {
   dryRun: false,
   force: false,
   packageManager: 'npm',
+  provider: 'skip',
 };
 
 type Flags = Omit<CreateOptions, '_'>;