version: 1.10

package format

import "go/format"

Overview

Package format implements standard formatting of Go source.

Index

Examples

Package files

format.go internal.go

func Node

  1. func Node(dst io.Writer, fset *token.FileSet, node interface{}) error

Node formats node in canonical gofmt style and writes the result to dst.

The node type must be ast.File, printer.CommentedNode, []ast.Decl, []ast.Stmt,
or assignment-compatible to ast.Expr, ast.Decl, ast.Spec, or ast.Stmt. Node does
not modify node. Imports are not sorted for nodes representing partial source
files (for instance, if the node is not an ast.File or a printer.CommentedNode
not wrapping an *ast.File).

The function may return early (before the entire result is written) and return a
formatting error, for instance due to an incorrect AST.


Example:

  1. const expr = "(6+2*3)/4"
  3. // parser.ParseExpr parses the argument and returns the
  4. // corresponding ast.Node.
  5. node, err := parser.ParseExpr(expr)
  6. if err != nil {
  7.     log.Fatal(err)
  8. }
  10. // Create a FileSet for node. Since the node does not come
  11. // from a real source file, fset will be empty.
  12. fset := token.NewFileSet()
  14. var buf bytes.Buffer
  15. err = Node(&buf, fset, node)
  16. if err != nil {
  17.     log.Fatal(err)
  18. }
  20. fmt.Println(buf.String())
  22. // Output: (6 + 2*3) / 4

func Source

  1. func Source(src []byte) ([]byte, error)

Source formats src in canonical gofmt style and returns the result or an (I/O or
syntax) error. src is expected to be a syntactically correct Go source file, or
a list of Go declarations or statements.

If src is a partial source file, the leading and trailing space of src is
applied to the result (such that it has the same leading and trailing space as
src), and the result is indented by the same amount as the first line of src
containing code. Imports are not sorted for partial source files.

Caution: Tools relying on consistent formatting based on the installed version
of gofmt (for instance, such as for presubmit checks) should execute that gofmt
binary instead of calling Source.