Awesome Go

goreturns

CategoryCode Analysis
SubcategoryCode Analysis
Stars0

Adds zero-value return statements to match the func return types

About goreturns

This tool adds zero-value return values to incomplete Go return statements, to save you time when writing Go. It is inspired by and based on goimports.

short screencast

full 30-second screencast: http://youtu.be/hyEMO9vtKZ8

For example, the following incomplete return statement:

func F() (*MyType, int, error) { return errors.New("foo") }

is made complete by adding nil and 0 returns (the zero values for *MyType and int):

func F() (*MyType, int, error) { return nil, 0, errors.New("foo") }

To install:

go get -u github.com/sqs/goreturns

To run:

goreturns file.go

To view a diff showing what it'd do on a sample file:

goreturns -d $GOPATH/github.com/sqs/goreturns/_sample/a.go

Editor integration: replace gofmt or goimports in your post-save hook with goreturns. By default goreturns calls goimports on files before performing its own processing.

It acts the same as gofmt (same flags, etc) but in addition to code formatting, also fixes returns.

Frequently Asked Questions

What is goreturns?

goreturns is a Code Analysis library for the Go programming language. Adds zero-value return statements to match the func return types

How do I install goreturns?

Install goreturns with the Go module system using `go get sqs/goreturns`. Check the repository for the current installation instructions.

What category does goreturns belong to?

goreturns is listed under Code Analysis, specifically Code Analysis.

← Back to Code Analysis