Red Hat Summit Red Hat SummitApoyoConsolaDesarrolladoresIniciar una pruebaContacto

Este contenido no está disponible en el idioma seleccionado.

Chapter 3. The gofmt formatting tool

Instead of a style guide, the Go programming language uses the gofmt code formatting tool. gofmt automatically formats your code according to the Go layout rules.

3.1. Prerequisites
Copiar enlace

3.2. Formatting code
Copiar enlace

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, run:

  • On Red Hat Enterprise Linux 7: 

    $ scl enable go-toolset-1.18 'gofmt -w <code_path>'
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to format.

  • On Red Hat Enterprise Linux 8: 

    $ gofmt -w <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to format.

  • On Red Hat Enterprise Linux 9: 

    $ gofmt -w <code_path>
    Copy to Clipboard Toggle word wrap
    • 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.

3.3. Previewing changes to code
Copiar enlace

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

To show differences in your code in a given path, run:

  • On Red Hat Enterprise Linux 7: 

    $ scl enable go-toolset-1.18 'gofmt -d <code_path>'
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.

  • On Red Hat Enterprise Linux 8: 

    $ gofmt -d <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.

  • On Red Hat Enterprise Linux 9: 

    $ gofmt -d <code_path>
    Copy to Clipboard Toggle word wrap
    • Replace <code_path> with the path to the code you want to compare.

3.4. Simplifying code
Copiar enlace

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

Procedure

  • To simplify code in a given path, run:

    • On Red Hat Enterprise Linux 7: 

      $ scl enable go-toolset-1.18 'gofmt -s <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.

    • On Red Hat Enterprise Linux 8: 

      $ gofmt -s <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.

    • On Red Hat Enterprise Linux 9: 

      $ gofmt -s <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to simplify.

  • To apply the changes, run:

    • On Red Hat Enterprise Linux 7: 

      $ scl enable go-toolset-1.18 'gofmt -w <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

    • On Red Hat Enterprise Linux 8: 

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

    • On Red Hat Enterprise Linux 9: 

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

3.5. Refactoring code
Copiar enlace

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

Procedure

  • To refactor your code in a given path, run:

    • On Red Hat Enterprise Linux 7: 

      $ scl enable go-toolset-1.18 'gofmt -r <rewrite_rule> <code_path>'
      Copy to Clipboard Toggle word wrap
      • 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.

    • On Red Hat Enterprise Linux 8: 

      $ gofmt -r <rewrite_rule> <code_path>
      Copy to Clipboard Toggle word wrap
      • 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.

    • On Red Hat Enterprise Linux 9: 

      $ gofmt -r <rewrite_rule> <code_path>
      Copy to Clipboard Toggle word wrap
      • 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.

  • To apply the changes, run:

    • On Red Hat Enterprise Linux 7: 

      $ scl enable go-toolset-1.18 'gofmt -w <code_path>'
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

    • On Red Hat Enterprise Linux 8: 

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.

    • On Red Hat Enterprise Linux 9: 

      $ gofmt -w <code_path>
      Copy to Clipboard Toggle word wrap
      • Replace <code_path> with the path to the code you want to format.
Volver arriba
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2025 Red Hat