cui

Documentation

Index

• func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rulesets.RuleSet, error)
• func GetLintCommand() *cobra.Command
• func RenderSummary(rs *model.RuleResultSet, args []string, silent bool)
• func RenderTime(timeFlag bool, duration time.Duration, fi os.FileInfo)
• type CategoryGauge
  • func NewCategoryGauge(title string, percent int, cat *model.RuleCategory) CategoryGauge
• type Dashboard
  • func CreateDashboard(resultSet *model.RuleResultSet, index *model.SpecIndex, info *model.SpecInfo) *Dashboard
  • func (dash *Dashboard) ComposeGauges()
  • func (dash *Dashboard) GenerateTabbedView()
  • func (dash *Dashboard) Render() error
• type Snippet
  • func NewSnippet() *Snippet
  • func (snip *Snippet) Draw(buf *Buffer)
• type StatsChart
  • func NewStatsChart(index *model.SpecIndex, info *model.SpecInfo) StatsChart
• type TabbedView

Functions

func BuildRuleSetFromUserSuppliedSet

func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rulesets.RuleSet, error)

BuildRuleSetFromUserSuppliedSet creates a ready to run ruleset, augmented or provided by a user configured ruleset. This ruleset could be lifted directly from a Spectral configuration.

func GetLintCommand

func GetLintCommand() *cobra.Command

func RenderSummary

func RenderSummary(rs *model.RuleResultSet, args []string, silent bool)

func RenderTime

func RenderTime(timeFlag bool, duration time.Duration, fi os.FileInfo)

RenderTime will render out the time taken to process a specification, and the size of the file in kb.

Types

type CategoryGauge

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

CategoryGauge represents a percent bar visualizing how well spec did in a particular category

func NewCategoryGauge

func NewCategoryGauge(title string, percent int, cat *model.RuleCategory) CategoryGauge

NewCategoryGauge returns a new gauge widget that is ready to render

type Dashboard

type Dashboard struct {
	C chan bool
	// contains filtered or unexported fields
}

Dashboard represents the dashboard controlling container

func CreateDashboard

func CreateDashboard(resultSet *model.RuleResultSet, index *model.SpecIndex, info *model.SpecInfo) *Dashboard

func (*Dashboard) ComposeGauges

func (dash *Dashboard) ComposeGauges()

ComposeGauges prepares health gauges for rendering into the main grid.

func (*Dashboard) GenerateTabbedView

func (dash *Dashboard) GenerateTabbedView()

GenerateTabbedView generates tabs

func (*Dashboard) Render

func (dash *Dashboard) Render() error

Render will render the dashboard.

type Snippet

type Snippet struct {
	Block
	Text      string
	TextStyle Style
	WrapText  bool
}

func NewSnippet

func NewSnippet() *Snippet

func (*Snippet) Draw

func (snip *Snippet) Draw(buf *Buffer)

type StatsChart

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

StatsChart represents a bar chart showing statistics of the specification.

func NewStatsChart

func NewStatsChart(index *model.SpecIndex, info *model.SpecInfo) StatsChart

NewStatsChart returns a new gauge widget that is ready to render

type TabbedView

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

TabbedView represents a tabbed view holding various data views