git-revision-webpack-plugin 使用教程

git-revision-webpack-plugin 使用教程

git-revision-webpack-plugin🏗 Webpack plugin that generates VERSION and COMMITHASH files during build项目地址:https://gitcode.com/gh_mirrors/gi/git-revision-webpack-plugin

1. 项目目录结构及介绍

git-revision-webpack-plugin/
├── lib/
│   ├── index.js
│   └── utils.js
├── test/
│   ├── index.test.js
│   └── utils.test.js
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

目录结构介绍

• lib/: 包含项目的主要代码文件，index.js 是插件的入口文件，utils.js 包含一些辅助函数。
• test/: 包含项目的测试文件，index.test.js 和 utils.test.js 分别对应 lib/ 目录下的文件进行测试。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
• README.md: 项目的说明文档，包含项目的介绍、安装和使用方法。
• webpack.config.js: 示例的 Webpack 配置文件，展示了如何使用 git-revision-webpack-plugin 插件。

2. 项目的启动文件介绍

项目的启动文件是 lib/index.js，它是 git-revision-webpack-plugin 插件的入口文件。该文件定义了插件的主要功能，包括生成版本号（VERSION）、提交哈希（COMMITHASH）和分支名称（BRANCH）。

主要功能

• VERSION: 生成当前版本的版本号。
• COMMITHASH: 生成当前提交的哈希值。
• BRANCH: 生成当前的分支名称。

使用示例

const GitRevisionPlugin = require('git-revision-webpack-plugin');
const gitRevision = new GitRevisionPlugin();

module.exports = {
  plugins: [
    gitRevision,
    new webpack.DefinePlugin({
      'process.env.VERSION': JSON.stringify(gitRevision.version()),
      'process.env.COMMITHASH': JSON.stringify(gitRevision.commithash()),
      'process.env.BRANCH': JSON.stringify(gitRevision.branch()),
    }),
  ],
};

3. 项目的配置文件介绍

项目的配置文件是 webpack.config.js，它展示了如何在 Webpack 配置中使用 git-revision-webpack-plugin 插件。

配置文件内容

const GitRevisionPlugin = require('git-revision-webpack-plugin');
const gitRevision = new GitRevisionPlugin();

module.exports = {
  plugins: [
    gitRevision,
    new webpack.DefinePlugin({
      'process.env.VERSION': JSON.stringify(gitRevision.version()),
      'process.env.COMMITHASH': JSON.stringify(gitRevision.commithash()),
      'process.env.BRANCH': JSON.stringify(gitRevision.branch()),
    }),
  ],
};

配置说明

• GitRevisionPlugin: 初始化 git-revision-webpack-plugin 插件实例。
• webpack.DefinePlugin: 使用 DefinePlugin 将生成的版本号、提交哈希和分支名称注入到 Webpack 构建过程中，以便在项目中使用。

通过以上配置，你可以在项目中直接使用 process.env.VERSION、process.env.COMMITHASH 和 process.env.BRANCH 来获取相应的 Git 信息。

总结

git-revision-webpack-plugin 是一个方便的 Webpack 插件，用于在构建过程中生成项目的版本号、提交哈希和分支名称。通过简单的配置，你可以在项目中轻松获取这些信息，便于版本管理和调试。

git-revision-webpack-plugin🏗 Webpack plugin that generates VERSION and COMMITHASH files during build项目地址:https://gitcode.com/gh_mirrors/gi/git-revision-webpack-plugin