Explain the possible parameters when webpack.config.js exports a function #1479

jennings · 2017-08-02T05:35:07Z

This adds a table of possible --env arguments and how they translate into the env parameter.

It also mentions the second parameter, argv, and gives an example of detecting if -p or --optimize-minimize was given.

skipjack

@jennings thanks for this addition. Please see my comment below, I think everything you've added is perfect, we should just move it to another section of the docs.

skipjack · 2017-08-06T04:37:36Z

content/configuration/configuration-types.md

+| webpack --env.prod=1         | { prod: 1 }               |
+| webpack --env.prod=foo       | { prod: "foo" }           |
+| webpack --env.prod --env.bar | { prod: true, bar: true } |
+| webpack --env.prod --env bar | [{ prod: true }, "bar"]   |


The majority of this should be moved to the CLI section of the documentation, probably in this section as that's the only place I'm seeing --env mentioned. Then, from this page, we should link to there (feel free to create a dedicated section for --env with a header so you can link directly to it's hash).

jennings · 2017-08-06T06:22:49Z

@skipjack Thanks for your help, I rebased and updated based on your suggestions, let me know if you'd like me to change anything else.

skipjack

@jennings added some other minor comments, once those are addressed we should be good to go.

skipjack · 2017-08-06T12:54:37Z

content/api/cli.md

@@ -129,6 +119,25 @@ webpack --json > stats.json

 In every other case, webpack prints out a set of stats showing bundle, chunk and timing details. Using this option the output can be a JSON object. This response is accepted by webpack's [analyse tool](https://webpack.github.com/analyse), or chrisbateman's [webpack-visualizer](https://chrisbateman.github.io/webpack-visualizer/), or th0r's [webpack-bundle-analyzer](https://github.com/th0r/webpack-bundle-analyzer). The analyse tool will take in the JSON and provide all the details of the build in graphical form.

+### Environment options


I would capitalize "Options" as it's in the title.

skipjack · 2017-08-06T12:57:03Z

content/configuration/configuration-types.md

@@ -11,21 +11,26 @@ contributors:
 Besides exporting a single config object, there are a few more ways that cover other needs as well.


-## Exporting a function to use `--env`
+## Exporting a function to use `--env` and `argv`


Maybe simplify this title to "Exporting a Function"? Then in api/cli.md update your link to go directly here, e.g. /configuration/configuration-types#exporting-a-function.

skipjack · 2017-08-06T12:58:24Z

content/configuration/configuration-types.md

+One option is to export a function from your webpack config instead of exporting an object. The function will be invoked with two arguments:
+
+* An environment as the first parameter. See the [environment options CLI documentation](/api/cli#environment-options) for syntax examples.
+


Drop this line break... typically between list items we don't include them.

* Expand on how --env arguments gets translated into the env parameter. * Briefly explain the argv parameter.

jennings · 2017-08-06T21:32:27Z

@skipjack Updated:

Capitalized "Environment Options"
Removed the blank space between list items
Rename the title to "Exporting a Function" and fixed up the link
I also noticed I forgot to surround the environment examples with backticks, so I added those

skipjack · 2017-08-07T02:28:50Z

@jennings thanks! Awesome work on this as well as #1489. If you're interested in contributing regularly, I would be happy to invite you to the organization. I feel like we're finally getting this repo into a good place but there is still a little ways to go with the backlog before we can fully focus on cleaning things up, reviewing the content, and organizing it all properly.

Anyways any time you can spare is definitely appreciated.

jennings · 2017-08-07T21:30:40Z

@skipjack Thanks :)

I do want to contribute more. I'm not certain yet how much time I can devote to it, but, I can give it a shot. Anything specific you would want me to go after? I saw #1258, it seems like most topics in your checklist have been "claimed".

I'm fairly new to webpack, but I don't mind learning something new in order to improve the docs.

skipjack · 2017-08-07T21:53:48Z

Yeah #1258 is pretty close to completion as you can see in this comment. The ones left are somewhat advanced so I don't know if that would be a good start.

If you could pick up any of the miscellaneous issues though that would be great and feel free to comment on them to discuss direction, e.g. where the new content might go if it's not obvious or just general thoughts on how the issue can be resolved.

skipjack added Configuration Enhancement labels Aug 2, 2017

skipjack self-requested a review August 2, 2017 12:15

skipjack requested changes Aug 6, 2017

View reviewed changes

jennings force-pushed the config-function-params branch 2 times, most recently from d12cb4f to ccd2754 Compare August 6, 2017 06:20

skipjack requested changes Aug 6, 2017

View reviewed changes

Discuss params when webpack.config.js exports a function

363650f

* Expand on how --env arguments gets translated into the env parameter. * Briefly explain the argv parameter.

jennings force-pushed the config-function-params branch from ccd2754 to 363650f Compare August 6, 2017 21:30

skipjack approved these changes Aug 7, 2017

View reviewed changes

skipjack merged commit d4234bb into webpack:master Aug 7, 2017

jennings deleted the config-function-params branch August 7, 2017 17:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Explain the possible parameters when webpack.config.js exports a function #1479

Explain the possible parameters when webpack.config.js exports a function #1479

jennings commented Aug 2, 2017

skipjack left a comment

skipjack Aug 6, 2017

jennings commented Aug 6, 2017

skipjack left a comment

skipjack Aug 6, 2017

skipjack Aug 6, 2017

skipjack Aug 6, 2017

jennings commented Aug 6, 2017

skipjack commented Aug 7, 2017

jennings commented Aug 7, 2017

skipjack commented Aug 7, 2017

		@@ -129,6 +119,25 @@ webpack --json > stats.json

		In every other case, webpack prints out a set of stats showing bundle, chunk and timing details. Using this option the output can be a JSON object. This response is accepted by webpack's [analyse tool](https://webpack.github.com/analyse), or chrisbateman's [webpack-visualizer](https://chrisbateman.github.io/webpack-visualizer/), or th0r's [webpack-bundle-analyzer](https://github.com/th0r/webpack-bundle-analyzer). The analyse tool will take in the JSON and provide all the details of the build in graphical form.

		### Environment options

		One option is to export a function from your webpack config instead of exporting an object. The function will be invoked with two arguments:

		* An environment as the first parameter. See the [environment options CLI documentation](/api/cli#environment-options) for syntax examples.

Explain the possible parameters when webpack.config.js exports a function #1479

Explain the possible parameters when webpack.config.js exports a function #1479

Conversation

jennings commented Aug 2, 2017

skipjack left a comment

Choose a reason for hiding this comment

skipjack Aug 6, 2017

Choose a reason for hiding this comment

jennings commented Aug 6, 2017

skipjack left a comment

Choose a reason for hiding this comment

skipjack Aug 6, 2017

Choose a reason for hiding this comment

skipjack Aug 6, 2017

Choose a reason for hiding this comment

skipjack Aug 6, 2017

Choose a reason for hiding this comment

jennings commented Aug 6, 2017

skipjack commented Aug 7, 2017

jennings commented Aug 7, 2017

skipjack commented Aug 7, 2017