Documentation ¶
Index ¶
- Constants
- Variables
- func NewExecutableID(workspace, namespace, name string) string
- func ParseExecutableID(id string) (workspace, namespace, name string)
- func SortedValidVerbs() []string
- func ValidVerbs() []string
- type Aliases
- type Argument
- type ArgumentList
- type Collection
- type CollectionItem
- type Entity
- type ExecExecutableType
- type Executable
- func (e *Executable) AliasesIDs() []string
- func (e *Executable) DefinitionPath() string
- func (e *Executable) Env() *ExecutableEnvironment
- func (e *Executable) ID() string
- func (e *Executable) IsExecutableFromWorkspace(workspaceFilter string) bool
- func (e *Executable) IsVisibleFromWorkspace(workspaceFilter string) bool
- func (e *Executable) JSON() (string, error)
- func (e *Executable) Markdown() string
- func (e *Executable) MergeTags(tags Tags)
- func (e *Executable) NameEquals(name string) bool
- func (e *Executable) Ref() Ref
- func (e *Executable) SetContext(workspaceName, workspacePath, namespace, definitionPath string)
- func (e *Executable) SetDefaults()
- func (e *Executable) Validate() error
- func (e *Executable) WorkspacePath() string
- func (e *Executable) YAML() (string, error)
- type ExecutableDefinition
- type ExecutableDefinitionList
- type ExecutableDefinitionTemplate
- type ExecutableDirectory
- type ExecutableEnvironment
- type ExecutableList
- func (l ExecutableList) FilterByNamespace(ns string) ExecutableList
- func (l ExecutableList) FilterBySubstring(str string) ExecutableList
- func (l ExecutableList) FilterByTags(tags Tags) ExecutableList
- func (l ExecutableList) FilterByVerb(verb Verb) ExecutableList
- func (l ExecutableList) FilterByWorkspace(ws string) ExecutableList
- func (l ExecutableList) FindByVerbAndID(verb Verb, id string) (*Executable, error)
- func (l ExecutableList) Items() []*types.CollectionItem
- func (l ExecutableList) JSON() (string, error)
- func (l ExecutableList) Plural() string
- func (l ExecutableList) Singular() string
- func (l ExecutableList) YAML() (string, error)
- type ExecutableLocationConfig
- type ExecutableTypeSpec
- type GitConfig
- type InteractiveConfig
- type LaunchExecutableType
- type ParallelExecutableType
- type Parameter
- type ParameterList
- type Ref
- type RenderExecutableType
- type RequestExecutableType
- type RequestResponseFile
- type SerialExecutableType
- type Tags
- type TemplateData
- type TemplateDataEntry
- type UserConfig
- type Verb
- type Visibility
- type WorkspaceConfig
- type WorkspaceConfigList
- type WorkspaceMode
Constants ¶
const ( ActivateGroupID = "activate" DeactivateGroupID = "deactivate" UpdateGroupID = "update" ManageGroupID = "manage" LaunchGroupID = "launch" CreationGroupID = "creation" )
const DefaultTimeout = 30 * time.Minute
const (
ReservedEnvVarPrefix = "FLOW_"
)
const TmpDirLabel = "f:tmp"
Variables ¶
var ( ValidVerbToGroupID = map[string]string{ "exec": ActivateGroupID, "run": ActivateGroupID, "start": ActivateGroupID, "install": ActivateGroupID, "setup": ActivateGroupID, "release": ActivateGroupID, "deploy": ActivateGroupID, "apply": ActivateGroupID, "delete": DeactivateGroupID, "remove": DeactivateGroupID, "uninstall": DeactivateGroupID, "destroy": DeactivateGroupID, "undeploy": DeactivateGroupID, "update": UpdateGroupID, "upgrade": UpdateGroupID, "refresh": UpdateGroupID, "reload": UpdateGroupID, "manage": ManageGroupID, "configure": ManageGroupID, "monitor": ManageGroupID, "edit": ManageGroupID, "open": LaunchGroupID, "launch": LaunchGroupID, "show": LaunchGroupID, "view": LaunchGroupID, "render": LaunchGroupID, "generate": CreationGroupID, "add": CreationGroupID, "new": CreationGroupID, "transform": CreationGroupID, "build": CreationGroupID, } )
Functions ¶
func NewExecutableID ¶
func ParseExecutableID ¶
func SortedValidVerbs ¶ added in v0.1.0
func SortedValidVerbs() []string
func ValidVerbs ¶
func ValidVerbs() []string
Types ¶
type Argument ¶ added in v0.1.3
type Argument struct { // +docsgen:envKey // The name of the environment variable that will be assigned the value. EnvKey string `yaml:"envKey"` // +docsgen:typeArg // The type of the argument. This is used to determine how to parse the value of the argument. // String is the default type. Type string `yaml:"type"` // +docsgen:default // The default value to use if a value is not set. Default string `yaml:"default"` // +docsgen:required // If true, a value must be set. If false, the default value will be used if a value is not set. Required bool `yaml:"required"` // +docsgen:flag // The flag to use when setting the argument from the command line. // Either `flag` or `pos` must be set, but not both. Flag string `yaml:"flag"` // +docsgen:pos // The position of the argument in the command line arguments. Values start at 1. // Either `flag` or `pos` must be set, but not both. Pos int `yaml:"pos"` // contains filtered or unexported fields }
func (*Argument) ValidateValue ¶ added in v0.1.3
type ArgumentList ¶ added in v0.1.3
type ArgumentList []Argument
func (*ArgumentList) SetValues ¶ added in v0.1.3
func (al *ArgumentList) SetValues(flagArgs map[string]string, posArgs []string) error
func (*ArgumentList) ToEnvMap ¶ added in v0.1.3
func (al *ArgumentList) ToEnvMap() map[string]string
func (*ArgumentList) Validate ¶ added in v0.1.3
func (al *ArgumentList) Validate() error
func (*ArgumentList) ValidateValues ¶ added in v0.1.3
func (al *ArgumentList) ValidateValues() error
type Collection ¶ added in v0.1.0
type CollectionItem ¶ added in v0.1.0
type ExecExecutableType ¶
type ExecExecutableType struct { ExecutableDirectory `yaml:",inline"` ExecutableEnvironment `yaml:",inline"` Command string `yaml:"cmd,omitempty"` File string `yaml:"file,omitempty"` LogMode io.LogMode `yaml:"logMode,omitempty"` // contains filtered or unexported fields }
func (*ExecExecutableType) GetLogFields ¶
func (e *ExecExecutableType) GetLogFields() map[string]interface{}
func (*ExecExecutableType) SetLogFields ¶
func (e *ExecExecutableType) SetLogFields(fields map[string]interface{})
type Executable ¶
type Executable struct { Verb Verb `yaml:"verb,omitempty"` Name string `yaml:"name,omitempty"` Aliases []string `yaml:"aliases,omitempty"` Tags Tags `yaml:"tags,omitempty"` Description string `yaml:"description,omitempty"` Timeout time.Duration `yaml:"timeout,omitempty"` Visibility *Visibility `yaml:"visibility,omitempty"` // +docsgen:typeExec // The type of executable. Only one type can be set. Type *ExecutableTypeSpec `yaml:",inline,omitempty"` // contains filtered or unexported fields }
func (*Executable) AliasesIDs ¶
func (e *Executable) AliasesIDs() []string
func (*Executable) DefinitionPath ¶
func (e *Executable) DefinitionPath() string
func (*Executable) Env ¶ added in v0.1.3
func (e *Executable) Env() *ExecutableEnvironment
func (*Executable) ID ¶
func (e *Executable) ID() string
func (*Executable) IsExecutableFromWorkspace ¶
func (e *Executable) IsExecutableFromWorkspace(workspaceFilter string) bool
IsExecutableFromWorkspace returns true if the executable can be executed from the given workspace.
func (*Executable) IsVisibleFromWorkspace ¶
func (e *Executable) IsVisibleFromWorkspace(workspaceFilter string) bool
IsVisibleFromWorkspace returns true if the executable should be shown in terminal output for the given workspace.
func (*Executable) JSON ¶ added in v0.1.0
func (e *Executable) JSON() (string, error)
func (*Executable) Markdown ¶ added in v0.1.0
func (e *Executable) Markdown() string
func (*Executable) MergeTags ¶
func (e *Executable) MergeTags(tags Tags)
func (*Executable) NameEquals ¶
func (e *Executable) NameEquals(name string) bool
func (*Executable) Ref ¶
func (e *Executable) Ref() Ref
func (*Executable) SetContext ¶
func (e *Executable) SetContext(workspaceName, workspacePath, namespace, definitionPath string)
func (*Executable) SetDefaults ¶
func (e *Executable) SetDefaults()
func (*Executable) Validate ¶
func (e *Executable) Validate() error
func (*Executable) WorkspacePath ¶
func (e *Executable) WorkspacePath() string
func (*Executable) YAML ¶ added in v0.1.0
func (e *Executable) YAML() (string, error)
type ExecutableDefinition ¶
type ExecutableDefinition struct { // +docsgen:namespace // The namespace of the executable definition. This is used to group executables together. // If not set, the executables in the definition will be grouped into the root (*) namespace. // Namespaces can be reused across multiple definitions. Namespace string `yaml:"namespace,omitempty"` Tags Tags `yaml:"tags,omitempty"` // +docsgen:visibility // The visibility of the executables to Flow. // If not set, the visibility will default to `public`. // // `public` executables can be executed and listed from anywhere. // `private` executables can be executed and listed only within their own workspace. // `internal` executables can be executed within their own workspace but are not listed. // `hidden` executables cannot be executed or listed. Visibility Visibility `yaml:"visibility,omitempty"` // +docsgen:fromFiles // A list of `.sh` files to convert into executables within the definition. FromFiles []string `yaml:"fromFile,omitempty"` // +docsgen:executables // A list of executables to be defined in the executable definition. Executables ExecutableList `yaml:"executables,omitempty"` // contains filtered or unexported fields }
func (*ExecutableDefinition) DefinitionPath ¶
func (d *ExecutableDefinition) DefinitionPath() string
func (*ExecutableDefinition) SetContext ¶
func (d *ExecutableDefinition) SetContext(workspaceName, workspacePath, definitionPath string)
func (*ExecutableDefinition) SetDefaults ¶
func (d *ExecutableDefinition) SetDefaults()
func (*ExecutableDefinition) WorkspacePath ¶
func (d *ExecutableDefinition) WorkspacePath() string
type ExecutableDefinitionList ¶
type ExecutableDefinitionList []*ExecutableDefinition
func (*ExecutableDefinitionList) FilterByNamespace ¶
func (l *ExecutableDefinitionList) FilterByNamespace(namespace string) ExecutableDefinitionList
func (*ExecutableDefinitionList) FilterByTag ¶
func (l *ExecutableDefinitionList) FilterByTag(tag string) ExecutableDefinitionList
type ExecutableDefinitionTemplate ¶ added in v0.1.3
type ExecutableDefinitionTemplate struct { // +docsgen:data // A list of template data to be used when rendering the executable definition. Data TemplateData `yaml:"data"` // +docsgen:artifacts // A list of files to include when copying the template in a new location. The files are copied as-is. Artifacts []string `yaml:"artifacts,omitempty"` *ExecutableDefinition `yaml:",inline"` // contains filtered or unexported fields }
func (*ExecutableDefinitionTemplate) Location ¶ added in v0.1.3
func (t *ExecutableDefinitionTemplate) Location() string
func (*ExecutableDefinitionTemplate) SetContext ¶ added in v0.1.3
func (t *ExecutableDefinitionTemplate) SetContext(location string)
func (*ExecutableDefinitionTemplate) Validate ¶ added in v0.1.3
func (t *ExecutableDefinitionTemplate) Validate() error
type ExecutableDirectory ¶ added in v0.1.3
type ExecutableDirectory struct { // +docsgen:dir // The directory to execute the command in. // If unset, the directory of the executable definition will be used. // If set to `f:tmp`, a temporary directory will be created for the process. // If prefixed with `./`, the path will be relative to the current working directory. // If prefixed with `//`, the path will be relative to the workspace root. // Environment variables in the path will be expended at runtime. Directory string `yaml:"dir,omitempty"` }
type ExecutableEnvironment ¶ added in v0.1.3
type ExecutableEnvironment struct { // +docsgen:params // List of parameters to pass to the executable. Parameters ParameterList `yaml:"params,omitempty"` // +docgen:args // List of arguments to pass to the executable. Args ArgumentList `yaml:"args,omitempty"` }
type ExecutableList ¶
type ExecutableList []*Executable
func (ExecutableList) FilterByNamespace ¶
func (l ExecutableList) FilterByNamespace(ns string) ExecutableList
func (ExecutableList) FilterBySubstring ¶ added in v0.2.0
func (l ExecutableList) FilterBySubstring(str string) ExecutableList
func (ExecutableList) FilterByTags ¶
func (l ExecutableList) FilterByTags(tags Tags) ExecutableList
func (ExecutableList) FilterByVerb ¶
func (l ExecutableList) FilterByVerb(verb Verb) ExecutableList
func (ExecutableList) FilterByWorkspace ¶
func (l ExecutableList) FilterByWorkspace(ws string) ExecutableList
func (ExecutableList) FindByVerbAndID ¶
func (l ExecutableList) FindByVerbAndID(verb Verb, id string) (*Executable, error)
func (ExecutableList) Items ¶ added in v0.1.0
func (l ExecutableList) Items() []*types.CollectionItem
func (ExecutableList) JSON ¶ added in v0.1.0
func (l ExecutableList) JSON() (string, error)
func (ExecutableList) Plural ¶ added in v0.1.0
func (l ExecutableList) Plural() string
func (ExecutableList) Singular ¶ added in v0.1.0
func (l ExecutableList) Singular() string
func (ExecutableList) YAML ¶ added in v0.1.0
func (l ExecutableList) YAML() (string, error)
type ExecutableLocationConfig ¶ added in v0.1.0
type ExecutableLocationConfig struct { // +docsgen:included // A list of directories to include in the executable search. Included []string `json:"included,omitempty" yaml:"included,omitempty"` // +docsgen:excluded // A list of directories to exclude from the executable search. Excluded []string `json:"excluded,omitempty" yaml:"excluded,omitempty"` }
type ExecutableTypeSpec ¶
type ExecutableTypeSpec struct { // +docsgen:exec // Standard executable type. Runs a command/file in a subprocess. Exec *ExecExecutableType `yaml:"exec,omitempty"` // +docsgen:launch // Launches an application or opens a URI. Launch *LaunchExecutableType `yaml:"launch,omitempty"` // +docsgen:request // Makes an HTTP request. Request *RequestExecutableType `yaml:"request,omitempty"` // +docsgen:render // Renders a Markdown template with provided data. Requires the Interactive UI. Render *RenderExecutableType `yaml:"render,omitempty"` // +docsgen:serial // Runs a list of executables in serial. Serial *SerialExecutableType `yaml:"serial,omitempty"` // +docsgen:parallel // Runs a list of executables in parallel. Parallel *ParallelExecutableType `yaml:"parallel,omitempty"` }
type InteractiveConfig ¶ added in v0.1.0
type InteractiveConfig struct { Enabled bool `json:"enabled" yaml:"enabled"` // +docsgen:notify // Whether to send a desktop notification when a command completes. NotifyOnCompletion bool `json:"notify" yaml:"notify"` // +docsgen:sound // Whether to play a sound when a command completes. SoundOnCompletion bool `json:"sound" yaml:"sound"` }
type LaunchExecutableType ¶
type LaunchExecutableType struct { ExecutableEnvironment `yaml:",inline"` App string `yaml:"app,omitempty"` URI string `yaml:"uri,omitempty"` Wait bool `yaml:"wait,omitempty"` }
type ParallelExecutableType ¶
type ParallelExecutableType struct { ExecutableEnvironment `yaml:",inline"` ExecutableRefs []Ref `yaml:"refs,omitempty"` MaxThreads int `yaml:"maxThreads,omitempty"` FailFast bool `yaml:"failFast,omitempty"` }
type Parameter ¶
type Parameter struct { // +docsgen:text // A static value to be passed to the executable. Text string `yaml:"text"` // +docsgen:prompt // A prompt to be displayed to the user when collecting an input value. Prompt string `yaml:"prompt"` // +docsgen:secretRef // A reference to a secret to be passed to the executable. SecretRef string `yaml:"secretRef"` // +docsgen:envKey // The name of the environment variable that will be assigned the value. EnvKey string `yaml:"envKey"` }
+docsgen:param A parameter is a value that can be passed to an executable and all of its sub-executables. Only one of `text`, `secretRef`, or `prompt` must be set. Specifying more than one will result in an error.
type ParameterList ¶
type ParameterList []Parameter
type Ref ¶
type Ref string
+docsgen:ref A reference to an executable. The format is `<verb> <workspace>/<namespace>:<executable name>`. For example, `exec ws/ns:my-flow`.
The workspace and namespace are optional. If the workspace is not specified, the current workspace will be used. If the namespace is not specified, the current namespace will be used.
func (Ref) GetNamespace ¶ added in v0.1.6
func (Ref) GetWorkspace ¶ added in v0.1.6
type RenderExecutableType ¶ added in v0.1.0
type RenderExecutableType struct { ExecutableDirectory `yaml:",inline"` ExecutableEnvironment `yaml:",inline"` TemplateFile string `yaml:"templateFile,omitempty"` TemplateDataFile string `yaml:"templateDataFile,omitempty"` }
type RequestExecutableType ¶ added in v0.1.0
type RequestExecutableType struct { ExecutableEnvironment `yaml:",inline"` Method string `yaml:"method,omitempty"` URL string `yaml:"url,omitempty"` Body string `yaml:"body,omitempty"` Headers map[string]string `yaml:"headers,omitempty"` Timeout time.Duration `yaml:"timeout,omitempty"` ResponseFile *RequestResponseFile `yaml:"responseFile,omitempty"` TransformResponse string `yaml:"transformResponse,omitempty"` LogResponse bool `yaml:"logResponse,omitempty"` ValidStatusCodes []int `yaml:"validStatusCodes,omitempty"` }
type RequestResponseFile ¶ added in v0.1.0
type RequestResponseFile struct { ExecutableDirectory `yaml:",inline"` Filename string `yaml:"filename,omitempty"` SaveAs string `yaml:"saveAs,omitempty"` }
type SerialExecutableType ¶
type SerialExecutableType struct { ExecutableEnvironment `yaml:",inline"` // +docsgen:refs // List of executables references ExecutableRefs []Ref `yaml:"refs,omitempty"` FailFast bool `yaml:"failFast,omitempty"` }
type Tags ¶
type Tags []string
+docsgen:tags A list of tags. Tags can be used with list commands to filter returned data.
func (Tags) ContextString ¶ added in v0.1.0
func (Tags) PreviewString ¶ added in v0.1.0
type TemplateData ¶ added in v0.1.3
type TemplateData []TemplateDataEntry
func (*TemplateData) MapInterface ¶ added in v0.1.3
func (t *TemplateData) MapInterface() map[string]interface{}
func (*TemplateData) Set ¶ added in v0.1.3
func (t *TemplateData) Set(key, value string)
func (*TemplateData) Validate ¶ added in v0.1.3
func (t *TemplateData) Validate() error
func (*TemplateData) ValidateValues ¶ added in v0.1.3
func (t *TemplateData) ValidateValues() error
type TemplateDataEntry ¶ added in v0.1.3
type TemplateDataEntry struct { // +docsgen:key // The key to associate the data with. This is used as the key in the template data map. Key string `yaml:"key"` // +docsgen:prompt // A prompt to be displayed to the user when collecting an input value. Prompt string `yaml:"prompt"` // +docsgen:default // The default value to use if a value is not set. Default string `yaml:"default"` // +docsgen:required // If true, a value must be set. If false, the default value will be used if a value is not set. Required bool `yaml:"required"` // contains filtered or unexported fields }
func (*TemplateDataEntry) Set ¶ added in v0.1.3
func (t *TemplateDataEntry) Set(value string)
func (*TemplateDataEntry) Validate ¶ added in v0.1.3
func (t *TemplateDataEntry) Validate() error
func (*TemplateDataEntry) ValidateValue ¶ added in v0.1.3
func (t *TemplateDataEntry) ValidateValue() error
func (*TemplateDataEntry) Value ¶ added in v0.1.3
func (t *TemplateDataEntry) Value() string
type UserConfig ¶
type UserConfig struct { // +docsgen:workspaces // Map of workspace names to their paths. Workspaces map[string]string `json:"workspaces" yaml:"workspaces"` // +docsgen:currentWorkspace // The name of the current workspace. This should match a key in the `workspaces` map. CurrentWorkspace string `json:"currentWorkspace" yaml:"currentWorkspace"` // +docsgen:workspaceMode // The mode of the workspace. This can be either `fixed` or `dynamic`. // In `fixed` mode, the current workspace used at runtime is always the one set in the currentWorkspace config field. // In `dynamic` mode, the current workspace used at runtime is determined by the current directory. // If the current directory is within a workspace, that workspace is used. WorkspaceMode WorkspaceMode `json:"workspaceMode" yaml:"workspaceMode"` // +docsgen:currentNamespace // The name of the current namespace. This is not required to be set. CurrentNamespace string `json:"currentNamespace" yaml:"currentNamespace"` // +docsgen:interactive // Configurations for the interactive UI. Interactive *InteractiveConfig `json:"interactive" yaml:"interactive"` // +docsgen:templates // A map of executable definition template names to their paths. Templates map[string]string `json:"templates,omitempty" yaml:"templates,omitempty"` // +docsgen:defaultLogMode // The default log mode to use when running executables. // This can either be `hidden`, `json`, `logfmt` or `text` DefaultLogMode io.LogMode `json:"defaultLogMode,omitempty" yaml:"defaultLogMode,omitempty"` }
func (*UserConfig) JSON ¶ added in v0.1.0
func (c *UserConfig) JSON() (string, error)
func (*UserConfig) Markdown ¶ added in v0.1.0
func (c *UserConfig) Markdown() string
func (*UserConfig) Validate ¶
func (c *UserConfig) Validate() error
func (*UserConfig) YAML ¶ added in v0.1.0
func (c *UserConfig) YAML() (string, error)
type Verb ¶
type Verb string
+docsgen:verb Keywords that describe the action an executable performs. While executables are configured with a single verb, the verb can be aliased to related verbs. For example, the `exec` verb can replaced with "run" or "start" when referencing an executable. This allows users to use the verb that best describes the action they are performing.
**Activation verbs**: `exec`, `run`, `start`, `install`, `setup`, `release`, `deploy`, `apply` **Deactivation verbs**: `delete`, `remove`, `uninstall`, `destroy`, `undeploy` **Update verbs**: `update`, `upgrade`, `refresh`, `reload` **Management verbs**: `manage`, `configure`, `monitor`, `edit` **Launch verbs**: `open`, `launch`, `show`, `view`, `render` **Creation verbs**: `generate`, `add`, `new`, `build`, `transform`
func RelatedVerbs ¶
type Visibility ¶ added in v0.1.5
type Visibility string
const ( // VisibilityPublic is executable and visible across all workspaces. VisibilityPublic Visibility = "public" // VisibilityPrivate is executable and visible only within it's own workspace. VisibilityPrivate Visibility = "private" // VisibilityInternal is not visible but can be executed within a workspace. VisibilityInternal Visibility = "internal" // VisibilityHidden is not executable or visible. VisibilityHidden Visibility = "hidden" )
func (Visibility) IsHidden ¶ added in v0.1.5
func (v Visibility) IsHidden() bool
func (Visibility) IsInternal ¶ added in v0.1.5
func (v Visibility) IsInternal() bool
func (Visibility) IsPrivate ¶ added in v0.1.5
func (v Visibility) IsPrivate() bool
func (Visibility) IsPublic ¶ added in v0.1.5
func (v Visibility) IsPublic() bool
func (Visibility) NewPointer ¶ added in v0.2.0
func (v Visibility) NewPointer() *Visibility
func (Visibility) String ¶ added in v0.1.5
func (v Visibility) String() string
type WorkspaceConfig ¶
type WorkspaceConfig struct { // +docsgen:displayName // The display name of the workspace. This is used in the interactive UI. DisplayName string `json:"displayName" yaml:"displayName"` Description string `json:"description,omitempty" yaml:"description,omitempty"` Tags Tags `json:"tags,omitempty" yaml:"tags,omitempty"` Git *GitConfig `json:"git,omitempty" yaml:"git,omitempty"` Executables *ExecutableLocationConfig `json:"executables,omitempty" yaml:"executables,omitempty"` // contains filtered or unexported fields }
func DefaultWorkspaceConfig ¶
func DefaultWorkspaceConfig(name string) *WorkspaceConfig
func (*WorkspaceConfig) AssignedName ¶
func (c *WorkspaceConfig) AssignedName() string
func (*WorkspaceConfig) JSON ¶ added in v0.1.0
func (c *WorkspaceConfig) JSON() (string, error)
func (*WorkspaceConfig) Location ¶
func (c *WorkspaceConfig) Location() string
func (*WorkspaceConfig) Markdown ¶ added in v0.1.0
func (c *WorkspaceConfig) Markdown() string
func (*WorkspaceConfig) SetContext ¶
func (c *WorkspaceConfig) SetContext(name, location string)
func (*WorkspaceConfig) YAML ¶ added in v0.1.0
func (c *WorkspaceConfig) YAML() (string, error)
type WorkspaceConfigList ¶ added in v0.1.0
type WorkspaceConfigList []WorkspaceConfig
func (WorkspaceConfigList) Items ¶ added in v0.1.0
func (l WorkspaceConfigList) Items() []*types.CollectionItem
func (WorkspaceConfigList) JSON ¶ added in v0.1.0
func (l WorkspaceConfigList) JSON() (string, error)
func (WorkspaceConfigList) Plural ¶ added in v0.1.0
func (l WorkspaceConfigList) Plural() string
func (WorkspaceConfigList) Singular ¶ added in v0.1.0
func (l WorkspaceConfigList) Singular() string
func (WorkspaceConfigList) YAML ¶ added in v0.1.0
func (l WorkspaceConfigList) YAML() (string, error)
type WorkspaceMode ¶ added in v0.1.3
type WorkspaceMode string
const ( WorkspaceModeFixed WorkspaceMode = "fixed" WorkspaceModeDynamic WorkspaceMode = "dynamic" )