This webpack plugin finds all 3rd party libraries used in a webpack build whose licenses match a given regex, and outputs the licenses for each package in your webpack build directory.
npm install license-webpack-plugin --save-dev
First, import the plugin into your webpack configuration:
var LicenseWebpackPlugin = ;
The plugin requires you to specify a regular expression for licenses to match under the pattern property.
To use the plugin, simply add it to your webpack config's plugin list.
The below example matches MIT, ISC, and any license starting with BSD. This example will also throw an error and terminate your build if it finds a license containing GPL in it.
pattern: /^$/unacceptablePattern: /GPL/abortOnUnacceptableLicense: true;
Below are all options that can be passed to the plugin:
patternA regular expression of license names to match. The license is read from the
package.jsonfor each module used in your webpack output.
unacceptablePatternA regular expression of license names that are unacceptable for the build.
abortOnUnacceptableLicenseUsed only in conjunction with the
unacceptablePatternoption, setting this to
truewill cause the plugin to throw an error and abort the build if an unacceptable license is found.
filenameThis is the output filename which gets written your webpack build directory. The default is
includeUndefinedwhether include packages without license or not. The default is
addLicenseTextwhether include license text to output file or not. The default is
addUrlwhether include url to repository to output file or not. The default is
licenseFilenamesA list of license filenames to match, in order of priority. The default is
['LICENSE', 'LICENSE.md', 'LICENSE.txt', 'license', 'license.md', 'license.txt']
licenseTemplateDirDirectory containing .txt files corresponding to SPDX license identifiers. This directory is referred to when the plugin cannot find a license file per the
licenseFilenamesproperty. Typically you would clone the SPDX master files repository and use the resulting directory containing all the various license
licenseTemplateDirfor the plugin.
licenseOverridesAn object whose keys are module names and values are filenames to use for the license file. Used when you want to override a license file for a particular module.
licenseTypeOverridesAn object whose keys are module names and values are SPDX license identifier strings (e.g.
'MIT'). Allows you to override the license type for any module.
false) Set to
trueto avoid having the plugin write error messages to the console
If a license file cannot be found and
includeUndefined property is set to
the plugin will write whatever the
license property contains in the module's
package.json and print an error.