webpack-plugin-git-stamp

插件简介

webpack-plugin-git-stamp 是一个 Webpack 插件，用于在构建完成后记录 Git 相关的信息，包括分支名称、提交哈希、提交信息、提交作者、最新标签以及构建时间等。这些信息将被写入到指定的 JSON 文件中，帮助开发者追溯构建版本，避免版本不一致的问题。

功能特性

• 自动获取 Git 相关信息：
  • 分支名称
  • 提交哈希
  • 提交信息
  • 提交作者
  • 最新标签
  • 构建时间
• 将 Git 版本信息写入构建目录下的 JSON 文件
• 适用于 Webpack 4，支持 Windows、Linux 和 macOS 等操作系统
• 简单易用，可以帮助构建产物的版本追踪和问题排查

安装

使用 npm 或 yarn 将插件安装为开发依赖：

npm install --save-dev webpack-plugin-git-stamp

或者

yarn add --dev webpack-plugin-git-stamp

使用方法

在 Webpack 配置文件 webpack.config.js 中引入并使用该插件：

// webpack.config.js
const path = require('path');
const GitStampPlugin = require('webpack-plugin-git-stamp'); // 引入插件

module.exports = {
  // 其他 Webpack 配置...
  plugins: [
    new GitStampPlugin({
      outDir: 'build',           // 可选，指定输出目录，默认是 'dist'
      fileName: 'version.json'   // 可选，指定输出的 JSON 文件名称，默认是 'version.json'
    }),
  ],
};

插件选项

插件接受一个配置对象，支持以下选项：

• outDir：string
  构建产物的输出目录，默认为 'dist'。可以设置为其他目录，如 'build'。

• fileName：string
  输出的 JSON 文件名称，默认为 'version.json'。可以自定义文件名。

构建输出

在运行 webpack 构建后，插件会自动生成一个 JSON 文件，包含以下内容：

• branch: 当前 Git 分支名称
• commitHash: 最新提交的哈希值
• commitMessage: 最新提交的信息
• commitAuthor: 最新提交的作者
• latestTag: 最新标签（如果有）
• buildTime: 构建时间

该文件默认保存在构建目录（dist 或你指定的目录）下，文件名为 version.json。

兼容性与注意事项

• Git 依赖：
  插件依赖于 Git 命令，确保在构建环境中安装了 Git 并且 Git 命令可用。如果是在 CI/CD 环境中构建，请确保构建环境配置了 Git。

• 跨平台支持：
  本插件在 Windows、Linux 和 macOS 等操作系统下均可正常工作。

• 权限问题：
  请确保构建目录具有写入权限，否则插件无法创建输出的 JSON 文件。

• CI/CD 环境：
  在某些 CI/CD 环境中，可能需要调整 Git 克隆策略以确保获取到完整的 Git 历史信息，避免因为浅克隆导致无法获取某些 Git 信息。

许可证

该插件采用 MIT License 开源许可证。