Merge pull request #18869 from storybookjs/yann/sb-635-command-silently-fails-if-sandbox-doesnt

improve sandbox command error handling and debugging

code/lib/cli/src/repro-next.ts

@@ -1,11 +1,11 @@
 import prompts from 'prompts';
-import fs from 'fs';
 import path from 'path';
 import chalk from 'chalk';
 import boxen from 'boxen';
 import { dedent } from 'ts-dedent';
 import degit from 'degit';
 
+import { existsSync } from 'fs-extra';
 import TEMPLATES from './repro-templates';
 
 const logger = console;
@@ -56,9 +56,10 @@ export const reproNext = async ({
       boxen(
         dedent`
           🔎 You filtered out all templates. 🔍
+          
           After filtering all the templates with "${chalk.yellow(
             filterValue
-          )}", we found no templates.
+          )}", we found no results. Please try again with a different filter.
 
           Available templates:
           ${keys.map((key) => chalk.blue`- ${key}`).join('\n')}
@@ -66,7 +67,7 @@ export const reproNext = async ({
         { borderStyle: 'round', padding: 1, borderColor: '#F1618C' } as any
       )
     );
-    return;
+    process.exit(1);
   }
 
   let selectedTemplate: Choice | null = null;
@@ -106,14 +107,19 @@ export const reproNext = async ({
   }
 
   let selectedDirectory = outputDirectory;
+  const outputDirectoryName = outputDirectory || selectedTemplate;
+  if (selectedDirectory && existsSync(`${selectedDirectory}`)) {
+    logger.info(`⚠️  ${selectedDirectory} already exists! Overwriting...`);
+  }
+
   if (!selectedDirectory) {
     const { directory } = await prompts({
       type: 'text',
       message: 'Enter the output directory',
       name: 'directory',
-      initial: selectedTemplate,
-      validate: (directoryName) =>
-        fs.existsSync(directoryName)
+      initial: outputDirectoryName,
+      validate: async (directoryName) =>
+        existsSync(directoryName)
           ? `${directoryName} already exists. Please choose another name.`
           : true,
     });
@@ -121,11 +127,11 @@ export const reproNext = async ({
   }
 
   try {
-    const cwd = path.isAbsolute(selectedDirectory)
+    const templateDestination = path.isAbsolute(selectedDirectory)
       ? selectedDirectory
       : path.join(process.cwd(), selectedDirectory);
 
-    logger.info(`🏃 Adding ${selectedConfig.name} into ${cwd}`);
+    logger.info(`🏃 Adding ${selectedConfig.name} into ${templateDestination}`);
 
     logger.log('📦 Downloading repro template...');
     try {
@@ -136,10 +142,10 @@ export const reproNext = async ({
         {
           force: true,
         }
-      ).clone(selectedTemplate.replace('/', '-'));
+      ).clone(templateDestination);
     } catch (err) {
       logger.error(`🚨 Failed to download repro template: ${err.message}`);
-      return;
+      throw err;
     }
 
     const initMessage = init

scripts/sandbox.ts

@@ -1,6 +1,14 @@
 /* eslint-disable no-restricted-syntax, no-await-in-loop */
 import path from 'path';
-import { remove, pathExists, readJSON, writeJSON, ensureSymlink } from 'fs-extra';
+import {
+  remove,
+  pathExists,
+  readJSON,
+  writeJSON,
+  ensureSymlink,
+  ensureDir,
+  existsSync,
+} from 'fs-extra';
 import prompts from 'prompts';
 
 import { getOptionsOrPrompt } from './utils/options';
@@ -75,6 +83,10 @@ async function getOptions() {
     dryRun: {
       description: "Don't execute commands, just list them (dry run)?",
     },
+    debug: {
+      description: 'Print all the logs to the console',
+      promptType: false,
+    },
   });
 }
 
@@ -147,6 +159,12 @@ async function addPackageScripts({
 
 async function readMainConfig({ cwd }: { cwd: string }) {
   const configDir = path.join(cwd, '.storybook');
+  if (!existsSync(configDir)) {
+    throw new Error(
+      `Unable to find the Storybook folder in "${configDir}". Are you sure it exists? Or maybe this folder uses a custom Storybook config directory?`
+    );
+  }
+
   const mainConfigPath = getInterpretedFile(path.resolve(configDir, 'main'));
   return readConfig(mainConfigPath);
 }
@@ -197,7 +215,10 @@ async function addStories(paths: string[], { mainConfig }: { mainConfig: ConfigF
 async function main() {
   const optionValues = await getOptions();
 
-  const { template, forceDelete, forceReuse, link, dryRun } = optionValues;
+  const { template, forceDelete, forceReuse, link, dryRun, debug } = optionValues;
+
+  await ensureDir(sandboxDir);
+
   const cwd = path.join(sandboxDir, template.replace('/', '-'));
 
   const exists = await pathExists(cwd);
@@ -222,6 +243,7 @@ async function main() {
       optionValues: { output: cwd, branch: 'next' },
       cwd: sandboxDir,
       dryRun,
+      debug,
     });
 
     const mainConfig = await readMainConfig({ cwd });
@@ -251,7 +273,7 @@ async function main() {
 
     for (const addon of optionValues.addon) {
       const addonName = `@storybook/addon-${addon}`;
-      await executeCLIStep(steps.add, { argument: addonName, cwd, dryRun });
+      await executeCLIStep(steps.add, { argument: addonName, cwd, dryRun, debug });
     }
 
     for (const addon of [...defaultAddons, ...optionValues.addon]) {
@@ -268,6 +290,7 @@ async function main() {
         cwd: codeDir,
         dryRun,
         optionValues: { local: true, start: false },
+        debug,
       });
     } else {
       await exec('yarn local-registry --publish', { cwd: codeDir }, { dryRun });
@@ -313,10 +336,11 @@ async function main() {
         dryRun,
         startMessage: `⬆️  Starting Storybook`,
         errorMessage: `🚨 Starting Storybook failed`,
+        debug: true,
       }
     );
   } else {
-    await executeCLIStep(steps.build, { cwd, dryRun });
+    await executeCLIStep(steps.build, { cwd, dryRun, debug });
     // TODO serve
   }
 

scripts/utils/cli-step.ts

@@ -19,6 +19,7 @@ export async function executeCLIStep<TOptions extends OptionSpecifier>(
     optionValues?: Partial<OptionValues<TOptions>>;
     cwd: string;
     dryRun?: boolean;
+    debug: boolean;
   }
 ) {
   if (cliStep.hasArgument && !options.argument)
@@ -38,6 +39,7 @@ export async function executeCLIStep<TOptions extends OptionSpecifier>(
       startMessage: `${cliStep.icon} ${cliStep.description}`,
       errorMessage: `🚨 ${cliStep.description} failed`,
       dryRun: options.dryRun,
+      debug: options.debug,
     }
   );
 }

scripts/utils/exec.ts

@@ -1,17 +1,21 @@
-import shell, { ExecOptions } from 'shelljs';
+import execa, { Options } from 'execa';
 import chalk from 'chalk';
 
 const logger = console;
 
+type StepOptions = {
+  startMessage?: string;
+  errorMessage?: string;
+  dryRun?: boolean;
+  debug?: boolean;
+};
+
 export const exec = async (
   command: string,
-  options: ExecOptions = {},
-  {
-    startMessage,
-    errorMessage,
-    dryRun,
-  }: { startMessage?: string; errorMessage?: string; dryRun?: boolean } = {}
-) => {
+  options: Options = {},
+  { startMessage, errorMessage, dryRun, debug }: StepOptions = {}
+): Promise<void> => {
+  logger.info();
   if (startMessage) logger.info(startMessage);
 
   if (dryRun) {
@@ -20,27 +24,16 @@ export const exec = async (
   }
 
   logger.debug(command);
-  return new Promise((resolve, reject) => {
-    const defaultOptions: ExecOptions = {
-      silent: false,
-    };
-    const child = shell.exec(command, {
-      ...defaultOptions,
-      ...options,
-      async: true,
-      silent: false,
-    });
+  const defaultOptions: Options = {
+    stdout: debug ? 'inherit' : 'ignore',
+  };
+  try {
+    await execa.command(command, { ...defaultOptions, ...options });
+  } catch (err) {
+    logger.error(chalk.red(`An error occurred while executing: \`${command}\``));
+    logger.log(errorMessage);
+    throw err;
+  }
 
