formatter

README

Formatter

formatter 包用于实现对代码的生成及格式化。在本项目中用于前端的代码生成。

本包的设计参考 prettier 实现，提供 indent / join / line 等工具方法。

Documentation

Index

• func Format(doc Doc, options *Options) string
• type Doc
  • func If(condition bool, doc Doc) Doc
• type DocContent
  • func NewDocContent(code string) *DocContent
• type DocGroup
  • func Content(contents ...interface{}) *DocGroup
  • func Group(docs ...Doc) *DocGroup
  • func Join(sep Doc, docs ...Doc) *DocGroup
• type DocNode
  • func Indent(doc Doc) *DocNode
  • func LineBreak() *DocNode
• type DocNodeType
• type Formatter
  • func NewFormatter(options *Options) *Formatter
  • func (f *Formatter) Format(doc Doc) string
• type Options

Functions

func Format

func Format(doc Doc, options *Options) string

Types

type Doc

type Doc interface {
	// contains filtered or unexported methods
}

func If

func If(condition bool, doc Doc) Doc

type DocContent

type DocContent string

func NewDocContent

func NewDocContent(code string) *DocContent

type DocGroup

type DocGroup struct {
	Docs []Doc
}

func Content

func Content(contents ...interface{}) *DocGroup

func Group

func Group(docs ...Doc) *DocGroup

func Join

func Join(sep Doc, docs ...Doc) *DocGroup

type DocNode

type DocNode struct {
	Type  DocNodeType
	Child Doc
}

func Indent

func Indent(doc Doc) *DocNode

func LineBreak

func LineBreak() *DocNode

type DocNodeType

type DocNodeType string

const (
	DocNodeIndent    DocNodeType = "string"
	DocNodeLineBreak DocNodeType = "linebreak"
)

type Formatter

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

func NewFormatter

func NewFormatter(options *Options) *Formatter

func (*Formatter) Format

func (f *Formatter) Format(doc Doc) string

type Options

type Options struct {
	IndentWidth int
}