vue-cli-plugin-git-version

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

安装

# 使用 npm
npm install -D vue-cli-plugin-git-version

# 使用 yarn
yarn add -D vue-cli-plugin-git-version

# 使用 pnpm
pnpm add -D vue-cli-plugin-git-version

使用方法

Vue CLI 项目

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

const GenBuildInfoWebpackPlugin = require('vue-cli-plugin-git-version');

module.exports = {
  configureWebpack: {
    plugins: [
      new GenBuildInfoWebpackPlugin()
    ]
  }
}

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

自定义选项

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

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

输出示例

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

{
  "name": "your-project-name",
  "version": "1.0.0",
  "branch": "main",
  "hash": "abcdef1234567890",
  "commitUser": "xkloveme ([email protected])",
  "commitContent": "Latest commit message",
  "time": "2023-04-10 15:30:45"
}

在项目中使用生成的信息

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

import versionInfo from 'public/version.json';

console.log('当前版本:', versionInfo.version);
console.log('构建时间:', versionInfo.time);

许可证

MIT © xkloveme