inject-git-info-webpack-plugin
v1.0.0
Published
InjectGitInfoWebpackPlugin是一个Webpack插件,用于将Git分支信息和项目版本号注入到构建的HTML文件中。这可以帮助您在部署的应用中快速识别当前使用的代码版本和分支。
Downloads
2
Readme
InjectGitInfoWebpackPlugin
InjectGitInfoWebpackPlugin是一个Webpack插件,用于将Git分支信息和项目版本号注入到构建的HTML文件中。这可以帮助您在部署的应用中快速识别当前使用的代码版本和分支。
功能
- 自动获取当前Git分支名。
- 将Git分支信息和项目版本号作为meta标签注入到HTML的head部分。
- 提供选项以自定义插件行为,包括自定义命令以获取版本信息。
安装
使用npm安装:
npm install inject-git-info-webpack-plugin --save-dev
或者使用yarn:
yarn add inject-git-info-webpack-plugin --dev
使用方法
首先,将插件导入到您的Webpack配置文件中:
const InjectGitInfoWebpackPlugin = require('inject-git-info-webpack-plugin');
然后,将插件添加到您的Webpack插件数组中:
module.exports = {
// ...其他配置
plugins: [
new InjectGitInfoWebpackPlugin(options),
// ...其他插件
]
};
配置项
InjectGitInfoWebpackPlugin接受一个可选的配置对象,允许您自定义插件的行为:
- name: 项目名称,默认使用process.env["npm_package_name"]。
- version: 项目版本号,默认使用当前日期。
- command: 自定义命令来获取版本信息,默认为"git rev-parse --abbrev-ref HEAD"获取Git分支名称。
- branch: 直接指定分支名称,如果提供,将覆盖command的执行结果。
示例
将Git分支信息和自定义版本号注入到HTML中:
const InjectGitInfoWebpackPlugin = require('inject-git-info-webpack-plugin');
module.exports = {
// ...其他配置
plugins: [
new InjectGitInfoWebpackPlugin({
name: 'MyAwesomeProject',
version: '1.2.3',
}),
]
};