diff --git a/README.md b/README.md index 763b8fc2..f2c29920 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-builder/README.md b/packages/monopack-builder/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-builder/README.md +++ b/packages/monopack-builder/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-cli/README.md b/packages/monopack-cli/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-cli/README.md +++ b/packages/monopack-cli/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-config/README.md b/packages/monopack-config/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-config/README.md +++ b/packages/monopack-config/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-dependency-collector/README.md b/packages/monopack-dependency-collector/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-dependency-collector/README.md +++ b/packages/monopack-dependency-collector/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-process/README.md b/packages/monopack-process/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-process/README.md +++ b/packages/monopack-process/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack-repo-builder/README.md b/packages/monopack-repo-builder/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack-repo-builder/README.md +++ b/packages/monopack-repo-builder/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ? diff --git a/packages/monopack/README.md b/packages/monopack/README.md index 763b8fc2..f2c29920 100644 --- a/packages/monopack/README.md +++ b/packages/monopack/README.md @@ -64,7 +64,29 @@ With npm You can include an optional configuration file : **monopack.config.js** -_TODO_ +This configuration file can be used to : + +* Define the monorepo root +* Override the default babel configuration +* Override the default webpack configuration + +The config file can export 3 entries : + +* monorepoRootPath : the relative path to the monorepo root. +* babelConfigModifier : a function that takes the current configuration and returns the modified configuration. +* webpackConfigModifier: a function that takes the current configuration and returns the modified configuration. + +For example : + +```js +module.exports.monorepoRootPath = '../..'; +module.exports.babelConfigModifier = defaultBabelConfiguration => { + return babelConfiguration(defaultBabelConfiguration); +}; +module.exports.webpackConfigModifier = defaultWebpackConfig => { + return webPackConfiguration(defaultWebpackConfig); +}; +``` ## Why such a tool ?