optionsSchema.json 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  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. "logLevel": {
  70. "description": "Log level in the terminal/console (trace, debug, info, warn, error or silent)",
  71. "enum": [
  72. "trace",
  73. "debug",
  74. "info",
  75. "warn",
  76. "error",
  77. "silent"
  78. ]
  79. },
  80. "clientLogLevel": {
  81. "description": "Controls the log messages shown in the browser.",
  82. "enum": [
  83. "none",
  84. "info",
  85. "warning",
  86. "error"
  87. ]
  88. },
  89. "overlay": {
  90. "description": "Shows an error overlay in browser.",
  91. "anyOf": [
  92. {
  93. "type": "boolean"
  94. },
  95. {
  96. "type": "object",
  97. "properties": {
  98. "errors": {
  99. "type": "boolean"
  100. },
  101. "warnings": {
  102. "type": "boolean"
  103. }
  104. }
  105. }
  106. ]
  107. },
  108. "progress": {
  109. "description": "Shows compilation progress in browser console.",
  110. "type": "boolean"
  111. },
  112. "key": {
  113. "description": "The contents of a SSL key.",
  114. "anyOf": [
  115. {
  116. "type": "string"
  117. },
  118. {
  119. "instanceof": "Buffer"
  120. }
  121. ]
  122. },
  123. "cert": {
  124. "description": "The contents of a SSL certificate.",
  125. "anyOf": [
  126. {
  127. "type": "string"
  128. },
  129. {
  130. "instanceof": "Buffer"
  131. }
  132. ]
  133. },
  134. "ca": {
  135. "description": "The contents of a SSL CA certificate.",
  136. "anyOf": [
  137. {
  138. "type": "string"
  139. },
  140. {
  141. "instanceof": "Buffer"
  142. }
  143. ]
  144. },
  145. "pfx": {
  146. "description": "The contents of a SSL pfx file.",
  147. "anyOf": [
  148. {
  149. "type": "string"
  150. },
  151. {
  152. "instanceof": "Buffer"
  153. }
  154. ]
  155. },
  156. "pfxPassphrase": {
  157. "description": "The passphrase to a (SSL) PFX file.",
  158. "type": "string"
  159. },
  160. "requestCert": {
  161. "description": "Enables request for client certificate. This is passed directly to the https server.",
  162. "type": "boolean"
  163. },
  164. "inline": {
  165. "description": "Enable inline mode to include client scripts in bundle (CLI-only).",
  166. "type": "boolean"
  167. },
  168. "disableHostCheck": {
  169. "description": "Disable the Host header check (Security).",
  170. "type": "boolean"
  171. },
  172. "public": {
  173. "description": "The public hostname/ip address of the server.",
  174. "type": "string"
  175. },
  176. "https": {
  177. "description": "Enable HTTPS for server.",
  178. "anyOf": [
  179. {
  180. "type": "object"
  181. },
  182. {
  183. "type": "boolean"
  184. }
  185. ]
  186. },
  187. "contentBase": {
  188. "description": "A directory to serve files non-webpack files from.",
  189. "anyOf": [
  190. {
  191. "items": {
  192. "type": "string"
  193. },
  194. "minItems": 1,
  195. "type": "array"
  196. },
  197. {
  198. "enum": [
  199. false
  200. ]
  201. },
  202. {
  203. "type": "number"
  204. },
  205. {
  206. "type": "string"
  207. }
  208. ]
  209. },
  210. "watchContentBase": {
  211. "description": "Watches the contentBase directory for changes.",
  212. "type": "boolean"
  213. },
  214. "open": {
  215. "description": "Let the CLI open your browser with the URL.",
  216. "anyOf": [
  217. {
  218. "type": "string"
  219. },
  220. {
  221. "type": "boolean"
  222. }
  223. ]
  224. },
  225. "useLocalIp": {
  226. "description": "Let the browser open with your local IP.",
  227. "type": "boolean"
  228. },
  229. "openPage": {
  230. "description": "Let the CLI open your browser to a specific page on the site.",
  231. "type": "string"
  232. },
  233. "features": {
  234. "description": "The order of which the features will be triggered.",
  235. "items": {
  236. "type": "string"
  237. },
  238. "type": "array"
  239. },
  240. "compress": {
  241. "description": "Gzip compression for all requests.",
  242. "type": "boolean"
  243. },
  244. "proxy": {
  245. "description": "Proxy requests to another server.",
  246. "anyOf": [
  247. {
  248. "items": {
  249. "anyOf": [
  250. {
  251. "type": "object"
  252. },
  253. {
  254. "instanceof": "Function"
  255. }
  256. ]
  257. },
  258. "minItems": 1,
  259. "type": "array"
  260. },
  261. {
  262. "type": "object"
  263. }
  264. ]
  265. },
  266. "historyApiFallback": {
  267. "description": "404 fallback to a specified file.",
  268. "anyOf": [
  269. {
  270. "type": "boolean"
  271. },
  272. {
  273. "type": "object"
  274. }
  275. ]
  276. },
  277. "staticOptions": {
  278. "description": "Options for static files served with contentBase.",
  279. "type": "object"
  280. },
  281. "setup": {
  282. "description": "Exposes the Express server to add custom middleware or routes.",
  283. "instanceof": "Function"
  284. },
  285. "before": {
  286. "description": "Exposes the Express server to add custom middleware or routes before webpack-dev-middleware will be added.",
  287. "instanceof": "Function"
  288. },
  289. "after": {
  290. "description": "Exposes the Express server to add custom middleware or routes after webpack-dev-middleware got added.",
  291. "instanceof": "Function"
  292. },
  293. "stats": {
  294. "description": "Decides what bundle information is displayed.",
  295. "anyOf": [
  296. {
  297. "type": "object"
  298. },
  299. {
  300. "type": "boolean"
  301. },
  302. {
  303. "enum": [
  304. "none",
  305. "errors-only",
  306. "minimal",
  307. "normal",
  308. "verbose"
  309. ]
  310. }
  311. ]
  312. },
  313. "reporter": {
  314. "description": "Customize what the console displays when compiling.",
  315. "instanceof": "Function"
  316. },
  317. "logTime": {
  318. "description": "Report time before and after compiling in console displays.",
  319. "type": "boolean"
  320. },
  321. "noInfo": {
  322. "description": "Hide all info messages on console.",
  323. "type": "boolean"
  324. },
  325. "quiet": {
  326. "description": "Hide all messages on console.",
  327. "type": "boolean"
  328. },
  329. "serverSideRender": {
  330. "description": "Expose stats for server side rendering (experimental).",
  331. "type": "boolean"
  332. },
  333. "index": {
  334. "description": "The filename that is considered the index file.",
  335. "type": "string"
  336. },
  337. "log": {
  338. "description": "Customize info logs for webpack-dev-middleware.",
  339. "instanceof": "Function"
  340. },
  341. "warn": {
  342. "description": "Customize warn logs for webpack-dev-middleware.",
  343. "instanceof": "Function"
  344. }
  345. },
  346. "type": "object"
  347. }