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.

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

Add missing config options to cli.md #1880

Merged
merged 9 commits into from
Mar 6, 2018
16,295 changes: 16,295 additions & 0 deletions package-lock.json

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion src/content/api/cli.md
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 |

### 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
2 changes: 1 addition & 1 deletion src/content/api/loaders.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ __sync-loader-with-multiple-results.js__

``` js
module.exports = function(content, map, meta) {
this.callback(null, someSyncOperation(content), sourceMaps, meta);
this.callback(null, someSyncOperation(content), map, meta);
return; // always return undefined when calling callback()
};
```
Expand Down
1 change: 1 addition & 0 deletions src/content/guides/asset-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Let's make a minor change to our project before we get started:
__dist/index.html__

``` diff
<!doctype html>
<html>
<head>
- <title>Getting Started</title>
Expand Down
21 changes: 11 additions & 10 deletions src/content/guides/author-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,18 @@ require(['webpackNumbers'], function ( webpackNumbers) {
The consumer also can use the library by loading it via a script tag:

``` html
<!doctype html>
<html>
...
<script src="https://unpkg.com/webpack-numbers"></script>
<script>
// ...
// Global variable
webpackNumbers.wordToNum('Five')
// Property in the window object
window.webpackNumbers.wordToNum('Five')
// ...
</script>
...
<script src="https://unpkg.com/webpack-numbers"></script>
<script>
// ...
// Global variable
webpackNumbers.wordToNum('Five')
// Property in the window object
window.webpackNumbers.wordToNum('Five')
// ...
</script>
</html>
```

Expand Down
2 changes: 1 addition & 1 deletion src/content/guides/development-vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ module.exports = {
And create a `index.html` file. The script tag should point to your bundle. If `output.filename` is not specified in the config, this will be `bundle.js`.

```html
<!DOCTYPE html>
<!doctype html>
<html>
<head>
<script src="/bundle.js" charset="utf-8"></script>
Expand Down
2 changes: 2 additions & 0 deletions src/content/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ document.body.appendChild(component());
__index.html__

``` html
<!doctype html>
<html>
<head>
<title>Getting Started</title>
Expand Down Expand Up @@ -127,6 +128,7 @@ Now, since we'll be bundling our scripts, we have to update our `index.html` fil
__dist/index.html__

``` diff
<!doctype html>
<html>
<head>
<title>Getting Started</title>
Expand Down
1 change: 1 addition & 0 deletions src/content/guides/output-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Let's also update our `dist/index.html` file, in preparation for webpack to spli
__dist/index.html__

``` diff
<!doctype html>
<html>
<head>
- <title>Asset Management</title>
Expand Down
1 change: 1 addition & 0 deletions src/content/guides/shimming.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,7 @@ With that in place, we can add the logic to conditionally load our new `polyfill
__dist/index.html__

``` diff
<!doctype html>
<html>
<head>
<title>Getting Started</title>
Expand Down
1 change: 1 addition & 0 deletions src/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ module.exports = {
__page.html__

```html
<!doctype html>
<html>
<head>
...
Expand Down
3 changes: 2 additions & 1 deletion src/content/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ contributors:
- rouzbeh84
- aretecode
- eko3alpha
- refactorized
---

webpack has a rich plugin interface. Most of the features within webpack itself use this plugin interface. This makes webpack **flexible**.
Expand All @@ -16,9 +17,9 @@ Name | Description
[`BabelMinifyWebpackPlugin`](/plugins/babel-minify-webpack-plugin) | Minification with [babel-minify](https://github.com/babel/minify)
[`BannerPlugin`](/plugins/banner-plugin) | Add a banner to the top of each generated chunk
[`CommonsChunkPlugin`](/plugins/commons-chunk-plugin) | Extract common modules shared between chunks
[`ComponentWebpackPlugin`](/plugins/component-webpack-plugin) | Use components with webpack
[`CompressionWebpackPlugin`](/plugins/compression-webpack-plugin) | Prepare compressed versions of assets to serve them with Content-Encoding
[`ContextReplacementPlugin`](/plugins/context-replacement-plugin) | Override the inferred context of a `require` expression
[`CopyWebpackPlugin`](/plugins/copy-webpack-plugin) | Copies individual files or entire directories to the build directory
[`DefinePlugin`](/plugins/define-plugin) | Allow global constants configured at compile time
[`DllPlugin`](/plugins/dll-plugin) | Split bundles in order to drastically improve build time
[`EnvironmentPlugin`](/plugins/environment-plugin) | Shorthand for using the [`DefinePlugin`](./define-plugin) on `process.env` keys
Expand Down
3 changes: 3 additions & 0 deletions src/scripts/fetch.sh
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ node ./src/scripts/fetch_package_names.js "peerigon" "extract-loader" | node ./s
# Fetch webpack-contrib (and various other) plugin repositories
node ./src/scripts/fetch_package_names.js "webpack-contrib" "-webpack-plugin" | node ./src/scripts/fetch_package_files.js "README.md" "./generated/plugins"

# Remove deprecated or archived plugins repositories
rm ./generated/plugins/component-webpack-plugin.json ./generated/plugins/component-webpack-plugin.md

# Fetch sponsors and backers from opencollective
node ./src/scripts/fetch_supporters.js

Expand Down