Skip to content

Commit b565b42

Browse files
committed
docs: udpate CLI options for v5 (#4719)
1 parent 2e4eaa7 commit b565b42

File tree

1 file changed

+13
-32
lines changed

1 file changed

+13
-32
lines changed

README.md

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -83,22 +83,26 @@ Options:
8383
-c, --config <value...> Provide path to a webpack configuration file e.g. ./webpack.config.js.
8484
--config-name <value...> Name of the configuration to use.
8585
-m, --merge Merge two or more configurations using 'webpack-merge'.
86+
--disable-interpret Disable interpret for loading the config file.
8687
--env <value...> Environment passed to the configuration when it is a function.
8788
--node-env <value> Sets process.env.NODE_ENV to the specified value.
89+
--define-process-env-node-env <value> Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`)
90+
--analyze It invokes webpack-bundle-analyzer plugin to get bundle information.
8891
--progress [value] Print compilation progress during build.
8992
-j, --json [value] Prints result as JSON or store it in a file.
90-
-d, --devtool <value> Determine source maps to use.
91-
--no-devtool Do not generate source maps.
92-
--entry <value...> The entry point(s) of your application e.g. ./src/main.js.
93-
--mode <value> Defines the mode to pass to webpack.
93+
--fail-on-warnings Stop webpack-cli process with non-zero exit code on warnings from webpack
94+
-d, --devtool <value> A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).
95+
--no-devtool Negative 'devtool' option.
96+
--entry <value...> A module that is loaded upon startup. Only the last one is exported.
97+
--mode <value> Enable production optimizations or development hints.
9498
--name <value> Name of the configuration. Used when loading multiple configurations.
95-
-o, --output-path <value> Output location of the file generated by webpack e.g. ./dist/.
96-
--stats [value] It instructs webpack on how to treat the stats e.g. verbose.
97-
--no-stats Disable stats output.
98-
-t, --target <value...> Sets the build target e.g. node.
99+
-o, --output-path <value> The output directory as **absolute path** (required).
100+
--stats [value] Stats options object or preset name.
101+
--no-stats Negative 'stats' option.
102+
-t, --target <value...> Environment to build for. Environment to build for. An array of environments to build for all of them when possible.
99103
--no-target Negative 'target' option.
100104
--watch-options-stdin Stop watching when stdin stream has ended.
101-
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
105+
--no-watch-options-stdin Negative 'watch-options-stdin' option.
102106
--allowed-hosts <value...> Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
103107
--allowed-hosts-reset Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
104108
--bonjour Allows to broadcasts dev server via ZeroConf networking on start.
@@ -131,25 +135,6 @@ Options:
131135
--host <value> Allows to specify a hostname to use.
132136
--hot [value] Enables Hot Module Replacement.
133137
--no-hot Disables Hot Module Replacement.
134-
--http2 Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.
135-
--no-http2 Does not serve over HTTP/2 using SPDY.
136-
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.
137-
--no-https Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
138-
--https-passphrase <value> Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.
139-
--https-request-cert Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.
140-
--no-https-request-cert Does not request for an SSL certificate.
141-
--https-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
142-
--https-ca-reset Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
143-
--https-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
144-
--https-cacert-reset Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
145-
--https-cert <value...> Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.
146-
--https-cert-reset Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.
147-
--https-crl <value...> Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.
148-
--https-crl-reset Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.
149-
--https-key <value...> Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
150-
--https-key-reset Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.
151-
--https-pfx <value...> Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.
152-
--https-pfx-reset Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.
153138
--ipc [value] Listen to a unix socket.
154139
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
155140
--no-live-reload Disables reload/refresh the page(s) when file changes are detected (enabled by default).
@@ -159,7 +144,6 @@ Options:
159144
--no-open Does not open the default browser.
160145
--open-target <value...> Opens specified page in browser.
161146
--open-app-name <value...> Open specified browser.
162-
--open-app <value...> Open specified browser. Deprecated: please use '--open-app-name'.
163147
--open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to open your default browser).
164148
--open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser.
165149
--open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser.
@@ -170,8 +154,6 @@ Options:
170154
--no-server-options-request-cert Does not request for an SSL certificate.
171155
--server-options-ca <value...> Path to an SSL CA certificate or content of an SSL CA certificate.
172156
--server-options-ca-reset Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate.
173-
--server-options-cacert <value...> Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
174-
--server-options-cacert-reset Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.
175157
--server-options-cert <value...> Path to an SSL certificate or content of an SSL certificate.
176158
--server-options-cert-reset Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content of an SSL certificate.
177159
--server-options-crl <value...> Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).
@@ -192,7 +174,6 @@ Options:
192174
--static-public-path-reset Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.
193175
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes.
194176
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.
195-
--web-socket-server <value> Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').
196177
--no-web-socket-server Disallows to set web socket server and options.
197178
--web-socket-server-type <value> Allows to set web socket server and options (by default 'ws').
198179

0 commit comments

Comments
 (0)