devcontainers

Documentation

Index

• func GetDevContainerURI(folderPath string) (string, error)
• func GetLocalFolderFromDevContainer(containerIDOrName string) (string, error)
• func GetWorkspaceMountPath(folderPath string) (string, error)
• type DevcontainerInfo
  • func ListDevcontainers() ([]DevcontainerInfo, error)
• type DevcontainerTemplate
  • func GetTemplateByName(name string) (*DevcontainerTemplate, error)
  • func GetTemplates() ([]DevcontainerTemplate, error)

Functions

func GetDevContainerURI

func GetDevContainerURI(folderPath string) (string, error)

GetDevContainerURI gets the devcontainer URI for a folder to launch using the VS Code --folder-uri switch

func GetLocalFolderFromDevContainer

func GetLocalFolderFromDevContainer(containerIDOrName string) (string, error)

GetLocalFolderFromDevContainer looks up the local (host) folder name from the container labels

func GetWorkspaceMountPath

func GetWorkspaceMountPath(folderPath string) (string, error)

GetWorkspaceMountPath returns the devcontainer mount path for the devcontainer in the specified folder

Types

type DevcontainerInfo

type DevcontainerInfo struct {
	ContainerID      string
	ContainerName    string
	DevcontainerName string
}

DevcontainerInfo holds details about a devcontainer

func ListDevcontainers

func ListDevcontainers() ([]DevcontainerInfo, error)

ListDevcontainers returns a list of devcontainers

type DevcontainerTemplate

type DevcontainerTemplate struct {
	Name string
	// Path is the path including the .devcontainer folder
	Path string
}

DevcontainerTemplate holds info on templates for list/add etc

func GetTemplateByName

func GetTemplateByName(name string) (*DevcontainerTemplate, error)

GetTemplateByName returns the template with the specified name or nil if not found

func GetTemplates

func GetTemplates() ([]DevcontainerTemplate, error)

GetTemplates returns a list of discovered templates