blocks

Documentation

Index

• func ReaderIgnore(_ *Reader, _ int, _ string) error
• func ReaderPassthrough(br *Reader, _ int, line string) error
• type BlockWriter
• type Reader
  • func (br *Reader) DoTheThing(fs afero.Fs, filename string, stdin io.Reader, stdout io.Writer) error

Functions

func ReaderIgnore

func ReaderIgnore(_ *Reader, _ int, _ string) error

func ReaderPassthrough

func ReaderPassthrough(br *Reader, _ int, line string) error

Types

type BlockWriter

type BlockWriter interface {
	Write(index, startLine, endLine int, text string)
	Close() error
}

type Reader

type Reader struct {
	FileName string

	Log *logrus.Logger

	// io
	Reader io.Reader
	Writer io.Writer

	// stats
	LineCount        int // total lines processed
	LinesBlock       int // total block lines processed
	BlockCount       int // total blocks found
	BlockCurrentLine int // current block line count

	CurrentNodeCursor          *astutil.Cursor
	CurrentNodeQuoteChar       string
	CurrentNodeLeadingPadding  string
	CurrentNodeTrailingPadding string

	ErrorBlocks int

	// options
	ReadOnly       bool
	FixFinishLines bool

	// callbacks
	LineRead  func(*Reader, int, string) error
	BlockRead blockReadFunc

	// Only used by the "blocks" command
	BlockWriter BlockWriter
}

func (*Reader) DoTheThing

func (br *Reader) DoTheThing(fs afero.Fs, filename string, stdin io.Reader, stdout io.Writer) error