@mapbox/batfish/dist/node/get-loggable-error-message.js

The React-powered static-site generator you didn't know you wanted

//      
'use strict';

const chalk = require('chalk');
const path = require('path');
const codeFrame = require('@babel/code-frame');
const webpackFormatMessages = require('webpack-format-messages');
const errorTypes = require('./error-types');
const renderPrettyErrorStack = require('./render-pretty-error-stack');

// If the Error is of a known type, convert it to a nice legible string.
// Otherwise return undefined and expect the consumer to deal with the Error's
// message.
function getLoggableErrorMessage(error       )                {
  let result = chalk.red.bold('Error: ');

  if (error instanceof errorTypes.ConfigFatalError) {
    result += 'Fatal configuration error.\n\n';
    result += `${error.message}\n`;
    return result;
  }

  if (error instanceof errorTypes.ConfigValidationError) {
    result += 'Invalid configuration.\n\n';
    if (error.messages) {
      error.messages.forEach((m) => {
        result += `- ${m}\n`;
      });
    } else {
      result += `${error.message}\n`;
    }
    return result;
  }

  if (error instanceof errorTypes.WebpackFatalError) {
    const webpackOptions = [
      'webpackLoaders',
      'webpackPlugins',
      'webpackStaticIgnore'
    ]
      .map((x) => chalk.yellow(x))
      .join(', ');
    result += `Webpack fatal error. Please check any Batfish configuration options that pass directly into Webpack configuration (${webpackOptions}).\n\n`;
    result += `Error message: ${error.originalError.message}\n`;
    return result;
  }

  if (error instanceof errorTypes.WebpackCompilationError) {
    result += `Webpack compilation error.\n\n`;
    const formattedMessages = webpackFormatMessages(error.stats);
    formattedMessages.errors.forEach((errorMessage) => {
      result += `${errorMessage}\n`;
    });
    return result;
  }

  if (error instanceof errorTypes.CssCompilationError) {
    result += `CSS compilation error. This may mean you have non-standard syntax that you forgot to compile with PostCSS.\n\n`;
    result += `${error.message}\n`;
    return result;
  }

  if (error instanceof errorTypes.WebpackNodeParseError) {
    result += `Failed to parse Webpack-compiled version of static-render-pages.js\n\n`;
    result += `Error message: ${error.originalError.message}\n\n`;
    result += renderPrettyErrorStack(error.originalError);
    return result;
  }

  if (error instanceof errorTypes.WebpackNodeExecutionError) {
    result += `Failed to execute Webpack-compiled version of static-render-pages.js.\n\n${chalk.bold.yellow(
      'You may be importing a JS file that cannot run in Node.'
    )}\n\n`;
    result += renderPrettyErrorStack(error.originalError);
    return result;
  }

  if (error instanceof errorTypes.FrontMatterError) {
    result += `Failed to parse front matter in ${chalk.yellow(
      path.relative(process.cwd(), error.filePath)
    )}.\n\n`;
    if (error.originalError.name === 'YAMLException') {
      result += `YAML error: ${error.originalError.reason}\n\n`;
      result += codeFrame.codeFrameColumns(
        error.originalError.mark.buffer,
        {
          start: {
            line: error.originalError.mark.line + 1,
            column: error.originalError.mark.column
          }
        },
        { highlightCode: true, linesAbove: 10, linesBelow: 10 }
      );
    } else {
      result += renderPrettyErrorStack(error.originalError);
    }
    return result;
  }

  return;
}

module.exports = getLoggableErrorMessage;