highlight_diff

README

highlight_diff

Package highlight_diff provides syntaxhighlight.Printer and syntaxhighlight.Annotator implementations for diff format. It implements intra-block character-level inner diff highlighting.

It uses GitHub Flavored Markdown .css class names "gi", "gd", "gu", "gh" for outer blocks, "x" for inner emphasis blocks.

Installation

go get -u github.com/shurcooL/highlight_diff

License

• MIT License

Documentation

Overview

Package highlight_diff provides syntaxhighlight.Printer and syntaxhighlight.Annotator implementations for diff format. It implements intra-block character-level inner diff highlighting.

It uses GitHub Flavored Markdown .css class names "gi", "gd", "gu", "gh" for outer blocks, "x" for inner emphasis blocks.

Index

• func Annotate(src []byte) (annotate.Annotations, error)
• func HighlightedDiffFunc(leftContent, rightContent string, segments *[2][]*annotate.Annotation, ...)
• func Print(s *Scanner, w io.Writer) error
• type HTMLAnnotator
  • func (a HTMLAnnotator) Annotate(start int, kind syntaxhighlight.Kind, tokText string) (*annotate.Annotation, error)
• type HTMLConfig
• type HTMLPrinter
  • func (p HTMLPrinter) Print(w io.Writer, kind syntaxhighlight.Kind, tokText string) error
• type Scanner
  • func NewScanner(src []byte) *Scanner
  • func (s *Scanner) Err() error
  • func (s *Scanner) Scan() bool
  • func (s *Scanner) Token() ([]byte, syntaxhighlight.Kind)

Functions

func Annotate

func Annotate(src []byte) (annotate.Annotations, error)

func HighlightedDiffFunc

func HighlightedDiffFunc(leftContent, rightContent string, segments *[2][]*annotate.Annotation, offsets [2]int)

func Print

func Print(s *Scanner, w io.Writer) error

Types

type HTMLAnnotator

type HTMLAnnotator HTMLConfig

func (HTMLAnnotator) Annotate

func (a HTMLAnnotator) Annotate(start int, kind syntaxhighlight.Kind, tokText string) (*annotate.Annotation, error)

type HTMLConfig

type HTMLConfig []string

type HTMLPrinter

type HTMLPrinter HTMLConfig

func (HTMLPrinter) Print

func (p HTMLPrinter) Print(w io.Writer, kind syntaxhighlight.Kind, tokText string) error

type Scanner

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

func NewScanner

func NewScanner(src []byte) *Scanner

func (*Scanner) Err

func (s *Scanner) Err() error

func (*Scanner) Scan

func (s *Scanner) Scan() bool

func (*Scanner) Token

func (s *Scanner) Token() ([]byte, syntaxhighlight.Kind)