pathutil

Documentation

Index

• Constants
• func BuildInfoJSON() string
• func BundledPlugConf() string
• func CloneURL(reposPath ReposPath) string
• func ConfigTOML() string
• func EncodeReposPath(reposPath ReposPath) string
• func Exists(path string) bool
• func FullReposPath(reposPath ReposPath) string
• func HomeDir() string
• func LockJSON() string
• func LookUpGvimrc() []string
• func LookUpVimrc() []string
• func Plugconf(reposPath ReposPath) string
• func RCDir(profileName string) string
• func TempDir() string
• func TrxLock() 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 NormalizeLocalRepos(name string) (ReposPath, error)
  • func NormalizeRepos(rawReposPath string) (ReposPath, error)
  • func (path *ReposPath) String() string
• type ReposPathList
  • func (list ReposPathList) Strings() []string

Constants

const Gvimrc = "gvimrc"

const ProfileGvimrc = "gvimrc.vim"

const ProfileVimrc = "vimrc.vim"

const Vimrc = "vimrc"

Functions

func BuildInfoJSON

func BuildInfoJSON() string

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

func BundledPlugConf

func BundledPlugConf() string

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

func CloneURL

func CloneURL(reposPath ReposPath) string

https://{reposPath}

func ConfigTOML

func ConfigTOML() string

$HOME/volt/config.toml

func EncodeReposPath

func EncodeReposPath(reposPath ReposPath) string

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

func Exists

func Exists(path string) bool

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

func FullReposPath

func FullReposPath(reposPath ReposPath) string

func HomeDir

func HomeDir() string

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

func LockJSON

func LockJSON() string

$HOME/volt/lock.json

func LookUpGvimrc

func LookUpGvimrc() []string

Look up gvimrc path from the following candidates:

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

func LookUpVimrc

func LookUpVimrc() []string

Look up vimrc path from the following candidates:

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

func Plugconf

func Plugconf(reposPath ReposPath) string

func RCDir

func RCDir(profileName string) string

$HOME/volt/rc/{profileName}

func TempDir

func TempDir() string

$HOME/tmp

func TrxLock

func TrxLock() string

$HOME/volt/trx.lock

func VimDir

func VimDir() string

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

func VimExecutable

func VimExecutable() (string, error)

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

func VimVoltDir

func VimVoltDir() string

(vim dir)/pack/volt

func VimVoltOptDir

func VimVoltOptDir() string

(vim dir)/pack/volt/opt

func VimVoltStartDir

func VimVoltStartDir() string

(vim dir)/pack/volt/start

func VoltPath

func VoltPath() string

$HOME/volt

Types

type ReposPath

type ReposPath string

func DecodeReposPath

func DecodeReposPath(name string) ReposPath

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

func NormalizeLocalRepos

func NormalizeLocalRepos(name string) (ReposPath, error)

func NormalizeRepos

func NormalizeRepos(rawReposPath string) (ReposPath, error)

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

func (*ReposPath) String

func (path *ReposPath) String() string

type ReposPathList

type ReposPathList []ReposPath

func (ReposPathList) Strings

func (list ReposPathList) Strings() []string