devcheck

Documentation

Index

• type ActivityConf
  • func (x *ActivityConf) Check(hub *tableau.Hub) error
  • func (x *ActivityConf) CheckCompatibility(hub, newHub *tableau.Hub) error
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Check(dir string, filter tableau.Filter, format format.Format, options ...Option) error
  • func (h *Hub) CheckCompatibility(dir, newDir string, filter tableau.Filter, format format.Format, ...) error
• type ItemConf
  • func (x *ItemConf) Check(hub *tableau.Hub) error
  • func (x *ItemConf) CheckCompatibility(hub, newHub *tableau.Hub) error
• type Option
  • func BreakFailedCount(count int) Option
  • func IgnoreUnknownFields() Option
  • func ProtoPackage(protoPackage string) Option
  • func SubdirRewrites(subdirRewrites map[string]string) Option
• type Options
  • func ParseOptions(setters ...Option) *Options

Types

type ActivityConf

type ActivityConf struct {
	tableau.ActivityConf
}

func (*ActivityConf) Check

func (x *ActivityConf) Check(hub *tableau.Hub) error

func (*ActivityConf) CheckCompatibility

func (x *ActivityConf) CheckCompatibility(hub, newHub *tableau.Hub) error

type Hub

type Hub struct {
	*tableau.Hub
	// contains filtered or unexported fields
}

func NewHub

func NewHub() *Hub

func (*Hub) Check

func (h *Hub) Check(dir string, filter tableau.Filter, format format.Format, options ...Option) error

func (*Hub) CheckCompatibility

func (h *Hub) CheckCompatibility(dir, newDir string, filter tableau.Filter, format format.Format, options ...Option) error

type ItemConf

type ItemConf struct {
	tableau.ItemConf
}

func (*ItemConf) Check

func (x *ItemConf) Check(hub *tableau.Hub) error

func (*ItemConf) CheckCompatibility

func (x *ItemConf) CheckCompatibility(hub, newHub *tableau.Hub) error

type Option

type Option func(*Options)

Option is the functional option type.

func BreakFailedCount

func BreakFailedCount(count int) Option

BreakFailedCount sets BreakFailedCount option.

func IgnoreUnknownFields

func IgnoreUnknownFields() Option

IgnoreUnknownFields sets IgnoreUnknownFields option as true.

func ProtoPackage

func ProtoPackage(protoPackage string) Option

ProtoPackage sets ProtoPackage option.

func SubdirRewrites

func SubdirRewrites(subdirRewrites map[string]string) Option

SubdirRewrites sets SubdirRewrites option.

type Options

type Options struct {
	// Break check loop if failed count is equal to or more than BreakFailedCount.
	// Default: 1.
	BreakFailedCount int
	// Rewrite subdir path (relative to workbook name option in .proto file).
	// Default: nil.
	SubdirRewrites map[string]string
	// The proto package name of .proto files.
	// Default: "protoconf".
	ProtoPackage string
	// Whether to ignore unknown JSON fields during parsing.
	// Default: false.
	IgnoreUnknownFields bool
}

func ParseOptions

func ParseOptions(setters ...Option) *Options

ParseOptions parses functional options and merge them to default Options.