git-keyword-stats 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4efc6dfce8350cfb5ef60080d87c17b8b4fa6826
4
- data.tar.gz: ade0bb9c2d70beef3a5d5bb71a67af84d4e7ec72
3
+ metadata.gz: ad3346538845a5ee60c1ce3688417b478d2dcfd0
4
+ data.tar.gz: 1b7f8c76c555ab02bf1768f555276858ee26a66b
5
5
  SHA512:
6
- metadata.gz: 508f25955d470cff2e8f0255aff60741fadb3371cffead26454cefdc505cece4f17c118254d73980db44136ca10aeff2550754fa14e6724c656eb806ca198882
7
- data.tar.gz: ae6fece3018420e9471b401ffcbe5882d4b69b42ba482d9b07e862257b5fa681a688712d68c89d146c4e9c9b9d4bb3b26c119f1bad460c3854659fd91b105ecc
6
+ metadata.gz: 65fb1bce68d09e3519707401190db976f829f56eea03dd2de56ac1010450260d5a7de745fc9d4c613feb7eb456d298f0c82da625d27cdcba4e9b9c3c16d18d5f
7
+ data.tar.gz: e896967f37ecc0f3accdf9a590d60d87750435a8f01f70b531f659a183d00b7df2a4cfb8d05180da8294809b5e8f3a485ebc005fa02bc15fcd465206b96d4761
data/README.md CHANGED
@@ -1,22 +1,24 @@
1
- [![Gem Version](https://badge.fury.io/rb/git-keyword-stats.svg)](https://badge.fury.io/rb/git-keyword-stats)
1
+ [![Gem Version](https://badge.fury.io/rb/git-keyword-stats.svg)](https://rubygems.org/gems/git-keyword-stats) [![Gem](https://img.shields.io/gem/dt/git-keyword-stats.svg)](https://rubygems.org/gems/git-keyword-stats)
2
2
 
3
- Inspired by [git-swear-stats], [the Linux Kernel Fuck Count] and [its descendent],
4
- `git-keyword-stats` will give you some interesting statistics on keywording in a
5
- git repository's commit messages.
3
+ How many times are words, names or functions found in the git repository?
4
+
5
+ `Git-keyword-stats` will give you some interesting statistics on keywording in a
6
+ git repository's commit messages.
6
7
 
7
- [the Linux Kernel Fuck Count]: http://durak.org/sean/pubs/kfc/
8
- [its descendent]: http://www.vidarholen.net/contents/wordcount/
9
- [git-swear-stats]: https://github.com/xiongchiamiov/git-swear-stats
10
8
 
11
9
  # Installation
12
10
 
13
- $ gem install git-keyword-stats
11
+ ```sh
12
+ gem install git-keyword-stats
13
+ ```
14
14
 
15
15
  # Usage
16
16
 
17
- $ git-keyword-stats --help
18
- git-keyword-stats
19
-
17
+ ```sh
18
+ git-keyword-stats --help
19
+ ```
20
+
21
+ ```
20
22
  Usage:
21
23
  git-keyword-stats [options] [messages|diffs]
22
24
 
@@ -29,41 +31,64 @@ git repository's commit messages.
29
31
  --since=<sn> Log since XY ago
30
32
  --until=<un> Log until XY ago
31
33
  --config=<file> Config file path
32
-
34
+
35
+ Readme:
36
+ https://github.com/arzzen/git-keyword-stats
37
+ ```
33
38
 
34
39
  # Example Output
35
40
 
36
41
  ### With default keywords (bugfix,clear,typo,hotfix,debug,bug)
37
42
 
38
- $ git keyword-stats
43
+ ```sh
44
+ git keyword-stats
45
+ ```
46
+
47
+ ```
39
48
  Reading in git log... done!
40
49
  Parsing git log.
41
50
 
42
- +----------------+------+-------+-----+-------+--------+
43
- | Author/Keyword | typo | clear | bug | debug | readme |
44
- +----------------+------+-------+-----+-------+--------+
45
- | arzzen | 2 | 2 | 1 | 2 | 0 |
46
- | xiongchiamiov | 0 | 0 | 0 | 8 | 1 |
47
- | James Pearson | 0 | 0 | 0 | 5 | 0 |
48
- +----------------+------+-------+-----+-------+--------+
49
- | Overall | 2 | 2 | 1 | 15 | 1 |
50
- +----------------+------+-------+-----+-------+--------+
51
-
52
- ### With custom keywords file
53
-
54
- $ git keyword-stats --config="path/to/file.yml"
55
-
56
- # example config file (cat path/to/file.yml)
57
-
51
+ +----------------+--------+---------+
52
+ | Author/Keyword | rename | replace |
53
+ +----------------+--------+---------+
54
+ | arzzen | 2 | 2 |
55
+ | xiongchiamiov | 0 | 1 |
56
+ | James Pearson | 0 | 5 |
57
+ +----------------+--------+---------+
58
+ | Overall | 2 | 8 |
59
+ +----------------+--------+---------+
60
+ ```
61
+
62
+ ### Custom keywords
63
+
64
+ ##### Example config.yml
65
+
66
+ ```sh
67
+ # list of keywords
58
68
  keywords:
59
- - 'bugfix'
60
- - '^(clear)$'
61
- - 'typo'
62
- - 'hotfix'
63
- - 'readme'
64
- - 'debug'
65
- - '^(bug)$'
66
- - '^(hot|typo|bug)fix$'
67
-
69
+ # you can use plain word
70
+ - 'rename'
71
+ - 'replace'
72
+ # you can use regexp
73
+ - '^(hot|typo|bug)fix$'
74
+ - '^(love|hate|meh)$'
75
+ - '^(trash|garbage|rubbish|junk)$'
76
+ - '^(ture|treu|tuer|flase|fasle|fales)$'
77
+ ```
78
+
79
+ ##### Usage config
80
+
81
+ ```sh
82
+ git keyword-stats --config="path/to/config.yml"
83
+ ```
68
84
 
85
+ ### TL;DR
86
+
87
+ Inspired by [git-swear-stats], [the Linux Kernel Fuck Count] and [its descendent],
88
+
89
+ [the Linux Kernel Fuck Count]: http://durak.org/sean/pubs/kfc/
90
+ [its descendent]: http://www.vidarholen.net/contents/wordcount/
91
+ [git-swear-stats]: https://github.com/xiongchiamiov/git-swear-stats
92
+
93
+
69
94
 
@@ -1,9 +1,3 @@
1
1
  keywords:
2
- - 'bugfix'
3
- - '^clear$'
4
- - 'typo'
5
- - 'hotfix'
6
- - 'readme'
7
- - 'debug'
8
- - '^bug$'
9
- - '^(hot|typo|bug)fix$'
2
+ - 'rename'
3
+ - 'replace'
@@ -42,12 +42,8 @@ end
42
42
  pp options if options['--debug']
43
43
 
44
44
  default = [
45
- '^bugfix$',
46
- '^clear$',
47
- '^typo$',
48
- '^hotfix$',
49
- '^debug$',
50
- '^bug$'
45
+ '^rename$',
46
+ '^replace$'
51
47
  ]
52
48
 
53
49
  if options['--config']
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: git-keyword-stats
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.3
4
+ version: 1.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - James Pearson
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2016-11-12 00:00:00.000000000 Z
12
+ date: 2017-01-05 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: docopt
@@ -67,7 +67,6 @@ files:
67
67
  - README.md
68
68
  - Rakefile
69
69
  - bin/default.yml
70
- - bin/english.yml
71
70
  - bin/git-keyword-stats
72
71
  - bin/slovak.yml
73
72
  homepage: https://github.com/arzzen/git-keyword-stats
@@ -89,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
89
88
  version: '0'
90
89
  requirements: []
91
90
  rubyforge_project:
92
- rubygems_version: 2.5.1
91
+ rubygems_version: 2.6.8
93
92
  signing_key:
94
93
  specification_version: 4
95
94
  summary: Gather statistics on keywording in a repo.
@@ -1,9 +0,0 @@
1
- keywords:
2
- - 'bugfix'
3
- - '^(clear)$'
4
- - 'typo'
5
- - 'hotfix'
6
- - 'readme'
7
- - 'debug'
8
- - '^(bug)$'
9
- - '^(hot|typo|bug)fix$'