\n\n[![tests][tests]][tests-url]\n[![cover][cover]][cover-url]\n[![size][size]][size-url]\n[](https://liberamanifesto.com)\n\n# webpack-manifest-plugin\n\nA Webpack plugin for generating an asset manifest.\n\n:heart: Please consider [Sponsoring my work](https://github.com/sponsors/shellscape)\n\n## Requirements\n\n`webpack-manifest-plugin` is an [evergreen 🌲](./.github/FAQ.md#what-does-evergreen-mean) module.\n\nThis module requires an [Active LTS](https://github.com/nodejs/Release) Node version (v10.0.0+) and Webpack v4.44.0+.\n\n## Contributing\n\nThis repository leverages [pnpm](https://pnpm.js.org/) for dependency management.\n\nTo begin, please install `pnpm`:\n\n```console\n$ npm install pnpm -g\n```\n\n## Install\n\nUsing npm:\n\n```console\nnpm install webpack-nano webpack-manifest-plugin --save-dev\n```\n\n_Note: We recommend using [webpack-nano](https://github.com/shellscape/webpack-nano), a very tiny, very clean webpack CLI._\n\n## Usage\n\nCreate a `webpack.config.js` file:\n\n```js\nconst { WebpackManifestPlugin } = require('webpack-manifest-plugin');\nconst options = { ... };\n\nmodule.exports = {\n\t// an example entry definition\n\tentry: [ 'app.js'\t],\n ...\n plugins: [\n new WebpackManifestPlugin(options)\n ]\n};\n```\n\nAnd run `webpack`:\n\n```console\n$ npx wp\n```\n\nWith the default options, the example above will create a `manifest.json` file in the output directory for the build. The manifest file will contain a map of source filenames to the corresponding build output file. e.g.\n\n```json\n{\n \"dist/batman.js\": \"dist/batman.1234567890.js\",\n \"dist/joker.js\": \"dist/joker.0987654321.js\"\n}\n```\n\n### Options\n\n### `basePath`\n\nType: `String` \nDefault: `''`\n\nSpecifies a path prefix for all keys in the manifest. Useful for including your output path in the manifest.\n\n### `fileName`\n\nType: `String` \nDefault: `manifest.json`\n\nSpecifies the file name to use for the resulting manifest. By default the plugin will emit `manifest.json` to your output directory. Passing an absolute path to the `fileName` option will override both the file name and path.\n\n### `filter`\n\nType: `Function` \nDefault: `undefined`\n\nAllows filtering the files which make up the manifest. The passed function should match the signature of `(file: FileDescriptor) => Boolean`. Return `true` to keep the file, `false` to remove the file.\n\n### `generate`\n\nType: `Function` \nDefault: `undefined`\n\nA custom `Function` to create the manifest. The passed function should match the signature of `(seed: Object, files: FileDescriptor[], entries: string[]) => Object` and can return anything as long as it's serialisable by `JSON.stringify`.\n\n### `map`\n\nType: `Function` \nDefault: `undefined`\n\nAllows modifying the files which make up the manifest. The passed function should match the signature of `(file: FileDescriptor) => FileDescriptor` where an object matching `FileDescriptor` is returned.\n\n### `publicPath`\n\nType: `String` \nDefault: `.output.publicPath`\n\nA path prefix that will be added to values of the manifest.\n\n### `removeKeyHash`\n\nType: `RegExp | false` \nDefault: `/([a-f0-9]{32}\\.?)/gi`\n\nIf set to a valid `RegExp`, removes hashes from manifest keys. e.g.\n\n```json\n{\n \"index.c5a9bff71fdfed9b6046.html\": \"index.c5a9bff71fdfed9b6046.html\"\n}\n```\n\n```json\n{\n \"index.html\": \"index.c5a9bff71fdfed9b6046.html\"\n}\n```\n\nThe default value for this option is a regular expression targeting Webpack's [default md5 hash](https://webpack.js.org/configuration/output/#outputhashfunction). To target other hashing functions / algorithms, set this option to an appropriate `RegExp`. To disable replacing the hashes in key names, set this option to `false`.\n\n### `seed`\n\nType: `Object` \nDefault: `{}`\n\nA cache of key/value pairs used to seed the manifest. This may include a set of [custom key/value](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json) pairs to include in your manifest, or may be used to combine manifests across compilations in [multi-compiler mode](https://github.com/webpack/webpack/tree/master/examples/multi-compiler). To combine manifests, pass a shared seed object to each compiler's `WebpackManifestPlugin` instance.\n\n### `serialize`\n\nType: `Function(Object) => string` \nDefault: `undefined`\n\nA `Function` which can be leveraged to serialize the manifest in a different format than json. e.g. `yaml`.\n\n### `sort`\n\nType: `Function` \nDefault: `undefined`\n\nAllows sorting the files which make up the manifest. The passed function should match the signature of `(fileA: FileDescriptor, fileB: FileDescriptor) => Number`. Return `0` to indicate no change, `-1` to indicate the file should be moved to a lower index, and `1` to indicate the file shoud be moved to a higher index.\n\n### `useEntryKeys`\n\nType: `Boolean` \nDefault: `false`\n\nIf `true`, the keys specified in the `entry` property will be used as keys in the manifest. No file extension will be added (unless specified as part of an `entry` property key).\n\n### `useLegacyEmit`\n\nType: `Boolean` \nDefault: `false`\n\nIf `true`, the manifest will be written on the deprecated webpack `emit` hook to be compatible with not yet updated webpack plugins.\n\nA lot of webpack plugins are not yet updated to match the new webpack 5 API. This is a problem when other plugins use the deprecated `emit` hook. The manifest will be written before these other plugins and thus files are missing on the manifest.\n\n### `writeToFileEmit`\n\nType: `Boolean` \nDefault: `false`\n\nIf `true`, will emit the manifest to the build directory _and_ in memory for compatibility with `webpack-dev-server`.\n\n## Manifest File Descriptor\n\nThis plugin utilizes the following object structure to work with files. Many options for this plugin utilize the structure below.\n\n```ts\n{\n chunk?: Chunk;\n isAsset: boolean;\n isChunk: boolean;\n isInitial: boolean;\n isModuleAsset: boolean;\n name: string | null;\n path: string;\n}\n```\n\n### `chunk`\n\nType: [`Chunk`](https://github.com/webpack/webpack/blob/master/lib/Chunk.js)\n\nOnly available if `isChunk` is `true`\n\n### `isInitial`\n\nType: `Boolean`\n\nIs required to run you app. Cannot be `true` if `isChunk` is `false`.\n\n### `isModuleAsset`\n\nType: `Boolean`\n\nIs required by a module. Cannot be `true` if `isAsset` is `false`.\n\n## Compiler Hooks\n\nThis plugin supports the following hooks via the `getCompilerHooks` export; `afterEmit`, `beforeEmit`. These hooks can be useful, e.g. changing manifest contents before emitting to disk.\n\n### `getCompilerHooks`\n\nReturns: `{ afterEmit: SyncWaterfallHook, beforeEmit: SyncWaterfallHook }`\n\n### `assetHookStage`\n\nType: `Number`\nDefault: `Infinity`\n\nIf you need to consume the output of this plugin in another plugin, it can be useful to adjust the stage at which the manifest is generated. Pass a new stage to `assetHookStage` to change when the manifest is generated. See the [docs on `processAssets`](https://webpack.js.org/api/compilation-hooks/#list-of-asset-processing-stages) for more detail.\n\nNote: any files added to the compilation after the stage specified will not be included in the manifest.\n\n#### Usage\n\n```js\nconst { getCompilerHooks } = require('webpack-manifest-plugin');\n\nclass BatmanPlugin {\n apply(compiler) {\n const { beforeEmit } = getCompilerHooks(compiler);\n\n beforeEmit.tap('BatmanPlugin', (manifest) => {\n return { ...manifest, name: 'hello' };\n });\n }\n}\n```\n\n## Notes\n\n- If using this plugin with `webpack-clean` and `webpack-dev-server`, please review [this issue](https://github.com/shellscape/webpack-manifest-plugin/issues/267).\n\n## Attiribution\n\nSpecial thanks to [Dane Thurber](https://github.com/danethurber), the original author of this plugin, without whom this plugin would not exist.\n\n## Meta\n\n[CONTRIBUTING](./.github/CONTRIBUTING.md)\n\n[LICENSE (MIT)](./LICENSE)\n",
"licenseText": "The MIT License (MIT)\n\nCopyright (c) Dane Thurber \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
},
"artifacts": [],
"remote": {
"resolved": "https://registry.yarnpkg.com/webpack-manifest-plugin/-/webpack-manifest-plugin-4.1.1.tgz#10f8dbf4714ff93a215d5a45bcc416d80506f94f",
"type": "tarball",
"reference": "https://registry.yarnpkg.com/webpack-manifest-plugin/-/webpack-manifest-plugin-4.1.1.tgz",
"hash": "10f8dbf4714ff93a215d5a45bcc416d80506f94f",
"integrity": "sha512-YXUAwxtfKIJIKkhg03MKuiFAD72PlrqCiwdwO4VEXdRO5V0ORCNwaOwAZawPZalCbmH9kBDmXnNeQOw+BIEiow==",
"registry": "npm",
"packageName": "webpack-manifest-plugin",
"cacheIntegrity": "sha512-YXUAwxtfKIJIKkhg03MKuiFAD72PlrqCiwdwO4VEXdRO5V0ORCNwaOwAZawPZalCbmH9kBDmXnNeQOw+BIEiow== sha1-EPjb9HFP+TohXVpFvMQW2AUG+U8="
},
"registry": "npm",
"hash": "10f8dbf4714ff93a215d5a45bcc416d80506f94f"
}
![\"webpack-manfiest-plugin\"](\"https://raw.githubusercontent.com/shellscape/webpack-manifest-plugin/master/assets/manifest.svg?sanitize=true\")