Trace.Hpc.Codecov.Report

Generate Codecov report data.

Types

data Report

Data type to hold information for generating test coverage report.

Constructors

Report

Fields

• reportTix :: FilePath

  Input tix file.

• reportMixDirs :: [FilePath]

  Directories containing mix files referred by the tix file.

• reportSrcDirs :: [FilePath]

  Directories containing source codes referred by the mix files.

• reportExcludes :: [String]

  Module name strings to exclude from coverage report.

• reportOutFile :: Maybe FilePath

  Output file to write JSON report, if given.

• reportVerbose :: Bool

  Flag for showing verbose message during report generation.

Instances

Eq Report

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: Report -> Report -> Bool

(/=) :: Report -> Report -> Bool

Show Report

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

data CoverageEntry

Single file entry in coverage report.

See the Codecov API for detail.

Constructors

CoverageEntry

Fields

• ce_filename :: FilePath

  Source code file name.

• ce_hits :: LineHits

  Line hits of the file.

Instances

Eq CoverageEntry

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: CoverageEntry -> CoverageEntry -> Bool

(/=) :: CoverageEntry -> CoverageEntry -> Bool

Show CoverageEntry

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> CoverageEntry -> ShowS

show :: CoverageEntry -> String

showList :: [CoverageEntry] -> ShowS

type LineHits = [(Int, Hit)]

Pair of line number and hit tag.

data Hit

Data type to represent coverage of source code line.

Constructors

Missed

The line is not covered at all.

Partial

The line is partially covered.

Full

The line is fully covered.

Instances

Eq Hit

Defined in Trace.Hpc.Codecov.Report

Methods

(==) :: Hit -> Hit -> Bool

(/=) :: Hit -> Hit -> Bool

Show Hit

Defined in Trace.Hpc.Codecov.Report

Methods

showsPrec :: Int -> Hit -> ShowS

show :: Hit -> String

showList :: [Hit] -> ShowS

Functions

genReport :: Report -> IO ()

Generate report data from options.

genCoverageEntries :: Report -> IO [CoverageEntry]

Generate test coverage entries.

emitCoverageJSON

Arguments

:: Maybe FilePath

Just output file name, or Nothing for stdout.

-> [CoverageEntry]

Coverage entries to write.

-> IO ()

Emit simple coverage JSON data.