common

Documentation

Overview

Package common ...

Package common ...

Package common ...

Package common ...

Index

• func CheckMaxArgs(items []string, max int) error
• func CheckMinMaxArgs(items []string, min int, max int) error
• func Contains(s []string, str string) bool
• func CopyFileFromEmbeddedFS(efs *embed.FS, fs afero.Fs, pathToFile string, saveTo string) error
• func Difference(a, b []string) []string
• func DirExists(fs afero.Fs, path string) bool
• func FileExists(fs afero.Fs, path string) (bool, error)
• func MkDir(fs afero.Fs, x ...string) error
• func MoveFile(efs *embed.FS, fs afero.Fs, sourceFile string, saveTo string, backup bool) error
• func PrintHelperTextDeploySummary(numOfFolders, numOfFiles int)
• func PrintHelperTextDryRunFlag()
• func PrintHelperTextNewMetadata(metadataInfo *config.TemplateData)
• func PrintHelperTextNewResource(name string)
• func PrintNextStepsHelperForNewProject(uc *UserProjectConfig)
• func PrintNextStepsHelperForNewProjectWithExistingTheme(uc *UserProjectConfig)
• func ReadFileLineByLine(appFs afero.Fs, filepath string) ([]string, error)
• func ShowDeployCommandWarningMessages()
• func TouchFile(fs afero.Fs, x ...string) error
• func Union(a, b []string) []string
• func UnionMap(m1, m2 map[string]string) map[string]string
• func Unique(s []string) []string
• func WriteToDisk(fs afero.Fs, inpath string, r io.Reader) (err error)
• type UserProjectConfig
  • func (uc *UserProjectConfig) PrintHelperTextNewTheme()

Functions

func CheckMaxArgs

func CheckMaxArgs(items []string, max int) error

CheckMaxArgs returns an error if there are more than N args.

func CheckMinMaxArgs

func CheckMinMaxArgs(items []string, min int, max int) error

CheckMinMaxArgs returns an error if the number of args is not within the expected range.

func Contains

func Contains(s []string, str string) bool

Contains returns true if an element is in a slice.

func CopyFileFromEmbeddedFS

func CopyFileFromEmbeddedFS(efs *embed.FS, fs afero.Fs, pathToFile string, saveTo string) error

CopyFileFromEmbeddedFS copy files from the embedded file system to the actual file system.

func Difference

func Difference(a, b []string) []string

Difference returns the elements in `a` that aren't in `b`.

func DirExists

func DirExists(fs afero.Fs, path string) bool

DirExists returns true if the directory/folder exists.

func FileExists

func FileExists(fs afero.Fs, path string) (bool, error)

FileExists returns true if the file exists.

func MkDir

func MkDir(fs afero.Fs, x ...string) error

MkDir is a wrapper for afero MkdirAll to create folder structure on the file system.

func MoveFile

func MoveFile(efs *embed.FS, fs afero.Fs, sourceFile string, saveTo string, backup bool) error

MoveFile copy files from the embedded file system to the actual file system and can backups them.

func PrintHelperTextDeploySummary

func PrintHelperTextDeploySummary(numOfFolders, numOfFiles int)

PrintHelperTextDeploySummary prints a summary message string for commands like deploy.

func PrintHelperTextDryRunFlag

func PrintHelperTextDryRunFlag()

PrintHelperTextDryRunFlag prints a message box for commands supporting the 'dry-run mode'.

func PrintHelperTextNewMetadata

func PrintHelperTextNewMetadata(metadataInfo *config.TemplateData)

PrintHelperTextNewMetadata prints an help message string for 'metadata creation'.

func PrintHelperTextNewResource

func PrintHelperTextNewResource(name string)

PrintHelperTextNewResource prints an help message string for 'resource creation'.

func PrintNextStepsHelperForNewProject

func PrintNextStepsHelperForNewProject(uc *UserProjectConfig)

PrintNextStepsHelperForNewProject prints an help message as next steps for a project creation.

func PrintNextStepsHelperForNewProjectWithExistingTheme

func PrintNextStepsHelperForNewProjectWithExistingTheme(uc *UserProjectConfig)

PrintNextStepsHelperForNewProjectWithExistingTheme pprints an help message as next steps for a project creation with an existing theme'.

func ReadFileLineByLine

func ReadFileLineByLine(appFs afero.Fs, filepath string) ([]string, error)

ReadFileLineByLine returns a slice of strings representing lines of the input file.

func ShowDeployCommandWarningMessages

func ShowDeployCommandWarningMessages()

ShowDeployCommandWarningMessages display a set of useful information for the deploy over FTP process.

func TouchFile

func TouchFile(fs afero.Fs, x ...string) error

TouchFile is used to create a file on the file system.

func Union

func Union(a, b []string) []string

Union returns a slice containing the unique values of the input slices.

func UnionMap

func UnionMap(m1, m2 map[string]string) map[string]string

UnionMap returns a map joining elements from the inputs.

func Unique

func Unique(s []string) []string

Unique removes duplicated entries from a slice of strings.

func WriteToDisk

func WriteToDisk(fs afero.Fs, inpath string, r io.Reader) (err error)

WriteToDisk writes content to a file on the file system. Returns error if something went wrong.

Types

type UserProjectConfig

type UserProjectConfig struct {
	ProjectName   string
	CSSLibName    string
	ThemeName     string
	NPMClientName string
}

UserProjectConfig represents the user selections when creating a new sveltin project.

func (*UserProjectConfig) PrintHelperTextNewTheme

func (uc *UserProjectConfig) PrintHelperTextNewTheme()

PrintHelperTextNewTheme returns an help message string for 'theme creation'.