Skip to content

Latest commit

 

History

History
 
 

README.md

git-stat-viewer Build Status npm package

Git 代码提交量统计工具,支持命令行和视图操作

功能概览

  • 代码行数统计
  • 文件格式美化
  • 计算总行数
  • 添加日期限制
  • 支持分支切换
  • 封装命令行工具
  • 视图操作

快速上手

  1. 全局安装
npm i git-stat-viewer -g
  1. 执行统计

node >= v8.9环境中,执行

gitstat g/generate [配置文件/git仓库地址/git本地仓库目录] [结果输出文件]

指定统计时间

gitstat g/generate [配置文件/git仓库地址/git本地仓库目录] [结果输出文件] --since YYYY-MM-DD --until YYYY-MM-DD

命令行若输入多个仓库地址,以,隔开

--since 可简写成 -s--until 可简写成 -u

执行完成之后,在 git-stat/dist.md 中查看统计结果

一个将输出结果在typora中展示的🌰:

user name added lines removed lines total lines
Ling 354 55 299
Ling Z 1024 99 925
  1. 清除缓存
# 清除本地缓存的git仓库
gitstat clear
# 同时清除输出的结果文件
gitstat clear --all

配置说明

config.json/yaml中,有如下参数可定义:

param type comment
repositories Array Git仓库信息
repositories[i].address String Git远程仓库地址
repositories[i].branch String Git分支
since String 统计的开始时间,格式YYYY-MM-DD
until String 统计的结束时间,格式YYYY-MM-DD
distFile String 输出的文件名,默认dist.md

如定义一个config.yaml:

# 代码仓库列表
repositories:
  -
    address: 'https://github.com/cookx/git-stat.git'
    branch: master
# 开始日期
since: 2019-1-1
# 结束日期
until: 2020-6-30
# 输出文件
distFile: dist.md

License

MIT