Skip to content

Commit 391b618

Browse files
snitin315snitin315
committed
docs: update
1 parent b7b14ca commit 391b618

File tree

1 file changed

+63
-54
lines changed

1 file changed

+63
-54
lines changed

‎README.md

+63-54
Original file line numberDiff line numberDiff line change
@@ -83,82 +83,91 @@ Options:
8383
--no-target Negative 'target' option.
8484
--watch-options-stdin Stop watching when stdin stream has ended.
8585
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
86-
--allowed-hosts <value...> Defines routes which are enabled by default, on by default and allows localhost/value from the 'host' option/value from the 'client.webSocketURL'
87-
option. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
88-
--allowed-hosts-reset Clear all items provided in configuration. Defines routes which are enabled by default, on by default and allows localhost/value from the 'host'
89-
option/value from the 'client.webSocketURL' option. https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
90-
--bonjour Broadcasts the server via ZeroConf networking on start. https://webpack.js.org/configuration/dev-server/#devserverbonjour
91-
--no-bonjour Do not broadcast the server via ZeroConf networking on start.
92-
--client-transport <value> Allows to set custom transport to communicate with server.
93-
--client-logging <value> Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient
94-
--client-progress Print compilation progress in percentage in the browser.
95-
--no-client-progress Do not print compilation progress in percentage in the browser.
96-
--client-overlay Show a full-screen overlay in the browser when there are compiler errors or warnings.
97-
--no-client-overlay Do not show a full-screen overlay in the browser when there are compiler errors or warnings.
98-
--client-overlay-errors Show a full-screen overlay in the browser when there are compiler errors.
86+
--allowed-hosts <value...> Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying dev
87+
server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
88+
--allowed-hosts-reset Clear all items provided in configuration. Allows to enumerate the hosts from which access to the dev server are
89+
allowed (useful when you are proxying dev server, by default is 'auto').
90+
https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
91+
--bonjour Allows to broadcasts dev server via ZeroConf networking on start.
92+
https://webpack.js.org/configuration/dev-server/#devserverbonjour
93+
--no-bonjour Negative 'bonjour' option.
94+
--client-hot-entry Injects a Hot Module Replacement entry.
95+
--no-client-hot-entry Negative 'client-hot-entry' option.
96+
--client-logging <value> Allows to specify options for client script in the browser.
97+
https://webpack.js.org/configuration/dev-server/#devserverclient
98+
--client-need-client-entry Inject a client entry.
99+
--no-client-need-client-entry Negative 'client-need-client-entry' option.
100+
--client-overlay Enables a full-screen overlay in the browser when there are compiler errors or warnings.
101+
--no-client-overlay Negative 'client-overlay' option.
102+
--client-overlay-errors Enables a full-screen overlay in the browser when there are compiler errors.
99103
--no-client-overlay-errors Negative 'client-overlay-errors' option.
100-
--client-overlay-warnings Show a full-screen overlay in the browser when there are compiler warnings.
104+
--client-overlay-warnings Enables a full-screen overlay in the browser when there are compiler warnings.
101105
--no-client-overlay-warnings Negative 'client-overlay-warnings' option.
102-
--client-need-client-entry Tells devServer to inject a client entry.
103-
--no-client-need-client-entry Negative 'client-need-client-entry' option.
104-
--client-hot-entry Tells devServer to inject a Hot Module Replacement entry.
105-
--no-client-hot-entry Do not tell devServer to inject a Hot Module Replacement entry.
106-
--client-web-socket-url <value> When using dev server and you're proxying dev-server, the client script does not always know where to connect to.
106+
--client-progress Prints compilation progress in percentage in the browser.
107+
--no-client-progress Negative 'client-progress' option.
108+
--client-transport <value> Allows to set custom transport to communicate with dev server.
109+
--client-web-socket-url <value> Allows to specify URL to web socket server (useful when you're proxying dev server and client script does not
110+
always know where to connect to).
107111
--client-web-socket-url-host <value> Tells clients connected to devServer to use the provided host.
108-
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
109112
--client-web-socket-url-path <value> Tells clients connected to devServer to use the provided path to connect.
113+
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
110114
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
111-
--web-socket-server <value> Allows to set web socket server and options.
112-
--compress Enable gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress
113-
--no-compress Disable gzip compression.
114-
--history-api-fallback When using the HTML5 History API, the index.html page will likely have to be served in place of any 404 responses.
115+
--compress Enables gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress
116+
--no-compress Negative 'compress' option.
117+
--history-api-fallback Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page
118+
Applications that utilise the HTML5 History API.
115119
https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback
116120
--no-history-api-fallback Negative 'history-api-fallback' option.
117-
--host <value> Specify a host to use. If you want your server to be accessible externally. https://webpack.js.org/configuration/dev-server/#devserverhost
118-
--hot [value] Enable webpack's Hot Module Replacement feature. https://webpack.js.org/configuration/dev-server/#devserverhot
119-
--no-hot Disable webpack's Hot Module Replacement feature.
120-
--http2 Serve over HTTP/2 using spdy. https://webpack.js.org/configuration/dev-server/#devserverhttp2
121-
--no-http2 Do not use HTTP/2.
122-
--https By default, dev-server will be served over HTTP. It can optionally be served over HTTP/2 with HTTPS.
121+
--host <value> Allows to specify a hostname to use. https://webpack.js.org/configuration/dev-server/#devserverhost
122+
--hot [value] Enables Hot Module Replacement. https://webpack.js.org/configuration/dev-server/#devserverhot
123+
--no-hot Negative 'hot' option.
124+
--http2 Allows to serve over HTTP/2 using SPDY. https://webpack.js.org/configuration/dev-server/#devserverhttp2
125+
--no-http2 Negative 'http2' option.
126+
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
123127
https://webpack.js.org/configuration/dev-server/#devserverhttps
124-
--no-https Do not use HTTPS protocol.
128+
--no-https Negative 'https' option.
125129
--https-passphrase <value> Passphrase for a pfx file.
126130
--https-request-cert Request for an SSL certificate.
127-
--no-https-request-cert Do not request for an SSL certificate.
131+
--no-https-request-cert Negative 'https-request-cert' option.
128132
--https-cacert <value> Path to an SSL CA certificate.
129133
--https-key <value> Path to an SSL key.
130134
--https-pfx <value> Path to an SSL pfx file.
131135
--https-cert <value> Path to an SSL certificate.
132-
--live-reload By default, the dev-server will reload/refresh the page when file changes are detected.
136+
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
133137
https://webpack.js.org/configuration/dev-server/#devserverlivereload
134-
--no-live-reload Disables live reloading on changing files.
135-
--open [value...] Tells dev-server to open the browser after server had been started. Set it to true to open your default browser.
136-
https://webpack.js.org/configuration/dev-server/#devserveropen
137-
--no-open Do not open the default browser.
138-
--open-target [value...] Open specified route in browser.
139-
--no-open-target Do not open specified route in browser.
138+
--no-live-reload Negative 'live-reload' option.
139+
--open [value...] Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to true to
140+
open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen
141+
--no-open Negative 'open' option.
142+
--open-target [value...] Opens specified page in browser.
143+
--no-open-target Negative 'open-target' option.
140144
--open-app-name <value...> Open specified browser.
141145
--open-app <value...> Open specified browser.
142-
--open-reset Clear all items provided in configuration. Tells dev-server to open the browser after server had been started. Set it to true to open your default
143-
browser. https://webpack.js.org/configuration/dev-server/#devserveropen
144-
--open-target-reset Clear all items provided in configuration. Open specified route in browser.
146+
--open-reset Clear all items provided in configuration. Allows to configure dev server to open the browser(s) and page(s) after
147+
server had been started (set it to true to open your default browser).
148+
https://webpack.js.org/configuration/dev-server/#devserveropen
149+
--open-target-reset Clear all items provided in configuration. Opens specified page in browser.
145150
--open-app-name-reset Clear all items provided in configuration. Open specified browser.
146-
--port <value> Specify a port number to listen for requests on. https://webpack.js.org/configuration/dev-server/#devserverport
147-
--static [value...] It is possible to configure advanced options for serving static files from directory. See the Express documentation for the possible options.
151+
--port <value> Allows to specify a port to use. https://webpack.js.org/configuration/dev-server/#devserverport
152+
--static [value...] Allows to configure options for serving static files from directory (by default 'public' directory).
148153
https://webpack.js.org/configuration/dev-server/#devserverstatic
149154
--no-static Negative 'static' option.
150155
--static-directory <value...> Directory for static contents.
151-
--static-public-path <value...> The bundled files will be available in the browser under this path.
152-
--static-serve-index Tells dev-server to use serveIndex middleware when enabled.
153-
--no-static-serve-index Do not tell dev-server to use serveIndex middleware.
154-
--static-watch Watch for files in static content directory.
155-
--no-static-watch Do not watch for files in static content directory.
156-
--static-reset Clear all items provided in configuration. It is possible to configure advanced options for serving static files from directory. See the Express
157-
documentation for the possible options. https://webpack.js.org/configuration/dev-server/#devserverstatic
158-
--static-public-path-reset Clear all items provided in configuration. The bundled files will be available in the browser under this path.
159-
--watch-files <value...> List of files to watch for file changes and serve. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
160-
--watch-files-reset Clear all items provided in configuration. List of files to watch for file changes and serve.
156+
--static-public-path <value...> The static files will be available in the browser under this public path.
157+
--static-serve-index Tells dev server to use serveIndex middleware when enabled.
158+
--no-static-serve-index Negative 'static-serve-index' option.
159+
--static-watch Watches for files in static content directory.
160+
--no-static-watch Negative 'static-watch' option.
161+
--static-reset Clear all items provided in configuration. Allows to configure options for serving static files from directory (by
162+
default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic
163+
--static-public-path-reset Clear all items provided in configuration. The static files will be available in the browser under this public
164+
path.
165+
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes.
161166
https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
167+
--watch-files-reset Clear all items provided in configuration. Allows to configure list of globs/directories/files to watch for file
168+
changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
169+
--web-socket-server <value> Allows to set web socket server and options (by default 'ws').
170+
https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
162171
163172
Global options:
164173
--color Enable colors on console.

0 commit comments

Comments
 (0)