Format Go source with gofmt

Enforce consistent Go code layout on Red Hat Enterprise Linux by using gofmt, the formatting tool in Go Toolset. The gofmt utility applies standard Go formatting rules so teams can share code without maintaining separate style guides.

Prerequisites

  • Go Toolset is installed.

Format code

You can use the gofmt formatting tool to format code in a given path. When the path leads to a single file, the changes apply only to the file. When the path leads to a directory, all .go files in the directory are processed.

Procedure

To format your code in a given path, enter:
$ gofmt -w <code_path>

Replace <code_path> with the path to the code you want to format.

Note

To print the formatted code to standard output instead of writing it to the original file, omit the -w option.

Preview changes to code

You can use the gofmt formatting tool to preview changes done by formatting code in a given path. The output in unified diff format is printed to standard output.

Procedure

Show differences in your code in a given path:
$ gofmt -d <code_path>

Replace <code_path> with the path to the code you want to compare.

Simplify code

You can use the gofmt formatting tool to simplify your code.

Procedure

  1. To simplify code in a given path, enter:
    $ gofmt -s -w <code_path>

    Replace <code_path> with the path to the code you want to simplify.

  2. To apply the changes, enter:
    $ gofmt -w <code_path>

    Replace <code_path> with the path to the code you want to format.

Refactor code

You can use the gofmt formatting tool to refactor your code by applying arbitrary substitutions.

Procedure

  1. To refactor your code in a given path, enter:
    # gofmt -r -w <rewrite_rule><code_path>

    Replace <code_path> with the path to the code you want to refactor and <rewrite_rule> with the rule you want it to be rewritten by.

  2. To apply the changes, enter:
    # gofmt -w <code_path>

    Replace <code_path> with the path to the code you want to format.