structs

Documentation

Index

• Variables
• type Include
  • func (i Include) IsSame(include Include) bool
  • func (i *Include) UnmarshalJSON(bb []byte) error
• type Lock
  • func (l *Lock) FromSpec(spec *Spec)
• type ModuleInfo
• type RemoteSpec
  • func (r *RemoteSpec) UnmarshalJSON(bb []byte) error
• type RunError
  • func (e RunError) Error() string
• type Spec
  • func (s *Spec) AddInclude(include Include) bool
• type Stats
• type Tool
  • func (t Tool) ID() string
  • func (t Tool) IsSame(tool Tool) bool
• type ToolState
• type Tools
  • func (tools *Tools) Add(tool Tool) bool
  • func (tools *Tools) Filter(tags []string) Tools
  • func (tools *Tools) Remove(tool Tool) bool
  • func (tools *Tools) UpsertTool(tool Tool)

Variables

var ErrToolNotInstalled = errors.New("tool not installed")

Types

type Include

type Include struct {
	Src  string   `json:"src"`
	Tags []string `json:"tags"`
}

func (Include) IsSame

func (i Include) IsSame(include Include) bool

func (*Include) UnmarshalJSON

func (i *Include) UnmarshalJSON(bb []byte) error

type Lock

type Lock struct {
	Tools   Tools        `json:"tools"`
	Remotes []RemoteSpec `json:"remotes"`
}

func (*Lock) FromSpec

func (l *Lock) FromSpec(spec *Spec)

type ModuleInfo

type ModuleInfo struct {
	Name        string // golangci-lint
	Mod         prog.Version
	BinDir      string // /home/user/bin/tools/.golangci-lint__v1.1.1
	BinPath     string // /home/user/bin/tools/.golangci-lint__v1.1.1/golangci-lint
	IsInstalled bool
	IsPrivate   bool
}

type RemoteSpec

type RemoteSpec struct {
	Source string   `json:"source"`
	Spec   Spec     `json:"spec"`
	Tags   []string `json:"tags"`
}

func (*RemoteSpec) UnmarshalJSON

func (r *RemoteSpec) UnmarshalJSON(bb []byte) error

type RunError

type RunError struct {
	ExitCode int
}

func (RunError) Error

func (e RunError) Error() string

type Spec

type Spec struct {
	// This dir is store all toolset-related files.
	// This directory should be managed by toolset only.
	Dir      string    `json:"dir"`
	Tools    Tools     `json:"tools"`
	Includes []Include `json:"includes"`
}

func (*Spec) AddInclude

func (s *Spec) AddInclude(include Include) bool

type Stats

type Stats struct {
	Version string               `json:"version"`
	Tools   map[string]time.Time `json:"tools"`
}

type Tool

type Tool struct {
	// Name of runtime
	Runtime string `json:"runtime"`
	// Path to module with version
	Module string `json:"module"`
	// Alias create a link in tools. Works like exposing some tools
	Alias optional.Val[string] `json:"alias"`
	Tags  []string             `json:"tags"`
}

func (Tool) ID

func (t Tool) ID() string

func (Tool) IsSame

func (t Tool) IsSame(tool Tool) bool

IsSame returns true when it detects that this is the same tools. It does not check tool version.

type ToolState

type ToolState struct {
	Module  ModuleInfo
	Tool    Tool
	LastUse optional.Val[time.Time]
}

ToolState describe a state of this tool.

type Tools

type Tools []Tool

func (*Tools) Add

func (tools *Tools) Add(tool Tool) bool

Add will add tool to list if that tool not exists yet. Returns true when tool was added.

func (*Tools) Filter

func (tools *Tools) Filter(tags []string) Tools

func (*Tools) Remove

func (tools *Tools) Remove(tool Tool) bool

func (*Tools) UpsertTool

func (tools *Tools) UpsertTool(tool Tool)

UpsertTool will add tool if not exists or replace to the given version.