diff --git a/plugins/golang/README.md b/plugins/golang/README.md new file mode 100644 index 0000000..b0af071 --- /dev/null +++ b/plugins/golang/README.md @@ -0,0 +1,29 @@ +# Golang plugin + +The `golang plugin` plugin adds some aliases for common [Golang](https://golang.org/) commands. + +To use it, add `golang` to the plugins array of your bashrc file: + +``` +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 | +| gom | `go mod` | Access to operations on modules | +| 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 | diff --git a/plugins/golang/golang.plugin.sh b/plugins/golang/golang.plugin.sh new file mode 100644 index 0000000..8914553 --- /dev/null +++ b/plugins/golang/golang.plugin.sh @@ -0,0 +1,17 @@ +#!/usr/bin/env bash + +alias gob='go build' +alias goc='go clean' +alias god='go doc' +alias gof='go fmt' +alias gofa='go fmt ./...' +alias gog='go get' +alias goi='go install' +alias gol='go list' +alias gom='go mod' +alias gop='cd $GOPATH' +alias gopb='cd $GOPATH/bin' +alias gops='cd $GOPATH/src' +alias gor='go run' +alias got='go test' +alias gov='go vet' \ No newline at end of file