vue项目中生成LICENSE文件

vue项目中生成LICENSE文件

简介

LICENSE 文件是一个文本文件，它包含了你的项目所使用的开源软件的许可证信息。
在开发过程中，我们经常会使用到各种各样的第三方开源软件，这些软件是有版权和许可证的，我们在使用时需要遵循它们的许可证规定。LICENSE 文件就是为了记录这些许可证信息，以便其他人了解你的项目使用了哪些开源软件和它们的许可证类型。
而且，编写和包含 LICENSE 文件是一个很好的开发习惯，也是展示你的项目合规性和专业性的重要一环。

生成licence文件的步骤

这里使用license-weback-plugin插件来实现vue项目打包后的文件中生成LICENSE文件。

一、安装license-webpack-plugin

npm install --save-dev license-webpack-plugin

二、在webpack配置文件中注册插件

// 引入插件
const {
    
    LicenseWebpackPlugin} = require('license-webpack-plugin')

// 在对应webpack中的plugins模块中注册
module.exports = {
    
    
  // ...
  configureWebpack: {
    
    
    plugins: [
      new LicenseWebpackPlugin()
    ]
  }
  // ...
}

之后，在执行了 npm run build 打包指令之后，生成的dits目录下会自动创建LICENSE文件。

注意：
1、license-webpack-plugin可以根据package.json中的license字段来生成LICENSE文件，如果没有该字段，则默认使用MIT许可证。
2、如果需要自定义许可证，可以在package.json中添加license字段并设置为想要使用的许可证。

如何在package.json中简单配置license

在pacgage.json文件只能够添加license字段是为了指定项目的许可证类型。

比如一个简单的配置如下：

{
    
    
  "name": "my-project",
  "version": "1.0.0",
  "description": "My awesome Vue project",
  "author": "John Doe",
  "license": "MIT",
  "dependencies": {
    
    
    "vue": "^2.6.12"
  }
}

上面示例中，license字段被设置为了MIT，这意味着你的项目使用MIT许可证，该许可证很常用。

如果需要替换该许可证，可以尝试替换类型，比如"Apache-2.0"、"GPL-3.0"等。

如果你的项目使用了多种许可证类型的开源软件，你可以使用choosealicense.com网站提供的工具来生成一个适合你项目的LICENSE文件。在生成LICENSE文件时，你需要将其中的许可证类和版权信息替换为你的项目所使用的开源软件对应的信息。