dev

package
v0.21.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 12, 2026 License: MIT Imports: 32 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DisplayAdvisory

func DisplayAdvisory(w io.Writer, r *AdvisoryResult)

DisplayAdvisory shows SkillsBench research-backed advisory findings.

func DisplayBatchSummary

func DisplayBatchSummary(w io.Writer, results []batchSkillResult)

DisplayBatchSummary shows the batch summary table with before/after for each skill.

func DisplayCheckResults

func DisplayCheckResults(w io.Writer, title string, results []*checks.CheckResult)

DisplayCheckResults renders pre-computed check results under a titled section.

func DisplayImprovement

func DisplayImprovement(w io.Writer, section, suggestion string)

DisplayImprovement shows a suggested improvement.

func DisplayIssues

func DisplayIssues(w io.Writer, issues []scoring.Issue)

DisplayIssues lists all issues found.

func DisplayIterationHeader

func DisplayIterationHeader(w io.Writer, iteration, maxIterations int)

DisplayIterationHeader shows iteration progress.

func DisplayMaxIterations

func DisplayMaxIterations(w io.Writer, currentLevel scoring.AdherenceLevel)

DisplayMaxIterations shows timeout message.

func DisplayMcp

func DisplayMcp(w io.Writer, r *McpResult)

DisplayMcp shows MCP integration scoring results.

func DisplayScore

func DisplayScore(w io.Writer, sk *skill.Skill, score *scoring.ScoreResult)

DisplayScore shows the current score with issues.

func DisplaySummary

func DisplaySummary(w io.Writer, skillName string, before, after *scoring.ScoreResult, beforeTokens, afterTokens int)

DisplaySummary shows before/after comparison box.

func DisplayTargetReached

func DisplayTargetReached(w io.Writer, level scoring.AdherenceLevel)

DisplayTargetReached shows success message.

func NewCommand

func NewCommand() *cobra.Command

NewCommand returns the `waza dev` sub-command tree.

Types

type Advisory

type Advisory struct {
	Check   string // check identifier
	Message string // human-readable explanation
	Kind    string // "positive", "warning", or "info"
}

Advisory represents a single SkillsBench advisory finding.

type AdvisoryResult

type AdvisoryResult struct {
	Advisories []Advisory
}

AdvisoryResult holds all advisory findings.

type AdvisoryScorer

type AdvisoryScorer struct{}

AdvisoryScorer runs SkillsBench research-backed checks.

func (AdvisoryScorer) Score

Score evaluates a skill against SkillsBench research findings.

type LinkIssue

type LinkIssue struct {
	Source string // source file (relative to skill dir)
	Target string // link target
	Reason string // human-readable description
}

LinkIssue describes a single link problem found during validation.

type LinkResult

type LinkResult struct {
	BrokenLinks    []LinkIssue
	DirectoryLinks []LinkIssue
	ScopeEscapes   []LinkIssue
	DeadURLs       []LinkIssue
	OrphanedFiles  []string
	TotalLinks     int
	ValidLinks     int
	Issues         []scoring.Issue
}

LinkResult holds the output from link validation checks.

func (*LinkResult) Passed

func (r *LinkResult) Passed() bool

Passed returns true when no link errors were found.

type LinkScorer

type LinkScorer struct{}

LinkScorer validates links in a skill's markdown files.

func (LinkScorer) Score

func (LinkScorer) Score(sk *skill.Skill) *LinkResult

Score runs link validation on the skill directory.

type McpResult

type McpResult struct {
	HasInvokes           bool
	ToolsTablePresent    bool
	PrereqsDocumented    bool
	CliFallbackDescribed bool
	NameCollisions       []string
	Issues               []scoring.Issue
	SubScore             int // 0–4
}

McpResult holds the output from MCP integration checks.

type McpScorer

type McpScorer struct{}

McpScorer evaluates MCP integration documentation quality for skills that declare INVOKES: in their description.

func (McpScorer) Score

func (McpScorer) Score(sk *skill.Skill) *McpResult

Score runs MCP integration checks. Returns nil if the skill does not use INVOKES: (i.e. not an MCP-dependent skill).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL