Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arzzen/git-keyword-stats
Gather statistics on keywording in a repo.
https://github.com/arzzen/git-keyword-stats
descendents git git-swear-stats gitlog keyword statistics swear
Last synced: 4 months ago
JSON representation
Gather statistics on keywording in a repo.
- Host: GitHub
- URL: https://github.com/arzzen/git-keyword-stats
- Owner: arzzen
- License: mit
- Created: 2016-11-12T11:47:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-05T09:22:45.000Z (almost 5 years ago)
- Last Synced: 2024-05-02T00:52:18.615Z (9 months ago)
- Topics: descendents, git, git-swear-stats, gitlog, keyword, statistics, swear
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://rubygems.org/gems/git-keyword-stats) [](https://rubygems.org/gems/git-keyword-stats)
How many times are words, names or functions found in the git repository?
`Git-keyword-stats` will give you some interesting statistics on keywording in a
git repository's commit messages.
# Installation
```sh
gem install git-keyword-stats
```
# Usage
```sh
git-keyword-stats --help
```
```
Usage:
git-keyword-stats [options] [messages|diffs]
Options:
-h, --help Show this screen.
--debug Print out debug messages.
--include-merges Look at merge commits.
--no-progress Don't print out progress information.
--last-month Log since 1 month ago
--since= Log since XY ago
--until= Log until XY ago
--config= Config file path
Readme:
https://github.com/arzzen/git-keyword-stats
```
# Example Output
##### With default keywords
```sh
git-keyword-stats
```
```
Reading in git log... done!
Parsing git log.
+----------------+--------+---------+
| Author/Keyword | rename | replace |
+----------------+--------+---------+
| arzzen | 2 | 2 |
| xiongchiamiov | 0 | 1 |
| James Pearson | 0 | 5 |
+----------------+--------+---------+
| Overall | 2 | 8 |
+----------------+--------+---------+
```
### Custom keywords
##### Example config.yml
```sh
# list of keywords
keywords:
# you can use plain word
- 'rename'
- 'replace'
# you can use regexp
- '^(hot|typo|bug)fix$'
- '^(love|hate|meh)$'
- '^(trash|garbage|rubbish|junk)$'
- '^(ture|treu|tuer|flase|fasle|fales)$'
```
##### Usage config
```sh
git-keyword-stats --config="path/to/config.yml"
```
### TL;DR
Inspired by [git-swear-stats], [the Linux Kernel Fuck Count] and [its descendent],
[the Linux Kernel Fuck Count]: http://durak.org/sean/pubs/kfc/
[its descendent]: http://www.vidarholen.net/contents/wordcount/
[git-swear-stats]: https://github.com/xiongchiamiov/git-swear-stats