Documentation
¶
Overview ¶
Package dirs provides various utility functions in dealing with directories such as a list of all the files with a given (set of) extensions and finding paths within the Go source directory (GOPATH, etc)
Index ¶
- func AllFiles(path string) ([]string, error)
- func DirAndFile(file string) string
- func DirFS(fpath string) (fs.FS, string, error)
- func Dirs(path string) []string
- func ExtFileNames(path string, exts []string) []string
- func ExtFileNamesFS(fsys fs.FS, path string, exts ...string) []string
- func ExtFiles(path string, exts []string) []fs.DirEntry
- func FileExists(filePath string) (bool, error)
- func FileExistsFS(fsys fs.FS, filePath string) (bool, error)
- func FindFilesOnPaths(paths []string, files ...string) []string
- func GoSrcDir(dir string) (absDir string, err error)
- func HasFile(path, file string) bool
- func LatestMod(path string, exts []string) time.Time
- func RelFilePath(file, root string) string
- func SplitExt(fname string) (fbase, ext string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AllFiles ¶
AllFiles returns a slice of all the files, recursively, within a given directory Due to the nature of the filepath.Walk function, the first entry will be the directory itself, for reference -- just skip past that if you don't need it.
func DirAndFile ¶ added in v0.1.3
DirAndFile returns the final dir and file name.
func DirFS ¶
DirFS returns the directory part of given file path as an os.DirFS and the filename as a string. These can then be used to access the file using the FS-based interface, consistent with embed and other use-cases.
func ExtFileNames ¶
ExtFileNames returns all the file names with given extension(s) in directory in sorted order (if exts is empty then all files are returned)
func ExtFileNamesFS ¶ added in v0.1.3
ExtFileNamesFS returns all the file names with given extension(s) in given FS filesystem, in sorted order (if exts is empty then all files are returned)
func ExtFiles ¶
ExtFiles returns all the FileInfo's for files with given extension(s) in directory in sorted order (if exts is empty then all files are returned). In case of error, returns nil.
func FileExists ¶
FileExists checks whether given file exists, returning true if so, false if not, and error if there is an error in accessing the file.
func FileExistsFS ¶
FileExistsFS checks whether given file exists, returning true if so, false if not, and error if there is an error in accessing the file.
func FindFilesOnPaths ¶
FindFilesOnPaths attempts to locate given file(s) on given list of paths, returning the full Abs path to each file found (nil if none)
func GoSrcDir ¶
GoSrcDir tries to locate dir in GOPATH/src/ or GOROOT/src/pkg/ and returns its full path. GOPATH may contain a list of paths. From Robin Elkind github.com/mewkiz/pkg
func LatestMod ¶
LatestMod returns the latest (most recent) modification time for any of the files in the directory (optionally filtered by extension(s) if exts != nil) if no files or error, returns zero time value
func RelFilePath ¶ added in v0.1.3
RelFilePath returns the file name relative to given root file path, if it is under that root -- otherwise it returns the final dir and file name.
Types ¶
This section is empty.
Source Files