parcel 2.0.0-nightly.99 → 2.1.0

package/src/cli.js

@@ -1,50 +1,70 @@
 // @flow
 
-import type {ParcelConfigFile, InitialParcelOptions} from '@parcel/types';
+import type {InitialParcelOptions} from '@parcel/types';
 import {BuildError} from '@parcel/core';
-import {NodePackageManager} from '@parcel/package-manager';
 import {NodeFS} from '@parcel/fs';
 import ThrowableDiagnostic from '@parcel/diagnostic';
-import {prettyDiagnostic} from '@parcel/utils';
+import {prettyDiagnostic, openInBrowser} from '@parcel/utils';
+import {Disposable} from '@parcel/events';
+import {INTERNAL_ORIGINAL_CONSOLE} from '@parcel/logger';
+import chalk from 'chalk';
+import commander from 'commander';
+import path from 'path';
+import getPort from 'get-port';
+import {version} from '../package.json';
 
 require('v8-compile-cache');
 
-function logUncaughtError(e: mixed) {
+const program = new commander.Command();
+
+// Exit codes in response to signals are traditionally
+// 128 + signal value
+// https://tldp.org/LDP/abs/html/exitcodes.html
+const SIGINT_EXIT_CODE = 130;
+
+async function logUncaughtError(e: mixed) {
   if (e instanceof ThrowableDiagnostic) {
     for (let diagnostic of e.diagnostics) {
-      let out = prettyDiagnostic(diagnostic);
-      console.error(out.message);
-      console.error(out.codeframe || out.stack);
-      for (let h of out.hints) {
-        console.error(h);
+      let {message, codeframe, stack, hints, documentation} =
+        await prettyDiagnostic(diagnostic);
+      INTERNAL_ORIGINAL_CONSOLE.error(chalk.red(message));
+      if (codeframe || stack) {
+        INTERNAL_ORIGINAL_CONSOLE.error('');
+      }
+      INTERNAL_ORIGINAL_CONSOLE.error(codeframe);
+      INTERNAL_ORIGINAL_CONSOLE.error(stack);
+      if ((stack || codeframe) && hints.length > 0) {
+        INTERNAL_ORIGINAL_CONSOLE.error('');
+      }
+      for (let h of hints) {
+        INTERNAL_ORIGINAL_CONSOLE.error(chalk.blue(h));
+      }
+      if (documentation) {
+        INTERNAL_ORIGINAL_CONSOLE.error(chalk.magenta.bold(documentation));
       }
     }
   } else {
-    console.error(e);
+    INTERNAL_ORIGINAL_CONSOLE.error(e);
   }
+
+  // A hack to definitely ensure we logged the uncaught exception
+  await new Promise(resolve => setTimeout(resolve, 100));
 }
 
-process.on('unhandledRejection', (reason: mixed) => {
-  logUncaughtError(reason);
+const handleUncaughtException = async exception => {
+  try {
+    await logUncaughtError(exception);
+  } catch (err) {
+    console.error(exception);
+    console.error(err);
+  }
+
   process.exit(1);
-});
+};
 
-const chalk = require('chalk');
-const program = require('commander');
-const path = require('path');
-const getPort = require('get-port');
-const version = require('../package.json').version;
-
-// Capture the NODE_ENV this process was launched with, so that it can be
-// used in Parcel (such as in process.env inlining).
-const initialNodeEnv = process.env.NODE_ENV;
-// Then, override NODE_ENV to be PARCEL_BUILD_ENV (replaced with `production` in builds)
-// so that dependencies of Parcel like React (which renders the cli through `ink`)
-// run in the appropriate mode.
-if (typeof process.env.PARCEL_BUILD_ENV === 'string') {
-  process.env.NODE_ENV = process.env.PARCEL_BUILD_ENV;
-}
+process.on('unhandledRejection', handleUncaughtException);
 
+program.storeOptionsAsProperties();
 program.version(version);
 
 // --no-cache, --cache-dir, --no-source-maps, --no-autoinstall, --global?, --public-url, --log-level
@@ -52,57 +72,77 @@ program.version(version);
 
 const commonOptions = {
   '--no-cache': 'disable the filesystem cache',
+  '--config <path>':
+    'specify which config to use. can be a path or a package name',
   '--cache-dir <path>': 'set the cache directory. defaults to ".parcel-cache"',
   '--no-source-maps': 'disable sourcemaps',
-  '--no-autoinstall': 'disable autoinstall',
   '--target [name]': [
     'only build given target(s)',
     (val, list) => list.concat([val]),
     [],
   ],
-  '--log-level <level>': [
-    'set the log level, either "none", "error", "warn", "info", or "verbose".',
-    /^(none|error|warn|info|verbose)$/,
-  ],
+  '--log-level <level>': new commander.Option(
+    '--log-level <level>',
+    'set the log level',
+  ).choices(['none', 'error', 'warn', 'info', 'verbose']),
+  '--dist-dir <dir>':
+    'output directory to write to when unspecified by targets',
+  '--no-autoinstall': 'disable autoinstall',
   '--profile': 'enable build profiling',
   '-V, --version': 'output the version number',
+  '--detailed-report [count]': [
+    'print the asset timings and sizes in the build report',
+    parseOptionInt,
+  ],
+  '--reporter <name>': [
+    'additional reporters to run',
+    (val, acc) => {
+      acc.push(val);
+      return acc;
+    },
+    [],
+  ],
 };
 
 var hmrOptions = {
   '--no-hmr': 'disable hot module replacement',
+  '-p, --port <port>': [
+    'set the port to serve on. defaults to $PORT or 1234',
+    process.env.PORT,
+  ],
+  '--host <host>':
+    'set the host to listen on, defaults to listening on all interfaces',
   '--https': 'serves files over HTTPS',
   '--cert <path>': 'path to certificate to use with HTTPS',
   '--key <path>': 'path to private key to use with HTTPS',
+  '--hmr-port <port>': ['hot module replacement port', process.env.HMR_PORT],
 };
 
 function applyOptions(cmd, options) {
   for (let opt in options) {
-    cmd.option(
-      opt,
-      ...(Array.isArray(options[opt]) ? options[opt] : [options[opt]]),
-    );
+    const option = options[opt];
+    if (option instanceof commander.Option) {
+      cmd.addOption(option);
+    } else {
+      cmd.option(opt, ...(Array.isArray(option) ? option : [option]));
+    }
   }
 }
 
 let serve = program
   .command('serve [input...]')
   .description('starts a development server')
-  .option(
-    '-p, --port <port>',
-    'set the port to serve on. defaults to 1234',
-    parseInt,
-  )
   .option('--public-url <url>', 'the path prefix for absolute urls')
-  .option(
-    '--host <host>',
-    'set the host to listen on, defaults to listening on all interfaces',
-  )
   .option(
     '--open [browser]',
     'automatically open in specified browser, defaults to default browser',
   )
   .option('--watch-for-stdin', 'exit when stdin closes')
-  .action(run);
+  .option(
+    '--lazy',
+    'Build async bundles on demand, when requested in the browser',
+  )
+  .action(runCommand);
 
 applyOptions(serve, hmrOptions);
 applyOptions(serve, commonOptions);
@@ -110,13 +150,10 @@ applyOptions(serve, commonOptions);
 let watch = program
   .command('watch [input...]')
   .description('starts the bundler in watch mode')
-  .option(
-    '--dist-dir <dir>',
-    'output directory to write to when unspecified by targets',
-  )
   .option('--public-url <url>', 'the path prefix for absolute urls')
+  .option('--no-content-hash', 'disable content hashing')
   .option('--watch-for-stdin', 'exit when stdin closes')
-  .action(run);
+  .action(runCommand);
 
 applyOptions(watch, hmrOptions);
 applyOptions(watch, commonOptions);
@@ -124,143 +161,237 @@ applyOptions(watch, commonOptions);
 let build = program
   .command('build [input...]')
   .description('bundles for production')
-  .option('--no-minify', 'disable minification')
+  .option('--no-optimize', 'disable minification')
   .option('--no-scope-hoist', 'disable scope-hoisting')
   .option('--public-url <url>', 'the path prefix for absolute urls')
-  .option(
-    '--dist-dir <dir>',
-    'Output directory to write to when unspecified by targets',
-  )
-  .action(run);
+  .option('--no-content-hash', 'disable content hashing')
+  .action(runCommand);
 
 applyOptions(build, commonOptions);
 
 program
   .command('help [command]')
   .description('display help information for a command')
-  .action(function(command) {
+  .action(function (command) {
     let cmd = program.commands.find(c => c.name() === command) || program;
     cmd.help();
   });
 
-program.on('--help', function() {
-  console.log('');
-  console.log(
+program.on('--help', function () {
+  INTERNAL_ORIGINAL_CONSOLE.log('');
+  INTERNAL_ORIGINAL_CONSOLE.log(
     '  Run `' +
       chalk.bold('parcel help <command>') +
       '` for more information on specific commands',
   );
-  console.log('');
+  INTERNAL_ORIGINAL_CONSOLE.log('');
 });
 
+// Override to output option description if argument was missing
+commander.Command.prototype.optionMissingArgument = function (option) {
+  INTERNAL_ORIGINAL_CONSOLE.error(
+    "error: option `%s' argument missing",
+    option.flags,
+  );
+  INTERNAL_ORIGINAL_CONSOLE.log(program.createHelp().optionDescription(option));
+  process.exit(1);
+};
+
 // Make serve the default command except for --help
 var args = process.argv;
 if (args[2] === '--help' || args[2] === '-h') args[2] = 'help';
+
 if (!args[2] || !program.commands.some(c => c.name() === args[2])) {
   args.splice(2, 0, 'serve');
 }
 
 program.parse(args);
 
-async function run(entries: Array<string>, command: any) {
-  entries = entries.map(entry => path.resolve(entry));
+function runCommand(...args) {
+  run(...args).catch(handleUncaughtException);
+}
 
+async function run(
+  entries: Array<string>,
+  _opts: any, // using pre v7 Commander options as properties
+  command: any,
+) {
   if (entries.length === 0) {
-    console.log('No entries found');
-    return;
+    entries = ['.'];
   }
+
+  entries = entries.map(entry => path.resolve(entry));
+
   let Parcel = require('@parcel/core').default;
-  let packageManager = new NodePackageManager(new NodeFS());
-  let defaultConfig: ParcelConfigFile = await packageManager.require(
-    '@parcel/config-default',
-    __filename,
-  );
+  let fs = new NodeFS();
+  let options = await normalizeOptions(command, fs);
   let parcel = new Parcel({
     entries,
-    packageManager,
-    defaultConfig: {
-      ...defaultConfig,
-      filePath: (
-        await packageManager.resolve('@parcel/config-default', __filename)
-      ).resolved,
-    },
-    patchConsole: true,
-    ...(await normalizeOptions(command)),
+    // $FlowFixMe[extra-arg] - flow doesn't know about the `paths` option (added in Node v8.9.0)
+    defaultConfig: require.resolve('@parcel/config-default', {
+      paths: [fs.cwd(), __dirname],
+    }),
+    shouldPatchConsole: true,
+    ...options,
   });
 
-  if (command.name() === 'watch' || command.name() === 'serve') {
-    let {unsubscribe} = await parcel.watch(err => {
-      if (err) {
-        throw err;
-      }
-    });
+  let disposable = new Disposable();
+  let unsubscribe: () => Promise<mixed>;
+  let isExiting;
+  async function exit(exitCode: number = 0) {
+    if (isExiting) {
+      return;
+    }
 
-    let isExiting;
-    const exit = async () => {
-      if (isExiting) {
+    isExiting = true;
+    if (unsubscribe != null) {
+      await unsubscribe();
+    } else if (parcel.isProfiling) {
+      await parcel.stopProfiling();
+    }
+
+    if (process.stdin.isTTY && process.stdin.isRaw) {
+      // $FlowFixMe
+      process.stdin.setRawMode(false);
+    }
+
+    disposable.dispose();
+    process.exit(exitCode);
+  }
+
+  const isWatching = command.name() === 'watch' || command.name() === 'serve';
+  if (process.stdin.isTTY) {
+    // $FlowFixMe
+    process.stdin.setRawMode(true);
+    require('readline').emitKeypressEvents(process.stdin);
+
+    let stream = process.stdin.on('keypress', async (char, key) => {
+      if (!key.ctrl) {
         return;
       }
 
-      isExiting = true;
-      await unsubscribe();
-      process.exit();
-    };
+      switch (key.name) {
+        case 'c':
+          // Detect the ctrl+c key, and gracefully exit after writing the asset graph to the cache.
+          // This is mostly for tools that wrap Parcel as a child process like yarn and npm.
+          //
+          // Setting raw mode prevents SIGINT from being sent in response to ctrl-c:
+          // https://nodejs.org/api/tty.html#tty_readstream_setrawmode_mode
+          //
+          // We don't use the SIGINT event for this because when run inside yarn, the parent
+          // yarn process ends before Parcel and it appears that Parcel has ended while it may still
+          // be cleaning up. Handling events from stdin prevents this impression.
+
+          // Enqueue a busy message to be shown if Parcel doesn't shut down
+          // within the timeout.
+          setTimeout(
+            () =>
+              INTERNAL_ORIGINAL_CONSOLE.log(
+                chalk.bold.yellowBright('Parcel is shutting down...'),
+              ),
+            500,
+          );
+          // When watching, a 0 success code is acceptable when Parcel is interrupted with ctrl-c.
+          // When building, fail with a code as if we received a SIGINT.
+          await exit(isWatching ? 0 : SIGINT_EXIT_CODE);
+          break;
+        case 'e':
+          await (parcel.isProfiling
+            ? parcel.stopProfiling()
+            : parcel.startProfiling());
+          break;
+        case 'y':
+          await parcel.takeHeapSnapshot();
+          break;
+      }
+    });
+
+    disposable.add(() => {
+      stream.destroy();
+    });
+  }
+
+  if (isWatching) {
+    ({unsubscribe} = await parcel.watch(err => {
+      if (err) {
+        throw err;
+      }
+    }));
+
+    if (command.open && options.serveOptions) {
+      await openInBrowser(
+        `${options.serveOptions.https ? 'https' : 'http'}://${
+          options.serveOptions.host || 'localhost'
+        }:${options.serveOptions.port}`,
+        command.open,
+      );
+    }
 
     if (command.watchForStdin) {
       process.stdin.on('end', async () => {
-        console.log('STDIN closed, ending');
+        INTERNAL_ORIGINAL_CONSOLE.log('STDIN closed, ending');
 
         await exit();
       });
       process.stdin.resume();
     }
 
-    // Detect the ctrl+c key, and gracefully exit after writing the asset graph to the cache.
-    // This is mostly for tools that wrap Parcel as a child process like yarn and npm.
-    //
-    // Setting raw mode prevents SIGINT from being sent in response to ctrl-c:
-    // https://nodejs.org/api/tty.html#tty_readstream_setrawmode_mode
-    //
-    // We don't use the SIGINT event for this because when run inside yarn, the parent
-    // yarn process ends before Parcel and it appears that Parcel has ended while it may still
-    // be cleaning up. Handling events from stdin prevents this impression.
-    if (process.stdin.isTTY) {
-      // $FlowFixMe
-      process.stdin.setRawMode(true);
-      require('readline').emitKeypressEvents(process.stdin);
-
-      process.stdin.on('keypress', async (char, key) => {
-        if (key.ctrl && key.name === 'c') {
-          await exit();
-        }
-      });
-    }
-
-    // In non-tty cases, respond to SIGINT by cleaning up.
+    // In non-tty cases, respond to SIGINT by cleaning up. Since we're watching,
+    // a 0 success code is acceptable.
     process.on('SIGINT', exit);
     process.on('SIGTERM', exit);
   } else {
     try {
       await parcel.run();
-    } catch (e) {
+    } catch (err) {
       // If an exception is thrown during Parcel.build, it is given to reporters in a
       // buildFailure event, and has been shown to the user.
-      if (!(e instanceof BuildError)) {
-        logUncaughtError(e);
+      if (!(err instanceof BuildError)) {
+        await logUncaughtError(err);
       }
-      process.exit(1);
+      await exit(1);
     }
+
+    await exit();
   }
 }
 
-async function normalizeOptions(command): Promise<InitialParcelOptions> {
+function parsePort(portValue: string): number {
+  let parsedPort = Number(portValue);
+
+  // Throw an error if port value is invalid...
+  if (!Number.isInteger(parsedPort)) {
+    throw new Error(`Port ${portValue} is not a valid integer.`);
+  }
+
+  return parsedPort;
+}
+
+function parseOptionInt(value) {
+  const parsedValue = parseInt(value, 10);
+  if (isNaN(parsedValue)) {
+    throw new commander.InvalidOptionArgumentError('Must be an integer.');
+  }
+  return parsedValue;
+}
+
+async function normalizeOptions(
+  command,
+  inputFS,
+): Promise<InitialParcelOptions> {
   let nodeEnv;
   if (command.name() === 'build') {
-    nodeEnv = initialNodeEnv || 'production';
+    nodeEnv = process.env.NODE_ENV || 'production';
+    // Autoinstall unless explicitly disabled or we detect a CI environment.
+    command.autoinstall = !(command.autoinstall === false || process.env.CI);
   } else {
-    nodeEnv = initialNodeEnv || 'development';
+    nodeEnv = process.env.NODE_ENV || 'development';
   }
 
+  // Set process.env.NODE_ENV to a default if undefined so that it is
+  // available in JS configs and plugins.
+  process.env.NODE_ENV = nodeEnv;
+
   let https = !!command.https;
   if (command.cert && command.key) {
     https = {
@@ -269,19 +400,41 @@ async function normalizeOptions(command): Promise<InitialParcelOptions> {
     };
   }
 
-  let serve = false;
-  if (command.name() === 'serve') {
-    let {port = 1234, host, publicUrl} = command;
-    port = await getPort({port, host});
+  let serveOptions = false;
+  let {host} = command;
 
-    if (command.port && port !== command.port) {
-      // Parcel logger is not set up at this point, so just use native console.
-      console.warn(
-        chalk.bold.yellowBright(`⚠️  Port ${command.port} could not be used.`),
-      );
+  // Ensure port is valid and available
+  let port = parsePort(command.port || '1234');
+  let originalPort = port;
+  if (command.name() === 'serve' || command.hmr) {
+    try {
+      port = await getPort({port, host});
+    } catch (err) {
+      throw new ThrowableDiagnostic({
+        diagnostic: {
+          message: `Could not get available port: ${err.message}`,
+          origin: 'parcel',
+          stack: err.stack,
+        },
+      });
+    }
+
+    if (port !== originalPort) {
+      let errorMessage = `Port "${originalPort}" could not be used`;
+      if (command.port != null) {
+        // Throw the error if the user defined a custom port
+        throw new Error(errorMessage);
+      } else {
+        // Parcel logger is not set up at this point, so just use native INTERNAL_ORIGINAL_CONSOLE
+        INTERNAL_ORIGINAL_CONSOLE.warn(errorMessage);
+      }
     }
+  }
+
+  if (command.name() === 'serve') {
+    let {publicUrl} = command;
 
-    serve = {
+    serveOptions = {
       https,
       port,
       host,
@@ -289,29 +442,56 @@ async function normalizeOptions(command): Promise<InitialParcelOptions> {
     };
   }
 
-  let hmr = false;
+  let hmrOptions = null;
   if (command.name() !== 'build' && command.hmr !== false) {
-    hmr = true;
+    let hmrport = command.hmrPort ? parsePort(command.hmrPort) : port;
+
+    hmrOptions = {port: hmrport, host};
+  }
+
+  if (command.detailedReport === true) {
+    command.detailedReport = '10';
   }
 
+  let additionalReporters = [
+    {packageName: '@parcel/reporter-cli', resolveFrom: __filename},
+    ...(command.reporter: Array<string>).map(packageName => ({
+      packageName,
+      resolveFrom: path.join(inputFS.cwd(), 'index'),
+    })),
+  ];
+
   let mode = command.name() === 'build' ? 'production' : 'development';
   return {
-    disableCache: command.cache === false,
+    shouldDisableCache: command.cache === false,
     cacheDir: command.cacheDir,
+    config: command.config,
     mode,
-    minify: command.minify != null ? command.minify : mode === 'production',
-    sourceMaps: command.sourceMaps ?? true,
-    scopeHoist: command.scopeHoist,
-    publicUrl: command.publicUrl,
-    distDir: command.distDir,
-    hot: hmr,
-    serve,
+    hmrOptions,
+    shouldContentHash: hmrOptions ? false : command.contentHash,
+    serveOptions,
     targets: command.target.length > 0 ? command.target : null,
-    autoinstall: command.autoinstall ?? true,
+    shouldAutoInstall: command.autoinstall ?? true,
     logLevel: command.logLevel,
-    profile: command.profile,
+    shouldProfile: command.profile,
+    shouldBuildLazily: command.lazy,
+    detailedReport:
+      command.detailedReport != null
+        ? {
+            assetsPerBundle: parseInt(command.detailedReport, 10),
+          }
+        : null,
     env: {
       NODE_ENV: nodeEnv,
     },
+    additionalReporters,
+    defaultTargetOptions: {
+      shouldOptimize:
+        command.optimize != null ? command.optimize : mode === 'production',
+      sourceMaps: command.sourceMaps ?? true,
+      shouldScopeHoist: command.scopeHoist,
+      publicUrl: command.publicUrl,
+      distDir: command.distDir,
+    },
   };
 }