renderer

Documentation

Index

• type DefaultRenderer
  • func NewDefault(noColor bool) *DefaultRenderer
  • func (r *DefaultRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error
  • func (r *DefaultRenderer) PrintHint(message string) error
  • func (r *DefaultRenderer) PrintParseError(path string, err error) error
  • func (r *DefaultRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error
• type GitHubActionsRenderer
  • func NewGitHubActions() *GitHubActionsRenderer
  • func (r *GitHubActionsRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error
  • func (r *GitHubActionsRenderer) PrintHint(message string) error
  • func (r *GitHubActionsRenderer) PrintParseError(path string, err error) error
  • func (r *GitHubActionsRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error
• type MarkdownRenderer
  • func NewMarkdown(ruleList []rules.Rule) *MarkdownRenderer
  • func (r *MarkdownRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error
  • func (r *MarkdownRenderer) PrintHint(message string) error
  • func (r *MarkdownRenderer) PrintParseError(path string, err error) error
  • func (r *MarkdownRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error
• type Renderer

Types

type DefaultRenderer

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

DefaultRenderer handles diagnostic error rendering with consistent styling.

func NewDefault

func NewDefault(noColor bool) *DefaultRenderer

NewDefault creates a DefaultRenderer. When noColor is true, all styling is disabled.

func (*DefaultRenderer) PrintDiagnosticError

func (r *DefaultRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error

PrintDiagnosticError renders a diagnostic error with source annotation.

func (*DefaultRenderer) PrintHint

func (r *DefaultRenderer) PrintHint(message string) error

PrintHint renders a styled hint message to stderr.

func (*DefaultRenderer) PrintParseError

func (r *DefaultRenderer) PrintParseError(path string, err error) error

PrintParseError renders a YAML parse error with source annotation.

func (*DefaultRenderer) PrintSummary

func (r *DefaultRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error

PrintSummary renders a styled summary block with results, file counts, and optional online-rules warning.

type GitHubActionsRenderer

type GitHubActionsRenderer struct{}

GitHubActionsRenderer outputs diagnostics as GitHub Actions workflow commands. Format: ::error title=<title>,file=<file>,line=<line>::<file>:<line>:<col>: <message>

func NewGitHubActions

func NewGitHubActions() *GitHubActionsRenderer

NewGitHubActions creates a GitHubActionsRenderer.

func (*GitHubActionsRenderer) PrintDiagnosticError

func (r *GitHubActionsRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error

PrintDiagnosticError renders a diagnostic error as a GitHub Actions ::error command.

func (*GitHubActionsRenderer) PrintHint

func (r *GitHubActionsRenderer) PrintHint(message string) error

PrintHint renders a hint as a GitHub Actions ::warning command.

func (*GitHubActionsRenderer) PrintParseError

func (r *GitHubActionsRenderer) PrintParseError(path string, err error) error

PrintParseError renders a YAML parse error as a GitHub Actions ::error command.

func (*GitHubActionsRenderer) PrintSummary

func (r *GitHubActionsRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error

PrintSummary is a no-op for the GitHub Actions format.

type MarkdownRenderer

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

MarkdownRenderer outputs diagnostics as Markdown.

func NewMarkdown

func NewMarkdown(ruleList []rules.Rule) *MarkdownRenderer

NewMarkdown creates a MarkdownRenderer. The rules map is keyed by rule ID and used to look up Why/Fix guidance for each diagnostic.

func (*MarkdownRenderer) PrintDiagnosticError

func (r *MarkdownRenderer) PrintDiagnosticError(path string, e *diagnostic.Error) error

PrintDiagnosticError renders a diagnostic error as Markdown.

func (*MarkdownRenderer) PrintHint

func (r *MarkdownRenderer) PrintHint(message string) error

PrintHint outputs a hint as a Markdown blockquote.

func (*MarkdownRenderer) PrintParseError

func (r *MarkdownRenderer) PrintParseError(path string, err error) error

PrintParseError renders a YAML parse error as Markdown.

func (*MarkdownRenderer) PrintSummary

func (r *MarkdownRenderer) PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error

PrintSummary outputs a summary of the scan results. When errors exist, a "---" separator distinguishes the summary from diagnostics above.

type Renderer

type Renderer interface {
	PrintParseError(path string, err error) error
	PrintDiagnosticError(path string, e *diagnostic.Error) error
	PrintSummary(totalFiles, errorCount, errorFileCount, skippedOnline int) error
	PrintHint(message string) error
}

Renderer defines the interface for rendering diagnostic output.