customrules

Documentation

Index

• type EnumNamesLowerSnakeCaseRule
  • func NewEnumNamesLowerSnakeCaseRule() EnumNamesLowerSnakeCaseRule
  • func (r EnumNamesLowerSnakeCaseRule) Apply(proto *parser.Proto) ([]report.Failure, error)
  • func (r EnumNamesLowerSnakeCaseRule) ID() string
  • func (r EnumNamesLowerSnakeCaseRule) IsOfficial() bool
  • func (r EnumNamesLowerSnakeCaseRule) Purpose() string
• type SimpleRule
  • func NewSimpleRule(verbose bool, fixMode bool) SimpleRule
  • func (r SimpleRule) Apply(proto *parser.Proto) ([]report.Failure, error)
  • func (r SimpleRule) ID() string
  • func (r SimpleRule) IsOfficial() bool
  • func (r SimpleRule) Purpose() string

Types

type EnumNamesLowerSnakeCaseRule

type EnumNamesLowerSnakeCaseRule struct{}

EnumNamesLowerSnakeCaseRule verifies that all enum names are LowerSnakeCase.

func NewEnumNamesLowerSnakeCaseRule

func NewEnumNamesLowerSnakeCaseRule() EnumNamesLowerSnakeCaseRule

NewEnumNamesLowerSnakeCaseRule creates a new EnumNamesLowerSnakeCaseRule.

func (EnumNamesLowerSnakeCaseRule) Apply

func (r EnumNamesLowerSnakeCaseRule) Apply(proto *parser.Proto) ([]report.Failure, error)

Apply applies the rule to the proto.

func (EnumNamesLowerSnakeCaseRule) ID

func (r EnumNamesLowerSnakeCaseRule) ID() string

ID returns the ID of this rule.

func (EnumNamesLowerSnakeCaseRule) IsOfficial

func (r EnumNamesLowerSnakeCaseRule) IsOfficial() bool

IsOfficial decides whether or not this rule belongs to the official guide.

func (EnumNamesLowerSnakeCaseRule) Purpose

func (r EnumNamesLowerSnakeCaseRule) Purpose() string

Purpose returns the purpose of this rule.

type SimpleRule

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

SimpleRule verifies that all enum names are LowerSnakeCase.

func NewSimpleRule

func NewSimpleRule(
	verbose bool,
	fixMode bool,
) SimpleRule

NewSimpleRule creates a new SimpleRule.

func (SimpleRule) Apply

func (r SimpleRule) Apply(proto *parser.Proto) ([]report.Failure, error)

Apply applies the rule to the proto.

func (SimpleRule) ID

func (r SimpleRule) ID() string

ID returns the ID of this rule.

func (SimpleRule) IsOfficial

func (r SimpleRule) IsOfficial() bool

IsOfficial decides whether or not this rule belongs to the official guide.

func (SimpleRule) Purpose

func (r SimpleRule) Purpose() string

Purpose returns the purpose of this rule.