Forrest logo
tool overview
On this page you find all important commands for the CLI tool gofmt. If the command you are looking for is missing please ask our AI.

gofmt

The command line tool gofmt is a formatting tool for Go programming language code. It is used to automatically format Go source code files according to the official Go coding style guidelines. gofmt ensures that the code is consistently formatted and adheres to a specific style, which improves code readability and maintainability.

Some key features of gofmt include:

  1. Simplicity: gofmt follows a simplistic philosophy of having a single, standard way to format Go code. It removes the need for manual formatting and allows developers to focus on writing code rather than worrying about the formatting.

  2. Idiomatic Go Style: gofmt enforces the official Go coding style guidelines, also known as "idiomatic Go." This includes rules related to indentation, line breaks, use of braces, spacing, import organization, and more.

  3. Automatic Formatting: gofmt automatically scans a Go source code file and modifies it to match the official Go style. It takes care of the indentation levels, line wrapping, spacing, and other aspects of code formatting.

  4. Integration with IDEs and Editors: gofmt is widely supported by various integrated development environments (IDEs) and text editors. This allows developers to easily format their Go code with just a few keystrokes or by configuring automatic formatting on save.

Using gofmt is considered a best practice in the Go community as it helps maintain a consistent coding style across projects and makes code easier to read and understand.

List of commands for gofmt:

  • gofmt:tldr:0a3f9 gofmt: Format a file, and then simplify the code, overwriting the original file.
    $ gofmt -s -w ${source-go}
    try on your machine
    explain this command
  • gofmt:tldr:2b79f gofmt: Format a file and display the result to the console.
    $ gofmt ${source-go}
    try on your machine
    explain this command
  • gofmt:tldr:2d8f1 gofmt: Format a file, overwriting the original file in-place.
    $ gofmt -w ${source-go}
    try on your machine
    explain this command
  • gofmt:tldr:d9aed gofmt: Print all (including spurious) errors.
    $ gofmt -e ${source-go}
    try on your machine
    explain this command
tool overview