cli

Documentation

Index

• Variables
• func GroupByDirectory(reports []reporter.Report) map[string][]reporter.Report
• func GroupByDouble(reports []reporter.Report, groupBy []string) (map[string]map[string][]reporter.Report, error)
• func GroupByFileType(reports []reporter.Report) map[string][]reporter.Report
• func GroupByPassFail(reports []reporter.Report) map[string][]reporter.Report
• func GroupBySingle(reports []reporter.Report, groupBy string) (map[string][]reporter.Report, error)
• func GroupByTriple(reports []reporter.Report, groupBy []string) (map[string]map[string]map[string][]reporter.Report, error)
• type CLI
  • func Init(opts ...CLIOption) *CLI
  • func (c CLI) Run() (int, error)
• type CLIOption
  • func WithFinder(finder finder.FileFinder) CLIOption
  • func WithGroupOutput(groupOutput []string) CLIOption
  • func WithQuiet(quiet bool) CLIOption
  • func WithReporter(reporter reporter.Reporter) CLIOption

Variables

var GroupOutput []string

GroupOutput is a global variable that is used to store the group by options that the user specifies

var Quiet bool

Functions

func GroupByDirectory

func GroupByDirectory(reports []reporter.Report) map[string][]reporter.Report

Group Reports by Directory

func GroupByDouble

func GroupByDouble(reports []reporter.Report, groupBy []string) (map[string]map[string][]reporter.Report, error)

Group Reports for two groupings

func GroupByFileType

func GroupByFileType(reports []reporter.Report) map[string][]reporter.Report

Group Reports by File Type

func GroupByPassFail

func GroupByPassFail(reports []reporter.Report) map[string][]reporter.Report

Group Reports by Pass-Fail

func GroupBySingle

func GroupBySingle(reports []reporter.Report, groupBy string) (map[string][]reporter.Report, error)

Group Reports by single grouping

func GroupByTriple

func GroupByTriple(reports []reporter.Report, groupBy []string) (map[string]map[string]map[string][]reporter.Report, error)

Group Reports for three groupings

Types

type CLI

type CLI struct {
	// FileFinder interface to search for the files
	// in the SearchPath
	Finder finder.FileFinder
	// Reporter interface for outputting the results of the
	// the CLI run
	Reporter reporter.Reporter
}

func Init

func Init(opts ...CLIOption) *CLI

Initialize the CLI object

func (CLI) Run

func (c CLI) Run() (int, error)

The Run method performs the following actions: - Finds the calls the Find method from the Finder interface to return a list of files - Reads each file that was found - Calls the Validate method from the Validator interface to validate the file - Outputs the results using the Reporter

type CLIOption

type CLIOption func(*CLI)

Implement the go options pattern to be able to set options to the CLI struct using functional programming

func WithFinder

func WithFinder(finder finder.FileFinder) CLIOption

Set the CLI Finder

func WithGroupOutput

func WithGroupOutput(groupOutput []string) CLIOption

func WithQuiet

func WithQuiet(quiet bool) CLIOption

func WithReporter

func WithReporter(reporter reporter.Reporter) CLIOption

Set the reporter type