coverstatus

Documentation

Overview

Package coverstatus contains coverage color-coding and labeling for generating reports.

Index

• type Status
  • func New(f float64) Status
  • func (s Status) Colorize(str string) string
  • func (s Status) Emoji() string
  • func (s Status) WorkflowCommand() string

Types

type Status

type Status int

Status represents a coverage status level, ranging from "excellent" to "error"

func New

func New(f float64) Status

New categorizes the given percentage (between 0 and 1) as a coverage status

func (Status) Colorize

func (s Status) Colorize(str string) string

Colorize formats 'str' with this status's assigned color

func (Status) Emoji

func (s Status) Emoji() string

Emoji returns this status's assigned emoji

func (Status) WorkflowCommand

func (s Status) WorkflowCommand() string

WorkflowCommand returns a GitHub Actions workflow command for this coverage status. These are specifically the log "level" commands.