optionsSchema.json 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. {
  2. "additionalProperties": false,
  3. "properties": {
  4. "hot": {
  5. "description": "Enables Hot Module Replacement.",
  6. "type": "boolean"
  7. },
  8. "hotOnly": {
  9. "description": "Enables Hot Module Replacement without page refresh as fallback.",
  10. "type": "boolean"
  11. },
  12. "lazy": {
  13. "description": "Disables watch mode and recompiles bundle only on a request.",
  14. "type": "boolean"
  15. },
  16. "bonjour": {
  17. "description": "Publishes the ZeroConf DNS service",
  18. "type": "boolean"
  19. },
  20. "host": {
  21. "description": "The host the server listens to.",
  22. "type": "string"
  23. },
  24. "allowedHosts": {
  25. "description": "Specifies which hosts are allowed to access the dev server.",
  26. "items": {
  27. "type": "string"
  28. },
  29. "type": "array"
  30. },
  31. "filename": {
  32. "description": "The filename that needs to be requested in order to trigger a recompile (only in lazy mode).",
  33. "anyOf": [
  34. {
  35. "instanceof": "RegExp"
  36. },
  37. {
  38. "type": "string"
  39. }
  40. ]
  41. },
  42. "publicPath": {
  43. "description": "URL path where the webpack files are served from.",
  44. "type": "string"
  45. },
  46. "port": {
  47. "description": "The port the server listens to.",
  48. "anyOf": [
  49. {
  50. "type": "number"
  51. },
  52. {
  53. "type": "string"
  54. }
  55. ]
  56. },
  57. "socket": {
  58. "description": "The Unix socket to listen to (instead of on a host).",
  59. "type": "string"
  60. },
  61. "watchOptions": {
  62. "description": "Options for changing the watch behavior.",
  63. "type": "object"
  64. },
  65. "headers": {
  66. "description": "Response headers that are added to each response.",
  67. "type": "object"
  68. },
  69. "clientLogLevel": {
  70. "description": "Controls the log messages shown in the browser.",
  71. "enum": [
  72. "none",
  73. "info",
  74. "warning",
  75. "error"
  76. ]
  77. },
  78. "overlay": {
  79. "description": "Shows an error overlay in browser.",
  80. "anyOf": [
  81. {
  82. "type": "boolean"
  83. },
  84. {
  85. "type": "object",
  86. "properties": {
  87. "errors": {
  88. "type": "boolean"
  89. },
  90. "warnings": {
  91. "type": "boolean"
  92. }
  93. }
  94. }
  95. ]
  96. },
  97. "progress": {
  98. "description": "Shows compilation progress in browser console.",
  99. "type": "boolean"
  100. },
  101. "key": {
  102. "description": "The contents of a SSL key.",
  103. "anyOf": [
  104. {
  105. "type": "string"
  106. },
  107. {
  108. "instanceof": "Buffer"
  109. }
  110. ]
  111. },
  112. "cert": {
  113. "description": "The contents of a SSL certificate.",
  114. "anyOf": [
  115. {
  116. "type": "string"
  117. },
  118. {
  119. "instanceof": "Buffer"
  120. }
  121. ]
  122. },
  123. "ca": {
  124. "description": "The contents of a SSL CA certificate.",
  125. "anyOf": [
  126. {
  127. "type": "string"
  128. },
  129. {
  130. "instanceof": "Buffer"
  131. }
  132. ]
  133. },
  134. "pfx": {
  135. "description": "The contents of a SSL pfx file.",
  136. "anyOf": [
  137. {
  138. "type": "string"
  139. },
  140. {
  141. "instanceof": "Buffer"
  142. }
  143. ]
  144. },
  145. "pfxPassphrase": {
  146. "description": "The passphrase to a (SSL) PFX file.",
  147. "type": "string"
  148. },
  149. "requestCert": {
  150. "description": "Enables request for client certificate. This is passed directly to the https server.",
  151. "type": "boolean"
  152. },
  153. "inline": {
  154. "description": "Enable inline mode to include client scripts in bundle (CLI-only).",
  155. "type": "boolean"
  156. },
  157. "disableHostCheck": {
  158. "description": "Disable the Host header check (Security).",
  159. "type": "boolean"
  160. },
  161. "public": {
  162. "description": "The public hostname/ip address of the server.",
  163. "type": "string"
  164. },
  165. "https": {
  166. "description": "Enable HTTPS for server.",
  167. "anyOf": [
  168. {
  169. "type": "object"
  170. },
  171. {
  172. "type": "boolean"
  173. }
  174. ]
  175. },
  176. "contentBase": {
  177. "description": "A directory to serve files non-webpack files from.",
  178. "anyOf": [
  179. {
  180. "items": {
  181. "type": "string"
  182. },
  183. "minItems": 1,
  184. "type": "array"
  185. },
  186. {
  187. "enum": [
  188. false
  189. ]
  190. },
  191. {
  192. "type": "number"
  193. },
  194. {
  195. "type": "string"
  196. }
  197. ]
  198. },
  199. "watchContentBase": {
  200. "description": "Watches the contentBase directory for changes.",
  201. "type": "boolean"
  202. },
  203. "open": {
  204. "description": "Let the CLI open your browser with the URL.",
  205. "anyOf": [
  206. {
  207. "type": "string"
  208. },
  209. {
  210. "type": "boolean"
  211. }
  212. ]
  213. },
  214. "useLocalIp": {
  215. "description": "Let the browser open with your local IP.",
  216. "type": "boolean"
  217. },
  218. "openPage": {
  219. "description": "Let the CLI open your browser to a specific page on the site.",
  220. "type": "string"
  221. },
  222. "features": {
  223. "description": "The order of which the features will be triggered.",
  224. "items": {
  225. "type": "string"
  226. },
  227. "type": "array"
  228. },
  229. "compress": {
  230. "description": "Gzip compression for all requests.",
  231. "type": "boolean"
  232. },
  233. "proxy": {
  234. "description": "Proxy requests to another server.",
  235. "anyOf": [
  236. {
  237. "items": {
  238. "anyOf": [
  239. {
  240. "type": "object"
  241. },
  242. {
  243. "instanceof": "Function"
  244. }
  245. ]
  246. },
  247. "minItems": 1,
  248. "type": "array"
  249. },
  250. {
  251. "type": "object"
  252. }
  253. ]
  254. },
  255. "historyApiFallback": {
  256. "description": "404 fallback to a specified file.",
  257. "anyOf": [
  258. {
  259. "type": "boolean"
  260. },
  261. {
  262. "type": "object"
  263. }
  264. ]
  265. },
  266. "staticOptions": {
  267. "description": "Options for static files served with contentBase.",
  268. "type": "object"
  269. },
  270. "setup": {
  271. "description": "Exposes the Express server to add custom middleware or routes.",
  272. "instanceof": "Function"
  273. },
  274. "before": {
  275. "description": "Exposes the Express server to add custom middleware or routes before webpack-dev-middleware will be added.",
  276. "instanceof": "Function"
  277. },
  278. "after": {
  279. "description": "Exposes the Express server to add custom middleware or routes after webpack-dev-middleware got added.",
  280. "instanceof": "Function"
  281. },
  282. "stats": {
  283. "description": "Decides what bundle information is displayed.",
  284. "anyOf": [
  285. {
  286. "type": "object"
  287. },
  288. {
  289. "type": "boolean"
  290. },
  291. {
  292. "enum": [
  293. "none",
  294. "errors-only",
  295. "minimal",
  296. "normal",
  297. "verbose"
  298. ]
  299. }
  300. ]
  301. },
  302. "reporter": {
  303. "description": "Customize what the console displays when compiling.",
  304. "instanceof": "Function"
  305. },
  306. "reportTime": {
  307. "description": "Report time before and after compiling in console displays.",
  308. "type": "boolean"
  309. },
  310. "noInfo": {
  311. "description": "Hide all info messages on console.",
  312. "type": "boolean"
  313. },
  314. "quiet": {
  315. "description": "Hide all messages on console.",
  316. "type": "boolean"
  317. },
  318. "serverSideRender": {
  319. "description": "Expose stats for server side rendering (experimental).",
  320. "type": "boolean"
  321. },
  322. "index": {
  323. "description": "The filename that is considered the index file.",
  324. "type": "string"
  325. },
  326. "log": {
  327. "description": "Customize info logs for webpack-dev-middleware.",
  328. "instanceof": "Function"
  329. },
  330. "warn": {
  331. "description": "Customize warn logs for webpack-dev-middleware.",
  332. "instanceof": "Function"
  333. }
  334. },
  335. "type": "object"
  336. }