skill

Documentation

Index

• func FormatAvailableSkills(skills []Definition) string
• type AvailabilityOptions
• type Definition
• type Diagnostic
• type Frontmatter
  • func ParseFrontmatter(raw string) (Frontmatter, string, error)
• type LoadOptions
• type Snapshot
  • func Load(opts LoadOptions) (Snapshot, error)
  • func MirrorToWorkspace(workspaceDir string, snapshot Snapshot) (Snapshot, error)
• type Source
• type SourceDir

Functions

func FormatAvailableSkills

func FormatAvailableSkills(skills []Definition) string

Types

type AvailabilityOptions

type AvailabilityOptions struct {
	OS               string
	Arch             string
	InstalledPlugins []string
	HasEnv           func(string) bool
	HasCommand       func(string) bool
}

type Definition

type Definition struct {
	Name                    string   `json:"name"`
	Description             string   `json:"description"`
	UserInvocable           bool     `json:"user_invocable"`
	Source                  Source   `json:"source"`
	FilePath                string   `json:"file_path"`
	RuntimePath             string   `json:"runtime_path,omitempty"`
	RequiresPlugin          string   `json:"requires_plugin,omitempty"`
	RequiresBins            []string `json:"requires_bins,omitempty"`
	RequiresEnv             []string `json:"requires_env,omitempty"`
	OS                      []string `json:"os,omitempty"`
	Arch                    []string `json:"arch,omitempty"`
	RecommendedTools        []string `json:"recommended_tools,omitempty"`
	RecommendedProjectFiles []string `json:"recommended_project_files,omitempty"`
	WakePhases              []string `json:"wake_phases,omitempty"`
	Content                 string   `json:"content,omitempty"`
}

type Diagnostic

type Diagnostic struct {
	Path    string `json:"path,omitempty"`
	Message string `json:"message"`
}

type Frontmatter

type Frontmatter struct {
	Name                    string
	Description             string
	UserInvocable           *bool
	RequiresPlugin          string
	RequiresBins            []string
	RequiresEnv             []string
	OS                      []string
	Arch                    []string
	RecommendedTools        []string
	RecommendedProjectFiles []string
	WakePhases              []string
}

func ParseFrontmatter

func ParseFrontmatter(raw string) (Frontmatter, string, error)

type LoadOptions

type LoadOptions struct {
	Sources      []SourceDir
	Availability AvailabilityOptions
}

type Snapshot

type Snapshot struct {
	Version     int64        `json:"version"`
	Skills      []Definition `json:"skills"`
	Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
}

func Load

func Load(opts LoadOptions) (Snapshot, error)

func MirrorToWorkspace

func MirrorToWorkspace(workspaceDir string, snapshot Snapshot) (Snapshot, error)

type Source

type Source string

const (
	SourceWorkspace Source = "workspace"
	SourceUser      Source = "user"
	SourceBundled   Source = "bundled"
)

type SourceDir

type SourceDir struct {
	Source Source
	Dir    string
}