Last change
on this file since 8d391a1 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago |
initial commit
|
-
Property mode
set to
100644
|
File size:
1.3 KB
|
Line | |
---|
1 | # License Webpack Plugin
|
---|
2 |
|
---|
3 | [![Build Status](https://api.travis-ci.org/xz64/license-webpack-plugin.svg?branch=master)](https://travis-ci.org/xz64/license-webpack-plugin)
|
---|
4 |
|
---|
5 | Manage third-party license compliance in your webpack build.
|
---|
6 |
|
---|
7 | ## Installation
|
---|
8 | `npm install license-webpack-plugin --save-dev`
|
---|
9 |
|
---|
10 | ## Usage
|
---|
11 |
|
---|
12 | To use the plugin, simply add it to the plugins section in the webpack config.
|
---|
13 |
|
---|
14 | Example:
|
---|
15 | ```javascript
|
---|
16 | const LicenseWebpackPlugin = require('license-webpack-plugin').LicenseWebpackPlugin;
|
---|
17 |
|
---|
18 | module.exports = {
|
---|
19 | plugins: [
|
---|
20 | new LicenseWebpackPlugin()
|
---|
21 | ]
|
---|
22 | };
|
---|
23 | ```
|
---|
24 |
|
---|
25 | The default behavior will add a license notice file to each chunk of the webpack build. In addition, it will add a banner indicating the path to the license notice file in any Javascript assets. Third party libraries imported via external tools like SASS `@import` may not appear in the output (since webpack does not process `@import`). If this issue happens, please specify additional modules that the plugin should scan.
|
---|
26 |
|
---|
27 | To configure the plugin, check the [documentation](DOCUMENTATION.md).
|
---|
28 |
|
---|
29 | ## Build Instructions
|
---|
30 |
|
---|
31 | ```
|
---|
32 | yarn
|
---|
33 | yarn build
|
---|
34 | ```
|
---|
35 |
|
---|
36 | ## Migration Guides
|
---|
37 |
|
---|
38 | Migration guides for breaking changes are documented [here](MIGRATION.md).
|
---|
39 |
|
---|
40 | ## Changelog
|
---|
41 |
|
---|
42 | The changelog can be found [here](CHANGELOG.md).
|
---|
43 |
|
---|
44 | ## License
|
---|
45 | [ISC](https://opensource.org/licenses/ISC)
|
---|
Note:
See
TracBrowser
for help on using the repository browser.