gols

README

go-ls

This Go-related utility allows you to filter out folders from commandline 'wildcards' such as ./...

go-ls was created with the go '/vendor/' folder in mind, in combination with tools like go test

go-ls can be used on the commandline, or alternatively you can build its functionality into your own package.

For library usage docs, see http://godoc.org/github.com/laher/gols

Note that go-ls is simply a wrapper which Exec's go list. You can use it to feed the output into tools such as go test, go install, etc.

Why

Because lazy.

The use of /vendor/ folders has affected the use of ./... wildcards in go commands.

The Go team recommend the following approach to ignoring this folder:

go install $(go list ./... | grep -v /vendor/)

gols is basically a more convenient way to do the same thing

See bug report https://github.com/golang/go/issues/11659 for background.

Examples

For example, to run tests while excluding the 'vendor' folder:

go-test ./...

To simply list the filtered packages:

go-ls ./...

Other options:

go-ls -exec="go test -v" ./...
go-ls -exec="go install" -ignore=/vendor/,/scripts/ ./...
go-ls -h

Installation

To install go-ls only:

go get github.com/laher/gols/cmd/go-ls

Note that the other tools all have the same functionality as go-ls. They just have different defaults for the -exec option.

To install ALL of these tools (go-ls, go-test, go-install):

go get github.com/laher/gols/cmd/...

OR you can just install any one of the other tools:

go get github.com/laher/gols/cmd/go-test

Documentation

Index

• func Exec(execArr []string, pkgs []string) error
• func Ls(args []string, ignorePackageSubstrings []string, print bool) ([]string, error)
• func Main(execDefault string)

Functions

func Exec

func Exec(execArr []string, pkgs []string) error

Exec runs a given command via Exec, taking a list of packages. It doesn't ignore any packages (this should be done using Ls).

func Ls

func Ls(args []string, ignorePackageSubstrings []string, print bool) ([]string, error)

Ls is a wrapper around `go list`. It filters out unwanted packages from the results NOTE: Ls invokes "go list" via an os/exec.Command. It uses `go` from the $PATH environment variable

func Main

func Main(execDefault string)

Main runs go-ls, given a particular default