Skip to content

Commit

Permalink
docs(README): Add configuration file description
Browse files Browse the repository at this point in the history
  • Loading branch information
flegall committed Apr 5, 2018
1 parent 888ef0d commit 141fae2
Show file tree
Hide file tree
Showing 8 changed files with 184 additions and 8 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-dependency-collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-process/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack-repo-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down
24 changes: 23 additions & 1 deletion packages/monopack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?

Expand Down

0 comments on commit 141fae2

Please sign in to comment.