Gathering detailed insights and metrics for git-info-plugin
Gathering detailed insights and metrics for git-info-plugin
一个非常简单的 [webpack4](https://webpack.js.org/) 插件，用于快速查看本地build的git信息，用于快速定位当前build是基于哪次提交。
Installations
npm install git-info-pluginDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=7
Node Version
14.5.0
NPM Version
6.14.5
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
xuelq007
Download Statistics
Total Downloads
2,908
Last Day
3
Last Week
34
Last Month
38
Last Year
304
GitHub Statistics
MIT License
2 Stars
54 Commits
1 Watchers
11 Branches
1 Contributors
Updated on Jan 25, 2021
Maintainers
1
Package Meta Information
Latest Version
1.1.2
Package Id
git-info-plugin@1.1.2
Unpacked Size
13.27 kB
Size
5.92 kB
File Count
11
NPM Version
6.14.5
Node Version
14.5.0
Total Downloads
Cumulative downloads
Total Downloads
2,908
Last Day
200%
3
Compared to previous day
Last Week
3,300%
34
Compared to previous week
Last Month
58.3%
38
Compared to previous month
Last Year
9%
304
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
GitInfoPlugin
一个非常简单的 webpack4 插件，用于快速查看本地build的git信息，用于快速定位当前build是基于哪次提交。
A very simple webpack4 plugin which is used to check git info of local build. it helps developers know which commit the current build is based on.
使用(Usage)
1npm install --save-dev git-info-plugin
然后在webpack.config中按照如下配置：
1var GitInfoPlugin = require('git-info-plugin') 2 3module.exports = { 4 plugins: [ 5 new GitInfoPlugin() 6 ] 7}
构建完成后，打开网页，输入快捷键(默认ctrl + shift + Enter)，打开浏览器开发者工具，在console中可以看到当前build的最新一次git commit id.
open webpage and input default shortcut (ctrl + shift + enter), then open develper tools (chrome, firefox etc..). you could see newest commit id in console:
c698cec1c6c22641692c716535dfcb21492c41ed
branch
dev
detail
c698cec1 - lq007, 2 days ago : Fix some bugs
配置 (Config)
插件有默认配置，用户可不必自行填写。 默认配置如下：
Default config is below:
1module.exports = { 2 plugins: [ 3 new GitInfoPlugin({ 4 hotKey: 'ctrl+shift+13', 5 hotKeyDelimiter: '+', 6 info: 'detail', 7 show: 'console', 8 command: '', 9 filename: 'gitInfo' 10 } 11 ] 12}
hotKeyDelimiter: '+'
快捷键分隔符，默认为'+'，用户可自行设置为‘～’，‘¥’ 等等。
user could add custom hotkey delimiter like '#','%' etc..
hotKey: 'ctrl+shift+13'
通过设置hotKey用户可自定义快捷键以免与项目已有快捷键冲突。目前支持的快捷方式是Ctrl或Shift或Alt任意组合再加键盘的keyCode，
比如回车键(Enter)的keyCode是13.
Currently, legal hot keys are 'Ctrl' or 'Shift' or 'Alt' associated with keyCode. for example: ctrl+shift+13 (13 is Enter keyCode) or ctrl+13
:warning: 注意: 1. hotKey中的分隔符应和hotKeyDelimiter中的配置保持一致。
2. hotKey之间不允许出现空格
:warning: Note: 1. the delimiter in config hotKey should be consistent with that in config hotKeyDelimiter.
2. there should be no space between hotkeys.
info: 'id' || 'branch' || 'detail'
通过info配置，用户可选择项目中展示的info信息。目前支持id, branch以及detail三种形式。
Currently, it supports 3 types of info: id, branch and detail.
show: 'console' || 'file' || 'both'
默认为console, 即git信息只有用快捷键通过开发者工具中的console显示。
console is default value. it means we could only get git info from console through hotkey.
如果设置为file，git信息将会导出到文件gitInfo.md并且无法通过使用快捷键在console中显示。
file means git info will only show in exported file.
如果设置为both，即console模式和file模式同时开启。
both means 'console' mode and 'file' mode are both available.
command: ''
默认不赋值，仅仅使用插件提供的info option当中的选项。用户可以通过command配置自定义git command. 自定义后，info配置项将失效。
user could set custom git command through the option. Note that info options will be inactive if user set custom command.
例子(example) : { command: 'git status' }
:warning:警告: 请不要使用操作性command，比如'pull','add','delete','revert','merge'等，否则编译过程将会抛错。
:warning:Warning: Please don't use operational git commands which may change current project like 'pull', 'add', 'delete', 'revert', 'merge' etc.. or webpack will throw compile error.
filename: 'gitInfo'
用户可自定义导出git信息的文件名，默认值为'gitInfo'，导出文件即为'gitInfo.md'。
user could set custom file name for exported file. by default the name is 'gitInfo.md'.
版本支持 (Webpack version)
该插件支持webpack4及以上。
it supports webpack4 or above.
依赖 (Dependency)
在成功运行GitInfoPlugin之前，在webpack.config中需要有关于HtmlWebpackPlugin配置。
The plugin runs based on webpack HtmlWebpackPlugin.
1const GitInfoPlugin = require('git-info-plugin'); 2const HtmlWebpackPlugin = require('html-webpack-plugin'); 3 4module.exports = { 5 plugins: [ 6 new HtmlWebpackPlugin({ 7 template: './src/index.html' 8 }), 9 new GitInfoPlugin() 10 ] 11}
浏览器兼容性 (browser compatibility)
Chrome >= 45
FireFox >= 34
Safari >= 9
Edge
Not support IE <= 10
这是个方便开发人员的插件，所以并不需要兼容很多浏览器对吧？我觉得有chrome就足够了 :sunglasses:
It's just a plugin for developer, so we don't have to support old browsers, right ? actually Chrome is enough :yum:
TODO
- 移除对HtmlWebpackPlugin的依赖（当前插件需要用到html-webpack-plugin的hook，将一段script插入到生成的template html当中，这样其实不太好）。
remove dependent on HtmlWebpackPlugin (hook in HtmlWebpackPlugin is needed in GitInfoPlugin).
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
57 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
- Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
- Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
- Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More