config

package
v0.62.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2024 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultPaths = []string{".octocov.yml", "octocov.yml"}

Functions

func Generate added in v0.36.0 

func Generate(ctx context.Context, lang string, wr io.Writer) error

Types

type Body added in v0.49.0 

type Body struct {
	HideFooterLink bool   `yaml:"hideFooterLink"`
	If             string `yaml:"if,omitempty"`
}

type Central added in v0.49.0 

type Central struct {
	Root     string         `yaml:"root"`
	Reports  CentralReports `yaml:"reports"`
	Badges   CentralBadges  `yaml:"badges"`
	Push     *Push          `yaml:"push,omitempty"`
	ReReport *Report        `yaml:"reReport,omitempty"`
	If       string         `yaml:"if,omitempty"`
}

func (*Central) UnmarshalYAML added in v0.49.0 

func (c *Central) UnmarshalYAML(data []byte) error

type CentralBadges added in v0.49.0 

type CentralBadges struct {
	Datastores []string `yaml:"datastores"`
}

type CentralReports added in v0.49.0 

type CentralReports struct {
	Datastores []string `yaml:"datastores"`
}

type CodeToTestRatio added in v0.49.0 

type CodeToTestRatio struct {
	Code       []string             `yaml:"code"`
	Test       []string             `yaml:"test"`
	Badge      CodeToTestRatioBadge `yaml:"badge,omitempty"`
	Acceptable string               `yaml:"acceptable,omitempty"`
	If         string               `yaml:"if,omitempty"`
}

type CodeToTestRatioBadge added in v0.49.0 

type CodeToTestRatioBadge struct {
	Path string `yaml:"path,omitempty"`
}

type Comment added in v0.49.0 

type Comment struct {
	HideFooterLink bool   `yaml:"hideFooterLink"`
	DeletePrevious bool   `yaml:"deletePrevious"`
	If             string `yaml:"if,omitempty"`
}

type Config 

type Config struct {
	Repository        string             `yaml:"repository"`
	Coverage          *Coverage          `yaml:"coverage"`
	CodeToTestRatio   *CodeToTestRatio   `yaml:"codeToTestRatio,omitempty"`
	TestExecutionTime *TestExecutionTime `yaml:"testExecutionTime,omitempty"`
	Report            *Report            `yaml:"report,omitempty"`
	Central           *Central           `yaml:"central,omitempty"`
	Push              *Push              `yaml:"push,omitempty"`
	Comment           *Comment           `yaml:"comment,omitempty"`
	Summary           *Summary           `yaml:"summary,omitempty"`
	Body              *Body              `yaml:"body,omitempty"`
	Diff              *Diff              `yaml:"diff,omitempty"`
	Timeout           time.Duration      `yaml:"timeout,omitempty"`
	Locale            *language.Tag      `yaml:"locale,omitempty"`
	GitRoot           string             `yaml:"-"`
	// contains filtered or unexported fields
}

func New 

func New() *Config

func (*Config) Acceptable added in v0.8.0 

func (c *Config) Acceptable(r, rPrev Reporter) error

func (*Config) BodyConfigReady added in v0.43.0 

func (c *Config) BodyConfigReady() error

func (*Config) Build 

func (c *Config) Build()

func (*Config) CentralConfigReady added in v0.2.0 

func (c *Config) CentralConfigReady() error

func (*Config) CentralPushConfigReady added in v0.9.0 

func (c *Config) CentralPushConfigReady() error

func (*Config) CentralReReportReady added in v0.45.0 

func (c *Config) CentralReReportReady() error

func (*Config) CheckIf added in v0.27.0 

func (c *Config) CheckIf(cond string) (bool, error)

func (*Config) CodeToTestRatioBadgeConfigReady added in v0.6.0 

func (c *Config) CodeToTestRatioBadgeConfigReady() error

func (*Config) CodeToTestRatioColor added in v0.6.0 

func (c *Config) CodeToTestRatioColor(ratio float64) string

func (*Config) CodeToTestRatioConfigReady added in v0.12.0 

func (c *Config) CodeToTestRatioConfigReady() error

