lintutil

package

v1.6.0 Latest Latest Go to latest Published: May 16, 2021 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grokify/spectrum

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ParseScope(s string) (string, error)
func ScopeMatch(wantScope, tryScope string) bool
func StandardRules() []string
type PolicyRule
type PolicyViolation
type PolicyViolationLocations
- func (vl *PolicyViolationLocations) Finalize()
type PolicyViolationsSet
- func NewPolicyViolationsSet(ruleName string) PolicyViolationsSet
- func (set *PolicyViolationsSet) Count() uint
- func (set *PolicyViolationsSet) Locations() PolicyViolationLocations
type PolicyViolationsSets
- func NewPolicyViolationsSets() *PolicyViolationsSets
type ViolationLocationsByRuleSet
- func (vlrs *ViolationLocationsByRuleSet) Condense()
- func (vlrs *ViolationLocationsByRuleSet) Count() uint

Constants ¶

View Source

const (
	RulenameDatatypeIntFormatIsInt32OrInt64 = "datatype-int-format-int32-int64"
	RuleOpDescExist                         = "operation-description-exist"
	RuleOpIdExist                           = "operation-operationid-exist"

	RulenameOpIdStyleCamelCase  = "operation-operationid-style-camelcase"
	RulenameOpIdStyleKebabCase  = "operation-operationid-style-kebabcase"
	RulenameOpIdStylePascalCase = "operation-operationid-style-pascalcase"
	RulenameOpIdStyleSnakeCase  = "operation-operationid-style-snakecase"

	RuleOpSummaryExist                = "operation-summary-exist"
	RuleOpSummaryCaseFirstCapitalized = "operation-summary-first-letter-capitalized"
	RuleOpTagsCountOneOnly            = "operation-tags-count-one"
	RulePathParamNameExist            = "path-param-name-exist"
	RulePathParamStyleCamelCase       = "path-param-style-camelcase"
	RuleSchemaPropEnumStylePascalCase = "property-enum-style-pascalcase"
	RuleSchemaPropDescExist           = "property-description-exist"
	RuleSchemaObjectPropsExist        = "schema-object-properties-exist"
	RuleTagCaseFirstCapitalized       = "tag-case-first-capitalized"
)

View Source

const (
	ScopeOperation     = "operation"
	ScopeSpecification = "specification"
)

Variables ¶

This section is empty.

Functions ¶

func ParseScope ¶

func ParseScope(s string) (string, error)

func ScopeMatch ¶

func ScopeMatch(wantScope, tryScope string) bool

func StandardRules ¶

func StandardRules() []string

Types ¶

type PolicyRule ¶

type PolicyRule struct {
	Name         string
	StringFormat string
}

type PolicyViolation ¶

type PolicyViolation struct {
	RuleName  string
	RuleType  string
	Violation string
	Value     string
	Location  string
	Data      map[string]string
}

type PolicyViolationLocations ¶

type PolicyViolationLocations struct {
	RuleName  string
	Locations []string
}

func (*PolicyViolationLocations) Finalize ¶

func (vl *PolicyViolationLocations) Finalize()

type PolicyViolationsSet ¶

type PolicyViolationsSet struct {
	RuleName   string
	Violations []PolicyViolation
}

func NewPolicyViolationsSet ¶

func NewPolicyViolationsSet(ruleName string) PolicyViolationsSet

func (*PolicyViolationsSet) Count ¶

func (set *PolicyViolationsSet) Count() uint

func (*PolicyViolationsSet) Locations ¶

func (set *PolicyViolationsSet) Locations() PolicyViolationLocations

type PolicyViolationsSets ¶

type PolicyViolationsSets struct {
	ByRule map[string]PolicyViolationsSet
}

func NewPolicyViolationsSets ¶

func NewPolicyViolationsSets() *PolicyViolationsSets

func (*PolicyViolationsSets) AddSimple ¶

func (sets *PolicyViolationsSets) AddSimple(ruleName, location, value string)

func (*PolicyViolationsSets) AddViolation ¶

func (sets *PolicyViolationsSets) AddViolation(violation PolicyViolation)

func (*PolicyViolationsSets) AddViolations ¶

func (sets *PolicyViolationsSets) AddViolations(violations []PolicyViolation)

func (*PolicyViolationsSets) Count ¶

func (sets *PolicyViolationsSets) Count() uint

func (*PolicyViolationsSets) LocationsByRule ¶

func (sets *PolicyViolationsSets) LocationsByRule() ViolationLocationsByRuleSet

func (*PolicyViolationsSets) UpsertSet ¶

func (sets *PolicyViolationsSets) UpsertSet(upsertSet PolicyViolationsSet) error

func (*PolicyViolationsSets) UpsertSets ¶

func (sets *PolicyViolationsSets) UpsertSets(upsertSets *PolicyViolationsSets) error

type ViolationLocationsByRuleSet ¶

type ViolationLocationsByRuleSet struct {
	ViolationLocationsByRule map[string][]string
}

func (*ViolationLocationsByRuleSet) Condense ¶

func (vlrs *ViolationLocationsByRuleSet) Condense()

func (*ViolationLocationsByRuleSet) Count ¶

func (vlrs *ViolationLocationsByRuleSet) Count() uint

Source Files ¶

View all Source files

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