util

Documentation

Index

• Constants
• Variables
• func CreateWithRefStack(stackName, stackDir, refStackDir string) error
• func ValidateProjectDir(dir string) error
• func ValidateRefStackDir(dir string) error
• func ValidateStackDir(dir string) error
• func ValidateStackName(name string) error

Constants

const (
	StackYAMLFile     = "stack.yaml"
	StackYAMLTemplate = `# The metadata information of the stack. 
name: %s`

	KCLModFile         = "kcl.mod"
	KCLModFileTemplate = `` /* 140-byte string literal not displayed */

	MainKCLFile         = "main.k"
	MainKCLFileTemplate = `` /* 438-byte string literal not displayed */

)

Variables

var (
	ErrStackNameEmpty   = errors.New("the stack name must not be empty")
	ErrStackNameTooLong = errors.New("the stack name must be less than 100 characters")
	ErrStackNameInvalid = errors.New("the stack name can only contain alphanumeric, hyphens, underscores, and periods")
	ErrNotEmptyDir      = errors.New("not empty existing target directory for stack creation")
)

Functions

func CreateWithRefStack

func CreateWithRefStack(stackName, stackDir, refStackDir string) error

CreateWithRefStack creates a new stack with referenced stack if specified.

func ValidateProjectDir

func ValidateProjectDir(dir string) error

ValidateProjectDir returns whether the target project directory is valid or not.

func ValidateRefStackDir

func ValidateRefStackDir(dir string) error

ValidateRefStackDir returns whether the referenced stack directory is valid or not.

func ValidateStackDir

func ValidateStackDir(dir string) error

ValidateStackDir returns whether the target stack directory is valid or not.

func ValidateStackName

func ValidateStackName(name string) error

ValidateStackName returns whether the stack name is valid or not.