devcontainers

Documentation

Index

• Constants
• type DevcontainerInfo
  • func ListDevcontainers() ([]DevcontainerInfo, error)
• type DevcontainerTemplate
  • func GetTemplateByName(name string) (*DevcontainerTemplate, error)
  • func GetTemplates() ([]DevcontainerTemplate, error)

Constants

const (
	ListPartID                     int = 0
	ListPartLocalFolder            int = 1
	ListPartComposeProject         int = 2
	ListPartComposeService         int = 3
	ListPartComposeContainerNumber int = 4
	ListPartContainerName          int = 5
)

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