workspace

Documentation

Index

• func InstallPlugin(pluginSpec workspace.PluginSpec, log func(sev diag.Severity, msg string)) (*semver.Version, error)
• func ValidateProjectDescription(s string) error
• func ValidateProjectName(s string) error
• func ValueOrDefaultProjectDescription(description string, projectDescription string, defaultDescription string) string
• func ValueOrSanitizedDefaultProjectName(name string, projectName string, defaultNameToSanitize string) string
• type InstallPluginError
  • func (err *InstallPluginError) Error() string
  • func (err *InstallPluginError) Unwrap() error

Functions

func InstallPlugin

func InstallPlugin(pluginSpec workspace.PluginSpec, log func(sev diag.Severity, msg string)) (*semver.Version, error)

func ValidateProjectDescription

func ValidateProjectDescription(s string) error

ValidateProjectDescription ensures a project description name is valid, if it is not it returns an error with a message suitable for display to an end user.

func ValidateProjectName

func ValidateProjectName(s string) error

ValidateProjectName ensures a project name is valid, if it is not it returns an error with a message suitable for display to an end user.

func ValueOrDefaultProjectDescription

func ValueOrDefaultProjectDescription(
	description string, projectDescription string, defaultDescription string,
) string

ValueOrDefaultProjectDescription returns the value or defaultDescription.

func ValueOrSanitizedDefaultProjectName

func ValueOrSanitizedDefaultProjectName(name string, projectName string, defaultNameToSanitize string) string

ValueOrSanitizedDefaultProjectName returns the value or a sanitized valid project name based on defaultNameToSanitize.

Types

type InstallPluginError

type InstallPluginError struct {
	// The specification of the plugin to install
	Spec workspace.PluginSpec
	// The underlying error that occurred during the download or install.
	Err error
}

InstallPluginError is returned by InstallPlugin if we couldn't install the plugin

func (*InstallPluginError) Error

func (err *InstallPluginError) Error() string

func (*InstallPluginError) Unwrap

func (err *InstallPluginError) Unwrap() error