Skip to content

Commit 185a9c3

Browse files
snitin315snitin315
committed
refactor: update schema
1 parent 481a4cc commit 185a9c3

File tree

3 files changed

+244
-126
lines changed

3 files changed

+244
-126
lines changed

‎lib/options.json‎

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"$ref": "#/definitions/AllowedHostsItem"
1919
}
2020
],
21-
"description": "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"
21+
"description": "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').",
22+
"link": "https://webpack.js.org/configuration/dev-server/#devserverallowedhosts"
2223
},
2324
"AllowedHostsItem": {
2425
"type": "string",
@@ -31,14 +32,17 @@
3132
},
3233
{
3334
"type": "object",
34-
"description": "Options for bonjour, description available at https://github.com/watson/bonjour#initializing"
35+
"description": "Options for bonjour.",
36+
"link": "https://github.com/watson/bonjour#initializing"
3537
}
3638
],
37-
"description": "Allows to broadcasts dev server via ZeroConf networking on start. https://webpack.js.org/configuration/dev-server/#devserverbonjour"
39+
"description": "Allows to broadcasts dev server via ZeroConf networking on start.",
40+
"link": " https://webpack.js.org/configuration/dev-server/#devserverbonjour"
3841
},
3942
"Client": {
4043
"type": "object",
41-
"description": "Allows to specify options for client script in the browser. https://webpack.js.org/configuration/dev-server/#devserverclient",
44+
"description": "Allows to specify options for client script in the browser.",
45+
"link": " https://webpack.js.org/configuration/dev-server/#devserverclient",
4246
"additionalProperties": false,
4347
"properties": {
4448
"hotEntry": {
@@ -192,16 +196,19 @@
192196
},
193197
"Compress": {
194198
"type": "boolean",
195-
"description": "Enables gzip compression for everything served. https://webpack.js.org/configuration/dev-server/#devservercompress"
199+
"description": "Enables gzip compression for everything served.",
200+
"link": "https://webpack.js.org/configuration/dev-server/#devservercompress"
196201
},
197202
"DevMiddleware": {
198-
"description": "Provide options to 'webpack-dev-middleware' which handles webpack assets. https://webpack.js.org/configuration/dev-server/#devserverdevmiddleware",
203+
"description": "Provide options to 'webpack-dev-middleware' which handles webpack assets.",
204+
"link": "https://webpack.js.org/configuration/dev-server/#devserverdevmiddleware",
199205
"type": "object",
200206
"additionalProperties": true
201207
},
202208
"HTTP2": {
203209
"type": "boolean",
204-
"description": "Allows to serve over HTTP/2 using SPDY. https://webpack.js.org/configuration/dev-server/#devserverhttp2"
210+
"description": "Allows to serve over HTTP/2 using SPDY.",
211+
"link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2"
205212
},
206213
"HTTPS": {
207214
"anyOf": [
@@ -267,7 +274,8 @@
267274
}
268275
}
269276
],
270-
"description": "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"
277+
"description": "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).",
278+
"link": "https://webpack.js.org/configuration/dev-server/#devserverhttps"
271279
},
272280
"Headers": {
273281
"anyOf": [
@@ -278,7 +286,8 @@
278286
"instanceof": "Function"
279287
}
280288
],
281-
"description": "Allows to set custom headers on response. https://webpack.js.org/configuration/dev-server/#devserverheaders"
289+
"description": "Allows to set custom headers on response.",
290+
"link": "https://webpack.js.org/configuration/dev-server/#devserverheaders"
282291
},
283292
"HistoryApiFallback": {
284293
"anyOf": [
@@ -287,15 +296,18 @@
287296
},
288297
{
289298
"type": "object",
290-
"description": "Options for `historyApiFallback`, description available at https://github.com/bripkens/connect-history-api-fallback#options"
299+
"description": "Options for `historyApiFallback`.",
300+
"link": "https://github.com/bripkens/connect-history-api-fallback#options"
291301
}
292302
],
293-
"description": "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"
303+
"description": "Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5 History API.",
304+
"link": "https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback"
294305
},
295306
"Host": {
296307
"type": "string",
297308
"minLength": 1,
298-
"description": "Allows to specify a hostname to use. https://webpack.js.org/configuration/dev-server/#devserverhost"
309+
"description": "Allows to specify a hostname to use.",
310+
"link": "https://webpack.js.org/configuration/dev-server/#devserverhost"
299311
},
300312
"Hot": {
301313
"anyOf": [
@@ -306,7 +318,8 @@
306318
"enum": ["only"]
307319
}
308320
],
309-
"description": "Enables Hot Module Replacement. https://webpack.js.org/configuration/dev-server/#devserverhot"
321+
"description": "Enables Hot Module Replacement.",
322+
"link": "https://webpack.js.org/configuration/dev-server/#devserverhot"
310323
},
311324
"IPC": {
312325
"anyOf": [
@@ -319,23 +332,28 @@
319332
"enum": [true]
320333
}
321334
],
322-
"description": "Listen to a unix socket. https://webpack.js.org/configuration/dev-server/#devserveripc"
335+
"description": "Listen to a unix socket.",
336+
"link": "https://webpack.js.org/configuration/dev-server/#devserveripc"
323337
},
324338
"LiveReload": {
325339
"type": "boolean",
326-
"description": "Enables reload/refresh the page(s) when file changes are detected (enabled by default). https://webpack.js.org/configuration/dev-server/#devserverlivereload"
340+
"description": "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
341+
"link": "https://webpack.js.org/configuration/dev-server/#devserverlivereload"
327342
},
328343
"OnAfterSetupMiddleware": {
329344
"instanceof": "Function",
330-
"description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares. https://webpack.js.org/configuration/dev-server/#devserveronaftersetupmiddleware"
345+
"description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares.",
346+
"link": "https://webpack.js.org/configuration/dev-server/#devserveronaftersetupmiddleware"
331347
},
332348
"OnBeforeSetupMiddleware": {
333349
"instanceof": "Function",
334-
"description": "Provides the ability to execute a custom function and apply custom middleware(s) prior to all other middlewares. https://webpack.js.org/configuration/dev-server/#devserveronbeforesetupmiddleware"
350+
"description": "Provides the ability to execute a custom function and apply custom middleware(s) prior to all other middlewares.",
351+
"link": "https://webpack.js.org/configuration/dev-server/#devserveronbeforesetupmiddleware"
335352
},
336353
"OnListening": {
337354
"instanceof": "Function",
338-
"description": "Provides the ability to execute a custom function when dev server starts listening. https://webpack.js.org/configuration/dev-server/#devserveronlistening"
355+
"description": "Provides the ability to execute a custom function when dev server starts listening.",
356+
"link": "https://webpack.js.org/configuration/dev-server/#devserveronlistening"
339357
},
340358
"Open": {
341359
"anyOf": [
@@ -362,7 +380,8 @@
362380
"$ref": "#/definitions/OpenObject"
363381
}
364382
],
365-
"description": "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"
383+
"description": "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).",
384+
"link": "https://webpack.js.org/configuration/dev-server/#devserveropen"
366385
},
367386
"OpenBoolean": {
368387
"type": "boolean"
@@ -441,7 +460,8 @@
441460
"enum": ["auto"]
442461
}
443462
],
444-
"description": "Allows to specify a port to use. https://webpack.js.org/configuration/dev-server/#devserverport"
463+
"description": "Allows to specify a port to use.",
464+
"link": "https://webpack.js.org/configuration/dev-server/#devserverport"
445465
},
446466
"Proxy": {
447467
"anyOf": [
@@ -462,11 +482,13 @@
462482
}
463483
}
464484
],
465-
"description": "Allows to proxy requests, 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"
485+
"description": "Allows to proxy requests, can be useful when you have a separate API backend development server and you want to send API requests on the same domain.",
486+
"link": "https://webpack.js.org/configuration/dev-server/#devserverproxy"
466487
},
467488
"SetupExitSignals": {
468489
"type": "boolean",
469-
"description": "Allows to close dev server and exit the process on SIGINT and SIGTERM signals (enabled by default for CLI). https://webpack.js.org/configuration/dev-server/#devserversetupexitsignals",
490+
"description": "Allows to close dev server and exit the process on SIGINT and SIGTERM signals (enabled by default for CLI).",
491+
"link": "https://webpack.js.org/configuration/dev-server/#devserversetupexitsignals",
470492
"cli": {
471493
"exclude": true
472494
}
@@ -496,7 +518,8 @@
496518
"$ref": "#/definitions/StaticObject"
497519
}
498520
],
499-
"description": "Allows to configure options for serving static files from directory (by default 'public' directory). https://webpack.js.org/configuration/dev-server/#devserverstatic"
521+
"description": "Allows to configure options for serving static files from directory (by default 'public' directory).",
522+
"link": "https://webpack.js.org/configuration/dev-server/#devserverstatic"
500523
},
501524
"StaticObject": {
502525
"type": "object",
@@ -545,7 +568,8 @@
545568
},
546569
{
547570
"type": "object",
548-
"description": "Options for watch, description available at https://github.com/paulmillr/chokidar#api"
571+
"description": "Options for watch.",
572+
"link": "https://github.com/paulmillr/chokidar#api"
549573
}
550574
],
551575
"description": "Watches for files in static content directory."
@@ -578,7 +602,8 @@
578602
"$ref": "#/definitions/WatchFilesObject"
579603
}
580604
],
581-
"description": "Allows to configure list of globs/directories/files to watch for file changes. https://webpack.js.org/configuration/dev-server/#devserverwatchfiles"
605+
"description": "Allows to configure list of globs/directories/files to watch for file changes.",
606+
"link": "https://webpack.js.org/configuration/dev-server/#devserverwatchfiles"
582607
},
583608
"WatchFilesObject": {
584609
"cli": {
@@ -627,7 +652,8 @@
627652
"$ref": "#/definitions/WebSocketServerObject"
628653
}
629654
],
630-
"description": "Allows to set web socket server and options (by default 'ws'). https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
655+
"description": "Allows to set web socket server and options (by default 'ws').",
656+
"link": "https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
631657
},
632658
"WebSocketServerEnum": {
633659
"enum": ["sockjs", "ws"]

0 commit comments

Comments
 (0)