format

Documentation

Index

• type Config
• type Format
  • func New() *Format
  • func (f *Format) Build(config *Config) error
  • func (f *Format) Run(src io.Reader, dst io.Writer) error

Types

type Config

type Config struct {
	// SearchDir the swag would be parse
	SearchDir string

	// excludes dirs and files in SearchDir,comma separated
	Excludes string

	// MainFile (DEPRECATED)
	MainFile string
}

Config specifies configuration for a format run

type Format

type Format struct {
	// contains filtered or unexported fields
}

Format implements `fmt` command for formatting swag comments in Go source files.

func New

func New() *Format

New creates a new Format instance

func (*Format) Build

func (f *Format) Build(config *Config) error

Build runs formatter according to configuration in config

func (*Format) Run

func (f *Format) Run(src io.Reader, dst io.Writer) error

Run the format on src and write the result to dst.