Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/droptheplot/abcgo
ABC metrics for Go source code.
https://github.com/droptheplot/abcgo
abc abc-metrics go golang metrics
Last synced: 3 months ago
JSON representation
ABC metrics for Go source code.
- Host: GitHub
- URL: https://github.com/droptheplot/abcgo
- Owner: droptheplot
- License: mit
- Created: 2017-11-12T22:53:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T18:15:35.000Z (12 months ago)
- Last Synced: 2024-06-21T05:03:57.258Z (5 months ago)
- Topics: abc, abc-metrics, go, golang, metrics
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 25
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ABCGo
[](https://goreportcard.com/report/github.com/droptheplot/abcgo)
[](https://travis-ci.org/droptheplot/abcgo)
[](https://godoc.org/github.com/droptheplot/abcgo)
ABC metrics for Go source code.
## Definition
ABCGo uses these rules to calculate ABC:
* Add one to the **assignment** count when:
* Occurrence of an assignment operator: `=`, `*=`, `/=`, `%=`, `+=`, `<<=`, `>>=`, `&=`, `^=`.
* Occurrence of an increment or a decrement operator: `++`, `--`.
* Add one to **branch** count when:
* Occurrence of a function call.
* Add one to **condition** count when:
* Occurrence of a conditional operator: `<`, `>`, `<=`, `>=`, `==`, `!=`.
* Occurrence of the following keywords: `else`, `case`.
Final score is calculated as follows:
[Read more about ABC metrics.](https://en.wikipedia.org/wiki/ABC_Software_Metric)
## Getting Started
### Installation
```shell
$ go get -u github.com/droptheplot/abcgo
$ (cd $GOPATH/src/github.com/droptheplot/abcgo && go install)
```
### Usage
#### Single file
```shell
$ abcgo -path main.go
Source Func Score A B C
main.go:28 init 9 1 8 5
main.go:54 main 13 5 13 1
```
#### Directory
```shell
$ abcgo -path ./
Source Func Score A B C
main.go:28 init 9 1 8 5
main.go:54 main 13 5 13 1
main_test.go:54 TestSomething 9 0 9 2
```
#### JSON
```shell
$ abcgo -path main.go -format json
[
{
"path": "main.go",
"line": 54,
"name": "main",
"assignment": 5,
"branch": 13,
"condition": 1,
"score": 13
},
{
"path": "main.go",
"line": 54,
"name": "init",
"assignment": 1,
"branch": 8,
"condition": 5,
"score": 9
}
]
```
#### Raw
*(source, line, function name, score)*
```shell
$ abcgo -path main.go -format raw
main.go 28 init 9
main.go 54 main 13
main_test.go 54 TestSomething 9
```
#### Summary
```shell
$ abcgo -path ./ -format summary
A B C
Project summary: 22 43 15
```
### Options
* `-path [path]` - Path to file or directory.
* `-format [format]` - Output format (`table` (default), `raw` or `json`).
* `-sort` - Sort functions by score.
* `-no-test` - Skip `*_test.go` files.
### Plugins
* [Vim](https://github.com/droptheplot/abcgo/vim)