path

Documentation

Overview

package path provides a simple wrapper around a string path that can expand the users home directory, a common CLI need. Might be extracted into its own library and removed from warg if I find myself needing it in other code.

Index

• type Path
  • func New(path string) Path
  • func (p Path) Expand() (string, error)
  • func (p Path) MustExpand() string
  • func (p Path) String() string

Types

type Path

type Path struct {
	// contains filtered or unexported fields
}

func New

func New(path string) Path

func (Path) Expand

func (p Path) Expand() (string, error)

Expand expands the path to include the home directory if the path is prefixed with `~`. If it isn't prefixed with `~`, the path is returned as-is.

func (Path) MustExpand

func (p Path) MustExpand() string

MustExpand calls `Expand` and panics on any errors

func (Path) String

func (p Path) String() string