vue-cli-plugin-git-version

为 Vue CLI 项目生成 version.json 文件，包含项目版本和 Git 信息。

安装

1# 使用 npm
2npm install -D vue-cli-plugin-git-version
3
4# 使用 yarn
5yarn add -D vue-cli-plugin-git-version
6
7# 使用 pnpm
8pnpm add -D vue-cli-plugin-git-version

使用方法

Vue CLI 项目

在您的 Vue CLI 项目的 vue.config.js 文件中添加以下配置：

1const GenBuildInfoWebpackPlugin = require('vue-cli-plugin-git-version');
2
3module.exports = {
4  configureWebpack: {
5    plugins: [
6      new GenBuildInfoWebpackPlugin()
7    ]
8  }
9}

这将在构建过程中自动生成 version.json 文件。

自定义选项

您可以自定义输出文件的目录和文件名：

1new GenBuildInfoWebpackPlugin({
2  fileDir: 'path/to/custom/directory',
3  fileName: 'custom-version.json'
4})

输出示例

生成的 version.json 文件内容示例：

1{
2  "name": "your-project-name",
3  "version": "1.0.0",
4  "branch": "main",
5  "hash": "abcdef1234567890",
6  "commitUser": "xkloveme (xkloveme@example.com)",
7  "commitContent": "Latest commit message",
8  "time": "2023-04-10 15:30:45"
9}

在项目中使用生成的信息

您可以在项目中读取生成的 version.json 文件来使用这些信息：

1import versionInfo from 'public/version.json';
2
3console.log('当前版本:', versionInfo.version);
4console.log('构建时间:', versionInfo.time);

许可证

MIT © xkloveme