devcontainer

package
v3.7.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 2, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateConfigFile added in v3.4.3 

func CreateConfigFile(devcontainerPath string, workspaceFolder string, configDirForDevcontainer string) (string, error)

devcontainer.vim 起動時に使用する設定ファイルを作成する 設定ファイルは、 devcontainer.vim のキャッシュ内の `config` ディレクトリに、 ワークスペースフォルダのパスを md5 ハッシュ化した名前のディレクトリに格納する.

func Down 

func Down(args []string, devcontainerPath string, configDirForDevcontainer string) error

func Execute 

func Execute(devcontainerFilePath string, args ...string) (string, error)

func ExecuteCombineOutput 

func ExecuteCombineOutput(devcontainerFilePath string, args ...string) (string, error)

func GetConfigFilePath 

func GetConfigFilePath(readConfigurationCommandResult string) (string, error)

func GetConfigurationFilePath 

func GetConfigurationFilePath(devcontainerFilePath string, workspaceFolder string) (string, error)

func GetContainerID 

func GetContainerID(upCommandResult string) (string, error)

func ReadConfiguration 

func ReadConfiguration(devcontainerFilePath string, readConfiguration ...string) (string, error)

func Run added in v3.1.0 

func Run(
	args []string,
	noCdr bool,
	noPf bool,
	cdrPath string,
	vimInstallDir string,
	nvim bool,
	shell string,
	configDirForDocker string,
	vimrc string,
	defaultRunargs []string) error

docker run で、ワンショットでコンテナを立ち上げる

func Start 

func Start(
	services DevcontainerStartUseService,
	args []string,
	devcontainerPath string,
	noCdr bool,
	noPf bool,
	cdrPath string,
	vimInstallDir string,
	nvim bool,
	shell string,
	configFilePath string,
	vimrc string) error

devcontainer でコンテナを立ち上げ、 Vim を転送し、実行する。 既存実装の都合上、configFilePath から configDirForDevcontainer を抽出している

func Stop 

func Stop(args []string, devcontainerPath string, configDirForDevcontainer string) error

func Templates 

func Templates(
	devcontainerFilePath string,
	workspaceFolder string,
	templateID string) (string, error)

Types

type ChmodError added in v3.1.0 

type ChmodError struct {
	// contains filtered or unexported fields
}

func (*ChmodError) Error added in v3.1.0 

func (e *ChmodError) Error() string

type ConfigFilePath 

type ConfigFilePath struct {
	FsPath string `json:"fsPath"`
}

type Configuration 

type Configuration struct {
	ForwardPorts   []any          `json:"forwardPorts"`
	ConfigFilePath ConfigFilePath `json:"configFilePath"`
}

type ContainerStartError added in v3.1.0 

type ContainerStartError struct {
	// contains filtered or unexported fields
}

func (*ContainerStartError) Error added in v3.1.0 

func (e *ContainerStartError) Error() string

type DefaultDevcontainerStartUseService added in v3.4.3 

type DefaultDevcontainerStartUseService struct{}

func (DefaultDevcontainerStartUseService) StartVim added in v3.4.3 

func (s DefaultDevcontainerStartUseService) StartVim(containerID string, devcontainerPath string, workspaceFolder string, vimFileName string, sendToTCP string, containerArch string, useSystemVim bool, shell string, configDirForDevcontainer string) error

type DevcontainerJSON 

type DevcontainerJSON struct {
	DockerComposeFile interface{} `json:"dockerComposeFile"`
}

devcontainer.json のスキーマ(の一部)

func UnmarshalDevcontainerJSON 

func UnmarshalDevcontainerJSON(data []byte) (DevcontainerJSON, error)

type DevcontainerStartUseService added in v3.4.3 

type DevcontainerStartUseService interface {
	StartVim(containerID string, devcontainerPath string, workspaceFolder string, vimFileName string, sendToTCP string, containerArch string, useSystemVim bool, shell string, configFilePathForDevcontainer string) error
}

type ForwardConfig added in v3.4.0 

type ForwardConfig struct {
	Host string
	Port string
}

func GetForwardPorts added in v3.4.0 

func GetForwardPorts(readConfigurationCommandResult string) ([]ForwardConfig, error)

readConfigurationCommandResult から forwardPorts の情報を取得します。

type ReadConfigurationCommandResult 

type ReadConfigurationCommandResult struct {
	Configuration Configuration `json:"configuration"`
}

`devcontainers read-configuration` コマンドの実行結果スキーマ 

Example:	{
						"configuration":{
							"name":"development environment",
							"dockerComposeFile":[
								"../docker-compose.yaml"
							],
							"service":"app",
							"workspaceFolder":"/work",
							"remoteUser":"root",
							"configFilePath": {
								"$mid":1,
								"fsPath":"/home/mikoto/project/oasiz-mqtt-client/.devcontainer/devcontainer.json",
								"path":"/home/mikoto/project/oasiz-mqtt-client/.devcontainer/devcontainer.json",
								"scheme":"vscode-fileHost"
							}
						},
						"workspace": {
							"workspaceFolder":"/work"
						}
					}

func UnmarshalReadConfigurationCommandResult 

func UnmarshalReadConfigurationCommandResult(data []byte) (ReadConfigurationCommandResult, error)

type ReadConfigurationError 

type ReadConfigurationError struct {
	// contains filtered or unexported fields
}

func (*ReadConfigurationError) Error 

func (e *ReadConfigurationError) Error() string

type UnknownTypeError 

type UnknownTypeError struct {
	// contains filtered or unexported fields
}

func (*UnknownTypeError) Error 

func (e *UnknownTypeError) Error() string

type UpCommandResult 

type UpCommandResult struct {
	Outcome               string `json:"outcome"`
	ContainerID           string `json:"containerId"`
	ComposeProjectName    string `json:"composeProjectName"`
	RemoteUser            string `json:"remoteUser"`
	RemoteWorkspaceFolder string `json:"remoteWorkspaceFolder"`
}

`devcontainers up` コマンドの実行結果スキーマ

Example: {"outcome":"success","containerId":"7278c789a975c34177e0b77d00477d5518c4fae4e66e6f0f9196561d5f895740","composeProjectName":"oasiz-mqtt-client","remoteUser":"root","remoteWorkspaceFolder":"/work"}

func UnmarshalUpCommandResult 

func UnmarshalUpCommandResult(data []byte) (UpCommandResult, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.