12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235 |
- {
- "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": {
- "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."
- }
- },
- "warnings": {
- "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."
- }
- },
- "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"
- }
- }
- }
|