features

Documentation

Index

• Constants
• type Option
• type Spec
  • func Extract(fs billy.Filesystem, directory, reference string) (*Spec, error)
  • func (s *Spec) Compile(options map[string]any) (string, error)

Constants

const (
	TarLayerMediaType = "application/vnd.devcontainers.layer.v1+tar"
)

Types

type Option

type Option struct {
	Type        string   `json:"type"` // "boolean" or "string"
	Proposals   []string `json:"proposals"`
	Enum        []string `json:"enum"`
	Default     any      `json:"default"` // boolean or string
	Description string   `json:"description"`
}

type Spec

type Spec struct {
	ID               string            `json:"id"`
	Version          string            `json:"version"`
	Name             string            `json:"name"`
	Description      string            `json:"description"`
	DocumentationURL string            `json:"documentationURL"`
	LicenseURL       string            `json:"licenseURL"`
	Keywords         []string          `json:"keywords"`
	Options          map[string]Option `json:"options"`
	ContainerEnv     map[string]string `json:"containerEnv"`

	InstallScriptPath string `json:"-"`
}

func Extract

func Extract(fs billy.Filesystem, directory, reference string) (*Spec, error)

Extract unpacks the feature from the image and returns the parsed specification.

func (*Spec) Compile

func (s *Spec) Compile(options map[string]any) (string, error)

Extract unpacks the feature from the image and returns a set of lines that should be appended to a Dockerfile to install the feature.