formatrunner

Documentation

Index

• Constants
• func FormatSource(path string, src []byte, opts Options) ([]byte, []readability.Issue, error)
• type CheckFailedError
  • func (err CheckFailedError) Error() string
• type Mode
• type Options
• type Result
  • func Run(opts Options) (Result, error)

Constants

const GolinesVersion = "v0.13.0"

Functions

func FormatSource

func FormatSource(path string, src []byte, opts Options) ([]byte, []readability.Issue, error)

Types

type CheckFailedError

type CheckFailedError struct {
	ChangedFiles []string
}

func (CheckFailedError) Error

func (err CheckFailedError) Error() string

type Mode

type Mode string

const (
	Check Mode = "check"
	Write Mode = "write"
)

type Options

type Options struct {
	Mode            Mode
	Paths           []string
	MaxLen          int
	GoToolchain     string
	SkipGoLines     bool
	SkipReadability bool
	DiffMaxBytes    int
	IncludeHidden   bool
}

type Result

type Result struct {
	CheckedFiles []string
	ChangedFiles []string
	Diff         string
	Issues       []readability.Issue
}

func Run

func Run(opts Options) (Result, error)