formatter

Documentation

Overview

Package formatter contains everything related to changelog Formatters.

Index

• type CustomTemplateFormatter
  • func (it *CustomTemplateFormatter) Format(chlog *changelog.Changelog) (string, error)
• type Formatter
  • func NewCustomTemplateFormatter(goTemplate string) (Formatter, error)
  • func NewMarkdownFormatter(opts ...MarkdownOption) (Formatter, error)
• type MarkdownFormatter
  • func (it *MarkdownFormatter) Format(changelog *changelog.Changelog) (string, error)
• type MarkdownOption
  • func WithScopes() MarkdownOption

Types

type CustomTemplateFormatter

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

A CustomTemplateFormatter is a Formatter rendering changelogs with Go templates

func (*CustomTemplateFormatter) Format

func (it *CustomTemplateFormatter) Format(chlog *changelog.Changelog) (string, error)

Format renders the given changelog with the CustomTemplateFormatter's template.

type Formatter

type Formatter interface {
	// Format formats the given changelog.
	Format(changelog *changelog.Changelog) (string, error)
}

Formatter formats Changelogs.

func NewCustomTemplateFormatter

func NewCustomTemplateFormatter(goTemplate string) (Formatter, error)

NewCustomTemplateFormatter creates a new instance of a CustomTemplateFormatter

func NewMarkdownFormatter

func NewMarkdownFormatter(opts ...MarkdownOption) (Formatter, error)

NewMarkdownFormatter creates a new instance of a MarkdownFormatter

type MarkdownFormatter

type MarkdownFormatter struct {
	MarkdownOptions *markdownOptions
}

A MarkdownFormatter is a formatter rendering Markdown formats.

func (*MarkdownFormatter) Format

func (it *MarkdownFormatter) Format(changelog *changelog.Changelog) (string, error)

Format formats the given changelog in Markdown format.

type MarkdownOption

type MarkdownOption func(opt *markdownOptions)

A MarkdownOption sets options for markdown format such as whether or not to include scopes.

func WithScopes

func WithScopes() MarkdownOption

WithScopes includes scopes to markdown format.