Documentation
¶
Overview ¶
Package format exposes gofumpt's formatting in an API similar to go/format. In general, the APIs are only guaranteed to work well when the input source is in canonical gofmt format.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Extra ¶
type Extra struct {
// GroupParams groups function parameters with repeated types.
GroupParams bool
// ClotheReturns clothes naked returns in functions with named results.
ClotheReturns bool
}
Extra is the set of extra formatting rules which are available.
As the formatter evolves, we might add or remove boolean fields here. Go API users who wish to avoid build errors in such cases can use the string API in Extra.Set.
func (*Extra) IsBoolFlag ¶
type Options ¶
type Options struct {
// LangVersion is the Go version a piece of code is written in.
// The version is used to decide whether to apply formatting
// rules which require new language features.
// When empty, a default of go1 is assumed.
// Otherwise, the version must satisfy [go/version.IsValid].
//
// When formatting a Go module, LangVersion should typically be
//
// go list -m -f {{.GoVersion}}
//
// with a "go" prefix, or the equivalent from `go mod edit -json`.
LangVersion string
// ModulePath corresponds to the Go module path which contains the source
// code being formatted. When formatting a Go module, ModulePath should be
//
// go list -m -f {{.Path}}
//
// or the equivalent from `go mod edit -json`.
//
// ModulePath is used for formatting decisions like what import paths are
// considered to be not part of the standard library. When empty, the source
// is formatted as if it weren't inside a module.
ModulePath string
// ExtraRules enables all extra formatting rules, such as grouping function
// parameters with repeated types together.
//
// Deprecated: use [Options.Extra] instead.
ExtraRules bool
// Extra allows enabling extra formatting rules which are disabled by default.
Extra Extra
}
Options is the set of formatting options which affect gofumpt.
Click to show internal directories.
Click to hide internal directories.