Skip to content

Commit 43de133

Browse files
committed
refactor: cli flags
1 parent 185a9c3 commit 43de133

File tree

2 files changed

+79
-96
lines changed

2 files changed

+79
-96
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ 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...> 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').
87-
https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
88-
--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
89-
when you are proxying dev server, by default is 'auto'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
90-
--bonjour Allows to broadcasts dev server via ZeroConf networking on start. https://webpack.js.org/configuration/dev-server/#devserverbonjour
86+
--allowed-hosts <value...> Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are
87+
proxying dev server, by default is 'auto').
88+
--allowed-hosts-reset Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which
89+
access to the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
90+
--bonjour Allows to broadcasts dev server via ZeroConf networking on start.
9191
--no-bonjour Negative 'bonjour' option.
9292
--client-hot-entry Injects a Hot Module Replacement entry.
9393
--no-client-hot-entry Negative 'client-hot-entry' option.
94-
--client-logging <value> Allows to specify options for client script in the browser. https://webpack.js.org/configuration/dev-server/#devserverclient
94+
--client-logging <value> Allows to specify options for client script in the browser.
9595
--client-need-client-entry Inject a client entry.
9696
--no-client-need-client-entry Negative 'client-need-client-entry' option.
9797
--client-overlay Enables a full-screen overlay in the browser when there are compiler errors or warnings.
@@ -103,25 +103,26 @@ Options:
103103
--client-progress Prints compilation progress in percentage in the browser.
104104
--no-client-progress Negative 'client-progress' option.
105105
--client-transport <value> Allows to set custom transport to communicate with dev server.
106-
--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 always know where to connect to).
106+
--client-web-socket-url <value> Allows to specify URL to web socket server (useful when you're proxying dev server and client script
107+
does not always know where to connect to).
107108
--client-web-socket-url-hostname <value> Tells clients connected to devServer to use the provided hostname.
108109
--client-web-socket-url-pathname <value> Tells clients connected to devServer to use the provided path to connect.
109110
--client-web-socket-url-password <value> Tells clients connected to devServer to use the provided password to authenticate.
110111
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
111112
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
112113
--client-web-socket-url-username <value> Tells clients connected to devServer to use the provided username to authenticate.
113-
--compress Enables gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress
114+
--compress Enables gzip compression for everything served.
114115
--no-compress Negative 'compress' option.
115-
--history-api-fallback Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5
116-
History API. https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback
116+
--history-api-fallback Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single
117+
Page Applications that utilise the HTML5 History API.
117118
--no-history-api-fallback Negative 'history-api-fallback' option.
118-
--host <value> Allows to specify a hostname to use. https://webpack.js.org/configuration/dev-server/#devserverhost
119-
--hot [value] Enables Hot Module Replacement. https://webpack.js.org/configuration/dev-server/#devserverhot
119+
--host <value> Allows to specify a hostname to use.
120+
--hot [value] Enables Hot Module Replacement.
120121
--no-hot Negative 'hot' option.
121-
--http2 Allows to serve over HTTP/2 using SPDY. https://webpack.js.org/configuration/dev-server/#devserverhttp2
122+
--http2 Allows to serve over HTTP/2 using SPDY.
122123
--no-http2 Negative 'http2' option.
123-
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
124-
https://webpack.js.org/configuration/dev-server/#devserverhttps
124+
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over
125+
HTTP).
125126
--no-https Negative 'https' option.
126127
--https-passphrase <value> Passphrase for a pfx file.
127128
--https-request-cert Request for an SSL certificate.
@@ -130,37 +131,36 @@ Options:
130131
--https-key <value> Path to an SSL key.
131132
--https-pfx <value> Path to an SSL pfx file.
132133
--https-cert <value> Path to an SSL certificate.
133-
--ipc [value] Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc
134+
--ipc [value] Listen to a unix socket.
134135
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
135-
https://webpack.js.org/configuration/dev-server/#devserverlivereload
136136
--no-live-reload Negative 'live-reload' option.
137-
--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 open your default browser).
138-
https://webpack.js.org/configuration/dev-server/#devserveropen
137+
--open [value...] Allows to configure dev server to open the browser(s) and page(s) after server had been started (set
138+
it to true to open your default browser).
139139
--no-open Negative 'open' option.
140140
--open-target <value...> Opens specified page in browser.
141141
--open-app-name <value...> Open specified browser.
142142
--open-app <value...> Open specified browser.
143-
--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
144-
(set it to true to open your default browser). https://webpack.js.org/configuration/dev-server/#devserveropen
143+
--open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the
144+
browser(s) and page(s) after server had been started (set it to true to open your default browser).
145145
--open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser.
146146
--open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser.
147-
--port <value> Allows to specify a port to use. https://webpack.js.org/configuration/dev-server/#devserverport
147+
--port <value> Allows to specify a port to use.
148148
--static [value...] Allows to configure options for serving static files from directory (by default 'public' directory).
149-
https://webpack.js.org/configuration/dev-server/#devserverstatic
150149
--no-static Negative 'static' option.
151150
--static-directory <value...> Directory for static contents.
152151
--static-public-path <value...> The static files will be available in the browser under this public path.
153152
--static-serve-index Tells dev server to use serveIndex middleware when enabled.
154153
--no-static-serve-index Negative 'static-serve-index' option.
155154
--static-watch Watches for files in static content directory.
156155
--no-static-watch Negative 'static-watch' option.
157-
--static-reset Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public'
158-
directory). https://webpack.js.org/configuration/dev-server/#devserverstatic
159-
--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.
160-
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
161-
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.
162-
https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
163-
--web-socket-server <value> Allows to set web socket server and options (by default 'ws'). https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
156+
--static-reset Clear all items provided in 'static' configuration. Allows to configure options for serving static
157+
files from directory (by default 'public' directory).
158+
--static-public-path-reset Clear all items provided in 'static.publicPath' configuration. The static files will be available in
159+
the browser under this public path.
160+
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes.
161+
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of
162+
globs/directories/files to watch for file changes.
163+
--web-socket-server <value> Allows to set web socket server and options (by default 'ws').
164164
165165
Global options:
166166
--color Enable colors on console.

0 commit comments

Comments
 (0)