options.json 36 KB

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