modules

Documentation

Index

• Constants
• type ModuleCodegenConfig
• type ModuleConfig
  • func (modCfg *ModuleConfig) DependencyByName(name string) (*ModuleConfigDependency, bool)
  • func (modCfg *ModuleConfig) UnmarshalJSON(data []byte) error
• type ModuleConfigDependency
  • func (depCfg *ModuleConfigDependency) UnmarshalJSON(data []byte) error
• type ModuleConfigView

Constants

const EngineVersionLatest string = "latest"

EngineVersionLatest is replaced by the current engine.Version during module init.

const Filename = "dagger.json"

Filename is the name of the module config file.

Types

type ModuleCodegenConfig

type ModuleCodegenConfig struct {
	// Whether to automatically generate a .gitignore file for this module.
	AutomaticGitignore *bool `json:"automaticGitignore,omitempty"`
}

type ModuleConfig

type ModuleConfig struct {
	// The name of the module.
	Name string `json:"name"`

	// The version of the engine this module was last updated with.
	EngineVersion string `json:"engineVersion"`

	// The SDK this module uses
	SDK string `json:"sdk,omitempty"`

	// Paths to explicitly include from the module, relative to the configuration file.
	Include []string `json:"include,omitempty"`

	// Paths to explicitly exclude from the module, relative to the configuration file.
	Exclude []string `json:"exclude,omitempty"`

	// The modules this module depends on.
	Dependencies []*ModuleConfigDependency `json:"dependencies,omitempty"`

	// The path, relative to this config file, to the subdir containing the module's implementation source code.
	Source string `json:"source,omitempty"`

	// Named views defined for this module, which are sets of directory filters that can be applied to
	// directory arguments provided to functions.
	Views []*ModuleConfigView `json:"views,omitempty"`

	// Codegen configuration for this module.
	Codegen *ModuleCodegenConfig `json:"codegen,omitempty"`
}

ModuleConfig is the config for a single module as loaded from a dagger.json file.

func (*ModuleConfig) DependencyByName

func (modCfg *ModuleConfig) DependencyByName(name string) (*ModuleConfigDependency, bool)

func (*ModuleConfig) UnmarshalJSON

func (modCfg *ModuleConfig) UnmarshalJSON(data []byte) error

type ModuleConfigDependency

type ModuleConfigDependency struct {
	// The name to use for this dependency. By default, the same as the dependency module's name,
	// but can also be overridden to use a different name.
	Name string `json:"name"`

	// The source ref of the module dependency.
	Source string `json:"source"`

	// The pinned version of the module dependency.
	Pin string `json:"pin"`
}

func (*ModuleConfigDependency) UnmarshalJSON

func (depCfg *ModuleConfigDependency) UnmarshalJSON(data []byte) error

type ModuleConfigView

type ModuleConfigView struct {
	Name     string   `json:"name"`
	Patterns []string `json:"patterns,omitempty"`
}