document

Documentation

Index

• Variables
• type Block
• type Blocks
  • func (b Blocks) CodeBlocks() (result CodeBlocks)
• type CodeBlock
  • func (b *CodeBlock) Attributes() map[string]string
  • func (b *CodeBlock) Content() string
  • func (b *CodeBlock) Executable() string
  • func (b *CodeBlock) Intro() string
  • func (b *CodeBlock) Line(idx int) string
  • func (b *CodeBlock) LineCount() int
  • func (b *CodeBlock) Lines() (result []string)
  • func (b *CodeBlock) MapLines(fn func(string) (string, error)) error
  • func (b *CodeBlock) MarshalJSON() ([]byte, error)
  • func (b *CodeBlock) Name() string
  • func (b *CodeBlock) SetExtracted(val bool)
  • func (b *CodeBlock) Start() int
  • func (b *CodeBlock) Stop() int
• type CodeBlocks
  • func (b CodeBlocks) Lookup(name string) *CodeBlock
  • func (b CodeBlocks) Names() (result []string)
• type MarkdownBlock
  • func (b *MarkdownBlock) Content() string
  • func (b *MarkdownBlock) MarshalJSON() ([]byte, error)
  • func (b *MarkdownBlock) SetExtracted(val bool)
  • func (b *MarkdownBlock) Start() int
  • func (b *MarkdownBlock) Stop() int
• type NameResolver
• type ParsedSource
  • func (s *ParsedSource) Blocks() Blocks
  • func (s *ParsedSource) Root() ast.Node
  • func (s *ParsedSource) Source() []byte
• type Source
  • func NewSource(data []byte) *Source
  • func NewSourceFromFile(f fs.FS, filename string) (*Source, error)
  • func (s *Source) Parse() *ParsedSource
• type Updater
  • func NewUpdater(parsed *ParsedSource) *Updater
  • func NewUpdaterWithSource(data []byte) *Updater
  • func (u *Updater) Parsed() *ParsedSource
  • func (u *Updater) UpdateBlock(idx int, newSource string) error
  • func (u *Updater) Write(w io.Writer) error

Variables

var ErrIndexOutOfRange = errors.New("block index out of range")

Types

type Block

type Block interface {
	json.Marshaler
	Content() string
	Start() int
	Stop() int
}

type Blocks

type Blocks []Block

func (Blocks) CodeBlocks

func (b Blocks) CodeBlocks() (result CodeBlocks)

type CodeBlock

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

func (*CodeBlock) Attributes

func (b *CodeBlock) Attributes() map[string]string

Attributes returns code block attributes detected in the first line. They are of a form: "sh { attr=value }".

func (*CodeBlock) Content

func (b *CodeBlock) Content() string

Content returns unaltered snippet as a single blob of text.

func (*CodeBlock) Executable

func (b *CodeBlock) Executable() string

Executable returns an identifier of a program to execute the block.

func (*CodeBlock) Intro

func (b *CodeBlock) Intro() string

Intro returns a normalized description of the code block based on the preceding paragraph.

func (*CodeBlock) Line

func (b *CodeBlock) Line(idx int) string

Line returns a normalized code block line at index.

func (*CodeBlock) LineCount

func (b *CodeBlock) LineCount() int

LineCount returns the number of code block lines.

func (*CodeBlock) Lines

func (b *CodeBlock) Lines() (result []string)

Lines returns all code block lines, normalized.

func (*CodeBlock) MapLines

func (b *CodeBlock) MapLines(fn func(string) (string, error)) error

func (*CodeBlock) MarshalJSON

func (b *CodeBlock) MarshalJSON() ([]byte, error)

func (*CodeBlock) Name

func (b *CodeBlock) Name() string

Name returns a code block name.

func (*CodeBlock) SetExtracted

func (b *CodeBlock) SetExtracted(val bool)

func (*CodeBlock) Start

func (b *CodeBlock) Start() int

func (*CodeBlock) Stop

func (b *CodeBlock) Stop() int

type CodeBlocks

type CodeBlocks []*CodeBlock

func (CodeBlocks) Lookup

func (b CodeBlocks) Lookup(name string) *CodeBlock

func (CodeBlocks) Names

func (b CodeBlocks) Names() (result []string)

type MarkdownBlock

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

func (*MarkdownBlock) Content

func (b *MarkdownBlock) Content() string

func (*MarkdownBlock) MarshalJSON

func (b *MarkdownBlock) MarshalJSON() ([]byte, error)

func (*MarkdownBlock) SetExtracted

func (b *MarkdownBlock) SetExtracted(val bool)

func (*MarkdownBlock) Start

func (b *MarkdownBlock) Start() int

func (*MarkdownBlock) Stop

func (b *MarkdownBlock) Stop() int

type NameResolver

type NameResolver interface {
	Get(interface{}, string) string
}

type ParsedSource

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

func (*ParsedSource) Blocks

func (s *ParsedSource) Blocks() Blocks

func (*ParsedSource) Root

func (s *ParsedSource) Root() ast.Node

func (*ParsedSource) Source

func (s *ParsedSource) Source() []byte

type Source

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

func NewSource

func NewSource(data []byte) *Source

func NewSourceFromFile

func NewSourceFromFile(f fs.FS, filename string) (*Source, error)

func (*Source) Parse

func (s *Source) Parse() *ParsedSource

type Updater

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

func NewUpdater

func NewUpdater(parsed *ParsedSource) *Updater

func NewUpdaterWithSource

func NewUpdaterWithSource(data []byte) *Updater

func (*Updater) Parsed

func (u *Updater) Parsed() *ParsedSource

func (*Updater) UpdateBlock

func (u *Updater) UpdateBlock(idx int, newSource string) error

func (*Updater) Write

func (u *Updater) Write(w io.Writer) error