UNPKG

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