paths

Documentation

Index

• Constants
• func Realpath(path string) (string, error)
• type Paths
  • func NewPaths(base string) Paths
  • func (p Paths) BasePath() string
  • func (p Paths) BinPath() string
  • func (p Paths) DownloadPath() string
  • func (p Paths) IndexPath() string
  • func (p Paths) IndexPluginsPath() string
  • func (p Paths) InstallPath() string
  • func (p Paths) InstallReceiptsPath() string
  • func (p Paths) PluginInstallPath(plugin string) string
  • func (p Paths) PluginInstallReceiptPath(plugin string) string
  • func (p Paths) PluginVersionInstallPath(plugin, version string) string

Constants

const (
	ManifestExtension string = ".yaml"
	ManifestFile      string = "manifest.yaml"
)

Functions

func Realpath

func Realpath(path string) (string, error)

Realpath evaluates symbolic links. If the path is not a symbolic link, it returns the cleaned path. Symbolic links with relative paths return error.

Types

type Paths

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

Paths contains all important environment paths

func NewPaths

func NewPaths(base string) Paths

func (Paths) BasePath

func (p Paths) BasePath() string

BasePath returns hasura base directory.

func (Paths) BinPath

func (p Paths) BinPath() string

BinPath returns the path where plugin executable symbolic links are found. This path should be added to $PATH in client machine.

e.g. {BasePath}/bin

func (Paths) DownloadPath

func (p Paths) DownloadPath() string

DownloadPath returns a temporary directory for downloading plugins. It does not create a new directory on each call.

func (Paths) IndexPath

func (p Paths) IndexPath() string

IndexPath returns the base directory where plugin index repository is cloned.

e.g. {BasePath}/index/

func (Paths) IndexPluginsPath

func (p Paths) IndexPluginsPath() string

IndexPluginsPath returns the plugins directory of the index repository.

e.g. {BasePath}/index/plugins/

func (Paths) InstallPath

func (p Paths) InstallPath() string

InstallPath returns the base directory for plugin installations.

e.g. {BasePath}/store

func (Paths) InstallReceiptsPath

func (p Paths) InstallReceiptsPath() string

InstallReceiptsPath returns the base directory where plugin receipts are stored.

e.g. {BasePath}/receipts

func (Paths) PluginInstallPath

func (p Paths) PluginInstallPath(plugin string) string

PluginInstallPath returns the path to install the plugin.

e.g. {InstallPath}/{version}/{..files..}

func (Paths) PluginInstallReceiptPath

func (p Paths) PluginInstallReceiptPath(plugin string) string

PluginInstallReceiptPath returns the path to the install receipt for plugin.

e.g. {InstallReceiptsPath}/{plugin}.yaml

func (Paths) PluginVersionInstallPath

func (p Paths) PluginVersionInstallPath(plugin, version string) string

PluginVersionInstallPath returns the path to the specified version of specified plugin.

e.g. {PluginInstallPath}/{plugin}/{version}