webpack-command/lib/compiler.js

const path = require('path');

const camelcase = require('camelcase');
const capitalize = require('titleize');
const chalk = require('chalk');
const merge = require('merge-options');
const webpack = require('webpack');
const weblog = require('webpack-log');

const progress = require('./progress');
const StylishReporter = require('./reporters/StylishReporter');

function makeCallback(options) {
  const { compiler, config, reporter, resolve, reject } = options;
  const { watch } = config;

  return (error, stats) => {
    const log = weblog({ name: 'webpack', id: 'webpack-command' });

    if (error || !watch) {
      // for some reason webpack-cli invalidates the cache here. there's no
      // documentation as to why, so we're going to assume there's a reason.
      compiler.purgeInputFileSystem();
      log.debug('Input File System Purged');
    }

    const result = reporter.render(error, stats);

    if (error) {
      reject(error);
      return;
    } else if (stats && stats.hasErrors() && !watch) {
      process.exitCode = 1;
      // a little extra sugar to make running in npm scripts a bit nicer
      process.stdout.write('\n');
    }

    resolve(result);
  };
}

/**
 * Attempts to require a specified reporter. Tries the local built-ins first,
 * and if that fails, attempts to load an npm module that exports a reporter
 * handler function, and if that fails, attempts to load the reporter relative
 * to the current working directory.
 */
function requireReporter(name) {
  const prefix = capitalize(camelcase(name));
  const locations = [`./reporters/${prefix}Reporter`, name, path.resolve(name)];
  let result = null;

  for (const location of locations) {
    try {
      // eslint-disable-next-line import/no-dynamic-require, global-require
      result = require(location);
    } catch (e) {
      // noop
    }

    if (result) {
      break;
    }
  }

  return result;
}

/**
 * Removes invalid webpack config properties leftover from applying flags
 */
function sanitize(config) {
  const configs = [].concat(config).map((conf) => {
    const result = merge({}, conf);
    delete result.progress;
    delete result.reporter;
    delete result.watchStdin;

    // TODO: remove the need for this
    for (const property of ['entry', 'output']) {
      const target = result[property];
      if (target && Object.keys(target).length === 0) {
        delete result[property];
      }
    }

    return result;
  });

  // if we always return an array, every compilation will be a MultiCompiler
  return configs.length > 1 ? configs : configs[0];
}

module.exports = (config) => {
  const log = weblog({ name: 'webpack', id: 'webpack-command' });
  const target = sanitize(config);
  const compiler = webpack(target);
  const { done, run } = compiler.hooks;
  const configs = [].concat(config);
  const [first] = configs;
  const { reporter: reporterName, watchOptions } = first;
  let ReporterClass = requireReporter(reporterName || 'stylish');

  if (!ReporterClass) {
    log.error(`The reporter specified (${reporterName}) could not be located`);
    ReporterClass = StylishReporter;
  }

  const reporter = new ReporterClass({ compiler, config });

  if (first.progress) {
    progress.apply(first, compiler, reporter);
  }

  run.tap('WebpackCommand', () => {
    log.info('Starting Build');
  });

  done.tap('WebpackCommand', () => {
    log.info('Build Finished');
  });

  return {
    run() {
      return new Promise((resolve, reject) => {
        const { stdin } = watchOptions || {};
        const callback = makeCallback({
          compiler,
          config: first,
          reporter,
          resolve,
          reject,
        });

        if (first.watch) {
          log.info('Watching enabled');
          for (const conf of configs) {
            if (conf.bail) {
              const configName =
                configs.length > 1
                  ? `config[${conf.name || configs.indexOf(conf)}]`
                  : 'the config';
              log.warn(
                chalk`The {bold \`bail\`} option in ${configName} will force webpack to exit on the first error`
              );
              break;
            }
          }
          compiler.watch(watchOptions, callback);
        } else {
          compiler.run(callback);
        }

        /* istanbul ignore if */
        if (stdin) {
          process.stdin.on('end', () => {
            process.exit();
          });

          process.stdin.resume();
        }
      });
    },
  };
};