chromatic/bin/ui/messages/errors/buildFailed.js

Automate visual testing across browsers. Gather UI feedback. Versioned documentation.

import chalk from 'chalk';
import { EOL } from 'os';
import dedent from 'ts-dedent';

import { info } from '../../components/icons';
import link from '../../components/link';

export default ({ options, buildLogFile, spawnParams }, { message }, buildLog) => {
  const { buildScriptName } = options;
  const lines = buildLog.split(EOL).filter((line) => line && !line.startsWith('<s>'));

  return [
    dedent(chalk`
      The CLI tried to run your {bold ${buildScriptName}} script, but the command failed. This indicates a problem with your Storybook. Here's what to do:

      - Check the Storybook build log printed below.
      - Run {bold npm run ${buildScriptName}} or {bold yarn ${buildScriptName}} yourself and make sure it outputs a valid Storybook by opening the generated {bold index.html} in your browser.
      - Review the build-storybook CLI options at ${link(
        'https://storybook.js.org/docs/configurations/cli-options/#for-build-storybook'
      )}
    `),
    message,
    chalk`${info} Spawn settings:\n{dim ${JSON.stringify(spawnParams, null, 2)}}`,
    chalk`${info} Storybook build output:\n{dim ${buildLogFile}}`,
    lines.join(`\n`),
  ].join('\n\n');
};