The highest tagged major version is v3.

devcontainer

package

v1.3.1 Latest Latest Go to latest Published: Nov 12, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mikoto2000/devcontainer.vim

Links

Open Source Insights

Documentation ¶

Index ¶

func Down(args []string, devcontainerPath string, configDirForDevcontainer string) error
func Execute(devcontainerFilePath string, args ...string) (string, error)
func ExecuteCombineOutput(devcontainerFilePath string, args ...string) (string, error)
func ExecuteDevcontainer(args []string, devcontainerPath string, vimFilePath string, ...) error
func GetConfigFilePath(readConfigurationCommandResult string) (string, error)
func GetConfigurationFilePath(devcontainerFilePath string, workspaceFolder string) (string, error)
func GetContainerID(upCommandResult string) (string, error)
func ReadConfiguration(devcontainerFilePath string, readConfiguration ...string) (string, error)
func Stop(args []string, devcontainerPath string, configDirForDevcontainer string) error
func Templates(devcontainerFilePath string, workspaceFolder string, templateID string) (string, error)
type ConfigFilePath
type Configuration
type DevcontainerJSON
- func UnmarshalDevcontainerJSON(data []byte) (DevcontainerJSON, error)
type ReadConfigurationCommandResult
- func UnmarshalReadConfigurationCommandResult(data []byte) (ReadConfigurationCommandResult, error)
type ReadConfigurationError
- func (e *ReadConfigurationError) Error() string
type UnknownTypeError
- func (e *UnknownTypeError) Error() string
type UpCommandResult
- func UnmarshalUpCommandResult(data []byte) (UpCommandResult, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Down ¶ added in v0.4.0

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

func Execute ¶ added in v0.5.0

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

func ExecuteCombineOutput ¶ added in v0.6.0

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

func ExecuteDevcontainer ¶

func ExecuteDevcontainer(args []string, devcontainerPath string, vimFilePath string, cdrPath, configFilePath string, vimrc string) error

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

func GetConfigFilePath ¶ added in v0.5.0

func GetConfigFilePath(readConfigurationCommandResult string) (string, error)

func GetConfigurationFilePath ¶ added in v0.5.0

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

func GetContainerID ¶ added in v0.10.0

func GetContainerID(upCommandResult string) (string, error)

func ReadConfiguration ¶ added in v0.5.0

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

func Stop ¶ added in v0.10.0

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

func Templates ¶ added in v0.6.0

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

Types ¶

type ConfigFilePath ¶ added in v0.5.0

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

type Configuration ¶ added in v0.5.0

type Configuration struct {
	ConfigFilePath ConfigFilePath `json:"configFilePath"`
}

type DevcontainerJSON ¶ added in v1.0.1

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

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

func UnmarshalDevcontainerJSON ¶ added in v1.0.1

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

type ReadConfigurationCommandResult ¶ added in v0.5.0

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 ¶ added in v0.5.0

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

type ReadConfigurationError ¶ added in v1.2.3

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

func (*ReadConfigurationError) Error ¶ added in v1.2.3

func (e *ReadConfigurationError) Error() string

type UnknownTypeError ¶ added in v1.2.3

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

func (*UnknownTypeError) Error ¶ added in v1.2.3

func (e *UnknownTypeError) Error() string

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL