gosweep

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #typescript #golang #go #machine-learning #rust #docker #macos #java #vue #mcp

(★ 34)

A shell script to do various checks on Go code.

gosweep Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GoSweep

This script performs the build, test and automatic checking of a Go package and its sub-packages using:

1. [gofmt][gofmt]
2. [goimports][goimports]
3. [golint][golint]
4. [go vet][go_vet]
5. [ineffassign][ineffassign]
6. [race detector][race_detector]
7. [test coverage][test_coverage] on package and its sub-packages, `/vendor` directories excluded
8. [goveralls][goveralls]
9. [gocyclo][gocyclo]
10. [misspell][misspell]

Migrated from my [Gist](https://gist.github.com/h12w/0f22736320abe6be71ce).

## Dependencies

To setup all the dependencies need to run the script do:
```
$ go get -v github.com/client9/misspell/cmd/misspell
$ go get -v github.com/fzipp/gocyclo
$ go get -v github.com/golang/lint/golint
$ go get -v github.com/gordonklaus/ineffassign
$ go get -v github.com/h12w/gosweep
$ go get -v github.com/mattn/goveralls
$ go get -v golang.org/x/tools/cmd/goimports
```

## Environment variables

- **GOCYCLO_COMPLEXITY**: maximum allowed function complexity threshold (default: `5`).
- **MISSPELL_LOCALE**: English locale (default: `US`).

If you wish to set this for a project you can create a `.gosweep` file.
For example:

```bash
$ cat .gosweep
GOCYCLO_COMPLEXITY=5
MISSPELL_LOCALE='US'
```

## Continuous Integration

### travis-ci

Example of `.travis.yml` file for Go:

```yaml
language: go
cache:
  directories:
    - ${GOPATH}/src/github.com/${TRAVIS_REPO_SLUG}/vendor
    - ${GOPATH}/src/github.com/fzipp
    - ${GOPATH}/src/github.com/golang
    - ${GOPATH}/src/github.com/gordonklaus
    - ${GOPATH}/src/github.com/h12w
    - ${GOPATH}/src/github.com/mattn
go:
  - tip
  - 1.8
  - 1.7
  - 1.6
sudo: false

env:
    CI_SERVICE=travis-ci

install:
  - go get -v github.com/client9/misspell/cmd/misspell
  - go get -v github.com/fzipp/gocyclo
  - go get -v github.com/golang/lint/golint
  - go get -v github.com/gordonklaus/ineffassign
  - go get -v github.com/h12w/gosweep
  - go get -v github.com/mattn/goveralls
  - go get -v -u golang.org/x/tools/cmd/goimports

script:
  - bash ${GOPATH}/src/github.com/h12w/gosweep/gosweep.sh
```

[go_vet]:	http://golang.org/cmd/vet	"go vet"
[gocyclo]:  https://github.com/fzipp/gocyclo  "gocyclo"
[gofmt]:	http://golang.org/cmd/gofmt/	"gofmt"
[goimports]:	https://godoc.org/golang.org/x/tools/cmd/goimports	"golang.org/x/tools/cmd/goimports"
[golint]:	https://github.com/golang/lint	"golang/lint"
[goveralls]:	https://github.com/mattn/goveralls	"mattn/goveralls"
[ineffassign]: https://github.com/gordonklaus/ineffassign "ineffassign"
[misspell]: https://github.com/client9/misspell "misspell"
[race_detector]:	http://blog.golang.org/race-detector	"race detector"
[test_coverage]:	http://blog.golang.org/cover	"test coverage"

gosweep

gosweep Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gosweep

gosweep Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README