file

Documentation

Index

• func CopyFile(srcFile, dstFile string) (err error)
• func CreateTempDir(dirPattern string) (string, error)
• func DirFileFilterDefaultFunc(filePath string, isDir bool) bool
• func GenerateAbsFilePath(baseDir, file string) (string, error)
• func GetFileAbsDirPath(fileLoc string) (string, error)
• func GetFileAbsDirPathOrDirItself(fileLoc string) (string, error)
• func GetFileMap(srcPath string, filterFunc DirFileFilterFunc, fileNameFunc DirFileNameFunc, ...) (map[string][]byte, error)
• func GetFileMapByWalkDir(srcPath string, filterFunc DirFileFilterFunc, fileNameFunc DirFileNameFunc, ...) (map[string][]byte, error)
• func GetYamlNodeStrByPath(content []byte, path string) (string, error)
• func ReadYamls(path string) ([]byte, error)
• func RemoveFileIfExists(filename string) error
• func ReplaceAppNameInPathStr(filePath, appNamePlaceHolder, appName string) string
• type DirFileContentFunc
• type DirFileFilterFunc
• type DirFileNameFunc
• type YamlSequenceNode
  • func GetYamlNodeArrayByPath(content []byte, path string) (*YamlSequenceNode, error)
  • func MergeYamlNode(dst *YamlSequenceNode, src *YamlSequenceNode) *YamlSequenceNode
  • func (n *YamlSequenceNode) IsEmpty() bool

Functions

func CopyFile

func CopyFile(srcFile, dstFile string) (err error)

func CreateTempDir

func CreateTempDir(dirPattern string) (string, error)

func DirFileFilterDefaultFunc

func DirFileFilterDefaultFunc(filePath string, isDir bool) bool

DirFileFilterDefaultFunc is used for GetFileMap it will return false if isDir is true

func GenerateAbsFilePath

func GenerateAbsFilePath(baseDir, file string) (string, error)

GenerateAbsFilePath return all the path with a given file name

func GetFileAbsDirPath

func GetFileAbsDirPath(fileLoc string) (string, error)

GetFileAbsDirPath will return abs dir path for file

func GetFileAbsDirPathOrDirItself

func GetFileAbsDirPathOrDirItself(fileLoc string) (string, error)

GetFileAbsDirPathOrDirItself will return abs dir path, for file: return its parent directory for directory: return dir itself

func GetFileMap

func GetFileMap(
	srcPath string, filterFunc DirFileFilterFunc, fileNameFunc DirFileNameFunc, fileContentFunc DirFileContentFunc,
) (map[string][]byte, error)

GetFileMap return map of fileName and content if srcPath is a directory, it will invoke GetFileMapByWalkDir to get content map if srcPath is a file, it will use fileNameFunc and fileContentFunc to create a map

func GetFileMapByWalkDir

func GetFileMapByWalkDir(
	srcPath string, filterFunc DirFileFilterFunc, fileNameFunc DirFileNameFunc, processFunc DirFileContentFunc,
) (map[string][]byte, error)

GetFileMapByWalkDir will walk in directory return contentMap

func GetYamlNodeStrByPath

func GetYamlNodeStrByPath(content []byte, path string) (string, error)

GetYamlNodeStrByPath get element from yaml content by yaml path return string format of node

func ReadYamls

func ReadYamls(path string) ([]byte, error)

ReadYamls reads file or files from dir whose suffix is yaml or yml and returns the content of the files without "---" separator

func RemoveFileIfExists

func RemoveFileIfExists(filename string) error

func ReplaceAppNameInPathStr

func ReplaceAppNameInPathStr(filePath, appNamePlaceHolder, appName string) string

Types

type DirFileContentFunc

type DirFileContentFunc func(filePath string) ([]byte, error)

DirFileContentFunc is used to get file content then return this content

type DirFileFilterFunc

type DirFileFilterFunc func(filePath string, isDir bool) bool

DirFileFilterFunc is used to filter files when walk directory if this func return false, this file's content will not return

type DirFileNameFunc

type DirFileNameFunc func(filePath, srcPath string) string

DirFileNameFunc is used to make current filename to become map key srcPath is the basePath of file, for sometimes you may want to get relativePath of filePath

type YamlSequenceNode

type YamlSequenceNode struct {
	StrOrigin string
	StrArray  []string
}

YamlSequenceNode is yaml sequenceNode

func GetYamlNodeArrayByPath

func GetYamlNodeArrayByPath(content []byte, path string) (*YamlSequenceNode, error)

GetYamlNodeArrayByPath get element from yaml content by yaml path return string array for elements

func MergeYamlNode

func MergeYamlNode(dst *YamlSequenceNode, src *YamlSequenceNode) *YamlSequenceNode

func (*YamlSequenceNode) IsEmpty

func (n *YamlSequenceNode) IsEmpty() bool

IsEmpty check node fields are empty