123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266 |
- {
- "title": "Dev Server options",
- "type": "object",
- "definitions": {
- "AllowedHosts": {
- "anyOf": [
- {
- "type": "array",
- "minItems": 1,
- "items": {
- "$ref": "#/definitions/AllowedHostsItem"
- }
- },
- {
- "enum": ["auto", "all"]
- },
- {
- "$ref": "#/definitions/AllowedHostsItem"
- }
- ],
- "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').",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverallowedhosts"
- },
- "AllowedHostsItem": {
- "type": "string",
- "minLength": 1
- },
- "Bonjour": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disallows to broadcasts dev server via ZeroConf networking on start."
- }
- },
- {
- "type": "object",
- "description": "Options for bonjour.",
- "link": "https://github.com/watson/bonjour#initializing"
- }
- ],
- "description": "Allows to broadcasts dev server via ZeroConf networking on start.",
- "link": " https://webpack.js.org/configuration/dev-server/#devserverbonjour"
- },
- "Client": {
- "description": "Allows to specify options for client script in the browser or disable client script.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverclient",
- "anyOf": [
- {
- "enum": [false],
- "cli": {
- "negatedDescription": "Disables client script."
- }
- },
- {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "logging": {
- "$ref": "#/definitions/ClientLogging"
- },
- "overlay": {
- "$ref": "#/definitions/ClientOverlay"
- },
- "progress": {
- "$ref": "#/definitions/ClientProgress"
- },
- "reconnect": {
- "$ref": "#/definitions/ClientReconnect"
- },
- "webSocketTransport": {
- "$ref": "#/definitions/ClientWebSocketTransport"
- },
- "webSocketURL": {
- "$ref": "#/definitions/ClientWebSocketURL"
- }
- }
- }
- ]
- },
- "ClientLogging": {
- "enum": ["none", "error", "warn", "info", "log", "verbose"],
- "description": "Allows to set log level in the browser.",
- "link": "https://webpack.js.org/configuration/dev-server/#logging"
- },
- "ClientOverlay": {
- "anyOf": [
- {
- "description": "Enables a full-screen overlay in the browser when there are compiler errors or warnings.",
- "link": "https://webpack.js.org/configuration/dev-server/#overlay",
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disables the full-screen overlay in the browser when there are compiler errors or warnings."
- }
- },
- {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "errors": {
- "anyOf": [
- {
- "description": "Enables a full-screen overlay in the browser when there are compiler errors.",
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disables the full-screen overlay in the browser when there are compiler errors."
- }
- },
- {
- "instanceof": "Function",
- "description": "Filter compiler errors. Return true to include and return false to exclude."
- }
- ]
- },
- "warnings": {
- "anyOf": [
- {
- "description": "Enables a full-screen overlay in the browser when there are compiler warnings.",
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disables the full-screen overlay in the browser when there are compiler warnings."
- }
- },
- {
- "instanceof": "Function",
- "description": "Filter compiler warnings. Return true to include and return false to exclude."
- }
- ]
- },
- "runtimeErrors": {
- "anyOf": [
- {
- "description": "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disables the full-screen overlay in the browser when there are uncaught runtime errors."
- }
- },
- {
- "instanceof": "Function",
- "description": "Filter uncaught runtime errors. Return true to include and return false to exclude."
- }
- ]
- },
- "trustedTypesPolicyName": {
- "description": "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",
- "type": "string"
- }
- }
- }
- ]
- },
- "ClientProgress": {
- "description": "Prints compilation progress in percentage in the browser.",
- "link": "https://webpack.js.org/configuration/dev-server/#progress",
- "type": "boolean",
- "cli": {
- "negatedDescription": "Does not print compilation progress in percentage in the browser."
- }
- },
- "ClientReconnect": {
- "description": "Tells dev-server the number of times it should try to reconnect the client.",
- "link": "https://webpack.js.org/configuration/dev-server/#reconnect",
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Tells dev-server to not to try to reconnect the client."
- }
- },
- {
- "type": "number",
- "minimum": 0
- }
- ]
- },
- "ClientWebSocketTransport": {
- "anyOf": [
- {
- "$ref": "#/definitions/ClientWebSocketTransportEnum"
- },
- {
- "$ref": "#/definitions/ClientWebSocketTransportString"
- }
- ],
- "description": "Allows to set custom web socket transport to communicate with dev server.",
- "link": "https://webpack.js.org/configuration/dev-server/#websockettransport"
- },
- "ClientWebSocketTransportEnum": {
- "enum": ["sockjs", "ws"]
- },
- "ClientWebSocketTransportString": {
- "type": "string",
- "minLength": 1
- },
- "ClientWebSocketURL": {
- "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).",
- "link": "https://webpack.js.org/configuration/dev-server/#websocketurl",
- "anyOf": [
- {
- "type": "string",
- "minLength": 1
- },
- {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "hostname": {
- "description": "Tells clients connected to devServer to use the provided hostname.",
- "type": "string",
- "minLength": 1
- },
- "pathname": {
- "description": "Tells clients connected to devServer to use the provided path to connect.",
- "type": "string"
- },
- "password": {
- "description": "Tells clients connected to devServer to use the provided password to authenticate.",
- "type": "string"
- },
- "port": {
- "description": "Tells clients connected to devServer to use the provided port.",
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "string",
- "minLength": 1
- }
- ]
- },
- "protocol": {
- "description": "Tells clients connected to devServer to use the provided protocol.",
- "anyOf": [
- {
- "enum": ["auto"]
- },
- {
- "type": "string",
- "minLength": 1
- }
- ]
- },
- "username": {
- "description": "Tells clients connected to devServer to use the provided username to authenticate.",
- "type": "string"
- }
- }
- }
- ]
- },
- "Compress": {
- "type": "boolean",
- "description": "Enables gzip compression for everything served.",
- "link": "https://webpack.js.org/configuration/dev-server/#devservercompress",
- "cli": {
- "negatedDescription": "Disables gzip compression for everything served."
- }
- },
- "DevMiddleware": {
- "description": "Provide options to 'webpack-dev-middleware' which handles webpack assets.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverdevmiddleware",
- "type": "object",
- "additionalProperties": true
- },
- "HTTP2": {
- "type": "boolean",
- "description": "Allows to serve over HTTP/2 using SPDY. Deprecated, use the `server` option.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverhttp2",
- "cli": {
- "negatedDescription": "Does not serve over HTTP/2 using SPDY."
- }
- },
- "HTTPS": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disallows to configure the server's listening socket for TLS (by default, dev server will be served over HTTP)."
- }
- },
- {
- "type": "object",
- "additionalProperties": true,
- "properties": {
- "passphrase": {
- "type": "string",
- "description": "Passphrase for a pfx file. Deprecated, use the `server.options.passphrase` option."
- },
- "requestCert": {
- "type": "boolean",
- "description": "Request for an SSL certificate. Deprecated, use the `server.options.requestCert` option.",
- "cli": {
- "negatedDescription": "Does not request for an SSL certificate."
- }
- },
- "ca": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
- },
- "cacert": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
- },
- "cert": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL certificate or content of an SSL certificate. Deprecated, use the `server.options.cert` option."
- },
- "crl": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "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."
- },
- "key": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- },
- {
- "type": "object",
- "additionalProperties": true
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL key or content of an SSL key. Deprecated, use the `server.options.key` option."
- },
- "pfx": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- },
- {
- "type": "object",
- "additionalProperties": true
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL pfx file or content of an SSL pfx file. Deprecated, use the `server.options.pfx` option."
- }
- }
- }
- ],
- "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.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverhttps"
- },
- "HeaderObject": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "key": {
- "description": "key of header.",
- "type": "string"
- },
- "value": {
- "description": "value of header.",
- "type": "string"
- }
- },
- "cli": {
- "exclude": true
- }
- },
- "Headers": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "$ref": "#/definitions/HeaderObject"
- },
- "minItems": 1
- },
- {
- "type": "object"
- },
- {
- "instanceof": "Function"
- }
- ],
- "description": "Allows to set custom headers on response.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverheaders"
- },
- "HistoryApiFallback": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disallows to proxy requests through a specified index page."
- }
- },
- {
- "type": "object",
- "description": "Options for `historyApiFallback`.",
- "link": "https://github.com/bripkens/connect-history-api-fallback#options"
- }
- ],
- "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.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverhistoryapifallback"
- },
- "Host": {
- "description": "Allows to specify a hostname to use.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverhost",
- "anyOf": [
- {
- "enum": ["local-ip", "local-ipv4", "local-ipv6"]
- },
- {
- "type": "string",
- "minLength": 1
- }
- ]
- },
- "Hot": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disables Hot Module Replacement."
- }
- },
- {
- "enum": ["only"]
- }
- ],
- "description": "Enables Hot Module Replacement.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverhot"
- },
- "IPC": {
- "anyOf": [
- {
- "type": "string",
- "minLength": 1
- },
- {
- "type": "boolean",
- "enum": [true]
- }
- ],
- "description": "Listen to a unix socket.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserveripc"
- },
- "LiveReload": {
- "type": "boolean",
- "description": "Enables reload/refresh the page(s) when file changes are detected (enabled by default).",
- "cli": {
- "negatedDescription": "Disables reload/refresh the page(s) when file changes are detected (enabled by default)."
- },
- "link": "https://webpack.js.org/configuration/dev-server/#devserverlivereload"
- },
- "MagicHTML": {
- "type": "boolean",
- "description": "Tells dev-server whether to enable magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js').",
- "cli": {
- "negatedDescription": "Disables magic HTML routes (routes corresponding to your webpack output, for example '/main' for 'main.js')."
- },
- "link": "https://webpack.js.org/configuration/dev-server/#devservermagichtml"
- },
- "OnAfterSetupMiddleware": {
- "instanceof": "Function",
- "description": "Provides the ability to execute a custom function and apply custom middleware(s) after all other middlewares. Deprecated: please use the 'setupMiddlewares' option.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserveronaftersetupmiddleware"
- },
- "OnBeforeSetupMiddleware": {
- "instanceof": "Function",
- "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.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserveronbeforesetupmiddleware"
- },
- "OnListening": {
- "instanceof": "Function",
- "description": "Provides the ability to execute a custom function when dev server starts listening.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserveronlistening"
- },
- "Open": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "$ref": "#/definitions/OpenString"
- },
- {
- "$ref": "#/definitions/OpenObject"
- }
- ]
- }
- },
- {
- "$ref": "#/definitions/OpenBoolean"
- },
- {
- "$ref": "#/definitions/OpenString"
- },
- {
- "$ref": "#/definitions/OpenObject"
- }
- ],
- "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).",
- "link": "https://webpack.js.org/configuration/dev-server/#devserveropen"
- },
- "OpenBoolean": {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Does not open the default browser."
- }
- },
- "OpenObject": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "target": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- {
- "type": "string"
- }
- ],
- "description": "Opens specified page in browser."
- },
- "app": {
- "anyOf": [
- {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "name": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- },
- "minItems": 1
- },
- {
- "type": "string",
- "minLength": 1
- }
- ]
- },
- "arguments": {
- "items": {
- "type": "string",
- "minLength": 1
- }
- }
- }
- },
- {
- "type": "string",
- "minLength": 1,
- "description": "Open specified browser.",
- "cli": {
- "description": "Open specified browser. Deprecated: please use '--open-app-name'."
- }
- }
- ],
- "description": "Open specified browser."
- }
- }
- },
- "OpenString": {
- "type": "string",
- "minLength": 1
- },
- "Port": {
- "anyOf": [
- {
- "type": "number",
- "minimum": 0,
- "maximum": 65535
- },
- {
- "type": "string",
- "minLength": 1
- },
- {
- "enum": ["auto"]
- }
- ],
- "description": "Allows to specify a port to use.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverport"
- },
- "Proxy": {
- "anyOf": [
- {
- "type": "object"
- },
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "object"
- },
- {
- "instanceof": "Function"
- }
- ]
- }
- }
- ],
- "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.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverproxy"
- },
- "Server": {
- "anyOf": [
- {
- "$ref": "#/definitions/ServerEnum"
- },
- {
- "$ref": "#/definitions/ServerString"
- },
- {
- "$ref": "#/definitions/ServerObject"
- }
- ],
- "link": "https://webpack.js.org/configuration/dev-server/#devserverserver",
- "description": "Allows to set server and options (by default 'http')."
- },
- "ServerType": {
- "enum": ["http", "https", "spdy"]
- },
- "ServerEnum": {
- "enum": ["http", "https", "spdy"],
- "cli": {
- "exclude": true
- }
- },
- "ServerString": {
- "type": "string",
- "minLength": 1,
- "cli": {
- "exclude": true
- }
- },
- "ServerObject": {
- "type": "object",
- "properties": {
- "type": {
- "anyOf": [
- {
- "$ref": "#/definitions/ServerType"
- },
- {
- "$ref": "#/definitions/ServerString"
- }
- ]
- },
- "options": {
- "$ref": "#/definitions/ServerOptions"
- }
- },
- "additionalProperties": false
- },
- "ServerOptions": {
- "type": "object",
- "additionalProperties": true,
- "properties": {
- "passphrase": {
- "type": "string",
- "description": "Passphrase for a pfx file."
- },
- "requestCert": {
- "type": "boolean",
- "description": "Request for an SSL certificate.",
- "cli": {
- "negatedDescription": "Does not request for an SSL certificate."
- }
- },
- "ca": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL CA certificate or content of an SSL CA certificate."
- },
- "cacert": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL CA certificate or content of an SSL CA certificate. Deprecated, use the `server.options.ca` option."
- },
- "cert": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL certificate or content of an SSL certificate."
- },
- "crl": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to PEM formatted CRLs (Certificate Revocation Lists) or content of PEM formatted CRLs (Certificate Revocation Lists)."
- },
- "key": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- },
- {
- "type": "object",
- "additionalProperties": true
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL key or content of an SSL key."
- },
- "pfx": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- },
- {
- "type": "object",
- "additionalProperties": true
- }
- ]
- }
- },
- {
- "type": "string"
- },
- {
- "instanceof": "Buffer"
- }
- ],
- "description": "Path to an SSL pfx file or content of an SSL pfx file."
- }
- }
- },
- "SetupExitSignals": {
- "type": "boolean",
- "description": "Allows to close dev server and exit the process on SIGINT and SIGTERM signals (enabled by default for CLI).",
- "link": "https://webpack.js.org/configuration/dev-server/#devserversetupexitsignals",
- "cli": {
- "exclude": true
- }
- },
- "SetupMiddlewares": {
- "instanceof": "Function",
- "description": "Provides the ability to execute a custom function and apply custom middleware(s).",
- "link": "https://webpack.js.org/configuration/dev-server/#devserversetupmiddlewares"
- },
- "Static": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "$ref": "#/definitions/StaticString"
- },
- {
- "$ref": "#/definitions/StaticObject"
- }
- ]
- }
- },
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Disallows to configure options for serving static files from directory."
- }
- },
- {
- "$ref": "#/definitions/StaticString"
- },
- {
- "$ref": "#/definitions/StaticObject"
- }
- ],
- "description": "Allows to configure options for serving static files from directory (by default 'public' directory).",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverstatic"
- },
- "StaticObject": {
- "type": "object",
- "additionalProperties": false,
- "properties": {
- "directory": {
- "type": "string",
- "minLength": 1,
- "description": "Directory for static contents.",
- "link": "https://webpack.js.org/configuration/dev-server/#directory"
- },
- "staticOptions": {
- "type": "object",
- "link": "https://webpack.js.org/configuration/dev-server/#staticoptions",
- "additionalProperties": true
- },
- "publicPath": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string"
- },
- "minItems": 1
- },
- {
- "type": "string"
- }
- ],
- "description": "The static files will be available in the browser under this public path.",
- "link": "https://webpack.js.org/configuration/dev-server/#publicpath"
- },
- "serveIndex": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Does not tell dev server to use serveIndex middleware."
- }
- },
- {
- "type": "object",
- "additionalProperties": true
- }
- ],
- "description": "Tells dev server to use serveIndex middleware when enabled.",
- "link": "https://webpack.js.org/configuration/dev-server/#serveindex"
- },
- "watch": {
- "anyOf": [
- {
- "type": "boolean",
- "cli": {
- "negatedDescription": "Does not watch for files in static content directory."
- }
- },
- {
- "type": "object",
- "description": "Options for watch.",
- "link": "https://github.com/paulmillr/chokidar#api"
- }
- ],
- "description": "Watches for files in static content directory.",
- "link": "https://webpack.js.org/configuration/dev-server/#watch"
- }
- }
- },
- "StaticString": {
- "type": "string",
- "minLength": 1
- },
- "WatchFiles": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "anyOf": [
- {
- "$ref": "#/definitions/WatchFilesString"
- },
- {
- "$ref": "#/definitions/WatchFilesObject"
- }
- ]
- }
- },
- {
- "$ref": "#/definitions/WatchFilesString"
- },
- {
- "$ref": "#/definitions/WatchFilesObject"
- }
- ],
- "description": "Allows to configure list of globs/directories/files to watch for file changes.",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverwatchfiles"
- },
- "WatchFilesObject": {
- "cli": {
- "exclude": true
- },
- "type": "object",
- "properties": {
- "paths": {
- "anyOf": [
- {
- "type": "array",
- "items": {
- "type": "string",
- "minLength": 1
- }
- },
- {
- "type": "string",
- "minLength": 1
- }
- ],
- "description": "Path(s) of globs/directories/files to watch for file changes."
- },
- "options": {
- "type": "object",
- "description": "Configure advanced options for watching. See the chokidar documentation for the possible options.",
- "link": "https://github.com/paulmillr/chokidar#api",
- "additionalProperties": true
- }
- },
- "additionalProperties": false
- },
- "WatchFilesString": {
- "type": "string",
- "minLength": 1
- },
- "WebSocketServer": {
- "anyOf": [
- {
- "$ref": "#/definitions/WebSocketServerEnum"
- },
- {
- "$ref": "#/definitions/WebSocketServerString"
- },
- {
- "$ref": "#/definitions/WebSocketServerFunction"
- },
- {
- "$ref": "#/definitions/WebSocketServerObject"
- }
- ],
- "description": "Allows to set web socket server and options (by default 'ws').",
- "link": "https://webpack.js.org/configuration/dev-server/#devserverwebsocketserver"
- },
- "WebSocketServerType": {
- "enum": ["sockjs", "ws"]
- },
- "WebSocketServerEnum": {
- "anyOf": [
- {
- "enum": [false],
- "cli": {
- "negatedDescription": "Disallows to set web socket server and options."
- }
- },
- {
- "$ref": "#/definitions/WebSocketServerType"
- }
- ],
- "cli": {
- "description": "Deprecated: please use '--web-socket-server-type' option."
- }
- },
- "WebSocketServerFunction": {
- "instanceof": "Function"
- },
- "WebSocketServerObject": {
- "type": "object",
- "properties": {
- "type": {
- "anyOf": [
- {
- "$ref": "#/definitions/WebSocketServerType"
- },
- {
- "$ref": "#/definitions/WebSocketServerString"
- },
- {
- "$ref": "#/definitions/WebSocketServerFunction"
- }
- ]
- },
- "options": {
- "type": "object",
- "additionalProperties": true,
- "cli": {
- "exclude": true
- }
- }
- },
- "additionalProperties": false
- },
- "WebSocketServerString": {
- "type": "string",
- "minLength": 1
- }
- },
- "additionalProperties": false,
- "properties": {
- "allowedHosts": {
- "$ref": "#/definitions/AllowedHosts"
- },
- "bonjour": {
- "$ref": "#/definitions/Bonjour"
- },
- "client": {
- "$ref": "#/definitions/Client"
- },
- "compress": {
- "$ref": "#/definitions/Compress"
- },
- "devMiddleware": {
- "$ref": "#/definitions/DevMiddleware"
- },
- "headers": {
- "$ref": "#/definitions/Headers"
- },
- "historyApiFallback": {
- "$ref": "#/definitions/HistoryApiFallback"
- },
- "host": {
- "$ref": "#/definitions/Host"
- },
- "hot": {
- "$ref": "#/definitions/Hot"
- },
- "http2": {
- "$ref": "#/definitions/HTTP2"
- },
- "https": {
- "$ref": "#/definitions/HTTPS"
- },
- "ipc": {
- "$ref": "#/definitions/IPC"
- },
- "liveReload": {
- "$ref": "#/definitions/LiveReload"
- },
- "magicHtml": {
- "$ref": "#/definitions/MagicHTML"
- },
- "onAfterSetupMiddleware": {
- "$ref": "#/definitions/OnAfterSetupMiddleware"
- },
- "onBeforeSetupMiddleware": {
- "$ref": "#/definitions/OnBeforeSetupMiddleware"
- },
- "onListening": {
- "$ref": "#/definitions/OnListening"
- },
- "open": {
- "$ref": "#/definitions/Open"
- },
- "port": {
- "$ref": "#/definitions/Port"
- },
- "proxy": {
- "$ref": "#/definitions/Proxy"
- },
- "server": {
- "$ref": "#/definitions/Server"
- },
- "setupExitSignals": {
- "$ref": "#/definitions/SetupExitSignals"
- },
- "setupMiddlewares": {
- "$ref": "#/definitions/SetupMiddlewares"
- },
- "static": {
- "$ref": "#/definitions/Static"
- },
- "watchFiles": {
- "$ref": "#/definitions/WatchFiles"
- },
- "webSocketServer": {
- "$ref": "#/definitions/WebSocketServer"
- }
- }
- }
|