Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 2.06 KB

README.md

File metadata and controls

56 lines (40 loc) · 2.06 KB
Raw

Installation

Tagged releases are available from GitHub.

You can use godownloader to generate a shell script that downloads and installs the latest release.

You can also install the latest commit with:

$> go install github.com/ActiveState/gometalinter-helper/cmd/gometalinter-helper

Usage

gometalinter-helper [-commit-hook] [-all] [-exe ...] -- [args to gometalinter]

This command wraps gometalinter to make it a bit simpler to use with a commit hook or in a CI environment. You can also run it as a standalone command.

It has a number of modes, depending on what arguments you pass it and the presence of an environment variable named "CI".

  • -all - If you pass this flag then it will check all Go files in the current directory tree.

  • -commit-hook - If you pass this flag then it will check new or modified files that are about to be committed in a Git repo.

  • -ignore - If you have files with zglob ignore patterns like .gitignore you can pass these files via the "-ignore". Any files matching these patterns will be ignored.

If neither "-all" nor "-commit-hook" is passed and the "CI" environment variable is set, then it will run a check of the current branch. If that branch is "master" than it checks all Go files (like the "-all" flag). Otherwise it checks Go files in the current branch that differ from master.

Finally, you can pass an explicit list of files to check. Note that if you have files starting with a dash (-) this will probably blow up horribly. Don't do that.

It will always ignore files in a directory named "vendor" or ".git".

It accepts the following arguments:

  • -all - Check all files in the tree.
  • -commit-hook - Check files that are staged for a commit.
  • -exe string - The name of the executable to run. (default "gometalinter")
  • -help - Show usage information.
  • -ignore value - Ignore all files listed in the given file. The file should be in .gitignore format. Can be passed multiple times.
  • -verbose - Be verbose about it.