external

package
v0.2.0-beta Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2023 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExitCode

type ExitCode struct {
	Code        int64  // Code is the exit code of the validator
	Ok          bool   // Ok sets whether the exit code is considered as a pass or not
	Description string // Description is the description in the report that should be put alongside the error if the item fails to validate
}

ExitCode is the definition of an exit code

type ValidatorDefinition

type ValidatorDefinition struct {
	Name          string   // Name is the name of the validator
	Path          string   // Path is the path to the executable
	Args          []string // Args are the arguments to pass to the executable
	ReadFromStdin bool     // ReadFromStdin controls whether the validator expects the item to validate on stdin
	Fatal         bool     // Fatal controls whether the validator is fatal or not that is if it fails the pipeline should stop
}

ValidatorDefinition is the definition of an external validator

func Parse

func Parse() ([]ValidatorDefinition, error)

Parse parses the external validators in the config file and returns a slice containing all validators to later use in the pipeline

Jump to

Keyboard shortcuts

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