linter

Documentation

Index

• func ConsoleFormatter(out io.Writer, report Report)
• func GetNamingChecker(convention NamingConvention) func(string) bool
• func Naming(ctx *RuleContext)
• func NoDuplicateOperationIDs(ctx *RuleContext)
• func NoEmptyDescriptions(ctx *RuleContext)
• func NoEmptyOperationIDs(ctx *RuleContext)
• func NoMissingRequiredProperties(ctx *RuleContext)
• func NoUnusedDefinitions(ctx *RuleContext)
• func RequireOperationTags(ctx *RuleContext)
• func RunSpecLint(options Options)
• func SlashTerminatedPaths(ctx *RuleContext)
• type Config
  • func LoadConfig(path string) (*Config, error)
• type NamingConvention
• type NamingOpts
• type NoEmptyDescriptionsOpts
• type Options
• type Report
  • func NewReport() *Report
  • func (report *Report) AddViolation(violation RuleViolation)
  • func (report *Report) GetViolations() []RuleViolation
• type RuleContext
• type RuleViolation
• type Rules

Functions

func ConsoleFormatter

func ConsoleFormatter(out io.Writer, report Report)

func GetNamingChecker

func GetNamingChecker(convention NamingConvention) func(string) bool

func Naming

func Naming(ctx *RuleContext)

func NoDuplicateOperationIDs

func NoDuplicateOperationIDs(ctx *RuleContext)

func NoEmptyDescriptions

func NoEmptyDescriptions(ctx *RuleContext)

func NoEmptyOperationIDs

func NoEmptyOperationIDs(ctx *RuleContext)

func NoMissingRequiredProperties

func NoMissingRequiredProperties(ctx *RuleContext)

func NoUnusedDefinitions

func NoUnusedDefinitions(ctx *RuleContext)

func RequireOperationTags

func RequireOperationTags(ctx *RuleContext)

func RunSpecLint

func RunSpecLint(options Options)

func SlashTerminatedPaths

func SlashTerminatedPaths(ctx *RuleContext)

Types

type Config

type Config struct {
	Rules Rules `yaml:"rules,omitempty"`
}

func LoadConfig

func LoadConfig(path string) (*Config, error)

type NamingConvention

type NamingConvention = string

const (
	PascalCase NamingConvention = "PascalCase"
	SnakeCase  NamingConvention = "SnakeCase"
	CamelCase  NamingConvention = "CamelCase"
	KebabCase  NamingConvention = "KebabCase"
)

type NamingOpts

type NamingOpts struct {
	Paths       NamingConvention `yaml:"paths,omitempty"`
	Tags        NamingConvention `yaml:"tags,omitempty"`
	Operations  NamingConvention `yaml:"operation,omitempty"`
	Parameters  NamingConvention `yaml:"parameters,omitempty"`
	Definitions NamingConvention `yaml:"definitions,omitempty"`
	Properties  NamingConvention `yaml:"properties,omitempty"`
}

type NoEmptyDescriptionsOpts

type NoEmptyDescriptionsOpts struct {
	Operations bool `yaml:"operations,omitempty"`
	Properties bool `yaml:"properties,omitempty"`
	Parameters bool `yaml:"parameters,omitempty"`
}

type Options

type Options struct {
	Spec   string
	Config string
}

type Report

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

func NewReport

func NewReport() *Report

func (*Report) AddViolation

func (report *Report) AddViolation(violation RuleViolation)

func (*Report) GetViolations

func (report *Report) GetViolations() []RuleViolation

type RuleContext

type RuleContext struct {
	Config   Config
	Analyzer analysis.Spec
	Report   Report
	Walk     func(visitor core.DocumentVisitor)
}

type RuleViolation

type RuleViolation struct {
	RuleName string
	Ref      string
	Failure  string
}

type Rules

type Rules struct {
	Naming                      *NamingOpts              `yaml:"naming,omitempty"`
	NoEmptyDescriptions         *NoEmptyDescriptionsOpts `yaml:"noEmptyDescriptions,omitempty"`
	NoEmptyOperationIDs         bool                     `yaml:"noEmptyOperationIDs,omitempty"`
	SlashTerminatedPaths        *bool                    `yaml:"slashTerminatedPaths,omitempty"`
	NoEmptyTags                 bool                     `yaml:"noEmptyTags,omitempty"`
	NoUnusedDefinitions         bool                     `yaml:"noUnusedDefinitions,omitempty"`
	NoDuplicateOperationIDs     bool                     `yaml:"noDuplicateOperationIDs,omitempty"`
	NoMissingRequiredProperties bool                     `yaml:"noMissingRequiredProperties,omitempty"`
}