Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahlo/go-styleguide
🏆 Opinionated Styleguide for the Go language
https://github.com/bahlo/go-styleguide
effective go golang styleguide
Last synced: 21 days ago
JSON representation
🏆 Opinionated Styleguide for the Go language
- Host: GitHub
- URL: https://github.com/bahlo/go-styleguide
- Owner: bahlo
- License: unlicense
- Created: 2017-07-29T10:03:30.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T17:05:35.000Z (3 months ago)
- Last Synced: 2024-10-01T21:43:53.415Z (about 1 month ago)
- Topics: effective, go, golang, styleguide
- Homepage:
- Size: 83 KB
- Stars: 1,490
- Watchers: 32
- Forks: 126
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - bahlo/go-styleguide
- awesome-golang-repositories - go-styleguide
- awesome-list - go-styleguide
- awesome-go-extra - go-styleguide - 07-29T10:03:30Z|2022-08-17T07:57:52Z| (Style Guides / Other Software)
README
# Go Styleguide
This serves as a supplement to
[Effective Go](https://golang.org/doc/effective_go.html), based on years of
experience and inspiration/ideas from conference talks.
## Table of contents
- [Add context to errors](#add-context-to-errors)
- [Consistent error and log messages](#consistent-error-and-log-messages)
- [Dependency management](#dependency-management)
- [Use modules](#use-modules)
- [Use Semantic Versioning](#use-semantic-versioning)
- [Structured logging](#structured-logging)
- [Avoid global variables](#avoid-global-variables)
- [Keep the happy path left](#keep-the-happy-path-left)
- [Testing](#testing)
- [Use an assert library](#use-an-assert-library)
- [Use sub-tests to structure functional tests](#use-sub-tests-to-structure-functional-tests)
- [Use table-driven tests](#use-table-driven-tests)
- [Avoid mocks](#avoid-mocks)
- [Avoid DeepEqual](#avoid-deepequal)
- [Avoid testing unexported funcs](#avoid-testing-unexported-funcs)
- [Add examples to your test files to demonstrate usage](#add-examples-to-your-test-files-to-demonstrate-usage)
- [Use linters](#use-linters)
- [Use goimports](#use-goimports)
- [Use meaningful variable names](#use-meaningful-variable-names)
- [Avoid side effects](#avoid-side-effects)
- [Favour pure functions](#favour-pure-functions)
- [Don't over-interface](#dont-over-interface)
- [Don't under-package](#dont-under-package)
- [Handle signals](#handle-signals)
- [Divide imports](#divide-imports)
- [Avoid unadorned return](#avoid-unadorned-return)
- [Use canonical import path](#use-canonical-import-path)
- [Avoid empty interface](#avoid-empty-interface)
- [Main first](#main-first)
- [Use internal packages](#use-internal-packages)
- [Avoid helper/util](#avoid-helperutil)
- [Embed binary data](#embed-binary-data)
- [Use `io.WriteString`](#use-iowritestring)
- [Use functional options](#use-functional-options)
- [Structs](#structs)
- [Use named structs](#use-named-structs)
- [Avoid new keyword](#avoid-new-keyword)
- [Consistent header naming](#consistent-header-naming)
- [Avoid magic numbers](#avoid-magic-numbers)
- [Use context for cancellation](#use-context-for-cancellation)
- [Avoid panic in production](#avoid-panic-in-production)
- [Error handling and error types](#error-handling-and-error-types)
- [Code formatting](#code-formatting)
- [Concurrency patterns](#concurrency-patterns)
- [Package documentation](#package-documentation)
- [Avoid unnecessary abstraction](#avoid-unnecessary-abstraction)
## Add context to errors
**Don't:**
```go
file, err := os.Open("foo.txt")
if err != nil {
return err
}
```
Using the approach above can lead to unclear error messages because of missing
context.
**Do:**
```go
file, err := os.Open("foo.txt")
if err != nil {
return fmt.Errorf("open foo.txt failed: %w", err)
}
```
Wrapping errors with a custom message provides context as it gets propagated up
the stack.
This does not always make sense.
If you're unsure if the context of a returned error is at all times sufficient,
wrap it.
## Dependency management
### Use modules
Use [modules](https://github.com/golang/go/wiki/Modules), since it is the built-in go dependency
management tooling and will be widely supported (available with Go 1.11+).
### Use Semantic Versioning
Tag your packages using [Semantic Versioning](http://semver.org), check the [modules wiki](https://github.com/golang/go/wiki/Modules#how-to-prepare-for-a-release) for more information about
best practices regarding releases.
The git tag for your go package should have the format `v..`, e.g., `v1.0.1`.
## Structured logging
**Don't:**
```go
log.Printf("Listening on :%d", port)
http.ListenAndServe(fmt.Sprintf(":%d", port), nil)
// 2017/07/29 13:05:50 Listening on :80
```
**Do:**
```go
import "github.com/sirupsen/logrus"
// ...
logger.WithField("port", port).Info("Server is listening")
http.ListenAndServe(fmt.Sprintf(":%d", port), nil)
// {"level":"info","msg":"Server is listening","port":"7000","time":"2017-12-24T13:25:31+01:00"}
```
This is a harmless example, but using structured logging makes debugging and log
parsing easier.
## Avoid global variables
**Don't:**
```go
var db *sql.DB
func main() {
db = // ...
http.HandleFunc("/drop", DropHandler)
// ...
}
func DropHandler(w http.ResponseWriter, r *http.Request) {
db.Exec("DROP DATABASE prod")
}
```
Global variables make testing and readability hard and every method has access
to them (even those, that don't need it).
**Do:**
```go
func main() {
db := // ...
handlers := Handlers{DB: db}
http.HandleFunc("/drop", handlers.DropHandler)
// ...
}
type Handlers struct {
DB *sql.DB
}
func (h *Handlers) DropHandler(w http.ResponseWriter, r *http.Request) {
h.DB.Exec("DROP DATABASE prod")
}
```
Use structs to encapsulate the variables and make them available only to those functions that actually need them by making them methods implemented for that struct.
Alternatively, higher-order functions can be used to inject dependencies via closures.
```go
func main() {
db := // ...
http.HandleFunc("/drop", DropHandler(db))
// ...
}
func DropHandler(db *sql.DB) http.HandleFunc {
return func (w http.ResponseWriter, r *http.Request) {
db.Exec("DROP DATABASE prod")
}
}
```
If you really need global variables or constants, e.g., for defining errors or string constants, put them at the top of your file.
**Don't:**
```go
import "xyz"
func someFunc() {
//...
}
const route = "/some-route"
func someOtherFunc() {
// usage of route
}
var NotFoundErr = errors.New("not found")
func yetAnotherFunc() {
// usage of NotFoundErr
}
```
**Do:**
```go
import "xyz"
const route = "/some-route"
var NotFoundErr = errors.New("not found")
func someFunc() {
//...
}
func someOtherFunc() {
// usage of route
}
func yetAnotherFunc() {
// usage of NotFoundErr
}
```
## Keep the happy path left
**Don't:**
```go
if item, ok := someMap[someKey]; ok {
return item
}
return ErrKeyNotFound
```
**Do:**
```go
item, ok := someMap[someKey]
if !ok {
return ErrKeyNotFound
}
return item
```
This helps to keep your code clear and readable. Not doing it accumulates in
larger functions and leads to the happy path being buried in a lot of if/for/...
statements.
## Testing
### Use an assert library
**Don't:**
```go
func TestAdd(t *testing.T) {
actual := 2 + 2
expected := 4
if (actual != expected) {
t.Errorf("Expected %d, but got %d", expected, actual)
}
}
```
**Do:**
```go
import "github.com/stretchr/testify/assert"
func TestAdd(t *testing.T) {
actual := 2 + 2
expected := 4
assert.Equal(t, expected, actual)
}
```
Using assert libraries makes your tests more readable, requires less code and
provides consistent error output.
### Use sub-tests to structure functional tests
**Don't:**
```go
func TestSomeFunctionSuccess(t *testing.T) {
// ...
}
func TestSomeFunctionWrongInput(t *testing.T) {
// ...
}
```
**Do:**
```go
func TestSomeFunction(t *testing.T) {
t.Run("success", func(t *testing.T){
//...
})
t.Run("wrong input", func(t *testing.T){
//...
})
}
```
### Use table driven tests
**Don't:**
```go
func TestAdd(t *testing.T) {
assert.Equal(t, 1+1, 2)
assert.Equal(t, 1+-1, 0)
assert.Equal(t, 1, 0, 1)
assert.Equal(t, 0, 0, 0)
}
```
The above approach looks simpler, but it's much harder to find a failing case,
especially when having hundreds of cases.
**Do:**
```go
func TestAdd(t *testing.T) {
cases := []struct {
A, B, Expected int
}{
{1, 1, 2},
{1, -1, 0},
{1, 0, 1},
{0, 0, 0},
}
for _, tc := range cases {
tc := tc
t.Run(fmt.Sprintf("%d + %d", tc.A, tc.B), func(t *testing.T) {
t.Parallel()
assert.Equal(t, tc.Expected, tc.A+tc.B)
})
}
}
```
Using table-driven tests in combination with subtests gives you direct insight
about which case is failing and which cases are tested.
– [Mitchell Hashimoto at GopherCon 2017](https://youtu.be/8hQG7QlcLBk?t=7m34s)
Running subtests in parallel allow you to have a lot more test cases and still get those awesomely fast go build times.
– [The Go Blog](https://blog.golang.org/subtests)
A `tc := tc` is needed. Because without it, only one of the cases would be checked.
– [Be Careful with Table Driven Tests and t.Parallel()](https://gist.github.com/posener/92a55c4cd441fc5e5e85f27bca008721)
### Avoid mocks
**Don't:**
```go
func TestRun(t *testing.T) {
mockConn := new(MockConn)
run(mockConn)
}
```
**Do:**
```go
import "github.com/stretchr/testify/assert"
func TestRun(t *testing.T) {
ln, err := net.Listen("tcp", "127.0.0.1:0")
assert.Nil(t, err)
go func() {
defer ln.Close()
_, err := ln.Accept()
assert.Nil(t, err)
}()
client, err := net.Dial("tcp", ln.Addr().String())
assert.Nil(t, err)
run(client)
}
```
Only use mocks if not otherwise possible, favor real implementations.
– [Mitchell Hashimoto at GopherCon 2017](https://youtu.be/8hQG7QlcLBk?t=26m51s)
### Avoid DeepEqual
**Don't:**
```go
type myType struct {
id int
name string
irrelevant []byte
}
func TestSomething(t *testing.T) {
actual := &myType{/* ... */}
expected := &myType{/* ... */}
assert.True(t, reflect.DeepEqual(expected, actual))
}
```
**Do:**
```go
type myType struct {
id int
name string
irrelevant []byte
}
func (m *myType) testString() string {
return fmt.Sprintf("%d.%s", m.id, m.name)
}
func TestSomething(t *testing.T) {
actual := &myType{/* ... */}
expected := &myType{/* ... */}
if actual.testString() != expected.testString() {
t.Errorf("Expected '%s', got '%s'", expected.testString(), actual.testString())
}
// or assert.Equal(t, actual.testString(), expected.testString())
}
```
Using `testString()` for comparing structs helps on complex structs with many
fields that are not relevant for the equality check.
This approach only makes sense for very big or tree-like structs.
– [Mitchell Hashimoto at GopherCon 2017](https://youtu.be/8hQG7QlcLBk?t=30m45s)
Google open sourced their [go-cmp](http://github.com/google/go-cmp) package as a more powerful and safer alternative to `reflect.DeepEqual`.
– [Joe Tsai](https://twitter.com/francesc/status/885630175668346880).
### Avoid testing unexported funcs
Only test unexported funcs if you can't access a path via exported funcs.
Since they are unexported, they are prone to change.
### Add examples to your test files to demonstrate usage
```go
func ExampleSomeInterface_SomeMethod(){
instance := New()
result, err := instance.SomeMethod()
fmt.Println(result, err)
// Output: someResult,
}
```
## Use linters
Use all the linters included in [golangci-lint](https://github.com/golangci/golangci-lint) to lint your projects before committing.
```bash
# Installation - replace vX.X.X with the version you want to use
GO111MODULE=on go get github.com/golangci/golangci-lint/cmd/[email protected]
# traditional way without go module
go get -u github.com/golangci/golangci-lint/cmd/golangci-lint
# Usage in the project workspace
golangci-lint run
```
For detailed usage and the ci-pipeline installation guide visit [golangci-lint](https://github.com/golangci/golangci-lint).
## Use goimports
Only commit gofmt'd files. Use `goimports` for this to format/update the import statements as well.
## Use meaningful variable names
Avoid single-letter variable names. They may seem more readable to you at the moment of writing but they make the code hard to understand for your colleagues and your future self.
**Don't:**
```go
func findMax(l []int) int {
m := l[0]
for _, n := range l {
if n > m {
m = n
}
}
return m
}
```
**Do:**
```go
func findMax(inputs []int) int {
max := inputs[0]
for _, value := range inputs {
if value > max {
max = value
}
}
return max
}
```
Single-letter variable names are fine in the following cases.
* They are absolute standard like ...
* `t` in tests
* `r` and `w` in http request handlers
* `i` for the index in a loop
* They name the receiver of a method, e.g., `func (s *someStruct) myFunction(){}`
Of course also too long variables names like `createInstanceOfMyStructFromString` should be avoided.
## Avoid side-effects
**Don't:**
```go
func init() {
someStruct.Load()
}
```
Side effects are only okay in special cases (e.g. parsing flags in a cmd).
If you find no other way, rethink and refactor.
## Favour pure functions
> In computer programming, a function may be considered a pure function if both of the following statements about the function hold:
> 1. The function always evaluates the same result value given the same argument value(s). The function result value cannot depend on any hidden information or state that may change while program execution proceeds or between different executions of the program, nor can it depend on any external input from I/O devices.
> 2. Evaluation of the result does not cause any semantically observable side effect or output, such as mutation of mutable objects or output to I/O devices.
– [Wikipedia](https://en.wikipedia.org/wiki/Pure_function)
**Don't:**
```go
func MarshalAndWrite(some *Thing) error {
b, err := json.Marshal(some)
if err != nil {
return err
}
return ioutil.WriteFile("some.thing", b, 0644)
}
```
**Do:**
```go
// Marshal is a pure func (even though useless)
func Marshal(some *Thing) ([]bytes, error) {
return json.Marshal(some)
}
// ...
```
This is obviously not possible at all times, but trying to make every possible
func pure makes code more understandable and improves debugging.
## Don't over-interface
**Don't:**
```go
type Server interface {
Serve() error
Some() int
Fields() float64
That() string
Are([]byte) error
Not() []string
Necessary() error
}
func debug(srv Server) {
fmt.Println(srv.String())
}
func run(srv Server) {
srv.Serve()
}
```
**Do:**
```go
type Server interface {
Serve() error
}
func debug(v fmt.Stringer) {
fmt.Println(v.String())
}
func run(srv Server) {
srv.Serve()
}
```
Favour small interfaces and only expect the interfaces you need in your funcs.
## Don't under-package
Deleting or merging packages is far easier than splitting big ones up.
When unsure if a package can be split, do it.
## Handle signals
**Don't:**
```go
func main() {
for {
time.Sleep(1 * time.Second)
ioutil.WriteFile("foo", []byte("bar"), 0644)
}
}
```
**Do:**
```go
func main() {
logger := // ...
sc := make(chan os.Signal, 1)
done := make(chan bool)
go func() {
for {
select {
case s := <-sc:
logger.Info("Received signal, stopping application",
zap.String("signal", s.String()))
done <- true
return
default:
time.Sleep(1 * time.Second)
ioutil.WriteFile("foo", []byte("bar"), 0644)
}
}
}()
signal.Notify(sc, os.Interrupt, os.Kill)
<-done // Wait for go-routine
}
```
Handling signals allows us to gracefully stop our server, close open files and
connections and therefore prevent file corruption among other things.
## Divide imports
**Don't:**
```go
import (
"encoding/json"
"github.com/some/external/pkg"
"fmt"
"github.com/this-project/pkg/some-lib"
"os"
)
```
**Do:**
```go
import (
"encoding/json"
"fmt"
"os"
"github.com/bahlo/this-project/pkg/some-lib"
"github.com/bahlo/another-project/pkg/some-lib"
"github.com/bahlo/yet-another-project/pkg/some-lib"
"github.com/some/external/pkg"
"github.com/some-other/external/pkg"
)
```
Divide imports into four groups sorted from internal to external for readability:
1. Standard library
2. Project internal packages
3. Company internal packages
4. External packages
## Avoid unadorned return
**Don't:**
```go
func run() (n int, err error) {
// ...
return
}
```
**Do:**
```go
func run() (n int, err error) {
// ...
return n, err
}
```
Named returns are good for documentation, unadorned returns are bad for
readability and error-prone.
## Use canonical import path
**Don't:**
```go
package sub
```
**Do:**
```go
package sub // import "github.com/my-package/pkg/sth/else/sub"
```
Adding the canonical import path adds context to the package and makes
importing easy.
## Avoid empty interface
**Don't:**
```go
func run(foo interface{}) {
// ...
}
```
Empty interfaces make code more complex and unclear, avoid them where you can.
## Main first
**Don't:**
```go
package main // import "github.com/me/my-project"
func someHelper() int {
// ...
}
func someOtherHelper() string {
// ...
}
func Handler(w http.ResponseWriter, r *http.Reqeust) {
// ...
}
func main() {
// ...
}
```
**Do:**
```go
package main // import "github.com/me/my-project"
func main() {
// ...
}
func Handler(w http.ResponseWriter, r *http.Reqeust) {
// ...
}
func someHelper() int {
// ...
}
func someOtherHelper() string {
// ...
}
```
Putting `main()` first makes reading the file a lot easier. Only the
`init()` function should be above it.
## Use internal packages
If you're creating a cmd, consider moving libraries to `internal/` to prevent
import of unstable, changing packages.
## Avoid helper/util
Use clear names and try to avoid creating a `helper.go`, `utils.go` or even
package.
## Embed binary data
To enable single-binary deployments, use the `//go:embed` directive and the [embed](https://pkg.go.dev/embed) package to add templates and other static
assets to your binary.
For Go versions prior [v1.16](https://go.dev/doc/go1.16#library-embed), use external tools
(e.g. [github.com/gobuffalo/packr](https://github.com/gobuffalo/packr)).
## Use `io.WriteString`
A number of important types that satisfy `io.Writer` also have a `WriteString`
method, including `*bytes.Buffer`, `*os.File` and `*bufio.Writer`. `WriteString`
is behavioral contract with implicit assent that passed string will be written
in efficient way, without a temporary allocation. Therefore using
`io.WriteString` may improve performance at most, and at least string will be
written in any way.
**Don't:**
```go
var w io.Writer = new(bytes.Buffer)
str := "some string"
w.Write([]byte(str))
```
**Do:**
```go
var w io.Writer = new(bytes.Buffer)
str := "some string"
io.WriteString(w, str)
```
## Use functional options
```go
func main() {
// ...
startServer(
WithPort(8080),
WithTimeout(1 * time.Second),
)
}
type Config struct {
port int
timeout time.Duration
}
type ServerOpt func(*Config)
func WithPort(port int) ServerOpt {
return func(cfg *Config) {
cfg.port = port
}
}
func WithTimeout(timeout time.Duration) ServerOpt {
return func(cfg *Config) {
cfg.timeout = timeout
}
}
func startServer(opts ...ServerOpt) {
cfg := new(Config)
for _, fn := range opts {
fn(cfg)
}
// ...
}
```
## Structs
### Use named structs
If a struct has more than one field, include field names when instantiating it.
**Don't:**
```go
params := myStruct{
1,
true,
}
```
**Do:**
```go
params := myStruct{
Foo: 1,
Bar: true,
}
```
### Avoid new keyword
Using the normal syntax instead of the `new` keyword makes it more clear what is happening: a new instance of the struct is created `MyStruct{}` and we get the pointer for it with `&`.
**Don't:**
```go
s := new(MyStruct)
```
**Do:**
```go
s := &MyStruct{}
```
## Consistent header naming
**Don't:**
```go
r.Header.Get("authorization")
w.Header.Set("Content-type")
w.Header.Set("content-type")
w.Header.Set("content-Type")
```
**Do:**
```go
r.Header.Get("Authorization")
w.Header.Set("Content-Type")
```
## Avoid magic numbers
A number without a name and any context is just a random value. It tells us nothing, so avoid them in your code (the exception might be the number 0, for example when creating loops).
**Don't:**
```go
func IsStrongPassword(password string) bool {
return len(password) >= 8
}
```
**Do:**
```go
const minPasswordLength = 8
func IsStrongPassword(password string) bool {
return len(password) >= minPasswordLength
}
```
## Error handling and error types
**Don't:**
```go
func readFile(filename string) ([]byte, error) {
data, err := ioutil.ReadFile(filename)
if err != nil {
return nil, err
}
return data, nil
}
```
**Do:**
```go
func readFile(filename string) ([]byte, error) {
data, err := ioutil.ReadFile(filename)
if err != nil {
return nil, fmt.Errorf("error reading file %s: %v", filename, err)
}
return data, nil
}
```
Using `fmt.Errorf` provides a simple and readable way to add context to errors.
## Package documentation
**Don't:**
```go
package main
func main() {
// No package or function documentation
}
```
**Do:**
```go
// Package main provides the entry point for the application.
package main
// main is the entry point for the application.
func main() {
// Start the application
}
```
Documenting packages and functions enhances code understanding and usability.