README.md 1.95 KB
Newer Older
Bjorn Stange's avatar
Bjorn Stange committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 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                                             |
24
| gom     | `go mod`                | Access to operations on modules                               |
Bjorn Stange's avatar
Bjorn Stange committed
25
26
27
28
29
30
| 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 |