folderutil

README

folderutil

The package contains various helpers to interact with folders

UserConfigDirOrDefault

UserConfigDirOrDefault returns the default root directory to use for user-specific configuration data. Users should create their own application-specific subdirectory within this one and use that.

On Unix systems, it returns $XDG_CONFIG_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.config. On Darwin, it returns $HOME/Library/Application Support. On Windows, it returns %AppData%. On Plan 9, it returns $home/lib.

If the location cannot be determined (for example, $HOME is not defined), then it will return given value as default.

Documentation

Index

• Constants
• Variables
• func AppConfigDirOrDefault(defaultAppConfigDir string, toolName string) string
• func GetFiles(root string) ([]string, error)
• func HomeDirOrDefault(defaultDirectory string) string
• func IsUnixOS() bool
• func IsWindowsOS() bool
• func IsWritable(path string) bool
• func SyncDirectory(source, destination string) error
• func UserConfigDirOrDefault(defaultConfigDir string) string
• type PathInfo
  • func NewPathInfo(path string) (PathInfo, error)
  • func (pathInfo PathInfo) MeshWith(anotherPath string) ([]string, error)
  • func (pathInfo PathInfo) Paths() ([]string, error)

Constants

const (
	UnixPathSeparator    = "/"
	WindowsPathSeparator = "\\"
)

Variables

var RemoveSourceDirAfterSync = true

Remove source directory after successful sync

var (
	// Separator evaluated at runtime
	Separator = string(os.PathSeparator)
)

Functions

func AppConfigDirOrDefault

func AppConfigDirOrDefault(defaultAppConfigDir string, toolName string) string

AppConfigDirOrDefault returns the app config directory

func GetFiles

func GetFiles(root string) ([]string, error)

GetFiles within a folder

func HomeDirOrDefault

func HomeDirOrDefault(defaultDirectory string) string

HomeDirOrDefault tries to obtain the user's home directory and returns the default if it cannot be obtained.

func IsUnixOS

func IsUnixOS() bool

func IsWindowsOS

func IsWindowsOS() bool

func IsWritable

func IsWritable(path string) bool

IsWritable checks if a path is writable by attempting to create a temporary file. Note: It's recommended to minimize the use of this function because it involves file creation. If performance is a concern, consider declaring a global variable in the module using this and initialize it once.

func SyncDirectory

func SyncDirectory(source, destination string) error

SyncDirectory sync all files and non-empty directories from source to destination folder optionally removes source directory and removes source

func UserConfigDirOrDefault

func UserConfigDirOrDefault(defaultConfigDir string) string

UserConfigDirOrDefault returns the user config directory or defaultConfigDir in case of error

Types

type PathInfo

type PathInfo struct {
	IsAbsolute         bool
	RootPath           string
	Parts              []string
	PartsWithSeparator []string
}

PathInfo about a folder

func NewPathInfo

func NewPathInfo(path string) (PathInfo, error)

NewPathInfo returns info about a given path

func (PathInfo) MeshWith

func (pathInfo PathInfo) MeshWith(anotherPath string) ([]string, error)

MeshWith combine all values from Path with another provided path

func (PathInfo) Paths

func (pathInfo PathInfo) Paths() ([]string, error)

Returns all possible combination of the various levels of the path parts