https://github.com/euank/go-errstats
Go program to print err-check statistics about Go code
https://github.com/euank/go-errstats
Last synced: about 1 year ago
JSON representation
Go program to print err-check statistics about Go code
- Host: GitHub
- URL: https://github.com/euank/go-errstats
- Owner: euank
- License: apache-2.0
- Created: 2015-12-23T05:21:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-01T06:44:43.000Z (over 8 years ago)
- Last Synced: 2025-03-24T20:51:12.821Z (about 1 year ago)
- Language: Go
- Size: 10.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-errstats
```
I wonder what percentage of all Go code is "if err != nil"
```
It's fairly common to hear complaints that Go's error handling is verbose, unwieldy, verbose, and verbose.
I don't want to get into that argument here, other than to supply data.
## What does this do?
This is a simple program to parse your Go programs (caveat: will only work if
your program already compiles, might not play nice with build flags) and figure
out what percent of your code is `if err != nil` conditionals.
## What doesn't it work on?
Interesting tidbit, when you do `err := recover(); err != nil`, the type of
`err` there is `interface{}`, so this program doesn't catch that one.
Most importantly, this program doesn't currently handle compound conditionals (e.g. `if err != nil && foo != bar`) and is thus liable to undercount.
It also doesn't handle build tags nor any other such fancery.
If you know of other issues or want to fix any of these, issues and pull requests are quite welcome.
## Sample outputs
I arbitrarily picked a few packages I had lying around to get some sample output:
### Go standard library
```
$ go version
go version go1.8.3 linux/amd64
$ cd $GOROOT && errstats $(go list ./src/... | grep -v "builtin")
Statistics about your go files:
Total lines: 674982
Total meaningful lines: 429480
Total expressions: 2680057
Total conditionals: 46280
Total conditionals that were error checks: 2824
Percent lines that were errchecks: 0.6575393499115209
Percent expressions that were errchecks: 0.10537089323100217
Percent conditionals that were errchecks: 6.101987899740709
Percent of err != nil checks using the var 'err': 97.06090651558074
```
### rkt
```
$ git checkout v1.29.0
$ errstats $(go list github.com/rkt/rkt/... | grep -v "^github.com/rkt/rkt/vendor/")
Statistics about your go files:
Total lines: 45958
Total meaningful lines: 25017
Total expressions: 169199
Total conditionals: 3837
Total conditionals that were error checks: 1923
Percent lines that were errchecks: 7.686772994363833
Percent expressions that were errchecks: 1.1365315397845142
Percent conditionals that were errchecks: 50.11727912431587
Percent of err != nil checks using the var 'err': 98.54394175767031
```
### Docker
```
$ git rev-parse --short HEAD
9b4a616e4b # better known as v18.01.0-ce
$ errstats $(sort <(go list ./...) <(go list ./vendor/... ./contrib/...) | uniq -u | grep -v "integration-cli")
Statistics about your go files:
Total lines: 110203
Total meaningful lines: 62945
Total expressions: 436162
Total conditionals: 10038
Total conditionals that were error checks: 4121
Percent lines that were errchecks: 6.546985463499881
Percent expressions that were errchecks: 0.9448324246495567
Percent conditionals that were errchecks: 41.053994819685194
Percent of err != nil checks using the var 'err': 98.9080320310604
```
## Logrus
```
$ git rev-parse --short HEAD
446d1c1
$ errstats $(go list github.com/Sirupsen/logrus/...)
Statistics about your go files:
Total lines: 1277
Total meaningful lines: 661
Total expressions: 4768
Total conditionals: 68
Total conditionals that were error checks: 9
Percent lines that were errchecks: 1.361573373676248
Percent expressions that were errchecks: 0.18875838926174499
Percent conditionals that were errchecks: 13.23529411764706
Percent of err != nil checks using the var 'err': 100
```
## Martini
```
$ git rev-parse --short HEAD
15a4762
$ errstats $(go list github.com/go-martini/martini/...)
Statistics about your go files:
Total lines: 1088
Total meaningful lines: 595
Total expressions: 4335
Total conditionals: 67
Total conditionals that were error checks: 8
Percent lines that were errchecks: 1.3445378151260505
Percent expressions that were errchecks: 0.1845444059976932
Percent conditionals that were errchecks: 11.940298507462686
Percent of err != nil checks using the var 'err': 100
```
## http2
```
$ git rev-parse --short HEAD
6c89489
$ errstats $(go list golang.org/x/net/http2/...)
Statistics about your go files:
Total lines: 8072
Total meaningful lines: 4652
Total expressions: 29802
Total conditionals: 636
Total conditionals that were error checks: 79
Percent lines that were errchecks: 1.6981943250214964
Percent expressions that were errchecks: 0.2650828803436011
Percent conditionals that were errchecks: 12.421383647798741
Percent of err != nil checks using the var 'err': 98.73417721518987
```
## ecs-agent
```
$ git checkout v1.7.0
$ cat <(. ./scripts/shared_env; errstats $(go list github.com/aws/amazon-ecs-agent/agent/...))
Statistics about your go files:
Total lines: 19539
Total meaningful lines: 9346
Total expressions: 64451
Total conditionals: 807
Total conditionals that were error checks: 217
Percent lines that were errchecks: 2.3218489193237746
Percent expressions that were errchecks: 0.33668988844238257
Percent conditionals that were errchecks: 26.889714993804215
Percent of err != nil checks using the var 'err': 97.6958525345622
```
## kubernetes
```
$ git describe
v1.9.2
$ errstats $(go list ./... | grep -v -E "^k8s.io/kubernetes/test")
# can't load package: package k8s.io/kubernetes/staging/src/k8s.io/api/admission/v1beta1: code in directory /home/esk/dev/kgo/src/k8s.io/kubernetes/staging/src/k8s.io/api/admission/v1beta1 expects import "k8s.io/api/admission/v1beta1"
# .... tons of the above
Statistics about your go files:
Total lines: 660010
Total meaningful lines: 332256
Total expressions: 2423393
Total conditionals: 40284
Total conditionals that were error checks: 11724
Percent lines that were errchecks: 3.528604449581046
Percent expressions that were errchecks: 0.4837845120457145
Percent conditionals that were errchecks: 29.103366100685136
Percent of err != nil checks using the var 'err': 97.77379733879222
```