license-checker-webpack-plugin 使用教程

1. 项目的目录结构及介绍

license-checker-webpack-plugin/
├── LICENSE
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── LicenseCheckerPlugin.js
│   └── utils.js
├── test/
│   ├── fixtures/
│   └── index.test.js
└── webpack.config.js

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件。
• src/: 项目的源代码目录。
  • index.js: 项目的入口文件。
  • LicenseCheckerPlugin.js: 插件的主要逻辑文件。
  • utils.js: 工具函数文件。
• test/: 项目的测试目录。
  • fixtures/: 测试用例的辅助文件。
  • index.test.js: 测试文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，它导入了 LicenseCheckerPlugin 并将其注册为 Webpack 插件。以下是 src/index.js 的代码示例：

const LicenseCheckerPlugin = require('./LicenseCheckerPlugin');

module.exports = LicenseCheckerPlugin;

3. 项目的配置文件介绍

项目的配置文件是 webpack.config.js，它包含了 Webpack 的配置信息，并使用了 license-checker-webpack-plugin 插件。以下是 webpack.config.js 的代码示例：

const LicenseCheckerPlugin = require('license-checker-webpack-plugin');

module.exports = {
  // 其他配置项...
  plugins: [
    new LicenseCheckerPlugin({
      allow: '(MIT OR Apache-2.0)',
      ignore: ['@microsoft/*'],
      outputFilename: 'ThirdPartyNotices.txt'
    })
  ]
};

在这个配置文件中，我们使用了 license-checker-webpack-plugin 插件，并配置了允许的许可证类型、需要忽略的包以及输出文件名。