@pandino/webpack-plugin-generate-manifest v0.8.31
webpack-plugin-generate-manifest
Generates Pandino Manifest JSON files based on package.json
info.
Context
This package is part of the pandino-root monorepo. For detailed information about what is Pandino / how this package fits into the ecosystem, please consult with the related documentation(s).
Install
Add the plugin to your Webpack config
// other imports
const GenerateManifestPlugin = require('@pandino/webpack-plugin-generate-manifest');
module.exports = {
...,
plugins: [
new GenerateManifestPlugin(),
],
};
OPTIONAL Set up a pandino section in your package.json file
Firstly you need to set up a pandino.manifest
section in your package.json
file.
This section may contain Pandino Manifest Header contents. By default the plugin will generate the basics based on the
info in package.json
. Any entry in this section overrides the default values, you may use this feature to override
defaults.
Example: adding a "Provide-Capability"
section to the generated Manifest file.
{
"name": "@test/test-api",
"version": "0.1.0",
"description": "Test API",
"pandino": {
"manifest": {
"Provide-Capability": "${name};type=\"DOM\";test=${test}"
}
}
}
The
"Bundle-Activator"
part of the Manifest is generated based on the Webpack context, so it should be taken care of out-of-box for any number of outputs.
Configuration options
addBundleLicenseEntry
default: true
Whether the plugin should add the Bundle-License
entry to the manifest.
bundleLicenseValue
values: 'relative-path'
| 'inline'
| 'package-license'
default: 'relative-path'
'relative-path':
This option sets the Bundle-License
header value to a relative file path, and copies the License file.
'inline':
This option inlines the License file contents to the value of the Bundle-License
header.
'package-license':
This option sets the Bundle-License
header value to whatever you have set in as a license
value in your
package.json
file.
licenseFileRegex
default: '^LICENSE(\\.txt)?$'
The regex pattern to use to find LICENSE files in our projects.
License
Eclipse Public License - v 2.0