Merge `rnpm config` with the `cli config`, step 1
Summary:
This is step one on merging the `rnpm` config with the `cli config`. The plan is to remove two sources of truth (rnpm package.json config and rn-cli Javascript config)
Rationale:
As of now, we have `rnpm` config, that used to live in the `local-cli/core/config/index.js` and the `rn-cli` config, living in `default.config.js` and `utils/Config.js`.
This PR moves all the things into one file, called `local-cli/core', simplifies things, enhances types (Config now has better types, added missing properties and fixed descriptions).
One notable addition is that users can now opt-in to override the commands that are loaded at the package level. Previously it was only possible to add a command by writing a plugin. Now, you can just tweak the `rn-cli.config.js`.
This is one of the several improvements I have on my roadmap, with better documentation for the CLI as well.
Closes https://github.com/facebook/react-native/pull/11564
Differential Revision: D4360095
fbshipit-source-id: feaec7c88df63e51cef1f9620c7eedeb738d3d00
2017-01-09 15:49:29 +00:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* This source code is licensed under the BSD-style license found in the
|
|
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
|
|
*
|
|
|
|
* @flow
|
|
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
|
|
|
|
const Config = require('../util/Config');
|
2017-01-13 05:03:57 +00:00
|
|
|
|
Merge `rnpm config` with the `cli config`, step 1
Summary:
This is step one on merging the `rnpm` config with the `cli config`. The plan is to remove two sources of truth (rnpm package.json config and rn-cli Javascript config)
Rationale:
As of now, we have `rnpm` config, that used to live in the `local-cli/core/config/index.js` and the `rn-cli` config, living in `default.config.js` and `utils/Config.js`.
This PR moves all the things into one file, called `local-cli/core', simplifies things, enhances types (Config now has better types, added missing properties and fixed descriptions).
One notable addition is that users can now opt-in to override the commands that are loaded at the package level. Previously it was only possible to add a command by writing a plugin. Now, you can just tweak the `rn-cli.config.js`.
This is one of the several improvements I have on my roadmap, with better documentation for the CLI as well.
Closes https://github.com/facebook/react-native/pull/11564
Differential Revision: D4360095
fbshipit-source-id: feaec7c88df63e51cef1f9620c7eedeb738d3d00
2017-01-09 15:49:29 +00:00
|
|
|
const defaultConfig = require('./default.config');
|
|
|
|
const minimist = require('minimist');
|
|
|
|
|
2017-02-02 13:30:03 +00:00
|
|
|
import type {GetTransformOptions} from '../../packager/src/Bundler';
|
Merge `rnpm config` with the `cli config`, step 1
Summary:
This is step one on merging the `rnpm` config with the `cli config`. The plan is to remove two sources of truth (rnpm package.json config and rn-cli Javascript config)
Rationale:
As of now, we have `rnpm` config, that used to live in the `local-cli/core/config/index.js` and the `rn-cli` config, living in `default.config.js` and `utils/Config.js`.
This PR moves all the things into one file, called `local-cli/core', simplifies things, enhances types (Config now has better types, added missing properties and fixed descriptions).
One notable addition is that users can now opt-in to override the commands that are loaded at the package level. Previously it was only possible to add a command by writing a plugin. Now, you can just tweak the `rn-cli.config.js`.
This is one of the several improvements I have on my roadmap, with better documentation for the CLI as well.
Closes https://github.com/facebook/react-native/pull/11564
Differential Revision: D4360095
fbshipit-source-id: feaec7c88df63e51cef1f9620c7eedeb738d3d00
2017-01-09 15:49:29 +00:00
|
|
|
import type {CommandT} from '../commands';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Configuration file of the CLI.
|
|
|
|
*/
|
|
|
|
export type ConfigT = {
|
|
|
|
extraNodeModules?: { [id: string]: string },
|
|
|
|
/**
|
|
|
|
* Specify any additional asset extentions to be used by the packager.
|
|
|
|
* For example, if you want to include a .ttf file, you would return ['ttf']
|
|
|
|
* from here and use `require('./fonts/example.ttf')` inside your app.
|
|
|
|
*/
|
|
|
|
getAssetExts?: () => Array<string>,
|
|
|
|
/**
|
|
|
|
* Specify any additional platforms to be used by the packager.
|
|
|
|
* For example, if you want to add a "custom" platform, and use modules
|
|
|
|
* ending in .custom.js, you would return ['custom'] here.
|
|
|
|
*/
|
|
|
|
getPlatforms: () => Array<string>,
|
2017-01-13 05:03:57 +00:00
|
|
|
/**
|
|
|
|
* Specify any additional node modules that should be processed for
|
|
|
|
* providesModule declarations.
|
|
|
|
*/
|
|
|
|
getProvidesModuleNodeModules?: () => Array<string>,
|
Merge `rnpm config` with the `cli config`, step 1
Summary:
This is step one on merging the `rnpm` config with the `cli config`. The plan is to remove two sources of truth (rnpm package.json config and rn-cli Javascript config)
Rationale:
As of now, we have `rnpm` config, that used to live in the `local-cli/core/config/index.js` and the `rn-cli` config, living in `default.config.js` and `utils/Config.js`.
This PR moves all the things into one file, called `local-cli/core', simplifies things, enhances types (Config now has better types, added missing properties and fixed descriptions).
One notable addition is that users can now opt-in to override the commands that are loaded at the package level. Previously it was only possible to add a command by writing a plugin. Now, you can just tweak the `rn-cli.config.js`.
This is one of the several improvements I have on my roadmap, with better documentation for the CLI as well.
Closes https://github.com/facebook/react-native/pull/11564
Differential Revision: D4360095
fbshipit-source-id: feaec7c88df63e51cef1f9620c7eedeb738d3d00
2017-01-09 15:49:29 +00:00
|
|
|
/**
|
|
|
|
* Returns the path to a custom transformer. This can also be overridden
|
|
|
|
* with the --transformer commandline argument.
|
|
|
|
*/
|
|
|
|
getTransformModulePath?: () => string,
|
|
|
|
getTransformOptions?: GetTransformOptions,
|
|
|
|
transformVariants?: () => {[name: string]: Object},
|
|
|
|
/**
|
|
|
|
* Returns a regular expression for modules that should be ignored by the
|
|
|
|
* packager on a given platform.
|
|
|
|
*/
|
|
|
|
getBlacklistRE(): RegExp,
|
|
|
|
getProjectRoots(): Array<string>,
|
|
|
|
getAssetExts(): Array<string>,
|
|
|
|
/**
|
|
|
|
* Returns an array of project commands used by the CLI to load
|
|
|
|
*/
|
|
|
|
getProjectCommands(): Array<CommandT>,
|
|
|
|
/**
|
|
|
|
* Returns project config from the current working directory
|
|
|
|
*/
|
|
|
|
getProjectConfig(): Object,
|
|
|
|
/**
|
|
|
|
* Returns dependency config from <node_modules>/packageName
|
|
|
|
*/
|
|
|
|
getDependencyConfig(pkgName: string): Object,
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Loads the CLI configuration
|
|
|
|
*/
|
|
|
|
function getCliConfig(): ConfigT {
|
|
|
|
const cliArgs = minimist(process.argv.slice(2));
|
|
|
|
|
|
|
|
let cwd;
|
|
|
|
let configPath;
|
|
|
|
|
|
|
|
if (cliArgs.config != null) {
|
|
|
|
cwd = process.cwd();
|
|
|
|
configPath = cliArgs.config;
|
|
|
|
} else {
|
|
|
|
cwd = __dirname;
|
|
|
|
configPath = Config.findConfigPath(cwd);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Config.get(cwd, defaultConfig, configPath);
|
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = getCliConfig();
|