tool

Documentation

Index

• type Config
  • func (c *Config) BinDir() string
  • func (c *Config) BinPath(bin string) string
  • func (c *Config) ManifestPath() string
  • func (c *Config) RequireManifest() error
• type Manifest
  • func NewManifest(tools []Tool) *Manifest
  • func (m *Manifest) AddTool(tool Tool)
  • func (m *Manifest) FindTool(name string) (t Tool, ok bool)
  • func (m *Manifest) Tools() []Tool
• type Parser
  • func NewParser(fs afero.Fs) Parser
• type Repository
  • func NewRepository(executor manager.Executor, builder manager.Builder, adder manager.Adder, ...) Repository
• type Tool
  • func (t Tool) Name() string
• type Writer
  • func NewWriter(fs afero.Fs) Writer

Types

type Config

type Config struct {
	FS           afero.Fs
	WorkingDir   string
	RootDir      string
	ManifestName string
	BinDirName   string
	Verbose      bool
	Log          *log.Logger
}

Config contains configurations to manage development tools.

func (*Config) BinDir

func (c *Config) BinDir() string

func (*Config) BinPath

func (c *Config) BinPath(bin string) string

func (*Config) ManifestPath

func (c *Config) ManifestPath() string

func (*Config) RequireManifest

func (c *Config) RequireManifest() error

RequireManifest returns an error if the manifest file does not exist.

type Manifest

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

Manifest contains tool list

func NewManifest

func NewManifest(tools []Tool) *Manifest

NewManifest creates a new Manifest instance.

func (*Manifest) AddTool

func (m *Manifest) AddTool(tool Tool)

AddTool adds a new tool to the manifest.

func (*Manifest) FindTool

func (m *Manifest) FindTool(name string) (t Tool, ok bool)

FindTool returns a tool by a name.

func (*Manifest) Tools

func (m *Manifest) Tools() []Tool

Tools returns a tool list.

type Parser

type Parser interface {
	Parse(path string) (*Manifest, error)
}

Parser retrieve tool packages from given paths.

func NewParser

func NewParser(fs afero.Fs) Parser

NewParser creates a new parser instance.

type Repository

type Repository interface {
	Add(ctx context.Context, pkgs ...string) error
	Build(ctx context.Context, t Tool) (string, error)
	BuildAll(ctx context.Context) error
	Run(ctx context.Context, name string, args ...string) error
}

Repository is an interface for managing and operating tools

func NewRepository

func NewRepository(executor manager.Executor, builder manager.Builder, adder manager.Adder, cfg *Config) Repository

NewRepository creates a new Repository instance.

type Tool

type Tool string

Tool represents a go package of a tool dependency.

func (Tool) Name

func (t Tool) Name() string

Name returns an executable name.

type Writer

type Writer interface {
	Write(path string, m *Manifest) error
}

Writer creates a tool file to manage tool dependencies.

func NewWriter

func NewWriter(fs afero.Fs) Writer

NewWriter creates a new Writer instance.