Decouple Metro config from CLI config (#30)

* Initial commit - delete Metro-related config

* Rewrite of the config, part 2

* Finish adopting link & unlink to new config format

* Rewrite 'server' command and the way we load config

* Fix errors and make server run

* Use require.resolve

* Simplify runServer code

* Updates to the config

* Remove duplicate platforms

* Use real and unified project root

* Fix projectRoots

* Unifiy root paths

* Remove projectRoot from type

* Leave two todos for tomororw

* Use projectRoot to read the root

* Fix projectRoot and implement config again

* Improve Metro config

* Fix configuration again

* Fix remaining Flow issues inside bundle

* Fix two failing test suites

* Fix getDependencyConfig tests and use snapshots

* Remove console

* Fix remaining Jest tests

* Remove console.log

* Fix issues with link/unlink tested in production

* Add legacy config to avoid breaking changes

* Fix a typo

* Exclude React Native CLI from being linked

* Remove console.log from production code

* Update getCommands.js

* Update loadMetroConfig.js

* Update package.json

* Update package.json

packages/local-cli/bundle/buildBundle.js

@@ -16,28 +16,20 @@ const outputBundle = require('metro/src/shared/output/bundle');
 const path = require('path');
 const saveAssets = require('./saveAssets');
 
-import type {RequestOptions, OutputOptions} from './types.flow';
-import type {ConfigT} from 'metro-config/src/configTypes.flow';
+const loadMetroConfig = require('../util/loadMetroConfig');
+
+import type { ContextT } from '../core/types.flow';
+import type { CommandLineArgs } from './bundleCommandLineArgs';
+
+async function buildBundle(args: CommandLineArgs, ctx: ContextT, output = outputBundle) {
+  const config = await loadMetroConfig(ctx.root, {
+    resetCache: args.resetCache,
+    config: args.config
+  });
 
-async function buildBundle(
-  args: OutputOptions & {
-    assetsDest: mixed,
-    entryFile: string,
-    maxWorkers: number,
-    resetCache: boolean,
-    transformer: string,
-    minify: boolean,
-  },
-  configPromise: Promise<ConfigT>,
-  /* $FlowFixMe(>=0.85.0 site=react_native_fb) This comment suppresses an error
-   * found when Flow v0.85 was deployed. To see the error, delete this comment
-   * and run Flow. */
-  output = outputBundle,
-) {
   // This is used by a bazillion of npm modules we don't control so we don't
   // have other choice than defining it as an env variable here.
   process.env.NODE_ENV = args.dev ? 'development' : 'production';
-  const config = await configPromise;
 
   let sourceMapUrl = args.sourcemapOutput;
   if (sourceMapUrl && !args.sourcemapUseAbsolutePath) {
@@ -52,7 +44,7 @@ async function buildBundle(
     platform: args.platform,
   };
 
-  const server = new Server({...config, resetCache: args.resetCache});
+  const server = new Server(config);
 
   try {
     const bundle = await output.build(server, requestOpts);

packages/local-cli/bundle/bundle.js

@@ -16,19 +16,15 @@ const outputBundle = require('metro/src/shared/output/bundle');
 /**
  * Builds the bundle starting to look for dependencies at the given entry path.
  */
-function bundleWithOutput(argv, configPromise, args, output) {
-  if (!output) {
-    output = outputBundle;
-  }
-  return buildBundle(args, configPromise, output);
+function bundleWithOutput(_, config, args, output) {
+  return buildBundle(args, config, output);
 }
 
 module.exports = {
   name: 'bundle',
   description: 'builds the javascript bundle for offline use',
   func: bundleWithOutput,
   options: bundleCommandLineArgs,
-
-  // not used by the CLI itself
+  // Used by `ramBundle.js`
   withOutput: bundleWithOutput,
 };

packages/local-cli/bundle/bundleCommandLineArgs.js

@@ -4,11 +4,32 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @format
+ * @flow
  */
 
 'use strict';
 
+const path = require('path');
+
+export type CommandLineArgs = {
+  assetsDest?: string,
+  entryFile: string,
+  resetCache: boolean,
+  resetGlobalCache: boolean,
+  transformer?: string,
+  minify?: boolean,
+  config?: string,
+  platform?: string,
+  dev: boolean,
+  bundleOutput: string,
+  bundleEncoding?: string,
+  maxWorkers?: number,
+  sourcemapOutput?: string,
+  sourcemapSourcesRoot?: string,
+  sourcemapUseAbsolutePath: boolean,
+  verbose: boolean,
+};
+
 module.exports = [
   {
     command: '--entry-file <path>',
@@ -27,7 +48,7 @@ module.exports = [
   {
     command: '--dev [boolean]',
     description: 'If false, warnings are disabled and the bundle is minified',
-    parse: val => (val === 'false' ? false : true),
+    parse: (val: string) => (val === 'false' ? false : true),
     default: true,
   },
   {
@@ -36,7 +57,7 @@ module.exports = [
       'Allows overriding whether bundle is minified. This defaults to ' +
       'false if dev is true, and true if dev is false. Disabling minification ' +
       'can be useful for speeding up production builds for testing purposes.',
-    parse: val => (val === 'false' ? false : true),
+    parse: (val: string) => (val === 'false' ? false : true),
   },
   {
     command: '--bundle-output <string>',
@@ -93,4 +114,9 @@ module.exports = [
       'Try to fetch transformed JS code from the global cache, if configured.',
     default: false,
   },
+  {
+    command: '--config [string]',
+    description: 'Path to the CLI configuration file',
+    parse: (val: string) => path.resolve(val),
+  },
 ];

packages/local-cli/cliEntry.js

@@ -10,25 +10,18 @@
 
 'use strict';
 
-const {configPromise} = require('./core');
-
 const assertRequiredOptions = require('./util/assertRequiredOptions');
-/* $FlowFixMe(>=0.54.0 site=react_native_oss) This comment suppresses an error
- * found when Flow v0.54 was deployed. To see the error delete this comment and
- * run Flow. */
 const chalk = require('chalk');
 const childProcess = require('child_process');
-/* $FlowFixMe(>=0.54.0 site=react_native_oss) This comment suppresses an error
- * found when Flow v0.54 was deployed. To see the error delete this comment and
- * run Flow. */
 const commander = require('commander');
-const commands = require('./commands');
+const getCommands = require('./core/getCommands');
+const getLegacyConfig = require('./core/getLegacyConfig');
+const minimist = require('minimist');
 const init = require('./init/init');
 const path = require('path');
 const pkg = require('./package.json');
 
-import type {CommandT} from './commands';
-import type {RNConfig} from './core';
+import type { CommandT, ContextT } from './core/types.flow';
 
 commander.version(pkg.version);
 
@@ -99,7 +92,7 @@ function printUnknownCommand(cmdName) {
   );
 }
 
-const addCommand = (command: CommandT, cfg: RNConfig) => {
+const addCommand = (command: CommandT, ctx: ContextT) => {
   const options = command.options || [];
 
   const cmd = commander
@@ -114,38 +107,56 @@ const addCommand = (command: CommandT, cfg: RNConfig) => {
       Promise.resolve()
         .then(() => {
           assertRequiredOptions(options, passedOptions);
-          return command.func(argv, cfg, passedOptions);
+          return command.func(argv, ctx, passedOptions);
         })
         .catch(handleError);
     });
 
   cmd.helpInformation = printHelpInformation.bind(cmd);
   cmd.examples = command.examples;
+  // $FlowFixMe: This is either null or not
   cmd.pkg = command.pkg;
 
   options.forEach(opt =>
     cmd.option(
       opt.command,
       opt.description,
       opt.parse || defaultOptParser,
-      typeof opt.default === 'function' ? opt.default(cfg) : opt.default,
+      typeof opt.default === 'function' ? opt.default(ctx) : opt.default,
     ),
   );
-
-  // Placeholder option for --config, which is parsed before any other option,
-  // but needs to be here to avoid "unknown option" errors when specified
-  cmd.option('--config [string]', 'Path to the CLI configuration file');
+
+  // This is needed to avoid `unknown option` error by Commander.js
+  cmd.option('--projectRoot [string]', 'Path to the root of the project');
 };
 
 async function run() {
-  const config = await configPromise;
   const setupEnvScript = /^win/.test(process.platform)
     ? 'setup_env.bat'
     : 'setup_env.sh';
 
   childProcess.execFileSync(path.join(__dirname, setupEnvScript));
 
-  commands.forEach(cmd => addCommand(cmd, config));
+  /**
+   * Read passed `options` and take the "global" settings
+   * 
+   * @todo(grabbou): Consider unifying this by removing either `commander`
+   * or `minimist`
+   */
+  const options = minimist(process.argv.slice(2));
+
+  const root = options.projectRoot
+    ? path.resolve(options.projectRoot)
+    : process.cwd();
+
+  const ctx = {
+    ...getLegacyConfig(root),
+    root,
+  };
+
+  const commands = getCommands(ctx.root);
+
+  commands.forEach(command => addCommand(command, ctx));
 
   commander.parse(process.argv);
 

packages/local-cli/core/__tests__/findAssets-test.js

@@ -13,7 +13,7 @@
 jest.mock('path');
 jest.mock('fs');
 
-const findAssets = require('../findAssets');
+const { findAssets } = require('../getAssets');
 const dependencies = require('../__fixtures__/dependencies');
 const fs = require('fs');