licensefinder

README

POSH License Finder provider

Usage

Plugin

func New(l log.Logger) (plugin.Plugin, error) {
	// ...
  inst.commands.Add(licensefinder.NewCommand(l, cache))
	// ...
}

Config

licenseFinder:
  logPath: .posh/logs/licenses.log
  decisionsPath: .posh/licenses.yaml

Documentation

Index

• type Command
  • func NewCommand(l log.Logger, cache cache.Cache, opts ...CommandOption) (*Command, error)
  • func (c *Command) Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest
  • func (c *Command) Description() string
  • func (c *Command) Execute(ctx context.Context, r *readline.Readline) error
  • func (c *Command) Help(ctx context.Context, r *readline.Readline) string
  • func (c *Command) Name() string
  • func (c *Command) Validate(ctx context.Context, r *readline.Readline) error
• type CommandOption
  • func CommandWithConfigKey(v string) CommandOption
  • func CommandWithName(v string) CommandOption
• type Config

Types

type Command

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

func NewCommand

func NewCommand(l log.Logger, cache cache.Cache, opts ...CommandOption) (*Command, error)

func (*Command) Complete

func (c *Command) Complete(ctx context.Context, r *readline.Readline) []goprompt.Suggest

func (*Command) Description

func (c *Command) Description() string

func (*Command) Execute

func (c *Command) Execute(ctx context.Context, r *readline.Readline) error

func (*Command) Help

func (c *Command) Help(ctx context.Context, r *readline.Readline) string

func (*Command) Name

func (c *Command) Name() string

func (*Command) Validate

func (c *Command) Validate(ctx context.Context, r *readline.Readline) error

type CommandOption

type CommandOption func(*Command)

func CommandWithConfigKey

func CommandWithConfigKey(v string) CommandOption

func CommandWithName

func CommandWithName(v string) CommandOption

type Config

type Config struct {
	LogPath       string `json:"logPath" yaml:"logPath"`
	DecisionsPath string `json:"decisionsPath" yaml:"decisionsPath"`
}