Documentation
¶
Index ¶
- Variables
- func ValidatePackageName(validatorName, name string) error
- type AddOptions
- type Capability
- type CommandInput
- type ConflictBehavior
- type DetectOptions
- type Detector
- type ErrCLINotFound
- type ErrConflictingLockfiles
- type ErrInvalidPackageName
- type ErrManifestNotInRoot
- type ErrMissingArgument
- type ErrNoManifest
- type ErrOrphanedWorkspaceMember
- type ErrUnsupportedVersion
- type ExecContext
- type ExecRunner
- type GenericManager
- func (m *GenericManager) Add(ctx context.Context, pkg string, opts AddOptions) (*Result, error)
- func (m *GenericManager) Capabilities() []Capability
- func (m *GenericManager) Dir() string
- func (m *GenericManager) Ecosystem() string
- func (m *GenericManager) Install(ctx context.Context, opts InstallOptions) (*Result, error)
- func (m *GenericManager) List(ctx context.Context) (*Result, error)
- func (m *GenericManager) Name() string
- func (m *GenericManager) Outdated(ctx context.Context) (*Result, error)
- func (m *GenericManager) Remove(ctx context.Context, pkg string) (*Result, error)
- func (m *GenericManager) Supports(cap Capability) bool
- func (m *GenericManager) Update(ctx context.Context, pkg string) (*Result, error)
- func (m *GenericManager) Warnings() []string
- type InstallOptions
- type Manager
- type MockRunner
- type Result
- type Runner
- type Translator
- func (t *Translator) BuildCommand(managerName, operation string, input CommandInput) ([]string, error)
- func (t *Translator) BuildCommands(managerName, operation string, input CommandInput) ([][]string, error)
- func (t *Translator) Definition(name string) (*definitions.Definition, bool)
- func (t *Translator) Register(def *definitions.Definition)
- func (t *Translator) RegisterValidator(name string, v *definitions.Validator)
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func ValidatePackageName ¶
Types ¶
type Capability ¶
type Capability int
const ( CapInstall Capability = iota CapInstallFrozen CapInstallClean CapAdd CapAddDev CapAddOptional CapRemove CapUpdate CapList CapOutdated CapAudit CapWorkspace CapJSONOutput CapSBOMCycloneDX CapSBOMSPDX )
func CapabilityFromString ¶
func CapabilityFromString(s string) (Capability, bool)
func (Capability) String ¶
func (c Capability) String() string
type CommandInput ¶
type ConflictBehavior ¶
type ConflictBehavior int
const ( ConflictError ConflictBehavior = iota ConflictUseFirst ConflictUseNewest )
type DetectOptions ¶
type DetectOptions struct {
RequireCLI bool
OnConflict ConflictBehavior
SearchParents bool
Manager string
}
type Detector ¶
type Detector struct {
// contains filtered or unexported fields
}
func NewDetector ¶
func NewDetector(translator *Translator, runner Runner) *Detector
func (*Detector) Detect ¶
func (d *Detector) Detect(dir string, opts DetectOptions) (Manager, error)
func (*Detector) DetectVersion ¶
func (d *Detector) DetectVersion(def *definitions.Definition) (string, error)
func (*Detector) Register ¶
func (d *Detector) Register(def *definitions.Definition)
type ErrCLINotFound ¶
func (ErrCLINotFound) Error ¶
func (e ErrCLINotFound) Error() string
type ErrConflictingLockfiles ¶
func (ErrConflictingLockfiles) Error ¶
func (e ErrConflictingLockfiles) Error() string
type ErrInvalidPackageName ¶
func (ErrInvalidPackageName) Error ¶
func (e ErrInvalidPackageName) Error() string
type ErrManifestNotInRoot ¶
func (ErrManifestNotInRoot) Error ¶
func (e ErrManifestNotInRoot) Error() string
type ErrMissingArgument ¶
type ErrMissingArgument struct {
Argument string
}
func (ErrMissingArgument) Error ¶
func (e ErrMissingArgument) Error() string
type ErrNoManifest ¶
type ErrNoManifest struct {
Dir string
}
func (ErrNoManifest) Error ¶
func (e ErrNoManifest) Error() string
type ErrOrphanedWorkspaceMember ¶
func (ErrOrphanedWorkspaceMember) Error ¶
func (e ErrOrphanedWorkspaceMember) Error() string
type ErrUnsupportedVersion ¶
func (ErrUnsupportedVersion) Error ¶
func (e ErrUnsupportedVersion) Error() string
type ExecContext ¶
type ExecContext int
const ( ContextProject ExecContext = iota ContextGlobal ContextWorkspace )
type GenericManager ¶
type GenericManager struct {
// contains filtered or unexported fields
}
func (*GenericManager) Add ¶
func (m *GenericManager) Add(ctx context.Context, pkg string, opts AddOptions) (*Result, error)
func (*GenericManager) Capabilities ¶
func (m *GenericManager) Capabilities() []Capability
func (*GenericManager) Dir ¶
func (m *GenericManager) Dir() string
func (*GenericManager) Ecosystem ¶
func (m *GenericManager) Ecosystem() string
func (*GenericManager) Install ¶
func (m *GenericManager) Install(ctx context.Context, opts InstallOptions) (*Result, error)
func (*GenericManager) Name ¶
func (m *GenericManager) Name() string
func (*GenericManager) Outdated ¶
func (m *GenericManager) Outdated(ctx context.Context) (*Result, error)
func (*GenericManager) Supports ¶
func (m *GenericManager) Supports(cap Capability) bool
func (*GenericManager) Warnings ¶
func (m *GenericManager) Warnings() []string
type InstallOptions ¶
type Manager ¶
type Manager interface {
Name() string
Ecosystem() string
Install(ctx context.Context, opts InstallOptions) (*Result, error)
Add(ctx context.Context, pkg string, opts AddOptions) (*Result, error)
Remove(ctx context.Context, pkg string) (*Result, error)
List(ctx context.Context) (*Result, error)
Outdated(ctx context.Context) (*Result, error)
Update(ctx context.Context, pkg string) (*Result, error)
Supports(cap Capability) bool
Capabilities() []Capability
}
type MockRunner ¶
type MockRunner struct {
Captured [][]string
Results []*Result
Errors []error
// contains filtered or unexported fields
}
func NewMockRunner ¶
func NewMockRunner() *MockRunner
func (*MockRunner) LastCaptured ¶
func (m *MockRunner) LastCaptured() []string
type Result ¶
type Translator ¶
type Translator struct {
// contains filtered or unexported fields
}
func NewTranslator ¶
func NewTranslator() *Translator
func (*Translator) BuildCommand ¶
func (t *Translator) BuildCommand(managerName, operation string, input CommandInput) ([]string, error)
func (*Translator) BuildCommands ¶
func (t *Translator) BuildCommands(managerName, operation string, input CommandInput) ([][]string, error)
BuildCommands returns all commands for an operation (including "then" chains)
func (*Translator) Definition ¶
func (t *Translator) Definition(name string) (*definitions.Definition, bool)
func (*Translator) Register ¶
func (t *Translator) Register(def *definitions.Definition)
func (*Translator) RegisterValidator ¶
func (t *Translator) RegisterValidator(name string, v *definitions.Validator)
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
docs
|
|
|
examples/dependabot-cron
command
|
|
|
examples/git-pkgs-integration
command
|
Click to show internal directories.
Click to hide internal directories.