lint

Documentation

Index

• type Block
  • func NewBlock(ctx string, txt string, sel string) Block
• type Linter
  • func (l Linter) Lint(src string, pat string) ([]core.File, error)
  • func (l Linter) LintString(src string) ([]core.File, error)

Types

type Block

type Block struct {
	Context string        // parent content (if any) - e.g., paragraph -> sentence
	Text    string        // text content
	Scope   core.Selector // section selector
}

A Block represents a section of text.

func NewBlock

func NewBlock(ctx string, txt string, sel string) Block

NewBlock makes a new Block with prepared text and a Selector.

type Linter

type Linter struct{}

A Linter lints a File.

func (Linter) Lint

func (l Linter) Lint(src string, pat string) ([]core.File, error)

Lint src according to its format.

func (Linter) LintString

func (l Linter) LintString(src string) ([]core.File, error)

LintString src according to its format.