validate

Documentation

Overview

Package validate provides Jackal package validation functions.

Index

• Variables
• func ImportDefinition(component *types.JackalComponent) error
• func Run(pkg types.JackalPackage) error
• func SupportedOS() []string

Variables

var (
	// IsLowercaseNumberHyphenNoStartHyphen is a regex for lowercase, numbers and hyphens that cannot start with a hyphen.
	// https://regex101.com/r/FLdG9G/2
	IsLowercaseNumberHyphenNoStartHyphen = regexp.MustCompile(`^[a-z0-9][a-z0-9\-]*$`).MatchString
	// IsUppercaseNumberUnderscore is a regex for uppercase, numbers and underscores.
	// https://regex101.com/r/tfsEuZ/1
	IsUppercaseNumberUnderscore = regexp.MustCompile(`^[A-Z0-9_]+$`).MatchString
)

Functions

func ImportDefinition

func ImportDefinition(component *types.JackalComponent) error

ImportDefinition validates the component trying to be imported.

func Run

func Run(pkg types.JackalPackage) error

Run performs config validations.

func SupportedOS

func SupportedOS() []string

SupportedOS returns the supported operating systems.

The supported operating systems are: linux, darwin, windows.

An empty string signifies no OS restrictions.