Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Let's ship the webpack 4 documentation #1856

Merged
merged 39 commits into from
Mar 20, 2018
Merged

Let's ship the webpack 4 documentation #1856

Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
dafbbb2
adding docs for new `output.devtoolNamespace` option and [namespace] …
MagicDuck Oct 17, 2017
f3c515c
adding extra lines as indicated
MagicDuck Oct 20, 2017
8ccb3da
docs(config): update `hashFunction` docs based on v4 (#1761)
EugeneHlushko Jan 16, 2018
7fa4fe0
docs(api): reformat index page at 80 characters / line
skipjack Dec 16, 2017
388aa68
docs(api): reformat node api docs and add more details on the compiler
skipjack Dec 16, 2017
4896c00
docs(api): reformat/rewrite the lead-in plugin docs and remove `tapab…
skipjack Dec 17, 2017
d5c0a24
docs(api): remove `module-factories.md` and `template.md`
skipjack Dec 17, 2017
38e33c2
docs(api): reformat line length in plugins.md
skipjack Dec 17, 2017
33caf72
docs(api): rewrite, rename, and resort the `compiler.md` page
skipjack Dec 18, 2017
ede8e02
docs(api): rewrite, rename, and resort the `compilation.md` page
skipjack Dec 18, 2017
e0f7a62
docs(api): fix sorting and start to reformat the last two plugin pages
skipjack Dec 18, 2017
ebe7331
docs(api): begin rewrite of the resolver page
skipjack Dec 27, 2017
b066b44
docs(config): fix header nesting in resolve.md
skipjack Dec 27, 2017
93efa5d
docs(api): rename resolvers page for clarity and finish rewrite
skipjack Dec 27, 2017
1555e7c
docs(api): make minor corrections to plugin docs
skipjack Dec 31, 2017
7941097
docs(api): rewrite the parser documentation
skipjack Dec 31, 2017
acf7b77
docs(api): update some of the compiler hook descriptions
skipjack Feb 7, 2018
7b89b9f
docs(plugins): add `ProfilingPlugin` documentation (#1830)
EugeneHlushko Feb 23, 2018
4354b9a
docs(config): document `info-verbosity` option in watch.md (#1817)
EugeneHlushko Feb 23, 2018
b1d2779
Merge branch 'master' into next
sokra Feb 26, 2018
6194853
update tree shaking guide for webpack 4
quantizor Feb 28, 2018
6de8690
docs(Guides): Update Getting Started to use webpack 4
TheDutchCoder Mar 1, 2018
7d1f662
docs(concepts): Update plugins.md (#1871)
arjendeblok Mar 1, 2018
44eb6c9
Merge branch 'master' into next
montogeek Mar 1, 2018
45db042
docs(Stats): add `buitlAt` to the example configuration (#1878)
osenvosem Mar 3, 2018
a44fa0a
docs(guides): add doctype to Get Started (#1874)
TheDutchCoder Mar 5, 2018
38faec2
docs(API): add missing config options to cli.md (#1880)
joshunger Mar 6, 2018
0c96dd5
docs(Concepts): update concepts page for v4 (#1883)
EugeneHlushko Mar 6, 2018
0e545a1
update related links to be relevant for webpack 4
quantizor Mar 15, 2018
9ad350d
add note about side effects and non-JS files
quantizor Mar 15, 2018
2f19976
add some more advanced usage notes
quantizor Mar 15, 2018
c1318e1
Merge pull request #1865 from probablyup/update-se-docs
jeremenichelli Mar 15, 2018
051a566
docs(concepts) Clarification about NODE_ENV and mode (#1885)
montogeek Mar 15, 2018
e1029fc
chore(site): Delete package-lock.json (#1917)
dhruvdutt Mar 16, 2018
8b13724
docs(guides): Correct a path error in getting started example (#1899)
bingtimren Mar 17, 2018
bec9d42
chore: Resolve conflicts on next branch (#1923)
dhruvdutt Mar 19, 2018
3197738
Merge branch 'master' into next
TheLarkInn Mar 19, 2018
40d89f9
docs(api) Fix markdown lint errors
montogeek Mar 19, 2018
74cb0e7
docs(api) Fix Plugins wording
montogeek Mar 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16,295 changes: 16,295 additions & 0 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion src/content/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,16 @@ Invocation | Resulting environment

T> See the [environment variables](/guides/environment-variables) guide for more information on its usage.

### Config Options

Parameter | Explanation | Input type | Default
------------------------- | ------------------------------------------- | ---------- | ------------------
`--config` | Path to the config file | string | webpack.config.js or webpackfile.js
`--config-register, -r` | Preload one or more modules before loading the webpack configuration | array |
`--config-name` | Name of the config to use | string |
`--env` | Environment passed to the config, when it is a function |
`--mode` | Mode to use, either "development" or "production" | string |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't this production by default?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, it throws if not supplied

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shows a warning:

WARNING in configuration
The 'mode' option has not been set. Set 'mode' option to 'development' or 'production' to enable defaults for this environment.

but still bundle the app

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, but it bundles the app as in production right? that's what I meant.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/webpack/webpack/blob/4f399322ad1922ae7bafdeea1c4d83bf9c9851a7/lib/WebpackOptionsDefaulter.js#L284

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that is the case
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, we default to production so people don't have consequences for not caring about the mode: property. However, we still will warn because we want users to be aware of being able to set the property.


### Output Options

This set of options allows you to manipulate certain [output](/configuration/output) parameters of your build.
Expand Down Expand Up @@ -196,7 +206,7 @@ Parameter | Explanation | Input type | D
`--debug` | Switch loaders to debug mode | boolean | false
`--devtool` | Define [source map type](/configuration/devtool/) for the bundled resources | string | -
`--progress` | Print compilation progress in percentage | boolean | false

`--display-error-details` | Display details about errors | boolean | false

### Module Options

Expand Down
Loading