parser

Documentation

Overview

Package parser defines the CovParser interface and global registry for coverage format auto-detection and dispatch.

Index

• func ParseFile(path string, p CovParser, stripPrefix string) (*covmodel.CovReport, error)
• func Register(p CovParser)
• type CovParser
  • func ForName(name string) (CovParser, error)

Functions

func ParseFile

func ParseFile(path string, p CovParser, stripPrefix string) (*covmodel.CovReport, error)

ParseFile opens path and parses it; if p is nil format is auto-detected. Use "-" for stdin.

func Register

func Register(p CovParser)

Register adds p to the global registry. Earlier registrations win on Detect.

Types

type CovParser

type CovParser interface {
	Name() string
	Extensions() []string
	Detect(header []byte) bool
	Parse(r io.Reader, source string) (*covmodel.CovReport, error)
}

CovParser converts a specific coverage format into a covmodel.CovReport.

func ForName

func ForName(name string) (CovParser, error)

ForName returns the parser for the given name or alias.