\n
![\"\"](\"https://raw.githubusercontent.com/codepunkt/webpack-license-plugin/master/docs/logo.png\"){kind=logo}
\n \n webpack-license-plugin\n
\n
\n \n \n ![](\"https://img.shields.io/npm/v/webpack-license-plugin.svg?logo=npm&style=popout\"/)
\n \n \n ![\"Continuous](\"https://img.shields.io/github/actions/workflow/status/codepunkt/webpack-license-plugin/test.yml?branch=main&style=popout&logo=github&logoColor=ddd\")
![\"Code](\"https://img.shields.io/codecov/c/github/codepunkt/webpack-license-plugin/master.svg?style=popout&logo=codecov\")
\n \n \n ![\"License:](\"https://img.shields.io/npm/l/webpack-license-plugin.svg?style=popout&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgd2lkdGg9IjMyIiBoZWlnaHQ9IjMyIiB2aWV3Qm94PSIzIDMgMjYgMjYiPgogIDxwYXRoIGZpbGw9IiMzZGE2MzkiIGQ9Ik0xNiA1LjU1OWMtNi4xMTggMC0xMS4wNzggNC45Ni0xMS4wNzggMTEuMDc5IDAgNC43NDkgMi45ODkgOC43OTkgNy4xODggMTAuMzc0bDIuNTUzLTYuODA4YTMuODA4IDMuODA4IDAgMSAxIDIuNjc0IDBsMi41NTMgNi44MDhjNC4xOTktMS41NzUgNy4xODgtNS42MjUgNy4xODgtMTAuMzc0IDAtNi4xMTktNC45Ni0xMS4wNzktMTEuMDc5LTExLjA3OXoiLz4KPC9zdmc+Cg==&colorB=lightgray\")
\n \n \n ![\"Contact](\"https://img.shields.io/badge/tweet-⇢-1da1f3.svg?logo=twitter&style=popout\"){kind=icon}
\n \n
\n Key Features •\n Installation •\n How to use •\n Available options •\n Examples\n
\n\n# Key features\n\nThis plugin extracts _open source license information_ about all of the packages in your webpack output and helps you identify and fix problems with your open source licensing policy.\n\nThis plugin has full unit and end to end test coverage and is tested with **webpack 2, 3, 4 and 5**. It will help you:\n\n- Discover every package used in your webpack output\n- Find out how it is licensed\n- Cancel builds that include unacceptable licenses\n- Exclude internal packages from being scanned\n- Create a customized inventory (usually called _bill of materials_) in `json`, `html`, `csv` or other formats\n\n# Installation\n\nInstall `webpack-license-plugin` as a development dependency to your current project\n\n#### npm\n\n```console\n$ npm install -D webpack-license-plugin\n```\n\n#### Yarn\n\n```console\n$ yarn add -D webpack-license-plugin\n```\n\n# How to use\n\nUse `webpack-license-plugin` in your webpack configuration by adding it to the `plugins` array.\n\n```js\nconst LicensePlugin = require('webpack-license-plugin')\n\nmodule.exports = {\n plugins: [\n // there might be other plugins here\n new LicensePlugin()\n ],\n}\n```\n\n# Available options\n\nOptions are given as an `Object` to the first parameter of the `LicensePlugin` constructor:\n\n```js\nconst licensePlugin = new LicensePlugin({ outputFilename: 'thirdPartyNotice.json' })\n```\n\nThe available options are:\n\n| Name | Description |\n| :------------- | :----------------------------------------------------------------------------------------------------------------------- |\n| **`additionalFiles`** | Default: `{}`. Object that defines additional files that should be generated by this plugin based on it's default output (e.g. an html representation of the licenses in addition to the generated json). Keys represent filenames, values are functions that get invoked with the packages array and should return the content written to the additional file. These functions can be async or return a Promise. |\n| **`excludedPackageTest`** | A method to exclude packages from the process. It is invoked with `packageName` (string) and `version` (string) of every package and should return true to exclude the package. |\n| **`licenseOverrides`** | Default: `{}`. Object with licenses to override. Keys have the format `