Add support for method name in coverage.
2 files changed
tree: 3389ad186fcbd10d7c3bceba8d48750a26209782
  1. checks/
  2. cmd/
  3. internal/
  4. samples/
  5. scm/
  6. .gitignore
  7. .travis.yml
  8. CI_SETUP.md
  9. CONFIGURATION.md
  10. DESIGN.md
  11. LICENSE
  12. main.go
  13. pre-commit-go.yml
  14. README.md
  15. TUTORIAL.md
README.md

pre-commit-go

pre-commit-go project includes two tools:

Warning

pre-commit-go is under heavy development. If you plan to use it as part of a CI, please make sure to pin your version or track it closely. We'll eventually settle and keep backward compability but the tool is not mature yet, so simply vendor it for now.

Usage

Setup

go get github.com/maruel/pre-commit-go/cmd/...

Use built-in help to list all options and commands:

pcg help

Run from within a git checkout inside $GOPATH. This installs the git hooks within .git/hooks and runs the checks in mode pre-push. It runs the checks on the diff against @{upstream}:

pcg

Bypassing hook

It may become necessary to commit something known to be broken. To bypass the pre-commit hook, use:

git commit --no-verify  (or -n)
git push --no-verify    (-n does something else! <3 git)

Running coverage

covg

You can use the -g flag to enable global inference, that is, coverage induced by a unit test will work across package boundary.

Configuration

See Configuration for more details if you want to tweak the default checks. The default checks are meant to be sensible, you can list them with:

pcg info

Continous integration support

pre-commit-go is designed to be used as part of CI. This is described in its own page.

  • Travis: Build Status
  • CircleCI: Build Status
  • Drone: Build Status
  • Coveralls: Coverage Status