utils

Documentation

Index

• Variables
• func RegexCapture(r *regexp.Regexp, s string) (groups map[string]string)
• type Markdown
  • func ParseMarkdown(content string) *Markdown
  • func (m *Markdown) AppendSection(s *MarkdownSection)
  • func (m *Markdown) FindSectionByHeading(level int, headline string) *MarkdownSection
  • func (m *Markdown) FindSectionByHeadingPrefix(level int, headlinePrefix string) *MarkdownSection
  • func (m *Markdown) PrependSection(s *MarkdownSection)
  • func (m *Markdown) String() string
• type MarkdownSection
  • func (m *MarkdownSection) AppendChild(child *MarkdownSection)
  • func (m *MarkdownSection) AppendContent(contentLines []string)
  • func (m *MarkdownSection) PrependChild(child *MarkdownSection)
  • func (m *MarkdownSection) PrependContent(contentLines []string)
  • func (m *MarkdownSection) String() string

Variables

var (
	// semanticVersionMatcher is taken from https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
	SemanticVersionMatcher = regexp.MustCompile(`v(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?`)
)

Functions

func RegexCapture

func RegexCapture(r *regexp.Regexp, s string) (groups map[string]string)

Types

type Markdown

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

func ParseMarkdown

func ParseMarkdown(content string) *Markdown

func (*Markdown) AppendSection

func (m *Markdown) AppendSection(s *MarkdownSection)

func (*Markdown) FindSectionByHeading

func (m *Markdown) FindSectionByHeading(level int, headline string) *MarkdownSection

func (*Markdown) FindSectionByHeadingPrefix

func (m *Markdown) FindSectionByHeadingPrefix(level int, headlinePrefix string) *MarkdownSection

func (*Markdown) PrependSection

func (m *Markdown) PrependSection(s *MarkdownSection)

func (*Markdown) String

func (m *Markdown) String() string

type MarkdownSection

type MarkdownSection struct {
	Level        int
	Heading      string
	ContentLines []string
	SubSections  []*MarkdownSection
}

func (*MarkdownSection) AppendChild

func (m *MarkdownSection) AppendChild(child *MarkdownSection)

func (*MarkdownSection) AppendContent

func (m *MarkdownSection) AppendContent(contentLines []string)

func (*MarkdownSection) PrependChild

func (m *MarkdownSection) PrependChild(child *MarkdownSection)

func (*MarkdownSection) PrependContent

func (m *MarkdownSection) PrependContent(contentLines []string)

func (*MarkdownSection) String

func (m *MarkdownSection) String() string