diff options
| author | Bjorn Stange <bjorn248@gmail.com> | 2018-10-03 12:13:48 -0400 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-03 18:13:48 +0200 |
| commit | dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a (patch) | |
| tree | d8f11c0742ff3032f9575ff4dd34cab9b5c9e4b9 /plugins | |
| parent | 544dfdd6da2ff3edc04bfd903fdb943960d743aa (diff) | |
| download | zsh-dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a.tar.gz zsh-dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a.tar.bz2 zsh-dfe7d6eca119ac58be04a2ef1bf142c3e78b6c1a.zip | |
golang: add README (#7207)
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/golang/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/plugins/golang/README.md b/plugins/golang/README.md new file mode 100644 index 000000000..72845b2a1 --- /dev/null +++ b/plugins/golang/README.md @@ -0,0 +1,29 @@ +# Golang plugin + +This plugin adds completion for the [Go Programming Language](https://golang.org/), +as well as some aliases for common Golang commands. + +To use it, add `golang` to the plugins array in your zshrc file: + +```zsh +plugins=(... golang) +``` + +## Aliases + +| Alias | Command | Description | +| ------- | ----------------------- | ------------------------------------------------------------- | +| gob | `go build` | Build your code | +| goc | `go clean` | Removes object files from package source directories | +| god | `go doc` | Prints documentation comments | +| gof | `go fmt` | Gofmt formats (aligns and indents) Go programs. | +| gofa | `go fmt ./...` | Run go fmt for all packages in current directory, recursively | +| gog | `go get` | Downloads packages and then installs them to $GOPATH | +| goi | `go install` | Compiles and installs packages to $GOPATH | +| gol | `go list` | Lists Go packages | +| gop | `cd $GOPATH` | Takes you to $GOPATH | +| gopb | `cd $GOPATH/bin` | Takes you to $GOPATH/bin | +| gops | `cd $GOPATH/src` | Takes you to $GOPATH/src | +| gor | `go run` | Compiles and runs your code | +| got | `go test` | Runs tests | +| gov | `go vet` | Vet examines Go source code and reports suspicious constructs | |