dir

package

v0.17.0 Latest Latest Go to latest Published: Oct 1, 2019 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package dir provides functions to manage the config directories.

This section is empty.

View Source

var ErrNetwork = goerrors.NewKind("network error downloading %s")

ErrNetwork is returned when could not download

View Source

var ErrNotExist = goerrors.NewKind("%s does not exist")

ErrNotExist is returned when config dir does not exists

View Source

var ErrNotValid = goerrors.NewKind("%s is not a valid config directory: %s")

ErrNotValid is returned when config dir is not valid

View Source

var ErrWrite = goerrors.NewKind("write error at %s")

ErrWrite is returned when could not write

func DownloadURL(url, dst string) (err error)

DownloadURL downloads the given url to a file to the dst path, creating the directory if it's needed

func Path() (string, error)

Path returns the absolute path for $SOURCED_DIR, or $HOME/.sourced if unset and returns an error if it does not exist or it could not be read.

func Prepare() error

Prepare tries to create the config directory, returning an error if it could not be created, or nil if already exist or was successfully created.

func TmpPath() string

TmpPath returns the absolute path for /tmp/srcd

This section is empty.