Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ExecutableFilter ¶
type ExecutableFilter struct {
// A list of directories to exclude from the executable search.
Excluded []string `json:"excluded,omitempty" yaml:"excluded,omitempty" mapstructure:"excluded,omitempty"`
// A list of directories to include in the executable search.
Included []string `json:"included,omitempty" yaml:"included,omitempty" mapstructure:"included,omitempty"`
}
type VerbAliases ¶
A map of executable verbs to valid aliases. This allows you to use custom aliases for exec commands in the workspace. Setting this will override all of the default flow command aliases. The verbs and its mapped aliases must be valid flow verbs.
If set to an empty object, verb aliases will be disabled.
type Workspace ¶
type Workspace struct {
// A description of the workspace. This description is rendered as markdown in the
// interactive UI.
Description string `json:"description,omitempty" yaml:"description,omitempty" mapstructure:"description,omitempty"`
// A path to a markdown file that contains the description of the workspace.
DescriptionFile string `json:"descriptionFile,omitempty" yaml:"descriptionFile,omitempty" mapstructure:"descriptionFile,omitempty"`
// The display name of the workspace. This is used in the interactive UI.
DisplayName string `json:"displayName,omitempty" yaml:"displayName,omitempty" mapstructure:"displayName,omitempty"`
// Executables corresponds to the JSON schema field "executables".
Executables *ExecutableFilter `json:"executables,omitempty" yaml:"executables,omitempty" mapstructure:"executables,omitempty"`
// Tags corresponds to the JSON schema field "tags".
Tags WorkspaceTags `json:"tags,omitempty" yaml:"tags,omitempty" mapstructure:"tags,omitempty"`
// VerbAliases corresponds to the JSON schema field "verbAliases".
VerbAliases *WorkspaceVerbAliases `json:"verbAliases,omitempty" yaml:"verbAliases,omitempty" mapstructure:"verbAliases,omitempty"`
// contains filtered or unexported fields
}
Configuration for a workspace in the Flow CLI. This configuration is used to define the settings for a workspace. Every workspace has a workspace config file named `flow.yaml` in the root of the workspace directory.
func DefaultWorkspaceConfig ¶
func (*Workspace) AssignedName ¶
func (*Workspace) SetContext ¶
type WorkspaceList ¶
type WorkspaceList []*Workspace
func (WorkspaceList) FindByName ¶
func (l WorkspaceList) FindByName(name string) *Workspace
func (WorkspaceList) Items ¶
func (l WorkspaceList) Items() []*types.EntityInfo
func (WorkspaceList) JSON ¶
func (l WorkspaceList) JSON() (string, error)
func (WorkspaceList) Plural ¶
func (l WorkspaceList) Plural() string
func (WorkspaceList) Singular ¶
func (l WorkspaceList) Singular() string
func (WorkspaceList) YAML ¶
func (l WorkspaceList) YAML() (string, error)
type WorkspaceTags ¶
type WorkspaceVerbAliases ¶
Click to show internal directories.
Click to hide internal directories.