Skip to content

Commit 2e02978

Browse files
anshumanvanshumanv
authored
fix: output description on invalid options (#3154)
1 parent ad3db67 commit 2e02978

File tree

4 files changed

+121
-83
lines changed

4 files changed

+121
-83
lines changed

‎lib/options.json

+45-49
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@
136136
},
137137
"properties": {
138138
"bonjour": {
139-
"type": "boolean"
139+
"type": "boolean",
140+
"description": "Broadcasts the server via ZeroConf networking on start. https://webpack.js.org/configuration/dev-server/#devserverbonjour"
140141
},
141142
"client": {
142143
"type": "object",
@@ -205,13 +206,16 @@
205206
]
206207
}
207208
},
209+
"description": "Specifies client properties. https://webpack.js.org/configuration/dev-server/#devserverclient",
208210
"additionalProperties": false
209211
},
210212
"compress": {
211-
"type": "boolean"
213+
"type": "boolean",
214+
"description": "Enable gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress"
212215
},
213216
"dev": {
214-
"type": "object"
217+
"type": "object",
218+
"description": "The bundled files will be available in the browser under this path. https://webpack.js.org/configuration/dev-server/#devserverdev-"
215219
},
216220
"firewall": {
217221
"anyOf": [
@@ -225,10 +229,12 @@
225229
},
226230
"minItems": 1
227231
}
228-
]
232+
],
233+
"description": "Defines routes which are enabled by default, on by default and allows localhost. https://webpack.js.org/configuration/dev-server/#devserverfirewall"
229234
},
230235
"headers": {
231-
"type": "object"
236+
"type": "object",
237+
"description": "Adds headers to all responses. https://webpack.js.org/configuration/dev-server/#devserverheaders"
232238
},
233239
"historyApiFallback": {
234240
"anyOf": [
@@ -238,7 +244,8 @@
238244
{
239245
"type": "object"
240246
}
241-
]
247+
],
248+
"description": "When using the HTML5 History API, the index.html page will likely have to be served in place of any 404 responses. https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback"
242249
},
243250
"host": {
244251
"anyOf": [
@@ -248,7 +255,8 @@
248255
{
249256
"type": "null"
250257
}
251-
]
258+
],
259+
"description": "Specify a host to use. If you want your server to be accessible externally. https://webpack.js.org/configuration/dev-server/#devserverhost"
252260
},
253261
"hot": {
254262
"anyOf": [
@@ -258,10 +266,12 @@
258266
{
259267
"enum": ["only"]
260268
}
261-
]
269+
],
270+
"description": "Enable webpack's Hot Module Replacement feature. https://webpack.js.org/configuration/dev-server/#devserverhot"
262271
},
263272
"http2": {
264-
"type": "boolean"
273+
"type": "boolean",
274+
"description": "Serve over HTTP/2 using spdy. https://webpack.js.org/configuration/dev-server/#devserverhttp2"
265275
},
266276
"https": {
267277
"anyOf": [
@@ -320,19 +330,24 @@
320330
}
321331
}
322332
}
323-
]
333+
],
334+
"description": "By default, dev-server will be served over HTTP. It can optionally be served over HTTP/2 with HTTPS. https://webpack.js.org/configuration/dev-server/#devserverhttps"
324335
},
325336
"liveReload": {
326-
"type": "boolean"
337+
"type": "boolean",
338+
"description": "By default, the dev-server will reload/refresh the page when file changes are detected. https://webpack.js.org/configuration/dev-server/#devserverlivereload"
327339
},
328340
"onAfterSetupMiddleware": {
329-
"instanceof": "Function"
341+
"instanceof": "Function",
342+
"description": "Provides the ability to execute custom middleware after all other middleware internally within the server. https://webpack.js.org/configuration/dev-server/#devserverafter"
330343
},
331344
"onBeforeSetupMiddleware": {
332-
"instanceof": "Function"
345+
"instanceof": "Function",
346+
"description": "Provides the ability to execute custom middleware prior to all other middleware internally within the server. https://webpack.js.org/configuration/dev-server/#devserverbefore"
333347
},
334348
"onListening": {
335-
"instanceof": "Function"
349+
"instanceof": "Function",
350+
"description": "Provides an option to execute a custom function when webpack-dev-server starts listening for connections on a port. https://webpack.js.org/configuration/dev-server/#onlistening"
336351
},
337352
"open": {
338353
"anyOf": [
@@ -359,7 +374,8 @@
359374
},
360375
"minItems": 1
361376
}
362-
]
377+
],
378+
"description": "Tells dev-server to open the browser after server had been started. Set it to true to open your default browser. https://webpack.js.org/configuration/dev-server/#devserveropen"
363379
},
364380
"port": {
365381
"anyOf": [
@@ -372,7 +388,8 @@
372388
{
373389
"type": "null"
374390
}
375-
]
391+
],
392+
"description": "Specify a port number to listen for requests on. https://webpack.js.org/configuration/dev-server/#devserverport"
376393
},
377394
"proxy": {
378395
"anyOf": [
@@ -393,13 +410,16 @@
393410
},
394411
"minItems": 1
395412
}
396-
]
413+
],
414+
"description": "Proxying some URLs can be useful when you have a separate API backend development server and you want to send API requests on the same domain. https://webpack.js.org/configuration/dev-server/#devserverproxy"
397415
},
398416
"public": {
399-
"type": "string"
417+
"type": "string",
418+
"description": "When using dev server and you're proxying dev-server, the client script does not always know where to connect to. It will try to guess the URL of the server based on window.location, but if that fails you'll need to use this. https://webpack.js.org/configuration/dev-server/#devserverpublic"
400419
},
401420
"setupExitSignals": {
402-
"type": "boolean"
421+
"type": "boolean",
422+
"description": "It takes a boolean and if true (default on CLI), the server will close and exit the process on SIGINT and SIGTERM. https://webpack.js.org/configuration/dev-server/#devserversetupexitsignals"
403423
},
404424
"static": {
405425
"anyOf": [
@@ -426,7 +446,8 @@
426446
},
427447
"minItems": 1
428448
}
429-
]
449+
],
450+
"description": "It is possible to configure advanced options for serving static files from directory. See the Express documentation for the possible options. https://webpack.js.org/configuration/dev-server/#devserverstatic"
430451
},
431452
"transportMode": {
432453
"anyOf": [
@@ -452,7 +473,8 @@
452473
{
453474
"enum": ["sockjs", "ws"]
454475
}
455-
]
476+
],
477+
"description": "This option allows us either to choose the current devServer transport mode for client/server individually or to provide custom client/server implementation. https://webpack.js.org/configuration/dev-server/#devservertransportmode"
456478
},
457479
"watchFiles": {
458480
"anyOf": [
@@ -475,34 +497,8 @@
475497
]
476498
}
477499
}
478-
]
479-
}
480-
},
481-
"errorMessage": {
482-
"properties": {
483-
"bonjour": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverbonjour)",
484-
"client": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverclient)",
485-
"compress": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devservercompress)",
486-
"dev": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverdev-)",
487-
"firewall": "should be {Boolean|Array} (https://webpack.js.org/configuration/dev-server/#devserverfirewall)",
488-
"headers": "should be {Object} (https://webpack.js.org/configuration/dev-server/#devserverheaders)",
489-
"historyApiFallback": "should be {Boolean|Object} (https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback)",
490-
"host": "should be {String|Null} (https://webpack.js.org/configuration/dev-server/#devserverhost)",
491-
"hot": "should be {Boolean|String} (https://webpack.js.org/configuration/dev-server/#devserverhot)",
492-
"http2": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttp2)",
493-
"https": "should be {Object|Boolean} (https://webpack.js.org/configuration/dev-server/#devserverhttps)",
494-
"liveReload": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserverlivereload)",
495-
"onAfterSetupMiddleware": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserverafter)",
496-
"onBeforeSetupMiddleware": "should be {Function} (https://webpack.js.org/configuration/dev-server/#devserverbefore)",
497-
"onListening": "should be {Function} (https://webpack.js.org/configuration/dev-server/#onlistening)",
498-
"open": "should be {Boolean|String|(String | Object)[]} (https://webpack.js.org/configuration/dev-server/#devserveropen)",
499-
"port": "should be {Number|String|Null} (https://webpack.js.org/configuration/dev-server/#devserverport)",
500-
"proxy": "should be {Object|Array} (https://webpack.js.org/configuration/dev-server/#devserverproxy)",
501-
"public": "should be {String} (https://webpack.js.org/configuration/dev-server/#devserverpublic)",
502-
"setupExitSignals": "should be {Boolean} (https://webpack.js.org/configuration/dev-server/#devserversetupexitsignals)",
503-
"static": "should be {Boolean|String|Object|Array} (https://webpack.js.org/configuration/dev-server/#devserverstatic)",
504-
"transportMode": "should be {String|Object} (https://webpack.js.org/configuration/dev-server/#devservertransportmode)",
505-
"watchFiles": "should be {String|Array|Object} (https://webpack.js.org/configuration/dev-server/#devserverwatchfiles)"
500+
],
501+
"description": "List of files to watch for file changes and serve. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles"
506502
}
507503
},
508504
"additionalProperties": false

0 commit comments

Comments
 (0)