devcontainers

Documentation

Index

• Constants
• func AddSnippetToDevcontainer(projectFolder string, snippetName string) error
• func CopyTemplateToFolder(templatePath string, targetFolder string, devcontainerName string) error
• func ExecInDevContainer(containerID string, workDir string, args []string) error
• func GetDefaultDevcontainerNameForFolder(folderPath string) (string, error)
• func GetDevContainerURI(folderPath string) (string, error)
• func GetDevContainerUserName(devContainerJsonPath string) (string, error)
• func GetLocalFolderFromDevContainer(containerIDOrName string) (string, error)
• func GetWorkspaceMountPath(folderPath string) (string, error)
• func SetDevcontainerName(devContainerJsonPath string, name string) error
• type DevcontainerInfo
  • func GetClosestPathMatchForPath(devContainers []DevcontainerInfo, devcontainerPath string) (DevcontainerInfo, error)
  • func ListDevcontainers() ([]DevcontainerInfo, error)
• type DevcontainerSnippet
  • func GetSnippetByName(name string) (*DevcontainerSnippet, error)
  • func GetSnippets() ([]DevcontainerSnippet, error)
• type DevcontainerSnippetType
• type DevcontainerTemplate
  • func GetTemplateByName(name string) (*DevcontainerTemplate, error)
  • func GetTemplates() ([]DevcontainerTemplate, error)
• type DockerMount
• type FolderSnippet
• type FolderSnippetAction
• type FolderSnippetActionType
• type SourceInfo
  • func GetSourceInfoFromDevContainer(containerIDOrName string) (SourceInfo, error)
• type SubstitutionValues

Constants

const (
	DevcontainerSnippetTypeSingleFile = "Snippet:SingleFile"
	DevcontainerSnippetTypeFolder     = "Snippet:Folder"
)

Functions

func AddSnippetToDevcontainer

func AddSnippetToDevcontainer(projectFolder string, snippetName string) error

func CopyTemplateToFolder

func CopyTemplateToFolder(templatePath string, targetFolder string, devcontainerName string) error

func ExecInDevContainer

func ExecInDevContainer(containerID string, workDir string, args []string) error

func GetDefaultDevcontainerNameForFolder

func GetDefaultDevcontainerNameForFolder(folderPath string) (string, error)

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 GetDevContainerUserName

func GetDevContainerUserName(devContainerJsonPath string) (string, error)

"remoteUser": "vscode"

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

func SetDevcontainerName

func SetDevcontainerName(devContainerJsonPath string, name string) error

Types

type DevcontainerInfo

type DevcontainerInfo struct {
	ContainerID      string `json:"containerID"`
	ContainerName    string `json:"containerName"`
	DevcontainerName string `json:"devcontainerName"`
	LocalFolderPath  string `json:"localFolderPath"`
}

DevcontainerInfo holds details about a devcontainer

func GetClosestPathMatchForPath

func GetClosestPathMatchForPath(devContainers []DevcontainerInfo, devcontainerPath string) (DevcontainerInfo, error)

GetClosestPathMatchForPath returns the dev container with the closes match to the specified path

func ListDevcontainers

func ListDevcontainers() ([]DevcontainerInfo, error)

ListDevcontainers returns a list of devcontainers

type DevcontainerSnippet

type DevcontainerSnippet struct {
	Name string
	Type DevcontainerSnippetType
	// Path is the path to either the path to the single script file or to the directory for multi-file snippets
	Path string
}

DevcontainerSnippet holds info on snippets for list/add etc Snippets can be either single script files or a directory with a set of files

func GetSnippetByName

func GetSnippetByName(name string) (*DevcontainerSnippet, error)

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

func GetSnippets

func GetSnippets() ([]DevcontainerSnippet, error)

GetSnippets returns a list of discovered templates

type DevcontainerSnippetType

type DevcontainerSnippetType string

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

type DockerMount

type DockerMount struct {
	Source      string `json:"Source"`
	Destination string `json:"Destination"`
}

DockerMount represents mount info from Docker output

type FolderSnippet

type FolderSnippet struct {
	Actions []FolderSnippetAction `json:"actions"`
}

FolderSnippet maps to the content of the snippet.json file for folder-based snippets

type FolderSnippetAction

type FolderSnippetAction struct {
	Type        FolderSnippetActionType `json:"type"`
	SourcePath  string                  `json:"source"`      // for mergeJSON this is snippet-relative path to JSON. for copyAndRun this is the script filename
	TargetPath  string                  `json:"target"`      // for mergeJSON this is project-relative path to JSON
	Content     string                  `json:"content"`     // for dockerfileSnippet this is the content to include
	ContentPath string                  `json:"contentPath"` // for dockerfileSnippet this is the path to content to include
}

type FolderSnippetActionType

type FolderSnippetActionType string

const (
	FolderSnippetActionMergeJSON         FolderSnippetActionType = "mergeJSON"         // merge JSON file from snippet with target JSON file
	FolderSnippetActionCopyAndRun        FolderSnippetActionType = "copyAndRun"        // COPY and RUN script from snippet in the Dockerfile (as with single-file snippet)
	FolderSnippetActionDockerfileSnippet FolderSnippetActionType = "dockerfileSnippet" // snippet to include as-is in the Dockerfile
)

type SourceInfo

type SourceInfo struct {
	DevcontainerFolder string
	DockerMount        DockerMount
}

SourceInfo holds properties about the source mounted in a dev container

func GetSourceInfoFromDevContainer

func GetSourceInfoFromDevContainer(containerIDOrName string) (SourceInfo, error)

GetSourceInfoFromDevContainer inspects the specified container and returns the SourceInfo

type SubstitutionValues

type SubstitutionValues struct {
	Name       string
	UserName   string
	HomeFolder string
}