options.json 36 KB

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