workspace

Documentation

Index

• Variables
• func GetProjectEnvVars(project *Project, params ProjectEnvVarParams, telemetryEnabled bool) map[string]string
• func GetProjectHostname(workspaceId string, projectName string) string
• func GetWorkspaceEnvVars(workspace *Workspace, params WorkspaceEnvVarParams, telemetryEnabled bool) map[string]string
• func IsWorkspaceNotFound(err error) bool
• type FileStatus
• type GitStatus
• type Project
  • func (p *Project) GetConfigHash() (string, error)
• type ProjectBuild
• type ProjectBuildDevcontainer
• type ProjectEnvVarParams
• type ProjectInfo
• type ProjectState
• type Status
• type Store
• type Workspace
  • func (w *Workspace) GetProject(projectName string) (*Project, error)
• type WorkspaceEnvVarParams
• type WorkspaceInfo

Variables

var (
	ErrWorkspaceNotFound = errors.New("workspace not found")
)

Functions

func GetProjectEnvVars

func GetProjectEnvVars(project *Project, params ProjectEnvVarParams, telemetryEnabled bool) map[string]string

func GetProjectHostname

func GetProjectHostname(workspaceId string, projectName string) string

func GetWorkspaceEnvVars

func GetWorkspaceEnvVars(workspace *Workspace, params WorkspaceEnvVarParams, telemetryEnabled bool) map[string]string

func IsWorkspaceNotFound

func IsWorkspaceNotFound(err error) bool

Types

type FileStatus

type FileStatus struct {
	Name     string `json:"name"`
	Extra    string `json:"extra"`
	Staging  Status `json:"staging"`
	Worktree Status `json:"worktree"`

} // @name FileStatus

type GitStatus

type GitStatus struct {
	CurrentBranch string        `json:"currentBranch"`
	Files         []*FileStatus `json:"fileStatus"`

} // @name GitStatus

type Project

type Project struct {
	Name        string                     `json:"name"`
	Image       string                     `json:"image"`
	User        string                     `json:"user"`
	Build       *ProjectBuild              `json:"build"`
	Repository  *gitprovider.GitRepository `json:"repository"`
	WorkspaceId string                     `json:"workspaceId"`
	ApiKey      string                     `json:"-"`
	Target      string                     `json:"target"`
	EnvVars     map[string]string          `json:"-"`
	State       *ProjectState              `json:"state,omitempty"`

} // @name Project

func (*Project) GetConfigHash

func (p *Project) GetConfigHash() (string, error)

GetConfigHash returns a SHA-256 hash of the project's build configuration, repository URL, and environment variables.

type ProjectBuild

type ProjectBuild struct {
	Devcontainer *ProjectBuildDevcontainer `json:"devcontainer"`

} // @name ProjectBuild

type ProjectBuildDevcontainer

type ProjectBuildDevcontainer struct {
	DevContainerFilePath string `json:"devContainerFilePath"`

} // @name ProjectBuildDevcontainer

type ProjectEnvVarParams

type ProjectEnvVarParams struct {
	ApiUrl    string
	ServerUrl string
	ClientId  string
}

type ProjectInfo

type ProjectInfo struct {
	Name             string `json:"name"`
	Created          string `json:"created"`
	IsRunning        bool   `json:"isRunning"`
	ProviderMetadata string `json:"providerMetadata,omitempty"`
	WorkspaceId      string `json:"workspaceId"`

} // @name ProjectInfo

type ProjectState

type ProjectState struct {
	UpdatedAt string     `json:"updatedAt"`
	Uptime    uint64     `json:"uptime"`
	GitStatus *GitStatus `json:"gitStatus"`

} // @name ProjectState

type Status

type Status string // @name Status

Status status code of a file in the Worktree

const (
	Unmodified         Status = "Unmodified"
	Untracked          Status = "Untracked"
	Modified           Status = "Modified"
	Added              Status = "Added"
	Deleted            Status = "Deleted"
	Renamed            Status = "Renamed"
	Copied             Status = "Copied"
	UpdatedButUnmerged Status = "Updated but unmerged"
)

type Store

type Store interface {
	List() ([]*Workspace, error)
	Find(idOrName string) (*Workspace, error)
	Save(workspace *Workspace) error
	Delete(workspace *Workspace) error
}

type Workspace

type Workspace struct {
	Id       string            `json:"id"`
	Name     string            `json:"name"`
	Projects []*Project        `json:"projects"`
	Target   string            `json:"target"`
	ApiKey   string            `json:"-"`
	EnvVars  map[string]string `json:"-"`

} // @name Workspace

func (*Workspace) GetProject

func (w *Workspace) GetProject(projectName string) (*Project, error)

type WorkspaceEnvVarParams

type WorkspaceEnvVarParams struct {
	ApiUrl    string
	ServerUrl string
	ClientId  string
}

type WorkspaceInfo

type WorkspaceInfo struct {
	Name             string         `json:"name"`
	Projects         []*ProjectInfo `json:"projects"`
	ProviderMetadata string         `json:"providerMetadata,omitempty"`

} // @name WorkspaceInfo