func (*Config) CommentConfigReady added in v0.11.0 

func (c *Config) CommentConfigReady() error

func (*Config) CoverageBadgeConfigReady added in v0.6.0 

func (c *Config) CoverageBadgeConfigReady() error

func (*Config) CoverageColor added in v0.2.0 

func (c *Config) CoverageColor(cover float64) string

func (*Config) CoverageConfigReady added in v0.12.0 

func (c *Config) CoverageConfigReady() error

func (*Config) CoverageConfigReadyOnLocal added in v0.59.0 

func (c *Config) CoverageConfigReadyOnLocal() error

func (*Config) DiffConfigReady added in v0.20.0 

func (c *Config) DiffConfigReady() error

func (*Config) Load 

func (c *Config) Load(path string) error

func (*Config) Loaded added in v0.2.0 

func (c *Config) Loaded() bool

func (*Config) PushConfigReady added in v0.9.0 

func (c *Config) PushConfigReady() error

func (*Config) ReportConfigReady added in v0.14.0 

func (c *Config) ReportConfigReady() error

func (*Config) ReportConfigTargetReady added in v0.20.1 

func (c *Config) ReportConfigTargetReady() error

func (*Config) Root added in v0.2.0 

func (c *Config) Root() string

func (*Config) Setwd added in v0.5.0 

func (c *Config) Setwd(path string)

func (*Config) SummaryConfigReady added in v0.42.0 

func (c *Config) SummaryConfigReady() error

func (*Config) TestExecutionTimeBadgeConfigReady added in v0.7.0 

func (c *Config) TestExecutionTimeBadgeConfigReady() error

func (*Config) TestExecutionTimeColor added in v0.7.0 

func (c *Config) TestExecutionTimeColor(d time.Duration) string

func (*Config) TestExecutionTimeConfigReady added in v0.12.0 

func (c *Config) TestExecutionTimeConfigReady() error

func (*Config) UnmarshalYAML added in v0.38.0 

func (c *Config) UnmarshalYAML(data []byte) error

func (*Config) Wd added in v0.53.0 

func (c *Config) Wd() string

type Coverage added in v0.49.0 

type Coverage struct {
	Path       string        `yaml:"path,omitempty"`
	Paths      []string      `yaml:"paths,omitempty"`
	Exclude    []string      `yaml:"exclude,omitempty"`
	Badge      CoverageBadge `yaml:"badge,omitempty"`
	Acceptable string        `yaml:"acceptable,omitempty"`
	If         string        `yaml:"if,omitempty"`
}

type CoverageBadge added in v0.49.0 

type CoverageBadge struct {
	Path string `yaml:"path,omitempty"`
}

type Diff added in v0.49.0 

type Diff struct {
	Path       string   `yaml:"path,omitempty"`
	Datastores []string `yaml:"datastores,omitempty"`
	If         string   `yaml:"if,omitempty"`
}

type Push added in v0.49.0 

type Push struct {
	If      string `yaml:"if,omitempty"`
	Message string `yaml:"message,omitempty"`
}

type Report added in v0.49.0 

type Report struct {
	If         string   `yaml:"if,omitempty"`
	Path       string   `yaml:"path,omitempty"`
	Datastores []string `yaml:"datastores,omitempty"`
}

type Reporter added in v0.56.0 

type Reporter interface {
	CoveragePercent() float64
	CodeToTestRatioRatio() float64
	TestExecutionTimeNano() float64
	IsMeasuredTestExecutionTime() bool
}

type Summary added in v0.49.0 

type Summary struct {
	HideFooterLink bool   `yaml:"hideFooterLink"`
	If             string `yaml:"if,omitempty"`
}

type TestExecutionTime added in v0.49.0 

type TestExecutionTime struct {
	Badge      TestExecutionTimeBadge `yaml:"badge,omitempty"`
	Acceptable string                 `yaml:"acceptable,omitempty"`
	Steps      []string               `yaml:"steps,omitempty"`
	If         string                 `yaml:"if,omitempty"`
}

type TestExecutionTimeBadge added in v0.49.0 

type TestExecutionTimeBadge struct {
	Path string `yaml:"path,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.