filepaths

Documentation

Index

• Constants
• Variables
• func AvailableVersionsFilePath() string
• func BackupsDir() string
• func ConnectionStatePath() string
• func DashboardServiceStateFilePath() string
• func DatabaseVersionFilePath() string
• func DefaultVarsFilePath(workspacePath string) string
• func EnsureBackupsDir() string
• func EnsureConfigDir() string
• func EnsureDashboardAssetsDir() string
• func EnsureDataDir() string
• func EnsureDatabaseDir() string
• func EnsureInternalDir() string
• func EnsureLogDir() string
• func EnsurePipesInternalDir() string
• func EnsurePluginDir() string
• func EnsurePluginInstallDir(pluginImageDisplayRef string) string
• func EnsureTemplateDir() string
• func FindPluginFolder(remoteSchema string) (string, error)
• func GetDataDir() string
• func GetInternalDir() string
• func GetPluginPath(pluginImageRef, pluginAlias string) (string, error)
• func IsModInstallShadowPath(dirName string) bool
• func LegacyDefaultVarsFilePath(workspacePath string) string
• func LegacyNotificationsFilePath() string
• func LegacyVersionFilePath() string
• func LocalPluginPath() string
• func PipesInternalDir() string
• func PluginAliasToLongName(pluginName string) string
• func PluginAliasToShortName(pluginName string) string
• func PluginBinaryPath(pluginImageDisplayRef, pluginAlias string) string
• func PluginInstallDir(pluginImageDisplayRef string) string
• func PluginManagerStateFilePath() string
• func PluginVersionFilePath() string
• func ReportAssetsVersionFilePath() string
• func RunningInfoFilePath() string
• func StateFileName() string
• func StateFilePath() string
• func WorkspaceLockPath(workspacePath string) string
• func WorkspaceModPath(workspacePath string) string
• func WorkspaceModShadowPath(workspacePath string) string

Constants

const (
	WorkspaceModDir             = "mods"
	WorkspaceModShadowDirPrefix = ".mods."
	WorkspaceConfigFileName     = "workspace.spc"
	WorkspaceLockFileName       = ".mod.cache.json"
)

mod related constants

const (
	PipesComponentInternal = "internal"
)

Variables

var DefaultPipesInstallDir = ""

PipesInstallDir is the location of config files commen between pipelings this must be set by the application at startup

var PipesInstallDir = ""

Functions

func AvailableVersionsFilePath

func AvailableVersionsFilePath() string

AvailableVersionsFilePath returns the path of the json file used to store cache available versions of installed plugins and the CLI

func BackupsDir

func BackupsDir() string

BackupsDir returns the path to the backups directory

func ConnectionStatePath

func ConnectionStatePath() string

ConnectionStatePath returns the path of the connections state file

func DashboardServiceStateFilePath

func DashboardServiceStateFilePath() string

func DatabaseVersionFilePath

func DatabaseVersionFilePath() string

DatabaseVersionFilePath returns the plugin version file path

func DefaultVarsFilePath

func DefaultVarsFilePath(workspacePath string) string

func EnsureBackupsDir

func EnsureBackupsDir() string

EnsureBackupsDir returns the path to the backups directory (creates if missing)

func EnsureConfigDir

func EnsureConfigDir() string

EnsureConfigDir returns the path to the config directory (creates if missing)

func EnsureDashboardAssetsDir

func EnsureDashboardAssetsDir() string

func EnsureDataDir

func EnsureDataDir() string

EnsureDataDir returns the path to the data directory (creates if missing)

func EnsureDatabaseDir

func EnsureDatabaseDir() string

EnsureDatabaseDir returns the path to the db directory (creates if missing)

func EnsureInternalDir

func EnsureInternalDir() string

EnsureInternalDir returns the path to the internal directory (creates if missing)

func EnsureLogDir

func EnsureLogDir() string

EnsureLogDir returns the path to the db log directory (creates if missing)

func EnsurePipesInternalDir

func EnsurePipesInternalDir() string

EnsurePipesInternalDir returns the path to the pipes internal directory (creates if missing)

func EnsurePluginDir

func EnsurePluginDir() string

EnsurePluginDir returns the path to the plugins directory (creates if missing)

func EnsurePluginInstallDir

func EnsurePluginInstallDir(pluginImageDisplayRef string) string

func EnsureTemplateDir

func EnsureTemplateDir() string

EnsureTemplateDir returns the path to the templates directory (creates if missing)

func FindPluginFolder

func FindPluginFolder(remoteSchema string) (string, error)

FindPluginFolder searches for a folder which when hashed would match the schema

func GetDataDir

func GetDataDir() string

GetDataDir returns the path to the data directory

func GetInternalDir

func GetInternalDir() string

GetInternalDir returns the path to the internal directory

func GetPluginPath

func GetPluginPath(pluginImageRef, pluginAlias string) (string, error)

func IsModInstallShadowPath

func IsModInstallShadowPath(dirName string) bool

func LegacyDefaultVarsFilePath

func LegacyDefaultVarsFilePath(workspacePath string) string

func LegacyNotificationsFilePath

func LegacyNotificationsFilePath() string

LegacyNotificationsFilePath returns the path of the (legacy) notifications.json file used to store update notifications

func LegacyVersionFilePath

func LegacyVersionFilePath() string

LegacyVersionFilePath returns the legacy version file path

func LocalPluginPath

func LocalPluginPath() string

LocalPluginPath returns the path to locally installed plugins

func PipesInternalDir

func PipesInternalDir() string

PipesInternalDir returns the path to the pipes internal directory (creates if missing)

func PluginAliasToLongName

func PluginAliasToLongName(pluginName string) string

func PluginAliasToShortName

func PluginAliasToShortName(pluginName string) string

func PluginBinaryPath

func PluginBinaryPath(pluginImageDisplayRef, pluginAlias string) string

func PluginInstallDir

func PluginInstallDir(pluginImageDisplayRef string) string

func PluginManagerStateFilePath

func PluginManagerStateFilePath() string

func PluginVersionFilePath

func PluginVersionFilePath() string

PluginVersionFilePath returns the plugin version file path

func ReportAssetsVersionFilePath

func ReportAssetsVersionFilePath() string

ReportAssetsVersionFilePath returns the report assets version file path

func RunningInfoFilePath

func RunningInfoFilePath() string

func StateFileName

func StateFileName() string

func StateFilePath

func StateFilePath() string

StateFilePath returns the path of the update_check.json state file

func WorkspaceLockPath

func WorkspaceLockPath(workspacePath string) string

func WorkspaceModPath

func WorkspaceModPath(workspacePath string) string

func WorkspaceModShadowPath

func WorkspaceModShadowPath(workspacePath string) string