mdformatter

Documentation

Index

• func Format(ctx context.Context, logger log.Logger, files []string, opts ...Option) error
• func FormatFrontMatter(m map[string]interface{}) ([]byte, error)
• type BackMatterTransformer
• type CodeBlockTransformer
• type Diffs
  • func IsFormatted(ctx context.Context, logger log.Logger, files []string, opts ...Option) (diffs Diffs, err error)
  • func (d Diffs) String() string
• type FormatFrontMatterTransformer
  • func (FormatFrontMatterTransformer) Close(SourceContext) error
  • func (FormatFrontMatterTransformer) TransformFrontMatter(_ SourceContext, frontMatter map[string]interface{}) ([]byte, error)
• type Formatter
  • func New(ctx context.Context, opts ...Option) *Formatter
  • func (f *Formatter) Format(file *os.File, out io.Writer) error
• type FrontMatterTransformer
• type LinkTransformer
• type Option
  • func WithBackMatterTransformer(bm BackMatterTransformer) Option
  • func WithCodeBlockTransformer(cb CodeBlockTransformer) Option
  • func WithFrontMatterTransformer(fm FrontMatterTransformer) Option
  • func WithLinkTransformer(l LinkTransformer) Option
  • func WithMetrics(reg *prometheus.Registry) Option
  • func WithSoftWraps() Option
• type RemoveFrontMatter
  • func (RemoveFrontMatter) Close() error
  • func (RemoveFrontMatter) TransformFrontMatter(_ SourceContext, _ map[string]interface{}) ([]byte, error)
• type SourceContext

Functions

func Format

func Format(ctx context.Context, logger log.Logger, files []string, opts ...Option) error

Format formats given markdown files in-place. IsFormatted `With...` function to see what modifiers you can add.

func FormatFrontMatter

func FormatFrontMatter(m map[string]interface{}) ([]byte, error)

Types

type BackMatterTransformer

type BackMatterTransformer interface {
	TransformBackMatter(ctx SourceContext) ([]byte, error)
	Close(ctx SourceContext) error
}

type CodeBlockTransformer

type CodeBlockTransformer interface {
	TransformCodeBlock(ctx SourceContext, infoString []byte, code []byte) ([]byte, error)
	Close(ctx SourceContext) error
}

type Diffs

type Diffs []gitdiff.Diff

func IsFormatted

func IsFormatted(ctx context.Context, logger log.Logger, files []string, opts ...Option) (diffs Diffs, err error)

IsFormatted tries to formats given markdown files and return Diff if files are not formatted. If diff is empty it means all files are formatted.

func (Diffs) String

func (d Diffs) String() string

type FormatFrontMatterTransformer

type FormatFrontMatterTransformer struct{}

func (FormatFrontMatterTransformer) Close

func (FormatFrontMatterTransformer) Close(SourceContext) error

func (FormatFrontMatterTransformer) TransformFrontMatter

func (FormatFrontMatterTransformer) TransformFrontMatter(_ SourceContext, frontMatter map[string]interface{}) ([]byte, error)

type Formatter

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

func New

func New(ctx context.Context, opts ...Option) *Formatter

func (*Formatter) Format

func (f *Formatter) Format(file *os.File, out io.Writer) error

Format writes formatted input file into out writer.

type FrontMatterTransformer

type FrontMatterTransformer interface {
	TransformFrontMatter(ctx SourceContext, frontMatter map[string]interface{}) ([]byte, error)
	Close(ctx SourceContext) error
}

type LinkTransformer

type LinkTransformer interface {
	TransformDestination(ctx SourceContext, destination []byte) ([]byte, error)
	Close(ctx SourceContext) error
}

type Option

type Option func(*Formatter)

Option is a functional option type for Formatter objects.

func WithBackMatterTransformer

func WithBackMatterTransformer(bm BackMatterTransformer) Option

WithBackMatterTransformer allows you to override the default BackMatterTransformer.

func WithCodeBlockTransformer

func WithCodeBlockTransformer(cb CodeBlockTransformer) Option

WithCodeBlockTransformer allows you to override the default CodeBlockTransformer.

func WithFrontMatterTransformer

func WithFrontMatterTransformer(fm FrontMatterTransformer) Option

WithFrontMatterTransformer allows you to override the default FrontMatterTransformer.

func WithLinkTransformer

func WithLinkTransformer(l LinkTransformer) Option

WithLinkTransformer allows you to override the default LinkTransformer.

func WithMetrics

func WithMetrics(reg *prometheus.Registry) Option

WithMetrics allows you to pass in Prometheus registry.

func WithSoftWraps

func WithSoftWraps() Option

WithCodeBlockTransformer allows you to override default softWrap.

type RemoveFrontMatter

type RemoveFrontMatter struct{}

func (RemoveFrontMatter) Close

func (RemoveFrontMatter) Close() error

func (RemoveFrontMatter) TransformFrontMatter

func (RemoveFrontMatter) TransformFrontMatter(_ SourceContext, _ map[string]interface{}) ([]byte, error)

type SourceContext

type SourceContext struct {
	context.Context

	Filepath    string
	LineNumbers string
}