UNPKG

40.6 kBJavaScriptView Raw
1"use strict";
2
3module.exports = {
4 "allowed-hosts": {
5 configs: [
6 {
7 type: "string",
8 multiple: true,
9 description:
10 "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').",
11 path: "allowedHosts[]",
12 },
13 {
14 description:
15 "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').",
16 multiple: false,
17 path: "allowedHosts",
18 type: "enum",
19 values: ["auto", "all"],
20 },
21 ],
22 description:
23 "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').",
24 multiple: true,
25 simpleType: "string",
26 },
27 "allowed-hosts-reset": {
28 configs: [
29 {
30 type: "reset",
31 multiple: false,
32 description:
33 "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').",
34 path: "allowedHosts",
35 },
36 ],
37 description:
38 "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').",
39 simpleType: "boolean",
40 multiple: false,
41 },
42 bonjour: {
43 configs: [
44 {
45 type: "boolean",
46 multiple: false,
47 description:
48 "Allows to broadcasts dev server via ZeroConf networking on start.",
49 negatedDescription:
50 "Disallows to broadcasts dev server via ZeroConf networking on start.",
51 path: "bonjour",
52 },
53 ],
54 description:
55 "Allows to broadcasts dev server via ZeroConf networking on start.",
56 simpleType: "boolean",
57 multiple: false,
58 },
59 client: {
60 configs: [
61 {
62 description:
63 "Allows to specify options for client script in the browser or disable client script.",
64 negatedDescription: "Disables client script.",
65 multiple: false,
66 path: "client",
67 type: "enum",
68 values: [false],
69 },
70 ],
71 description:
72 "Allows to specify options for client script in the browser or disable client script.",
73 multiple: false,
74 simpleType: "boolean",
75 },
76 "client-logging": {
77 configs: [
78 {
79 type: "enum",
80 values: ["none", "error", "warn", "info", "log", "verbose"],
81 multiple: false,
82 description: "Allows to set log level in the browser.",
83 path: "client.logging",
84 },
85 ],
86 description: "Allows to set log level in the browser.",
87 simpleType: "string",
88 multiple: false,
89 },
90 "client-overlay": {
91 configs: [
92 {
93 type: "boolean",
94 multiple: false,
95 description:
96 "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
97 negatedDescription:
98 "Disables the full-screen overlay in the browser when there are compiler errors or warnings.",
99 path: "client.overlay",
100 },
101 ],
102 description:
103 "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
104 simpleType: "boolean",
105 multiple: false,
106 },
107 "client-overlay-errors": {
108 configs: [
109 {
110 type: "boolean",
111 multiple: false,
112 description:
113 "Enables a full-screen overlay in the browser when there are compiler errors.",
114 negatedDescription:
115 "Disables the full-screen overlay in the browser when there are compiler errors.",
116 path: "client.overlay.errors",
117 },
118 ],
119 description:
120 "Enables a full-screen overlay in the browser when there are compiler errors.",
121 simpleType: "boolean",
122 multiple: false,
123 },
124 "client-overlay-trusted-types-policy-name": {
125 configs: [
126 {
127 description:
128 "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
129 multiple: false,
130 path: "client.overlay.trustedTypesPolicyName",
131 type: "string",
132 },
133 ],
134 description:
135 "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
136 multiple: false,
137 simpleType: "string",
138 },
139 "client-overlay-warnings": {
140 configs: [
141 {
142 type: "boolean",
143 multiple: false,
144 description:
145 "Enables a full-screen overlay in the browser when there are compiler warnings.",
146 negatedDescription:
147 "Disables the full-screen overlay in the browser when there are compiler warnings.",
148 path: "client.overlay.warnings",
149 },
150 ],
151 description:
152 "Enables a full-screen overlay in the browser when there are compiler warnings.",
153 simpleType: "boolean",
154 multiple: false,
155 },
156 "client-overlay-runtime-errors": {
157 configs: [
158 {
159 type: "boolean",
160 multiple: false,
161 description:
162 "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
163 negatedDescription:
164 "Disables the full-screen overlay in the browser when there are uncaught runtime errors.",
165 path: "client.overlay.runtimeErrors",
166 },
167 ],
168 description:
169 "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
170 simpleType: "boolean",
171 multiple: false,
172 },
173 "client-progress": {
174 configs: [
175 {
176 type: "boolean",
177 multiple: false,
178 description:
179 "Prints compilation progress in percentage in the browser.",
180 negatedDescription:
181 "Does not print compilation progress in percentage in the browser.",
182 path: "client.progress",
183 },
184 ],
185 description: "Prints compilation progress in percentage in the browser.",
186 simpleType: "boolean",
187 multiple: false,
188 },
189 "client-reconnect": {
190 configs: [
191 {
192 type: "boolean",
193 multiple: false,
194 description:
195 "Tells dev-server the number of times it should try to reconnect the client.",
196 negatedDescription:
197 "Tells dev-server to not to try to reconnect the client.",
198 path: "client.reconnect",
199 },
200 {
201 type: "number",
202 multiple: false,
203 description:
204 "Tells dev-server the number of times it should try to reconnect the client.",
205 path: "client.reconnect",
206 },
207 ],
208 description:
209 "Tells dev-server the number of times it should try to reconnect the client.",
210 simpleType: "string",
211 multiple: false,
212 },
213 "client-web-socket-transport": {
214 configs: [
215 {
216 type: "enum",
217 values: ["sockjs", "ws"],
218 multiple: false,
219 description:
220 "Allows to set custom web socket transport to communicate with dev server.",
221 path: "client.webSocketTransport",
222 },
223 {
224 type: "string",
225 multiple: false,
226 description:
227 "Allows to set custom web socket transport to communicate with dev server.",
228 path: "client.webSocketTransport",
229 },
230 ],
231 description:
232 "Allows to set custom web socket transport to communicate with dev server.",
233 simpleType: "string",
234 multiple: false,
235 },
236 "client-web-socket-url": {
237 configs: [
238 {
239 type: "string",
240 multiple: false,
241 description:
242 "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).",
243 path: "client.webSocketURL",
244 },
245 ],
246 description:
247 "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).",
248 simpleType: "string",
249 multiple: false,
250 },
251 "client-web-socket-url-hostname": {
252 configs: [
253 {
254 type: "string",
255 multiple: false,
256 description:
257 "Tells clients connected to devServer to use the provided hostname.",
258 path: "client.webSocketURL.hostname",
259 },
260 ],
261 description:
262 "Tells clients connected to devServer to use the provided hostname.",
263 simpleType: "string",
264 multiple: false,
265 },
266 "client-web-socket-url-password": {
267 configs: [
268 {
269 type: "string",
270 multiple: false,
271 description:
272 "Tells clients connected to devServer to use the provided password to authenticate.",
273 path: "client.webSocketURL.password",
274 },
275 ],
276 description:
277 "Tells clients connected to devServer to use the provided password to authenticate.",
278 simpleType: "string",
279 multiple: false,
280 },
281 "client-web-socket-url-pathname": {
282 configs: [
283 {
284 type: "string",
285 multiple: false,
286 description:
287 "Tells clients connected to devServer to use the provided path to connect.",
288 path: "client.webSocketURL.pathname",
289 },
290 ],
291 description:
292 "Tells clients connected to devServer to use the provided path to connect.",
293 simpleType: "string",
294 multiple: false,
295 },
296 "client-web-socket-url-port": {
297 configs: [
298 {
299 type: "number",
300 multiple: false,
301 description:
302 "Tells clients connected to devServer to use the provided port.",
303 path: "client.webSocketURL.port",
304 },
305 {
306 description:
307 "Tells clients connected to devServer to use the provided port.",
308 multiple: false,
309 path: "client.webSocketURL.port",
310 type: "string",
311 },
312 ],
313 description:
314 "Tells clients connected to devServer to use the provided port.",
315 simpleType: "string",
316 multiple: false,
317 },
318 "client-web-socket-url-protocol": {
319 configs: [
320 {
321 description:
322 "Tells clients connected to devServer to use the provided protocol.",
323 multiple: false,
324 path: "client.webSocketURL.protocol",
325 type: "enum",
326 values: ["auto"],
327 },
328 {
329 description:
330 "Tells clients connected to devServer to use the provided protocol.",
331 multiple: false,
332 path: "client.webSocketURL.protocol",
333 type: "string",
334 },
335 ],
336 description:
337 "Tells clients connected to devServer to use the provided protocol.",
338 multiple: false,
339 simpleType: "string",
340 },
341 "client-web-socket-url-username": {
342 configs: [
343 {
344 type: "string",
345 multiple: false,
346 description:
347 "Tells clients connected to devServer to use the provided username to authenticate.",
348 path: "client.webSocketURL.username",
349 },
350 ],
351 description:
352 "Tells clients connected to devServer to use the provided username to authenticate.",
353 simpleType: "string",
354 multiple: false,
355 },
356 compress: {
357 configs: [
358 {
359 type: "boolean",
360 multiple: false,
361 description: "Enables gzip compression for everything served.",
362 negatedDescription: "Disables gzip compression for everything served.",
363 path: "compress",
364 },
365 ],
366 description: "Enables gzip compression for everything served.",
367 simpleType: "boolean",
368 multiple: false,
369 },
370 "history-api-fallback": {
371 configs: [
372 {
373 type: "boolean",
374 multiple: false,
375 description:
376 "Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5 History API.",
377 negatedDescription:
378 "Disallows to proxy requests through a specified index page.",
379 path: "historyApiFallback",
380 },
381 ],
382 description:
383 "Allows to proxy requests through a specified index page (by default 'index.html'), useful for Single Page Applications that utilise the HTML5 History API.",
384 simpleType: "boolean",
385 multiple: false,
386 },
387 host: {
388 configs: [
389 {
390 description: "Allows to specify a hostname to use.",
391 multiple: false,
392 path: "host",
393 type: "enum",
394 values: ["local-ip", "local-ipv4", "local-ipv6"],
395 },
396 {
397 description: "Allows to specify a hostname to use.",
398 multiple: false,
399 path: "host",
400 type: "string",
401 },
402 ],
403 description: "Allows to specify a hostname to use.",
404 simpleType: "string",
405 multiple: false,
406 },
407 hot: {
408 configs: [
409 {
410 type: "boolean",
411 multiple: false,
412 description: "Enables Hot Module Replacement.",
413 negatedDescription: "Disables Hot Module Replacement.",
414 path: "hot",
415 },
416 {
417 type: "enum",
418 values: ["only"],
419 multiple: false,
420 description: "Enables Hot Module Replacement.",
421 path: "hot",
422 },
423 ],
424 description: "Enables Hot Module Replacement.",
425 simpleType: "string",
426 multiple: false,
427 },
428 http2: {
429 configs: [
430 {
431 type: "boolean",
432 multiple: false,
433 description:
434 "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
435 negatedDescription: "Does not serve over HTTP/2 using SPDY.",
436 path: "http2",
437 },
438 ],
439 description:
440 "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
441 simpleType: "boolean",
442 multiple: false,
443 },
444 https: {
445 configs: [
446 {
447 type: "boolean",
448 multiple: false,
449 description:
450 "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.",
451 negatedDescription:
452 "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP).",
453 path: "https",
454 },
455 ],
456 description:
457 "Allows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP). Deprecated, use the `server` option.",
458 simpleType: "boolean",
459 multiple: false,
460 },
461 "https-ca": {
462 configs: [
463 {
464 type: "string",
465 multiple: true,
466 description:
467 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
468 path: "https.ca[]",
469 },
470 ],
471 description:
472 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
473 simpleType: "string",
474 multiple: true,
475 },
476 "https-ca-reset": {
477 configs: [
478 {
479 description:
480 "Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
481 multiple: false,
482 path: "https.ca",
483 type: "reset",
484 },
485 ],
486 description:
487 "Clear all items provided in 'https.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
488 multiple: false,
489 simpleType: "boolean",
490 },
491 "https-cacert": {
492 configs: [
493 {
494 type: "string",
495 multiple: true,
496 description:
497 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
498 path: "https.cacert[]",
499 },
500 ],
501 description:
502 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
503 simpleType: "string",
504 multiple: true,
505 },
506 "https-cacert-reset": {
507 configs: [
508 {
509 description:
510 "Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
511 multiple: false,
512 path: "https.cacert",
513 type: "reset",
514 },
515 ],
516 description:
517 "Clear all items provided in 'https.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
518 multiple: false,
519 simpleType: "boolean",
520 },
521 "https-cert": {
522 configs: [
523 {
524 type: "string",
525 multiple: true,
526 description:
527 "Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.",
528 path: "https.cert[]",
529 },
530 ],
531 description:
532 "Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.",
533 simpleType: "string",
534 multiple: true,
535 },
536 "https-cert-reset": {
537 configs: [
538 {
539 description:
540 "Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.",
541 multiple: false,
542 path: "https.cert",
543 type: "reset",
544 },
545 ],
546 description:
547 "Clear all items provided in 'https.cert' configuration. Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option.",
548 multiple: false,
549 simpleType: "boolean",
550 },
551 "https-crl": {
552 configs: [
553 {
554 description:
555 "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.",
556 multiple: true,
557 path: "https.crl[]",
558 type: "string",
559 },
560 ],
561 description:
562 "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.",
563 multiple: true,
564 simpleType: "string",
565 },
566 "https-crl-reset": {
567 configs: [
568 {
569 description:
570 "Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.",
571 multiple: false,
572 path: "https.crl",
573 type: "reset",
574 },
575 ],
576 description:
577 "Clear all items provided in 'https.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists). Deprecated, use the `server.options.crl` option.",
578 multiple: false,
579 simpleType: "boolean",
580 },
581 "https-key": {
582 configs: [
583 {
584 type: "string",
585 multiple: true,
586 description:
587 "Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.",
588 path: "https.key[]",
589 },
590 ],
591 description:
592 "Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.",
593 simpleType: "string",
594 multiple: true,
595 },
596 "https-key-reset": {
597 configs: [
598 {
599 description:
600 "Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.",
601 multiple: false,
602 path: "https.key",
603 type: "reset",
604 },
605 ],
606 description:
607 "Clear all items provided in 'https.key' configuration. Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option.",
608 multiple: false,
609 simpleType: "boolean",
610 },
611 "https-passphrase": {
612 configs: [
613 {
614 type: "string",
615 multiple: false,
616 description:
617 "Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.",
618 path: "https.passphrase",
619 },
620 ],
621 description:
622 "Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option.",
623 simpleType: "string",
624 multiple: false,
625 },
626 "https-pfx": {
627 configs: [
628 {
629 type: "string",
630 multiple: true,
631 description:
632 "Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.",
633 path: "https.pfx[]",
634 },
635 ],
636 description:
637 "Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.",
638 simpleType: "string",
639 multiple: true,
640 },
641 "https-pfx-reset": {
642 configs: [
643 {
644 description:
645 "Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.",
646 multiple: false,
647 path: "https.pfx",
648 type: "reset",
649 },
650 ],
651 description:
652 "Clear all items provided in 'https.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option.",
653 multiple: false,
654 simpleType: "boolean",
655 },
656 "https-request-cert": {
657 configs: [
658 {
659 type: "boolean",
660 multiple: false,
661 description:
662 "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
663 negatedDescription: "Does not request for an SSL certificate.",
664 path: "https.requestCert",
665 },
666 ],
667 description:
668 "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
669 simpleType: "boolean",
670 multiple: false,
671 },
672 ipc: {
673 configs: [
674 {
675 type: "string",
676 multiple: false,
677 description: "Listen to a unix socket.",
678 path: "ipc",
679 },
680 {
681 type: "enum",
682 values: [true],
683 multiple: false,
684 description: "Listen to a unix socket.",
685 path: "ipc",
686 },
687 ],
688 description: "Listen to a unix socket.",
689 simpleType: "string",
690 multiple: false,
691 },
692 "live-reload": {
693 configs: [
694 {
695 type: "boolean",
696 multiple: false,
697 description:
698 "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
699 negatedDescription:
700 "Disables reload/refresh the page(s) when file changes are detected (enabled by default).",
701 path: "liveReload",
702 },
703 ],
704 description:
705 "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
706 simpleType: "boolean",
707 multiple: false,
708 },
709 "magic-html": {
710 configs: [
711 {
712 type: "boolean",
713 multiple: false,
714 description:
715 "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
716 negatedDescription:
717 "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
718 path: "magicHtml",
719 },
720 ],
721 description:
722 "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
723 simpleType: "boolean",
724 multiple: false,
725 },
726 open: {
727 configs: [
728 {
729 type: "string",
730 multiple: true,
731 description:
732 "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).",
733 path: "open[]",
734 },
735 {
736 type: "boolean",
737 multiple: false,
738 description:
739 "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).",
740 negatedDescription: "Does not open the default browser.",
741 path: "open",
742 },
743 ],
744 description:
745 "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).",
746 simpleType: "string",
747 multiple: true,
748 },
749 "open-app": {
750 configs: [
751 {
752 type: "string",
753 multiple: true,
754 description:
755 "Open specified browser. Deprecated: please use '--open-app-name'.",
756 path: "open[].app",
757 },
758 ],
759 description:
760 "Open specified browser. Deprecated: please use '--open-app-name'.",
761 simpleType: "string",
762 multiple: true,
763 },
764 "open-app-name": {
765 configs: [
766 {
767 type: "string",
768 multiple: true,
769 description: "Open specified browser.",
770 path: "open[].app.name",
771 },
772 {
773 type: "string",
774 multiple: true,
775 description: "Open specified browser.",
776 path: "open.app.name[]",
777 },
778 ],
779 description: "Open specified browser.",
780 simpleType: "string",
781 multiple: true,
782 },
783 "open-app-name-reset": {
784 configs: [
785 {
786 type: "reset",
787 multiple: false,
788 description:
789 "Clear all items provided in 'open.app.name' configuration. Open specified browser.",
790 path: "open.app.name",
791 },
792 ],
793 description:
794 "Clear all items provided in 'open.app.name' configuration. Open specified browser.",
795 simpleType: "boolean",
796 multiple: false,
797 },
798 "open-reset": {
799 configs: [
800 {
801 type: "reset",
802 multiple: false,
803 description:
804 "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).",
805 path: "open",
806 },
807 ],
808 description:
809 "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).",
810 simpleType: "boolean",
811 multiple: false,
812 },
813 "open-target": {
814 configs: [
815 {
816 type: "string",
817 multiple: true,
818 description: "Opens specified page in browser.",
819 path: "open[].target",
820 },
821 {
822 type: "string",
823 multiple: true,
824 description: "Opens specified page in browser.",
825 path: "open.target[]",
826 },
827 ],
828 description: "Opens specified page in browser.",
829 simpleType: "string",
830 multiple: true,
831 },
832 "open-target-reset": {
833 configs: [
834 {
835 type: "reset",
836 multiple: false,
837 description:
838 "Clear all items provided in 'open.target' configuration. Opens specified page in browser.",
839 path: "open.target",
840 },
841 ],
842 description:
843 "Clear all items provided in 'open.target' configuration. Opens specified page in browser.",
844 simpleType: "boolean",
845 multiple: false,
846 },
847 port: {
848 configs: [
849 {
850 type: "number",
851 multiple: false,
852 description: "Allows to specify a port to use.",
853 path: "port",
854 },
855 {
856 type: "string",
857 multiple: false,
858 description: "Allows to specify a port to use.",
859 path: "port",
860 },
861 {
862 type: "enum",
863 values: ["auto"],
864 multiple: false,
865 description: "Allows to specify a port to use.",
866 path: "port",
867 },
868 ],
869 description: "Allows to specify a port to use.",
870 simpleType: "string",
871 multiple: false,
872 },
873 "server-options-ca": {
874 configs: [
875 {
876 description:
877 "Path to an SSL CA certificate or content of an SSL CA certificate.",
878 multiple: true,
879 path: "server.options.ca[]",
880 type: "string",
881 },
882 ],
883 description:
884 "Path to an SSL CA certificate or content of an SSL CA certificate.",
885 multiple: true,
886 simpleType: "string",
887 },
888 "server-options-ca-reset": {
889 configs: [
890 {
891 description:
892 "Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate.",
893 multiple: false,
894 path: "server.options.ca",
895 type: "reset",
896 },
897 ],
898 description:
899 "Clear all items provided in 'server.options.ca' configuration. Path to an SSL CA certificate or content of an SSL CA certificate.",
900 multiple: false,
901 simpleType: "boolean",
902 },
903 "server-options-cacert": {
904 configs: [
905 {
906 description:
907 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
908 multiple: true,
909 path: "server.options.cacert[]",
910 type: "string",
911 },
912 ],
913 description:
914 "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
915 multiple: true,
916 simpleType: "string",
917 },
918 "server-options-cacert-reset": {
919 configs: [
920 {
921 description:
922 "Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
923 multiple: false,
924 path: "server.options.cacert",
925 type: "reset",
926 },
927 ],
928 description:
929 "Clear all items provided in 'server.options.cacert' configuration. Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option.",
930 multiple: false,
931 simpleType: "boolean",
932 },
933 "server-options-cert": {
934 configs: [
935 {
936 description:
937 "Path to an SSL certificate or content of an SSL certificate.",
938 multiple: true,
939 path: "server.options.cert[]",
940 type: "string",
941 },
942 ],
943 description: "Path to an SSL certificate or content of an SSL certificate.",
944 multiple: true,
945 simpleType: "string",
946 },
947 "server-options-cert-reset": {
948 configs: [
949 {
950 description:
951 "Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content of an SSL certificate.",
952 multiple: false,
953 path: "server.options.cert",
954 type: "reset",
955 },
956 ],
957 description:
958 "Clear all items provided in 'server.options.cert' configuration. Path to an SSL certificate or content of an SSL certificate.",
959 multiple: false,
960 simpleType: "boolean",
961 },
962 "server-options-crl": {
963 configs: [
964 {
965 description:
966 "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).",
967 multiple: true,
968 path: "server.options.crl[]",
969 type: "string",
970 },
971 ],
972 description:
973 "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).",
974 multiple: true,
975 simpleType: "string",
976 },
977 "server-options-crl-reset": {
978 configs: [
979 {
980 description:
981 "Clear all items provided in 'server.options.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).",
982 multiple: false,
983 path: "server.options.crl",
984 type: "reset",
985 },
986 ],
987 description:
988 "Clear all items provided in 'server.options.crl' configuration. Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists).",
989 multiple: false,
990 simpleType: "boolean",
991 },
992 "server-options-key": {
993 configs: [
994 {
995 description: "Path to an SSL key or content of an SSL key.",
996 multiple: true,
997 path: "server.options.key[]",
998 type: "string",
999 },
1000 ],
1001 description: "Path to an SSL key or content of an SSL key.",
1002 multiple: true,
1003 simpleType: "string",
1004 },
1005 "server-options-key-reset": {
1006 configs: [
1007 {
1008 description:
1009 "Clear all items provided in 'server.options.key' configuration. Path to an SSL key or content of an SSL key.",
1010 multiple: false,
1011 path: "server.options.key",
1012 type: "reset",
1013 },
1014 ],
1015 description:
1016 "Clear all items provided in 'server.options.key' configuration. Path to an SSL key or content of an SSL key.",
1017 multiple: false,
1018 simpleType: "boolean",
1019 },
1020 "server-options-passphrase": {
1021 configs: [
1022 {
1023 description: "Passphrase for a pfx file.",
1024 multiple: false,
1025 path: "server.options.passphrase",
1026 type: "string",
1027 },
1028 ],
1029 description: "Passphrase for a pfx file.",
1030 multiple: false,
1031 simpleType: "string",
1032 },
1033 "server-options-pfx": {
1034 configs: [
1035 {
1036 description: "Path to an SSL pfx file or content of an SSL pfx file.",
1037 multiple: true,
1038 path: "server.options.pfx[]",
1039 type: "string",
1040 },
1041 ],
1042 description: "Path to an SSL pfx file or content of an SSL pfx file.",
1043 multiple: true,
1044 simpleType: "string",
1045 },
1046 "server-options-pfx-reset": {
1047 configs: [
1048 {
1049 description:
1050 "Clear all items provided in 'server.options.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file.",
1051 multiple: false,
1052 path: "server.options.pfx",
1053 type: "reset",
1054 },
1055 ],
1056 description:
1057 "Clear all items provided in 'server.options.pfx' configuration. Path to an SSL pfx file or content of an SSL pfx file.",
1058 multiple: false,
1059 simpleType: "boolean",
1060 },
1061 "server-options-request-cert": {
1062 configs: [
1063 {
1064 description: "Request for an SSL certificate.",
1065 negatedDescription: "Does not request for an SSL certificate.",
1066 multiple: false,
1067 path: "server.options.requestCert",
1068 type: "boolean",
1069 },
1070 ],
1071 description: "Request for an SSL certificate.",
1072 multiple: false,
1073 simpleType: "boolean",
1074 },
1075 "server-type": {
1076 configs: [
1077 {
1078 description: "Allows to set server and options (by default 'http').",
1079 multiple: false,
1080 path: "server.type",
1081 type: "enum",
1082 values: ["http", "https", "spdy"],
1083 },
1084 ],
1085 description: "Allows to set server and options (by default 'http').",
1086 multiple: false,
1087 simpleType: "string",
1088 },
1089 static: {
1090 configs: [
1091 {
1092 type: "string",
1093 multiple: true,
1094 description:
1095 "Allows to configure options for serving static files from directory (by default 'public' directory).",
1096 path: "static[]",
1097 },
1098 {
1099 type: "boolean",
1100 multiple: false,
1101 description:
1102 "Allows to configure options for serving static files from directory (by default 'public' directory).",
1103 negatedDescription:
1104 "Disallows to configure options for serving static files from directory.",
1105 path: "static",
1106 },
1107 ],
1108 description:
1109 "Allows to configure options for serving static files from directory (by default 'public' directory).",
1110 simpleType: "string",
1111 multiple: true,
1112 },
1113 "static-directory": {
1114 configs: [
1115 {
1116 type: "string",
1117 multiple: true,
1118 description: "Directory for static contents.",
1119 path: "static[].directory",
1120 },
1121 ],
1122 description: "Directory for static contents.",
1123 simpleType: "string",
1124 multiple: true,
1125 },
1126 "static-public-path": {
1127 configs: [
1128 {
1129 type: "string",
1130 multiple: true,
1131 description:
1132 "The static files will be available in the browser under this public path.",
1133 path: "static[].publicPath",
1134 },
1135 {
1136 type: "string",
1137 multiple: true,
1138 description:
1139 "The static files will be available in the browser under this public path.",
1140 path: "static.publicPath[]",
1141 },
1142 ],
1143 description:
1144 "The static files will be available in the browser under this public path.",
1145 simpleType: "string",
1146 multiple: true,
1147 },
1148 "static-public-path-reset": {
1149 configs: [
1150 {
1151 type: "reset",
1152 multiple: false,
1153 description:
1154 "Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.",
1155 path: "static.publicPath",
1156 },
1157 ],
1158 description:
1159 "Clear all items provided in 'static.publicPath' configuration. The static files will be available in the browser under this public path.",
1160 simpleType: "boolean",
1161 multiple: false,
1162 },
1163 "static-reset": {
1164 configs: [
1165 {
1166 type: "reset",
1167 multiple: false,
1168 description:
1169 "Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public' directory).",
1170 path: "static",
1171 },
1172 ],
1173 description:
1174 "Clear all items provided in 'static' configuration. Allows to configure options for serving static files from directory (by default 'public' directory).",
1175 simpleType: "boolean",
1176 multiple: false,
1177 },
1178 "static-serve-index": {
1179 configs: [
1180 {
1181 type: "boolean",
1182 multiple: true,
1183 description:
1184 "Tells dev server to use serveIndex middleware when enabled.",
1185 negatedDescription:
1186 "Does not tell dev server to use serveIndex middleware.",
1187 path: "static[].serveIndex",
1188 },
1189 ],
1190 description: "Tells dev server to use serveIndex middleware when enabled.",
1191 simpleType: "boolean",
1192 multiple: true,
1193 },
1194 "static-watch": {
1195 configs: [
1196 {
1197 type: "boolean",
1198 multiple: true,
1199 description: "Watches for files in static content directory.",
1200 negatedDescription:
1201 "Does not watch for files in static content directory.",
1202 path: "static[].watch",
1203 },
1204 ],
1205 description: "Watches for files in static content directory.",
1206 simpleType: "boolean",
1207 multiple: true,
1208 },
1209 "watch-files": {
1210 configs: [
1211 {
1212 type: "string",
1213 multiple: true,
1214 description:
1215 "Allows to configure list of globs/directories/files to watch for file changes.",
1216 path: "watchFiles[]",
1217 },
1218 ],
1219 description:
1220 "Allows to configure list of globs/directories/files to watch for file changes.",
1221 simpleType: "string",
1222 multiple: true,
1223 },
1224 "watch-files-reset": {
1225 configs: [
1226 {
1227 type: "reset",
1228 multiple: false,
1229 description:
1230 "Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.",
1231 path: "watchFiles",
1232 },
1233 ],
1234 description:
1235 "Clear all items provided in 'watchFiles' configuration. Allows to configure list of globs/directories/files to watch for file changes.",
1236 simpleType: "boolean",
1237 multiple: false,
1238 },
1239 "web-socket-server": {
1240 configs: [
1241 {
1242 description:
1243 "Deprecated: please use '--web-socket-server-type' option.",
1244 negatedDescription: "Disallows to set web socket server and options.",
1245 multiple: false,
1246 path: "webSocketServer",
1247 type: "enum",
1248 values: [false],
1249 },
1250 {
1251 description:
1252 "Deprecated: please use '--web-socket-server-type' option.",
1253 multiple: false,
1254 path: "webSocketServer",
1255 type: "enum",
1256 values: ["sockjs", "ws"],
1257 },
1258 {
1259 description:
1260 "Allows to set web socket server and options (by default 'ws').",
1261 multiple: false,
1262 path: "webSocketServer",
1263 type: "string",
1264 },
1265 ],
1266 description:
1267 "Deprecated: please use '--web-socket-server-type' option. Allows to set web socket server and options (by default 'ws').",
1268 simpleType: "string",
1269 multiple: false,
1270 },
1271 "web-socket-server-type": {
1272 configs: [
1273 {
1274 description:
1275 "Allows to set web socket server and options (by default 'ws').",
1276 multiple: false,
1277 path: "webSocketServer.type",
1278 type: "enum",
1279 values: ["sockjs", "ws"],
1280 },
1281 {
1282 description:
1283 "Allows to set web socket server and options (by default 'ws').",
1284 multiple: false,
1285 path: "webSocketServer.type",
1286 type: "string",
1287 },
1288 ],
1289 description:
1290 "Allows to set web socket server and options (by default 'ws').",
1291 simpleType: "string",
1292 multiple: false,
1293 },
1294};