packages

Documentation

Index

• func NewView(results *structuredSearchResults, out output.Outputer) (*view, error)
• type ChangesetProvider
• type Confirmer
• type Import
  • func NewImport(prime primeable) *Import
  • func (i *Import) Run(params *ImportRunParams) error
• type ImportRunParams
  • func NewImportRunParams() *ImportRunParams
• type Info
  • func NewInfo(prime primeable) *Info
  • func (i *Info) Run(params InfoRunParams, nstype model.NamespaceType) error
• type InfoRunParams
• type Install
  • func NewInstall(prime primeable) *Install
  • func (a *Install) Run(params InstallRunParams, nsType model.NamespaceType) (rerr error)
• type InstallRunParams
• type List
  • func NewList(prime primeable) *List
  • func (l *List) Run(params ListRunParams, nstype model.NamespaceType) error
• type ListRunParams
• type PkgDetailsTable
• type Search
  • func NewSearch(prime primeable) *Search
  • func (s *Search) Run(params SearchRunParams, nstype model.NamespaceType) error
• type SearchRunParams
• type Uninstall
  • func NewUninstall(prime primeable) *Uninstall
  • func (u *Uninstall) Run(params UninstallRunParams, nsType model.NamespaceType) (rerr error)
• type UninstallRunParams

Functions

func NewView

func NewView(results *structuredSearchResults, out output.Outputer) (*view, error)

Types

type ChangesetProvider

type ChangesetProvider interface {
	Changeset(contents []byte, lang string) (model.Changeset, error)
}

ChangesetProvider describes the behavior required to convert some file data into a changeset.

type Confirmer

type Confirmer interface {
	Confirm(title, msg string, defaultOpt *bool) (bool, error)
}

Confirmer describes the behavior required to prompt a user for confirmation.

type Import

type Import struct {
	prompt.Prompter
	// contains filtered or unexported fields
}

Import manages the importing execution context.

func NewImport

func NewImport(prime primeable) *Import

NewImport prepares an importation execution context for use.

func (*Import) Run

func (i *Import) Run(params *ImportRunParams) error

Run executes the import behavior.

type ImportRunParams

type ImportRunParams struct {
	FileName       string
	Language       string
	NonInteractive bool
}

ImportRunParams tracks the info required for running Import.

func NewImportRunParams

func NewImportRunParams() *ImportRunParams

NewImportRunParams prepares the info required for running Import with default values.

type Info

type Info struct {
	// contains filtered or unexported fields
}

Info manages the information execution context.

func NewInfo

func NewInfo(prime primeable) *Info

NewInfo prepares an information execution context for use.

func (*Info) Run

func (i *Info) Run(params InfoRunParams, nstype model.NamespaceType) error

Run executes the information behavior.

type InfoRunParams

type InfoRunParams struct {
	Package   captain.PackageValue
	Timestamp captain.TimeValue
	Language  string
}

InfoRunParams tracks the info required for running Info.

type Install

type Install struct {
	// contains filtered or unexported fields
}

Install manages the installing execution context.

func NewInstall

func NewInstall(prime primeable) *Install

NewInstall prepares an installation execution context for use.

func (*Install) Run

func (a *Install) Run(params InstallRunParams, nsType model.NamespaceType) (rerr error)

Run executes the install behavior.

type InstallRunParams

type InstallRunParams struct {
	Packages  captain.PackagesValue
	Timestamp captain.TimeValue
	Revision  captain.IntValue
}

InstallRunParams tracks the info required for running Install.

type List

type List struct {
	// contains filtered or unexported fields
}

List manages the listing execution context.

func NewList

func NewList(prime primeable) *List

NewList prepares a list execution context for use.

func (*List) Run

func (l *List) Run(params ListRunParams, nstype model.NamespaceType) error

Run executes the list behavior.

type ListRunParams

type ListRunParams struct {
	Commit  string
	Name    string
	Project string
}

ListRunParams tracks the info required for running List.

type PkgDetailsTable

type PkgDetailsTable struct {
	Description string `opts:"omitEmpty" locale:"package_description,[HEADING]Description[/RESET]" json:"description"`
	Author      string `opts:"omitEmpty" locale:"package_author,[HEADING]Author[/RESET]" json:"author"`
	Authors     string `opts:"omitEmpty" locale:"package_authors,[HEADING]Authors[/RESET]" json:"authors"`
	Website     string `opts:"omitEmpty" locale:"package_website,[HEADING]Website[/RESET]" json:"website"`
	License     string `opts:"omitEmpty" locale:"package_license,[HEADING]License[/RESET]" json:"license"`
}

PkgDetailsTable describes package details.

type Search

type Search struct {
	// contains filtered or unexported fields
}

Search manages the searching execution context.

func NewSearch

func NewSearch(prime primeable) *Search

NewSearch prepares a searching execution context for use.

func (*Search) Run

func (s *Search) Run(params SearchRunParams, nstype model.NamespaceType) error

Run is executed when `state packages search` is ran

type SearchRunParams

type SearchRunParams struct {
	Language   string
	ExactTerm  bool
	Ingredient captain.PackageValueNoVersion
	Timestamp  captain.TimeValue
}

SearchRunParams tracks the info required for running search.

type Uninstall

type Uninstall struct {
	// contains filtered or unexported fields
}

Uninstall manages the uninstalling execution context.

func NewUninstall

func NewUninstall(prime primeable) *Uninstall

NewUninstall prepares an uninstallation execution context for use.

func (*Uninstall) Run

func (u *Uninstall) Run(params UninstallRunParams, nsType model.NamespaceType) (rerr error)

Run executes the uninstall behavior.

type UninstallRunParams

type UninstallRunParams struct {
	Packages captain.PackagesValueNoVersion
}

UninstallRunParams tracks the info required for running Uninstall.