Documentation
¶
Index ¶
- Variables
- func GetServices(configs []*Config) (services.Services, error)
- func Readme(ctx context.Context, pkg *devpkg.Package, projectDir string, markdown bool) (string, error)
- func Remove(projectDir string, pkgs []string) error
- func RemoveInvalidSymlinks(projectDir string) error
- func Update() error
- func WithDevbox(provider devboxProject) managerOption
- func WithLockfile(lockfile *lock.File) managerOption
- type Config
- type Includable
- type LocalPlugin
- func (l *LocalPlugin) CanonicalName() string
- func (l *LocalPlugin) Fetch() ([]byte, error)
- func (l *LocalPlugin) FileContent(subpath string) ([]byte, error)
- func (l *LocalPlugin) Hash() string
- func (l *LocalPlugin) IsLocal() bool
- func (l *LocalPlugin) LockfileKey() string
- func (l *LocalPlugin) Path() string
- type Manager
- type PluginOnlyData
Constants ¶
This section is empty.
Variables ¶
View Source
var ( VirtenvPath = filepath.Join(devboxHiddenDirName, "virtenv") VirtenvBinPath = filepath.Join(VirtenvPath, "bin") )
Functions ¶
func RemoveInvalidSymlinks ¶
func WithDevbox ¶
func WithDevbox(provider devboxProject) managerOption
func WithLockfile ¶
Types ¶
type Config ¶
type Config struct {
configfile.ConfigFile
PluginOnlyData
}
func GetBuiltinsForPackages ¶
func LoadConfigFromInclude ¶
func (*Config) Description ¶
func (*Config) ProcessComposeYaml ¶
type Includable ¶
type LocalPlugin ¶
type LocalPlugin struct {
// contains filtered or unexported fields
}
func (*LocalPlugin) CanonicalName ¶
func (l *LocalPlugin) CanonicalName() string
func (*LocalPlugin) Fetch ¶
func (l *LocalPlugin) Fetch() ([]byte, error)
func (*LocalPlugin) FileContent ¶
func (l *LocalPlugin) FileContent(subpath string) ([]byte, error)
func (*LocalPlugin) Hash ¶
func (l *LocalPlugin) Hash() string
func (*LocalPlugin) IsLocal ¶
func (l *LocalPlugin) IsLocal() bool
func (*LocalPlugin) LockfileKey ¶
func (l *LocalPlugin) LockfileKey() string
func (*LocalPlugin) Path ¶
func (l *LocalPlugin) Path() string
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
func NewManager ¶
func NewManager(opts ...managerOption) *Manager
func (*Manager) ApplyOptions ¶
func (m *Manager) ApplyOptions(opts ...managerOption)
func (*Manager) CreateFilesForConfig ¶
func (*Manager) UpdateLockfileVersion ¶
type PluginOnlyData ¶
type PluginOnlyData struct {
CreateFiles map[string]string `json:"create_files"`
DeprecatedDescription string `json:"readme"`
// If true, we remove the package that triggered this plugin from the environment
// Useful when we want to replace with flake
RemoveTriggerPackage bool `json:"__remove_trigger_package,omitempty"`
Version string `json:"version"`
// Source is the includable that triggered this plugin. There are two ways to include a plugin:
// 1. Built-in plugins are triggered by packages (See plugins.builtInMap)
// 2. Plugins can be added via the "include" field in devbox.json or plugin.json
Source Includable
}
Click to show internal directories.
Click to hide internal directories.