stow/oh-my-zsh/.oh-my-zsh/plugins/golang/README.md

   1 # Golang plugin
   2
   3 This plugin adds completion for the [Go Programming Language](https://golang.org/),
   4 as well as some aliases for common Golang commands.
   5
   6 To use it, add `golang` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... golang)
  10 ```
  11
  12 ## Aliases
  13
  14 | Alias  | Command           | Description                                                   |
  15 | ------ | ----------------- | ------------------------------------------------------------- |
  16 | gob    | `go build`        | Build your code                                               |
  17 | goc    | `go clean`        | Removes object files from package source directories          |
  18 | god    | `go doc`          | Prints documentation comments                                 |
  19 | gof    | `go fmt`          | Gofmt formats (aligns and indents) Go programs.               |
  20 | gofa   | `go fmt ./...`    | Run go fmt for all packages in current directory, recursively |
  21 | gofx   | `go fix`          | Update packages to use a new API                              |
  22 | gog    | `go get`          | Downloads packages and then installs them to $GOPATH          |
  23 | gog    | `go get ./...`    | Installs all dependencies in current directory, recursively   |
  24 | goi    | `go install`      | Compiles and installs packages to $GOPATH                     |
  25 | gol    | `go list`         | Lists Go packages                                             |
  26 | gom    | `go mod`          | Access to operations on modules                               |
  27 | gopa   | `cd $GOPATH`      | Takes you to `$GOPATH`                                        |
  28 | gopb   | `cd $GOPATH/bin`  | Takes you to `$GOPATH/bin`                                    |
  29 | gops   | `cd $GOPATH/src`  | Takes you to `$GOPATH/src`                                    |
  30 | gor    | `go run`          | Compiles and runs your code                                   |
  31 | got    | `go test`         | Runs tests                                                    |
  32 | gota   | `go test ./...`   | Runs tests in all subdirectories                              |
  33 | goto   | `go tool`         | Prints all the available tools                                |
  34 | gotoc  | `go tool compile` | Generates object file                                         |
  35 | gotod  | `go tool dist`    | Utility to bootstrap, build and test go runtime               |
  36 | gotofx | `go tool fix`     | Fixes an application to use newer features                    |
  37 | gov    | `go vet`          | Vet examines Go source code and reports suspicious constructs |
  38 | gow    | `go work`         | Work provides access to operations on workspaces              |