The highest tagged major version is v2.

cli

package

v1.5.0 Latest Latest Go to latest Published: Nov 2, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Boeing/config-file-validator

Links

Open Source Insights

Documentation ¶

Index ¶

type CLI
- func Init(opts ...CLIOption) *CLI
- func (c CLI) Run() (int, error)
type CLIOption
- func WithFinder(finder finder.FileFinder) CLIOption
- func WithReporter(reporter reporter.Reporter) CLIOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v1.4.0

type CLIOption func(*CLI)

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

func WithFinder ¶ added in v1.4.0

func WithFinder(finder finder.FileFinder) CLIOption

Set the CLI Finder

func WithReporter ¶ added in v1.4.0

func WithReporter(reporter reporter.Reporter) CLIOption

Set the reporter type

Source Files ¶

View all Source files

cli.go

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