UNPKG

webpack

Version:

Packs CommonJs/AMD modules for the browser. Allows to split your codebase into multiple bundles, which can be loaded on demand. Support loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

1,430 lines 160 kB
{ "definitions": { "Amd": { "description": "Set the value of `require.amd` and `define.amd`. Or disable AMD support.", "anyOf": [ { "description": "You can pass `false` to disable AMD support.", "enum": [false] }, { "description": "You can pass an object to set the value of `require.amd` and `define.amd`.", "type": "object" } ] }, "AssetFilterItemTypes": { "description": "Filtering value, regexp or function.", "cli": { "helper": true }, "anyOf": [ { "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "string", "absolutePath": false }, { "instanceof": "Function", "tsType": "((name: string, asset: import('../lib/stats/DefaultStatsFactoryPlugin').StatsAsset) => boolean)" } ] }, "AssetFilterTypes": { "description": "Filtering modules.", "cli": { "helper": true }, "anyOf": [ { "type": "array", "items": { "description": "Rule to filter.", "cli": { "helper": true }, "oneOf": [ { "$ref": "#/definitions/AssetFilterItemTypes" } ] } }, { "$ref": "#/definitions/AssetFilterItemTypes" } ] }, "AssetGeneratorDataUrl": { "description": "The options for data url generator.", "anyOf": [ { "$ref": "#/definitions/AssetGeneratorDataUrlOptions" }, { "$ref": "#/definitions/AssetGeneratorDataUrlFunction" } ] }, "AssetGeneratorDataUrlFunction": { "description": "Function that executes for module and should return an DataUrl string.", "instanceof": "Function", "tsType": "((source: string | Buffer, context: { filename: string, module: import('../lib/Module') }) => string)" }, "AssetGeneratorDataUrlOptions": { "description": "Options object for data url generation.", "type": "object", "additionalProperties": false, "properties": { "encoding": { "description": "Asset encoding (defaults to base64).", "enum": [false, "base64"] }, "mimetype": { "description": "Asset mimetype (getting from file extension by default).", "type": "string" } } }, "AssetGeneratorOptions": { "description": "Generator options for asset modules.", "type": "object", "implements": [ "#/definitions/AssetInlineGeneratorOptions", "#/definitions/AssetResourceGeneratorOptions" ], "additionalProperties": false, "properties": { "dataUrl": { "$ref": "#/definitions/AssetGeneratorDataUrl" }, "emit": { "description": "Emit an output asset from this asset module. This can be set to 'false' to omit emitting e. g. for SSR.", "type": "boolean" }, "filename": { "$ref": "#/definitions/FilenameTemplate" }, "publicPath": { "$ref": "#/definitions/RawPublicPath" } } }, "AssetInlineGeneratorOptions": { "description": "Generator options for asset/inline modules.", "type": "object", "additionalProperties": false, "properties": { "dataUrl": { "$ref": "#/definitions/AssetGeneratorDataUrl" } } }, "AssetModuleFilename": { "description": "The filename of asset modules as relative path inside the 'output.path' directory.", "anyOf": [ { "type": "string", "absolutePath": false }, { "instanceof": "Function", "tsType": "((pathData: import(\"../lib/Compilation\").PathData, assetInfo?: import(\"../lib/Compilation\").AssetInfo) => string)" } ] }, "AssetParserDataUrlFunction": { "description": "Function that executes for module and should return whenever asset should be inlined as DataUrl.", "instanceof": "Function", "tsType": "((source: string | Buffer, context: { filename: string, module: import('../lib/Module') }) => boolean)" }, "AssetParserDataUrlOptions": { "description": "Options object for DataUrl condition.", "type": "object", "additionalProperties": false, "properties": { "maxSize": { "description": "Maximum size of asset that should be inline as modules. Default: 8kb.", "type": "number" } } }, "AssetParserOptions": { "description": "Parser options for asset modules.", "type": "object", "additionalProperties": false, "properties": { "dataUrlCondition": { "description": "The condition for inlining the asset as DataUrl.", "anyOf": [ { "$ref": "#/definitions/AssetParserDataUrlOptions" }, { "$ref": "#/definitions/AssetParserDataUrlFunction" } ] } } }, "AssetResourceGeneratorOptions": { "description": "Generator options for asset/resource modules.", "type": "object", "additionalProperties": false, "properties": { "emit": { "description": "Emit an output asset from this asset module. This can be set to 'false' to omit emitting e. g. for SSR.", "type": "boolean" }, "filename": { "$ref": "#/definitions/FilenameTemplate" }, "publicPath": { "$ref": "#/definitions/RawPublicPath" } } }, "AuxiliaryComment": { "description": "Add a comment in the UMD wrapper.", "anyOf": [ { "description": "Append the same comment above each import style.", "type": "string" }, { "$ref": "#/definitions/LibraryCustomUmdCommentObject" } ] }, "Bail": { "description": "Report the first error as a hard error instead of tolerating it.", "type": "boolean" }, "CacheOptions": { "description": "Cache generated modules and chunks to improve performance for multiple incremental builds.", "anyOf": [ { "description": "Enable in memory caching.", "enum": [true] }, { "$ref": "#/definitions/CacheOptionsNormalized" } ] }, "CacheOptionsNormalized": { "description": "Cache generated modules and chunks to improve performance for multiple incremental builds.", "anyOf": [ { "description": "Disable caching.", "enum": [false] }, { "$ref": "#/definitions/MemoryCacheOptions" }, { "$ref": "#/definitions/FileCacheOptions" } ] }, "Charset": { "description": "Add charset attribute for script tag.", "type": "boolean" }, "ChunkFilename": { "description": "Specifies the filename template of output files of non-initial chunks on disk. You must **not** specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.", "oneOf": [ { "$ref": "#/definitions/FilenameTemplate" } ] }, "ChunkFormat": { "description": "The format of chunks (formats included by default are 'array-push' (web/WebWorker), 'commonjs' (node.js), 'module' (ESM), but others might be added by plugins).", "anyOf": [ { "enum": ["array-push", "commonjs", "module", false] }, { "type": "string" } ] }, "ChunkLoadTimeout": { "description": "Number of milliseconds before chunk request expires.", "type": "number" }, "ChunkLoading": { "description": "The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).", "anyOf": [ { "enum": [false] }, { "$ref": "#/definitions/ChunkLoadingType" } ] }, "ChunkLoadingGlobal": { "description": "The global variable used by webpack for loading of chunks.", "type": "string" }, "ChunkLoadingType": { "description": "The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).", "anyOf": [ { "enum": ["jsonp", "import-scripts", "require", "async-node", "import"] }, { "type": "string" } ] }, "Clean": { "description": "Clean the output directory before emit.", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/CleanOptions" } ] }, "CleanOptions": { "description": "Advanced options for cleaning assets.", "type": "object", "additionalProperties": false, "properties": { "dry": { "description": "Log the assets that should be removed instead of deleting them.", "type": "boolean" }, "keep": { "description": "Keep these assets.", "anyOf": [ { "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "string", "absolutePath": false }, { "instanceof": "Function", "tsType": "((filename: string) => boolean)" } ] } } }, "CompareBeforeEmit": { "description": "Check if to be emitted file already exists and have the same content before writing to output filesystem.", "type": "boolean" }, "Context": { "description": "The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory.", "type": "string", "absolutePath": true }, "CrossOriginLoading": { "description": "This option enables cross-origin loading of chunks.", "enum": [false, "anonymous", "use-credentials"] }, "Dependencies": { "description": "References to other configurations to depend on.", "type": "array", "items": { "description": "References to another configuration to depend on.", "type": "string" } }, "DevServer": { "description": "Options for the webpack-dev-server.", "type": "object" }, "DevTool": { "description": "A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).", "anyOf": [ { "enum": [false, "eval"] }, { "type": "string", "pattern": "^(inline-|hidden-|eval-)?(nosources-)?(cheap-(module-)?)?source-map$" } ] }, "DevtoolFallbackModuleFilenameTemplate": { "description": "Similar to `output.devtoolModuleFilenameTemplate`, but used in the case of duplicate module identifiers.", "anyOf": [ { "type": "string" }, { "instanceof": "Function", "tsType": "Function" } ] }, "DevtoolModuleFilenameTemplate": { "description": "Filename template string of function for the sources array in a generated SourceMap.", "anyOf": [ { "type": "string" }, { "instanceof": "Function", "tsType": "Function" } ] }, "DevtoolNamespace": { "description": "Module namespace to use when interpolating filename template string for the sources array in a generated SourceMap. Defaults to `output.library` if not set. It's useful for avoiding runtime collisions in sourcemaps from multiple webpack projects built as libraries.", "type": "string" }, "EmptyGeneratorOptions": { "description": "No generator options are supported for this module type.", "type": "object", "additionalProperties": false }, "EmptyParserOptions": { "description": "No parser options are supported for this module type.", "type": "object", "additionalProperties": false }, "EnabledChunkLoadingTypes": { "description": "List of chunk loading types enabled for use by entry points.", "type": "array", "items": { "$ref": "#/definitions/ChunkLoadingType" } }, "EnabledLibraryTypes": { "description": "List of library types enabled for use by entry points.", "type": "array", "items": { "$ref": "#/definitions/LibraryType" } }, "EnabledWasmLoadingTypes": { "description": "List of wasm loading types enabled for use by entry points.", "type": "array", "items": { "$ref": "#/definitions/WasmLoadingType" } }, "Entry": { "description": "The entry point(s) of the compilation.", "anyOf": [ { "$ref": "#/definitions/EntryDynamic" }, { "$ref": "#/definitions/EntryStatic" } ] }, "EntryDescription": { "description": "An object with entry point description.", "type": "object", "additionalProperties": false, "properties": { "chunkLoading": { "$ref": "#/definitions/ChunkLoading" }, "dependOn": { "description": "The entrypoints that the current entrypoint depend on. They must be loaded when this entrypoint is loaded.", "anyOf": [ { "description": "The entrypoints that the current entrypoint depend on. They must be loaded when this entrypoint is loaded.", "type": "array", "items": { "description": "An entrypoint that the current entrypoint depend on. It must be loaded when this entrypoint is loaded.", "type": "string", "minLength": 1 }, "minItems": 1, "uniqueItems": true }, { "description": "An entrypoint that the current entrypoint depend on. It must be loaded when this entrypoint is loaded.", "type": "string", "minLength": 1 } ] }, "filename": { "$ref": "#/definitions/EntryFilename" }, "import": { "$ref": "#/definitions/EntryItem" }, "layer": { "$ref": "#/definitions/Layer" }, "library": { "$ref": "#/definitions/LibraryOptions" }, "publicPath": { "$ref": "#/definitions/PublicPath" }, "runtime": { "$ref": "#/definitions/EntryRuntime" }, "wasmLoading": { "$ref": "#/definitions/WasmLoading" } }, "required": ["import"] }, "EntryDescriptionNormalized": { "description": "An object with entry point description.", "type": "object", "additionalProperties": false, "properties": { "chunkLoading": { "$ref": "#/definitions/ChunkLoading" }, "dependOn": { "description": "The entrypoints that the current entrypoint depend on. They must be loaded when this entrypoint is loaded.", "type": "array", "items": { "description": "An entrypoint that the current entrypoint depend on. It must be loaded when this entrypoint is loaded.", "type": "string", "minLength": 1 }, "minItems": 1, "uniqueItems": true }, "filename": { "$ref": "#/definitions/Filename" }, "import": { "description": "Module(s) that are loaded upon startup. The last one is exported.", "type": "array", "items": { "description": "Module that is loaded upon startup. Only the last one is exported.", "type": "string", "minLength": 1 }, "minItems": 1, "uniqueItems": true }, "layer": { "$ref": "#/definitions/Layer" }, "library": { "$ref": "#/definitions/LibraryOptions" }, "publicPath": { "$ref": "#/definitions/PublicPath" }, "runtime": { "$ref": "#/definitions/EntryRuntime" }, "wasmLoading": { "$ref": "#/definitions/WasmLoading" } } }, "EntryDynamic": { "description": "A Function returning an entry object, an entry string, an entry array or a promise to these things.", "instanceof": "Function", "tsType": "(() => EntryStatic | Promise<EntryStatic>)" }, "EntryDynamicNormalized": { "description": "A Function returning a Promise resolving to a normalized entry.", "instanceof": "Function", "tsType": "(() => Promise<EntryStaticNormalized>)" }, "EntryFilename": { "description": "Specifies the filename of the output file on disk. You must **not** specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.", "oneOf": [ { "$ref": "#/definitions/FilenameTemplate" } ] }, "EntryItem": { "description": "Module(s) that are loaded upon startup.", "anyOf": [ { "description": "All modules are loaded upon startup. The last one is exported.", "type": "array", "items": { "description": "A module that is loaded upon startup. Only the last one is exported.", "type": "string", "minLength": 1 }, "minItems": 1, "uniqueItems": true }, { "description": "The string is resolved to a module which is loaded upon startup.", "type": "string", "minLength": 1 } ] }, "EntryNormalized": { "description": "The entry point(s) of the compilation.", "anyOf": [ { "$ref": "#/definitions/EntryDynamicNormalized" }, { "$ref": "#/definitions/EntryStaticNormalized" } ] }, "EntryObject": { "description": "Multiple entry bundles are created. The key is the entry name. The value can be a string, an array or an entry description object.", "type": "object", "additionalProperties": { "description": "An entry point with name.", "anyOf": [ { "$ref": "#/definitions/EntryItem" }, { "$ref": "#/definitions/EntryDescription" } ] } }, "EntryRuntime": { "description": "The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.", "anyOf": [ { "enum": [false] }, { "type": "string", "minLength": 1 } ] }, "EntryStatic": { "description": "A static entry description.", "anyOf": [ { "$ref": "#/definitions/EntryObject" }, { "$ref": "#/definitions/EntryUnnamed" } ] }, "EntryStaticNormalized": { "description": "Multiple entry bundles are created. The key is the entry name. The value is an entry description object.", "type": "object", "additionalProperties": { "description": "An object with entry point description.", "oneOf": [ { "$ref": "#/definitions/EntryDescriptionNormalized" } ] } }, "EntryUnnamed": { "description": "An entry point without name.", "oneOf": [ { "$ref": "#/definitions/EntryItem" } ] }, "Environment": { "description": "The abilities of the environment where the webpack generated code should run.", "type": "object", "additionalProperties": false, "properties": { "arrowFunction": { "description": "The environment supports arrow functions ('() => { ... }').", "type": "boolean" }, "bigIntLiteral": { "description": "The environment supports BigInt as literal (123n).", "type": "boolean" }, "const": { "description": "The environment supports const and let for variable declarations.", "type": "boolean" }, "destructuring": { "description": "The environment supports destructuring ('{ a, b } = obj').", "type": "boolean" }, "dynamicImport": { "description": "The environment supports an async import() function to import EcmaScript modules.", "type": "boolean" }, "forOf": { "description": "The environment supports 'for of' iteration ('for (const x of array) { ... }').", "type": "boolean" }, "module": { "description": "The environment supports EcmaScript Module syntax to import EcmaScript modules (import ... from '...').", "type": "boolean" } } }, "Experiments": { "description": "Enables/Disables experiments (experimental features with relax SemVer compatibility).", "type": "object", "additionalProperties": false, "properties": { "asset": { "description": "Allow module type 'asset' to generate assets.", "type": "boolean" }, "asyncWebAssembly": { "description": "Support WebAssembly as asynchronous EcmaScript Module.", "type": "boolean" }, "buildHttp": { "description": "Build http(s): urls using a lockfile and resource content cache.", "anyOf": [ { "type": "boolean" }, { "$ref": "#/definitions/HttpUriOptions" } ] }, "cacheUnaffected": { "description": "Enable additional in memory caching of modules that are unchanged and reference only unchanged modules.", "type": "boolean" }, "futureDefaults": { "description": "Apply defaults of next major version.", "type": "boolean" }, "layers": { "description": "Enable module and chunk layers.", "type": "boolean" }, "lazyCompilation": { "description": "Compile entrypoints and import()s only when they are accessed.", "anyOf": [ { "type": "boolean" }, { "type": "object", "additionalProperties": false, "properties": { "backend": { "description": "A custom backend.", "instanceof": "Function", "tsType": "(((compiler: import('../lib/Compiler'), client: string, callback: (err?: Error, api?: any) => void) => void) | ((compiler: import('../lib/Compiler'), client: string) => Promise<any>))" }, "client": { "description": "A custom client.", "type": "string" }, "entries": { "description": "Enable/disable lazy compilation for entries.", "type": "boolean" }, "imports": { "description": "Enable/disable lazy compilation for import() modules.", "type": "boolean" }, "test": { "description": "Specify which entrypoints or import()ed modules should be lazily compiled. This is matched with the imported module and not the entrypoint name.", "anyOf": [ { "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "string" }, { "instanceof": "Function", "tsType": "((module: import('../lib/Module')) => boolean)" } ] } } } ] }, "outputModule": { "description": "Allow output javascript files as module source type.", "type": "boolean" }, "syncWebAssembly": { "description": "Support WebAssembly as synchronous EcmaScript Module (outdated).", "type": "boolean" }, "topLevelAwait": { "description": "Allow using top-level-await in EcmaScript Modules.", "type": "boolean" } } }, "ExternalItem": { "description": "Specify dependency that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`.", "anyOf": [ { "description": "Every matched dependency becomes external.", "instanceof": "RegExp", "tsType": "RegExp" }, { "description": "An exact matched dependency becomes external. The same string is used as external dependency.", "type": "string" }, { "description": "If an dependency matches exactly a property of the object, the property value is used as dependency.", "type": "object", "additionalProperties": { "$ref": "#/definitions/ExternalItemValue" }, "properties": { "byLayer": { "description": "Specify externals depending on the layer.", "anyOf": [ { "type": "object", "additionalProperties": { "$ref": "#/definitions/ExternalItem" } }, { "instanceof": "Function", "tsType": "((layer: string | null) => ExternalItem)" } ] } } }, { "description": "The function is called on each dependency (`function(context, request, callback(err, result))`).", "instanceof": "Function", "tsType": "(((data: ExternalItemFunctionData, callback: (err?: Error, result?: ExternalItemValue) => void) => void) | ((data: ExternalItemFunctionData) => Promise<ExternalItemValue>))" } ] }, "ExternalItemFunctionData": { "description": "Data object passed as argument when a function is set for 'externals'.", "type": "object", "additionalProperties": false, "properties": { "context": { "description": "The directory in which the request is placed.", "type": "string" }, "contextInfo": { "description": "Contextual information.", "type": "object", "tsType": "import('../lib/ModuleFactory').ModuleFactoryCreateDataContextInfo" }, "dependencyType": { "description": "The category of the referencing dependencies.", "type": "string" }, "getResolve": { "description": "Get a resolve function with the current resolver options.", "instanceof": "Function", "tsType": "((options?: ResolveOptions) => ((context: string, request: string, callback: (err?: Error, result?: string) => void) => void) | ((context: string, request: string) => Promise<string>))" }, "request": { "description": "The request as written by the user in the require/import expression/statement.", "type": "string" } } }, "ExternalItemValue": { "description": "The dependency used for the external.", "anyOf": [ { "type": "array", "items": { "description": "A part of the target of the external.", "type": "string", "minLength": 1 } }, { "description": "`true`: The dependency name is used as target of the external.", "type": "boolean" }, { "description": "The target of the external.", "type": "string" }, { "type": "object" } ] }, "Externals": { "description": "Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`.", "anyOf": [ { "type": "array", "items": { "$ref": "#/definitions/ExternalItem" } }, { "$ref": "#/definitions/ExternalItem" } ] }, "ExternalsPresets": { "description": "Enable presets of externals for specific targets.", "type": "object", "additionalProperties": false, "properties": { "electron": { "description": "Treat common electron built-in modules in main and preload context like 'electron', 'ipc' or 'shell' as external and load them via require() when used.", "type": "boolean" }, "electronMain": { "description": "Treat electron built-in modules in the main context like 'app', 'ipc-main' or 'shell' as external and load them via require() when used.", "type": "boolean" }, "electronPreload": { "description": "Treat electron built-in modules in the preload context like 'web-frame', 'ipc-renderer' or 'shell' as external and load them via require() when used.", "type": "boolean" }, "electronRenderer": { "description": "Treat electron built-in modules in the renderer context like 'web-frame', 'ipc-renderer' or 'shell' as external and load them via require() when used.", "type": "boolean" }, "node": { "description": "Treat node.js built-in modules like fs, path or vm as external and load them via require() when used.", "type": "boolean" }, "nwjs": { "description": "Treat NW.js legacy nw.gui module as external and load it via require() when used.", "type": "boolean" }, "web": { "description": "Treat references to 'http(s)://...' and 'std:...' as external and load them via import when used (Note that this changes execution order as externals are executed before any other code in the chunk).", "type": "boolean" }, "webAsync": { "description": "Treat references to 'http(s)://...' and 'std:...' as external and load them via async import() when used (Note that this external type is an async module, which has various effects on the execution).", "type": "boolean" } } }, "ExternalsType": { "description": "Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).", "enum": [ "var", "module", "assign", "this", "window", "self", "global", "commonjs", "commonjs2", "commonjs-module", "amd", "amd-require", "umd", "umd2", "jsonp", "system", "promise", "import", "script", "node-commonjs" ] }, "FileCacheOptions": { "description": "Options object for persistent file-based caching.", "type": "object", "additionalProperties": false, "properties": { "allowCollectingMemory": { "description": "Allows to collect unused memory allocated during deserialization. This requires copying data into smaller buffers and has a performance cost.", "type": "boolean" }, "buildDependencies": { "description": "Dependencies the build depends on (in multiple categories, default categories: 'defaultWebpack').", "type": "object", "additionalProperties": { "description": "List of dependencies the build depends on.", "type": "array", "items": { "description": "Request to a dependency (resolved as directory relative to the context directory).", "type": "string", "minLength": 1 } } }, "cacheDirectory": { "description": "Base directory for the cache (defaults to node_modules/.cache/webpack).", "type": "string", "absolutePath": true }, "cacheLocation": { "description": "Locations for the cache (defaults to cacheDirectory / name).", "type": "string", "absolutePath": true }, "compression": { "description": "Compression type used for the cache files.", "enum": [false, "gzip", "brotli"] }, "hashAlgorithm": { "description": "Algorithm used for generation the hash (see node.js crypto package).", "type": "string" }, "idleTimeout": { "description": "Time in ms after which idle period the cache storing should happen.", "type": "number", "minimum": 0 }, "idleTimeoutAfterLargeChanges": { "description": "Time in ms after which idle period the cache storing should happen when larger changes has been detected (cumulative build time > 2 x avg cache store time).", "type": "number", "minimum": 0 }, "idleTimeoutForInitialStore": { "description": "Time in ms after which idle period the initial cache storing should happen.", "type": "number", "minimum": 0 }, "immutablePaths": { "description": "List of paths that are managed by a package manager and contain a version or hash in its path so all files are immutable.", "type": "array", "items": { "description": "A path to a immutable directory (usually a package manager cache directory).", "type": "string", "absolutePath": true, "minLength": 1 } }, "managedPaths": { "description": "List of paths that are managed by a package manager and can be trusted to not be modified otherwise.", "type": "array", "items": { "description": "A path to a managed directory (usually a node_modules directory).", "type": "string", "absolutePath": true, "minLength": 1 } }, "maxAge": { "description": "Time for which unused cache entries stay in the filesystem cache at minimum (in milliseconds).", "type": "number", "minimum": 0 }, "maxMemoryGenerations": { "description": "Number of generations unused cache entries stay in memory cache at minimum (0 = no memory cache used, 1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). Cache entries will be deserialized from disk when removed from memory cache.", "type": "number", "minimum": 0 }, "memoryCacheUnaffected": { "description": "Additionally cache computation of modules that are unchanged and reference only unchanged modules in memory.", "type": "boolean" }, "name": { "description": "Name for the cache. Different names will lead to different coexisting caches.", "type": "string" }, "profile": { "description": "Track and log detailed timing information for individual cache items.", "type": "boolean" }, "store": { "description": "When to store data to the filesystem. (pack: Store data when compiler is idle in a single file).", "enum": ["pack"] }, "type": { "description": "Filesystem caching.", "enum": ["filesystem"] }, "version": { "description": "Version of the cache data. Different versions won't allow to reuse the cache and override existing content. Update the version when config changed in a way which doesn't allow to reuse cache. This will invalidate the cache.", "type": "string" } }, "required": ["type"] }, "Filename": { "description": "Specifies the filename of output files on disk. You must **not** specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.", "oneOf": [ { "$ref": "#/definitions/FilenameTemplate" } ] }, "FilenameTemplate": { "description": "Specifies the filename template of output files on disk. You must **not** specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.", "anyOf": [ { "type": "string", "absolutePath": false, "minLength": 1 }, { "instanceof": "Function", "tsType": "((pathData: import(\"../lib/Compilation\").PathData, assetInfo?: import(\"../lib/Compilation\").AssetInfo) => string)" } ] }, "FilterItemTypes": { "description": "Filtering value, regexp or function.", "cli": { "helper": true }, "anyOf": [ { "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "string", "absolutePath": false }, { "instanceof": "Function", "tsType": "((value: string) => boolean)" } ] }, "FilterTypes": { "description": "Filtering values.", "cli": { "helper": true }, "anyOf": [ { "type": "array", "items": { "description": "Rule to filter.", "cli": { "helper": true }, "oneOf": [ { "$ref": "#/definitions/FilterItemTypes" } ] } }, { "$ref": "#/definitions/FilterItemTypes" } ] }, "GeneratorOptionsByModuleType": { "description": "Specify options for each generator.", "type": "object", "additionalProperties": { "description": "Options for generating.", "type": "object", "additionalProperties": true }, "properties": { "asset": { "$ref": "#/definitions/AssetGeneratorOptions" }, "asset/inline": { "$ref": "#/definitions/AssetInlineGeneratorOptions" }, "asset/resource": { "$ref": "#/definitions/AssetResourceGeneratorOptions" }, "javascript": { "$ref": "#/definitions/EmptyGeneratorOptions" }, "javascript/auto": { "$ref": "#/definitions/EmptyGeneratorOptions" }, "javascript/dynamic": { "$ref": "#/definitions/EmptyGeneratorOptions" }, "javascript/esm": { "$ref": "#/definitions/EmptyGeneratorOptions" } } }, "GlobalObject": { "description": "An expression which is used to address the global object/scope in runtime code.", "type": "string", "minLength": 1 }, "HashDigest": { "description": "Digest type used for the hash.", "type": "string" }, "HashDigestLength": { "description": "Number of chars which are used for the hash.", "type": "number", "minimum": 1 }, "HashFunction": { "description": "Algorithm used for generation the hash (see node.js crypto package).", "anyOf": [ { "type": "string", "minLength": 1 }, { "instanceof": "Function", "tsType": "typeof import('../lib/util/Hash')" } ] }, "HashSalt": { "description": "Any string which is added to the hash to salt it.", "type": "string", "minLength": 1 }, "HotUpdateChunkFilename": { "description": "The filename of the Hot Update Chunks. They are inside the output.path directory.", "type": "string", "absolutePath": false }, "HotUpdateGlobal": { "description": "The global variable used by webpack for loading of hot update chunks.", "type": "string" }, "HotUpdateMainFilename": { "description": "The filename of the Hot Update Main File. It is inside the 'output.path' directory.", "type": "string", "absolutePath": false }, "HttpUriOptions": { "description": "Options for building http resources.", "type": "object", "additionalProperties": false, "properties": { "cacheLocation": { "description": "Location where resource content is stored for lockfile entries. It's also possible to disable storing by passing false.", "anyOf": [ { "enum": [false] }, { "type": "string", "absolutePath": true } ] }, "frozen": { "description": "When set, anything that would lead to a modification of the lockfile or any resource content, will result in an error.", "type": "boolean" }, "lockfileLocation": { "description": "Location of the lockfile.", "type": "string", "absolutePath": true }, "upgrade": { "description": "When set, resources of existing lockfile entries will be fetched and entries will be upgraded when resource content has changed.", "type": "boolean" } } }, "IgnoreWarnings": { "description": "Ignore specific warnings.", "type": "array", "items": { "description": "Ignore specific warnings.", "anyOf": [ { "description": "A RegExp to select the warning message.", "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "object", "additionalProperties": false, "properties": { "file": { "description": "A RegExp to select the origin file for the warning.", "instanceof": "RegExp", "tsType": "RegExp" }, "message": { "description": "A RegExp to select the warning message.", "instanceof": "RegExp", "tsType": "RegExp" }, "module": { "description": "A RegExp to select the origin module for the warning.", "instanceof": "RegExp", "tsType": "RegExp" } } }, { "description": "A custom function to select warnings based on the raw warning instance.", "instanceof": "Function", "tsType": "((warning: import('../lib/WebpackError'), compilation: import('../lib/Compilation')) => boolean)" } ] } }, "IgnoreWarningsNormalized": { "description": "Ignore specific warnings.", "type": "array", "items": { "description": "A function to select warnings based on the raw warning instance.", "instanceof": "Function", "tsType": "((warning: import('../lib/WebpackError'), compilation: import('../lib/Compilation')) => boolean)" } }, "Iife": { "description": "Wrap javascript code into IIFE's to avoid leaking into global scope.", "type": "boolean" }, "ImportFunctionName": { "description": "The name of the native import() function (can be exchanged for a polyfill).", "type": "string" }, "ImportMetaName": { "description": "The name of the native import.meta object (can be exchanged for a polyfill).", "type": "string" }, "InfrastructureLogging": { "description": "Options for infrastructure level logging.", "type": "object", "additionalProperties": false, "properties": { "appendOnly": { "description": "Only appends lines to the output. Avoids updating existing output e. g. for status messages. This option is only used when no custom console is provided.", "type": "boolean" }, "colors": { "description": "Enables/Disables colorful output. This option is only used when no custom console is provided.", "type": "boolean" }, "console": { "description": "Custom console used for logging.", "tsType": "Console" }, "debug": { "description": "Enable debug logging for specific loggers.", "anyOf": [ { "description": "Enable/Disable debug logging for all loggers.", "type": "boolean" }, { "$ref": "#/definitions/FilterTypes" } ] }, "level": { "description": "Log level.", "enum": ["none", "error", "warn", "info", "log", "verbose"] }, "stream": { "description": "Stream used for logging output. Defaults to process.stderr. This option is only used when no custom console is provided.", "tsType": "NodeJS.WritableStream" } } }, "JavascriptParserOptions": { "description": "Parser options for javascript modules.", "type": "object", "additionalProperties": true, "properties": { "amd": { "$ref": "#/definitions/Amd" }, "browserify": { "description": "Enable/disable special handling for browserify bundles.", "type": "boolean" }, "commonjs": { "description": "Enable/disable parsing of CommonJs syntax.", "type": "boolean" }, "commonjsMagicComments": { "description": "Enable/disable parsing of magic comments in CommonJs syntax.", "type": "boolean" }, "exprContextCritical": { "description": "Enable warnings for full dynamic dependencies.", "type": "boolean" }, "exprContextRecursive": { "description": "Enable recursive directory lookup for full dynamic dependencies.", "type": "boolean" }, "exprContextRegExp": { "description": "Sets the default regular expression for full dynamic dependencies.", "anyOf": [ { "instanceof": "RegExp", "tsType": "RegExp" }, { "type": "boolean" } ] }, "exprContextRequest": { "description": "Set the default request for full dynamic dependencies.", "type": "string" }, "harmony": { "description": "Enable/disable parsing of EcmaScript Modules syntax.", "type": "boolean" }, "import": { "description": "Enable/disable parsing of import() syntax.", "type": "boolean" }, "node": { "$ref": "#/definitions/Node" }, "requireContext": { "description": "Enable/disable parsing of require.context syntax.", "type": "boolean" }, "requireEnsure": { "description": "Enable/disable parsing of require.ensure syntax.", "type": "boolean" }, "requireInclude": { "description": "Enable/disable parsing of require.include syntax.", "type": "boolean" }, "requireJs": { "description": "Enable/disable parsing of require.js special syntax like require.config, requirejs.config, require.version and requirejs.onError.", "type": "boolean" }, "strictExportPresence": { "description": "Emit errors instead of warnings when imported names don't exist in imported module.", "type": "boolean" }, "strictThisContextOnImports": { "description": "Handle the this context correctly according to the spec for namespace objects.", "type": "boolean" }, "system": { "description": "Enable/disable parsing of System.js special syntax like System.import, System.get, System.set and System.register.", "type": "boolean" }, "unknownContextCritical": { "description": "Enable warnings when using the require function in a not statically analyse-able way.", "type": "boolean" }, "unknownContextRecursive": { "description": "Enable recursive directory lookup when using the require function in a not statically analyse-able way.", "type": "boolean" }, "unknownContextRegExp": { "description": "Sets the regular expression when using the require funct