Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bkielbasa/cyclop

go golang linter

Last synced: 9 days ago
JSON representation

Host: GitHub
URL: https://github.com/bkielbasa/cyclop
Owner: bkielbasa
License: mit
Created: 2020-05-04T10:53:58.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2023-11-29T13:30:08.000Z (7 months ago)
Last Synced: 2024-06-18T15:37:35.241Z (9 days ago)
Topics: go, golang, linter
Language: Go
Homepage:
Size: 44.9 KB
Stars: 45
Watchers: 3
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Lists

awesome-github-star - cyclop

README

        # cyclop

[![Coverage Status](https://coveralls.io/repos/github/bkielbasa/cyclop/badge.svg?branch=master)](https://coveralls.io/github/bkielbasa/cyclop?branch=master)

Cyclop calculates cyclomatic complexities of functions or packages in Go source code.

## Why cyclop?

Cyclop, compared to [other alternative](https://github.com/fzipp/gocyclo), calculates both function and package cyclomatic complexity.

## Usage

```

go get github.com/bkielbasa/cyclop/cmd/cyclop

cyclop .

```

Available parameters:

* `-maxComplexity int` - the max complexity calculated for a single function. `10` by default

* `-packageAverage float64` - the average cyclomatic complexity for a package. If the value is higher than `0` it will raise an error if the average will be higher. `0` default. 

* `-skipTests bool` - should checks be executed in tests files. `false` by default