-    child.stderr.pipe(process.stderr);
-
-    child.on('exit', (code) => {
-      if (code === 0) {
-        resolve(undefined);
-      } else {
-        logger.error(chalk.red(`An error occurred while executing: \`${command}\``));
-        logger.log(errorMessage);
-        reject(new Error(`command exited with code: ${code}: `));
-      }
-    });
-  });
+  return undefined;
 };

scripts/utils/options.ts

@@ -5,6 +5,8 @@
 import prompts, { Falsy, PrevCaller, PromptType } from 'prompts';
 import type { PromptObject } from 'prompts';
 import program from 'commander';
+import dedent from 'ts-dedent';
+import chalk from 'chalk';
 import kebabCase from 'lodash/kebabCase';
 
 // Option types
@@ -125,8 +127,14 @@ export function getOptions<TOptions extends OptionSpecifier>(
       if (isBooleanOption(option)) return acc.option(flags, option.description, !!option.inverse);
 
       const checkStringValue = (raw: string) => {
-        if (!option.values.includes(raw))
-          throw new Error(`Unexpected value '${raw}' for option '${key}'`);
+        if (!option.values.includes(raw)) {
+          const possibleOptions = chalk.cyan(option.values.join(', '));
+          throw new Error(
+            dedent`Unexpected value '${chalk.yellow(raw)}' for option '${chalk.magenta(key)}'.
+            
+            These are the possible options: ${possibleOptions}\n\n`
+          );
+        }
         return raw;
       };