stats

package

v0.0.0-...-c7609e9 Latest Latest Go to latest Published: Jan 9, 2021 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/github-vet/bots

Links

Open Source Insights

Documentation ¶

Overview ¶

Package stats implements a global statistics store for instrumenting code to count the occurrence of important events. The stats store is not thread-safe in the slightest.

Index ¶

Variables
func AddCount(stat CountStat, diff int)
func AddFile(filename string)
func Clear()
func CountMissingTestFiles() int
func FlushStats(writer *csv.Writer, owner, repo string)
func GetCount(stat CountStat) int
type CountStat
- func (c CountStat) String() string

Constants ¶

This section is empty.

Variables ¶

Functions ¶

func AddCount ¶

func AddCount(stat CountStat, diff int)

AddCount adds the provided diff to the count of the provided CountStat

func AddFile ¶

func AddFile(filename string)

AddFile counts the existence of a file and updates the values of StatFiles and StatTestFiles

func Clear ¶

func Clear()

Clear resets all stores statistics to zero.

func CountMissingTestFiles ¶

func CountMissingTestFiles() int

CountMissingTestFiles counts the number of files which don't have an associated test.

func FlushStats ¶

func FlushStats(writer *csv.Writer, owner, repo string)

FlushStats flushes the current set of collected statistics to the provided csv writer.

func GetCount ¶

func GetCount(stat CountStat) int

GetCount retrieves the current count of the provided CountStat so far.

Types ¶

type CountStat ¶

type CountStat uint8

const (
	StatSloc CountStat = iota
	StatSlocTest
	StatSlocVendored
	StatFuncDecl
	StatFuncCalls
	StatRangeLoops
	StatFiles
	StatTestFile
	StatVendoredFile
	StatUnaryReferenceExpr
	StatLoopclosureHits
	StatLooppointerHits
	StatPtrFuncStartsGoroutine
	StatPtrFuncWritesPtr
	StatPtrDeclCallsThirdPartyCode
	StatLooppointerReportsWritePtr
	StatLooppointerReportsAsync
	StatLooppointerReportsThirdParty
	StatLooppointerReportsPointerReassigned
	StatLooppointerReportsCompositeLit
)

func (CountStat) String ¶

func (c CountStat) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL