Skip to content

Commit 54790ab

Browse files
authored
feat: display documentation links on errors (#3512)
1 parent 39cac6f commit 54790ab

9 files changed

+375
-258
lines changed

Diff for: README.md

+31-22
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,14 @@ Options:
8585
--no-target Negative 'target' option.
8686
--watch-options-stdin Stop watching when stdin stream has ended.
8787
--no-watch-options-stdin Do not stop watching when stdin stream has ended.
88-
--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'). https://webpack.js.org/configuration/dev-server/#devserverallowedhosts
89-
--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'). 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
88+
--allowed-hosts <value...> Allows to enumerate the hosts from which access to the dev server are allowed (useful when you are proxying
89+
dev server, by default is 'auto').
90+
--allowed-hosts-reset Clear all items provided in 'allowedHosts' configuration. Allows to enumerate the hosts from which access to
91+
the dev server are allowed (useful when you are proxying dev server, by default is 'auto').
92+
--bonjour Allows to broadcasts dev server via ZeroConf networking on start.
9193
--no-bonjour Negative 'bonjour' option.
9294
--no-client Negative 'client' option.
93-
--client-logging <value> Allows to specify options for client script in the browser or disable client script. https://webpack.js.org/configuration/dev-server/#devserverclient
95+
--client-logging <value> Allows to specify options for client script in the browser or disable client script.
9496
--client-overlay Enables a full-screen overlay in the browser when there are compiler errors or warnings.
9597
--no-client-overlay Negative 'client-overlay' option.
9698
--client-overlay-errors Enables a full-screen overlay in the browser when there are compiler errors.
@@ -100,23 +102,25 @@ Options:
100102
--client-progress Prints compilation progress in percentage in the browser.
101103
--no-client-progress Negative 'client-progress' option.
102104
--client-web-socket-transport <value> Allows to set custom web socket transport to communicate with dev server.
103-
--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).
105+
--client-web-socket-url <value> Allows to specify URL to web socket server (useful when you're proxying dev server and client script does
106+
not always know where to connect to).
104107
--client-web-socket-url-hostname <value> Tells clients connected to devServer to use the provided hostname.
105108
--client-web-socket-url-pathname <value> Tells clients connected to devServer to use the provided path to connect.
106109
--client-web-socket-url-password <value> Tells clients connected to devServer to use the provided password to authenticate.
107110
--client-web-socket-url-port <value> Tells clients connected to devServer to use the provided port.
108111
--client-web-socket-url-protocol <value> Tells clients connected to devServer to use the provided protocol.
109112
--client-web-socket-url-username <value> Tells clients connected to devServer to use the provided username to authenticate.
110-
--compress Enables gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress
113+
--compress Enables gzip compression for everything served.
111114
--no-compress Negative 'compress' option.
112-
--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 History API. https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback
115+
--history-api-fallback Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page
116+
Applications that utilise the HTML5 History API.
113117
--no-history-api-fallback Negative 'history-api-fallback' option.
114-
--host <value> Allows to specify a hostname to use. https://webpack.js.org/configuration/dev-server/#devserverhost
115-
--hot [value] Enables Hot Module Replacement. https://webpack.js.org/configuration/dev-server/#devserverhot
118+
--host <value> Allows to specify a hostname to use.
119+
--hot [value] Enables Hot Module Replacement.
116120
--no-hot Negative 'hot' option.
117-
--http2 Allows to serve over HTTP/2 using SPDY. https://webpack.js.org/configuration/dev-server/#devserverhttp2
121+
--http2 Allows to serve over HTTP/2 using SPDY.
118122
--no-http2 Negative 'http2' option.
119-
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). https://webpack.js.org/configuration/dev-server/#devserverhttps
123+
--https Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).
120124
--no-https Negative 'https' option.
121125
--https-passphrase <value> Passphrase for a pfx file.
122126
--https-request-cert Request for an SSL certificate.
@@ -125,31 +129,36 @@ Options:
125129
--https-key <value> Path to an SSL key.
126130
--https-pfx <value> Path to an SSL pfx file.
127131
--https-cert <value> Path to an SSL certificate.
128-
--ipc [value] Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc
129-
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default). https://webpack.js.org/configuration/dev-server/#devserverlivereload
132+
--ipc [value] Listen to a unix socket.
133+
--live-reload Enables reload/refresh the page(s) when file changes are detected (enabled by default).
130134
--no-live-reload Negative 'live-reload' option.
131-
--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). https://webpack.js.org/configuration/dev-server/#devserveropen
135+
--open [value...] Allows to configure dev server to open the browser(s) and page(s) after server had been started (set it to
136+
true to open your default browser).
132137
--no-open Negative 'open' option.
133138
--open-target <value...> Opens specified page in browser.
134139
--open-app-name <value...> Open specified browser.
135140
--open-app <value...> Open specified browser.
136-
--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). https://webpack.js.org/configuration/dev-server/#devserveropen
141+
--open-reset Clear all items provided in 'open' configuration. Allows to configure dev server to open the browser(s) and
142+
page(s) after server had been started (set it to true to open your default browser).
137143
--open-target-reset Clear all items provided in 'open.target' configuration. Opens specified page in browser.
138144
--open-app-name-reset Clear all items provided in 'open.app.name' configuration. Open specified browser.
139-
--port <value> Allows to specify a port to use. https://webpack.js.org/configuration/dev-server/#devserverport
140-
--static [value...] Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic
145+
--port <value> Allows to specify a port to use.
146+
--static [value...] Allows to configure options for serving static files from directory (by default 'public' directory).
141147
--no-static Negative 'static' option.
142148
--static-directory <value...> Directory for static contents.
143149
--static-public-path <value...> The static files will be available in the browser under this public path.
144150
--static-serve-index Tells dev server to use serveIndex middleware when enabled.
145151
--no-static-serve-index Negative 'static-serve-index' option.
146152
--static-watch Watches for files in static content directory.
147153
--no-static-watch Negative 'static-watch' option.
148-
--static-reset Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic
149-
--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.
150-
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
151-
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles
152-
--web-socket-server <value> Allows to set web socket server and options (by default 'ws'). https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver
154+
--static-reset Clear all items provided in 'static' configuration. Allows to configure options for serving static files
155+
from directory (by default 'public' directory).
156+
--static-public-path-reset Clear all items provided in 'static.publicPath' configuration. The static files will be available in the
157+
browser under this public path.
158+
--watch-files <value...> Allows to configure list of globs/directories/files to watch for file changes.
159+
--watch-files-reset Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files
160+
to watch for file changes.
161+
--web-socket-server <value> Allows to set web socket server and options (by default 'ws').
153162
154163
Global options:
155164
--color Enable colors on console.

0 commit comments

Comments
 (0)