coverage

README

codeowners-coverage

Installation

go get github.com/aaronsky/codeowners-coverage/cmd/codeowners-coverage

Usage

As a Package

import (
    "fmt"
    "github.com/aaronsky/codeowners-coverage"
)

func getMyReport(path string) error {
	report, err := coverage.NewCoverageReport(path)
	if err != nil {
		return err
    }

	jsonString, err := report.ToFormat(coverage.ReportFormatJSON)
	if err != nil {
		return err
    }

    fmt.Println(jsonString)
}

CLI

codeowners-coverage also has a CLI. It works by loading a local Git repository, parsing its CODEOWNERS file, and crawling the disk for matches. To run, simply provide a path to a Git repository.

codeowners-coverage ~/go/src/github.com/docker/compose

In the event of a successful navigation, this will print JSON to stdout describing the coverage attributes of the repository.

License

This package is licensed under the MIT License.

Documentation

Overview

Package coverage will generate a coverage report for CODEOWNERS in the repository.

Index

• Constants
• type Report
  • func NewCoverageReport(path string) (*Report, error)
  • func (r *Report) ToFormat(format reportFormat) (string, error)

Constants

const (
	// ReportFormatJSON is a constant representing the JSON format for a Report object
	ReportFormatJSON reportFormat = "json"
)

Types

type Report

type Report struct {
	RemoteURL         string  `json:"remote_url"`
	SHA               string  `json:"sha"`
	CoveredFilesCount int     `json:"covered_files_count"`
	TotalFilesCount   int     `json:"total_files_count"`
	CoverageRatio     float64 `json:"coverage_ratio"`
}

Report contains information on the codeowner coverage of files in a repository

func NewCoverageReport

func NewCoverageReport(path string) (*Report, error)

NewCoverageReport produces a coverage report from the given repository Modifies state of the given repository by performing a git-clean.

func (*Report) ToFormat

func (r *Report) ToFormat(format reportFormat) (string, error)

ToFormat converts the report to a string in the given format. Currently only "json" is supported.