plugin

package

v0.0.0-...-b872246 Latest Latest Go to latest Published: Oct 14, 2023 License: Apache-2.0 Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/synopkg/devbox

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
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 WithDevbox(provider devboxProject) managerOption
func WithLockfile(lockfile *lock.File) managerOption
type Includable
type Manager
- func NewManager(opts ...managerOption) *Manager

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	VirtenvPath    = filepath.Join(devboxHiddenDirName, "virtenv")
	VirtenvBinPath = filepath.Join(VirtenvPath, "bin")

	WrapperPath    = filepath.Join(VirtenvPath, ".wrappers")
	WrapperBinPath = filepath.Join(WrapperPath, "bin")
)

Functions ¶

func Readme ¶

func Readme(ctx context.Context,
	pkg *devpkg.Package,
	projectDir string,
	markdown bool,
) (string, error)

func Remove ¶

func Remove(projectDir string, pkgs []string) error

func RemoveInvalidSymlinks ¶

func RemoveInvalidSymlinks(projectDir string) error

func WithDevbox ¶

func WithDevbox(provider devboxProject) managerOption

func WithLockfile ¶

func WithLockfile(lockfile *lock.File) managerOption

Types ¶

type Includable ¶

type Includable interface {
	CanonicalName() string
	Hash() string
	FileContent(subpath string) ([]byte, error)
}

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) Create ¶

func (m *Manager) Create(pkg *devpkg.Package) error

func (*Manager) Env ¶

func (m *Manager) Env(
	pkgs []*devpkg.Package,
	includes []string,
	computedEnv map[string]string,
) (map[string]string, error)

Env returns the environment variables for the given plugins. TODO: We should associate the env variables with the individual plugin binaries via wrappers instead of adding to the environment everywhere. TODO: this should have PluginManager as receiver so we can build once with pkgs, includes, etc

func (*Manager) GetServices ¶

func (m *Manager) GetServices(
	pkgs []*devpkg.Package,
	includes []string,
) (services.Services, error)

func (*Manager) Include ¶

func (m *Manager) Include(included string) error

func (*Manager) InitHooks ¶

func (m *Manager) InitHooks(
	pkgs []*devpkg.Package,
	includes []string,
) ([]string, error)

func (*Manager) ParseInclude ¶

func (m *Manager) ParseInclude(include string) (Includable, error)

func (*Manager) ProcessPluginPackages ¶

func (m *Manager) ProcessPluginPackages(
	userPackages []*devpkg.Package,
) ([]*devpkg.Package, error)

ProcessPluginPackages adds and removes packages as indicated by plugins

Source Files ¶

View all Source files

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