fs

Documentation

Overview

Package fs provides filesystem related functionality.

Index

• func CopyAll(dstdir, srcdir string) error
• func CopyDir(destdir, srcdir string, filter CopyFilterFunc) error
• func ListTerramateDirs(dir string) ([]string, error)
• func ListTerramateFiles(dir string) (filenames []string, err error)
• type CopyFilterFunc

Functions

func CopyAll

func CopyAll(dstdir, srcdir string) error

CopyAll copies all files from dstdir into srcdir.

func CopyDir

func CopyDir(destdir, srcdir string, filter CopyFilterFunc) error

CopyDir will copy srcdir to destdir. It will copy all dirs and files recursively. The destdir provided does not need to exist, it will be created. The provided filter function allows to filter which files/directories get copied.

func ListTerramateDirs

func ListTerramateDirs(dir string) ([]string, error)

ListTerramateDirs lists Terramate dirs, which are any dirs except ones starting with ".".

func ListTerramateFiles

func ListTerramateFiles(dir string) (filenames []string, err error)

ListTerramateFiles returns a list of terramate related files from the directory dir.

Types

type CopyFilterFunc

type CopyFilterFunc func(path string, entry os.DirEntry) bool

CopyFilterFunc filters which files/dirs will be copied by CopyDir. If the function returns true, the file/dir is copied. If it returns false, the file/dir is ignored.