pathutil

Documentation

Index

• Constants
• func BuildInfoJSON() string
• func BundledPlugConf() string
• func ConfigTOML() string
• func Exists(path string) bool
• func HomeDir() string
• func LockJSON() string
• func LookUpGvimrc() []string
• func LookUpVimrc() []string
• func RCDir(profileName string) string
• func TempDir() string
• func TrxDir() string
• func VimDir() string
• func VimExecutable() (string, error)
• func VimVoltDir() string
• func VimVoltOptDir() string
• func VimVoltStartDir() string
• func VoltPath() string
• type ReposPath
  • func DecodeReposPath(name string) ReposPath
  • func NormalizeRepos(rawReposPath string) (ReposPath, error)
  • func (path ReposPath) CloneURL() string
  • func (path ReposPath) EncodeToPlugDirName() string
  • func (path ReposPath) Equals(p2 ReposPath) bool
  • func (path ReposPath) FullPath() string
  • func (path ReposPath) Plugconf() string
  • func (path ReposPath) String() string
• type ReposPathList
  • func (list ReposPathList) Contains(reposPath ReposPath) bool
  • func (list ReposPathList) Find(reposPath ReposPath) ReposPath
  • func (list ReposPathList) Strings() []string

Constants

const Gvimrc = "gvimrc"

Gvimrc is the basename of gvimrc in ~/.vim

const ProfileGvimrc = "gvimrc.vim"

ProfileGvimrc is the basename of profile gvimrc.

const ProfileVimrc = "vimrc.vim"

ProfileVimrc is the basename of profile vimrc.

const Vimrc = "vimrc"

Vimrc is the basename of vimrc in ~/.vim

Functions

func BuildInfoJSON

func BuildInfoJSON() string

BuildInfoJSON returns "(vim dir)/pack/volt/build-info.json".

func BundledPlugConf

func BundledPlugConf() string

BundledPlugConf returns "(vim dir)/pack/volt/start/system/plugin/bundled_plugconf.vim".

func ConfigTOML

func ConfigTOML() string

ConfigTOML returns fullpath of "$HOME/volt/config.toml".

func Exists

func Exists(path string) bool

Exists returns true if path exists, otherwise returns false. Existence is checked by os.Lstat().

func HomeDir

func HomeDir() string

HomeDir detects HOME path. If HOME environment variable is not set, use USERPROFILE environment variable instead.

func LockJSON

func LockJSON() string

LockJSON returns fullpath of "$HOME/volt/lock.json".

func LookUpGvimrc

func LookUpGvimrc() []string

LookUpGvimrc looks up gvimrc path from the following candidates:

Windows  : $HOME/_gvimrc
           (vim dir)/gvimrc
Otherwise: $HOME/.gvimrc
           (vim dir)/gvimrc

func LookUpVimrc

func LookUpVimrc() []string

LookUpVimrc looks up vimrc path from the following candidates:

Windows  : $HOME/_vimrc
           (vim dir)/vimrc
Otherwise: $HOME/.vimrc
           (vim dir)/vimrc

func RCDir

func RCDir(profileName string) string

RCDir returns fullpath of "$HOME/volt/rc/{profileName}"

func TempDir

func TempDir() string

TempDir returns fullpath of "$HOME/tmp".

func TrxDir

func TrxDir() string

TrxDir returns fullpath of "$HOME/volt/trx".

func VimDir

func VimDir() string

VimDir returns the following fullpath:

Windows: $HOME/vimfiles
Other: $HOME/.vim

func VimExecutable

func VimExecutable() (string, error)

VimExecutable detects vim executable path. If VOLT_VIM environment variable is set, use it. Otherwise look up "vim" binary from PATH.

func VimVoltDir

func VimVoltDir() string

VimVoltDir returns "(vim dir)/pack/volt".

func VimVoltOptDir

func VimVoltOptDir() string

VimVoltOptDir returns "(vim dir)/pack/volt/opt".

func VimVoltStartDir

func VimVoltStartDir() string

VimVoltStartDir returns "(vim dir)/pack/volt/start".

func VoltPath

func VoltPath() string

VoltPath returns fullpath of "$HOME/volt".

Types

type ReposPath

type ReposPath string

ReposPath is string of "{site}/{user}/{repos}"

func DecodeReposPath

func DecodeReposPath(name string) ReposPath

DecodeReposPath decodes name to repos path. name is directory name: ~/.vim/pack/volt/opt/{name}

func NormalizeRepos

func NormalizeRepos(rawReposPath string) (ReposPath, error)

NormalizeRepos normalizes name into the following forms into ReposPath: 1. user/name[.git] 2. github.com/user/name[.git] 3. [git|http|https]://github.com/user/name[.git][/]

func (ReposPath) CloneURL

func (path ReposPath) CloneURL() string

CloneURL returns string "https://{reposPath}".

func (ReposPath) EncodeToPlugDirName

func (path ReposPath) EncodeToPlugDirName() string

EncodeToPlugDirName encodes path to directory name. The directory name is: ~/.vim/pack/volt/opt/{name}

func (ReposPath) Equals

func (path ReposPath) Equals(p2 ReposPath) bool

Equals returns true if path and p2 are the same.

func (ReposPath) FullPath

func (path ReposPath) FullPath() string

FullPath returns fullpath of ReposPath.

func (ReposPath) Plugconf

func (path ReposPath) Plugconf() string

Plugconf returns fullpath of plugconf.

func (ReposPath) String

func (path ReposPath) String() string

type ReposPathList

type ReposPathList []ReposPath

ReposPathList is []ReposPath

func (ReposPathList) Contains

func (list ReposPathList) Contains(reposPath ReposPath) bool

Contains returns true if list contains reposPath.

func (ReposPathList) Find

func (list ReposPathList) Find(reposPath ReposPath) ReposPath

Find returns an non-empty element (path.String() != "") if list contains reposPath.

func (ReposPathList) Strings

func (list ReposPathList) Strings() []string

Strings returns []string values.