util

Documentation

Index

• Constants
• Variables
• func GetDirAndName() (dir, name string, err error)
• func ValidateProjectDir(dir string) error
• func ValidateProjectName(name string) error

Constants

const (
	ProjectYAMLFile     = "project.yaml"
	ProjectYAMLTemplate = `name: %s`
)

Variables

var (
	ErrNotEmptyDir        = errors.New("the target directory for project creation should be empty")
	ErrProjectNameEmpty   = errors.New("the project name must not be empty")
	ErrProjectNameTooLong = errors.New("the project name must be less than 100 characters")
	ErrProjectNameInvalid = errors.New("the project name can only contain alphanumeric, hyphens, underscores, and periods")
)

Functions

func GetDirAndName

func GetDirAndName() (dir, name string, err error)

GetDirAndName returns the rooted path and the last element of the current working directory for the project to be created.

func ValidateProjectDir

func ValidateProjectDir(dir string) error

ValidateProjectDir ensures the project directory for creation is valid.

func ValidateProjectName

func ValidateProjectName(name string) error

ValidateProjectName ensures a project name is valid.