update readme to provide info regarding package level scans

This commit is contained in:
Grant Murphy 2017-12-13 16:35:54 +10:00
parent 02901b98fc
commit e3b6fd94c2
2 changed files with 4 additions and 12 deletions

View file

@ -64,12 +64,8 @@ $ gas -exclude=G303 ./...
#### Excluding files:
Gas can be told to \ignore paths that match a supplied pattern using the 'skip' command line option. This is
accomplished via [go-glob](github.com/ryanuber/go-glob). Multiple patterns can be specified as follows:
```
$ gas -skip=tests* -skip=*_example.go ./...
```
Gas will ignore dependencies in your vendor directory any files
that are not considered build artifacts by the compiler (so test files).
#### Annotating code

View file

@ -47,10 +47,10 @@ USAGE:
$ gas -fmt=json -out=results.json ./...
# Run a specific set of rules (by default all rules will be run):
$ gas -include=G101,G203,G401 ./...
$ gas -include=G101,G203,G401 ./...
# Run all rules except the provided
$ gas -exclude=G101 ./...
$ gas -exclude=G101 $GOPATH/src/github.com/example/project/...
`
)
@ -156,10 +156,6 @@ func main() {
// Setup usage description
flag.Usage = usage
// Exclude files
excluded := newFileList("*_test.go")
flag.Var(excluded, "skip", "File pattern to exclude from scan. Uses simple * globs and requires full or partial match")
// Parse command line arguments
flag.Parse()