schemacheck

Documentation

Index

• func NewGenerator(opts Options) generation.Generator
• type Options

Functions

func NewGenerator

func NewGenerator(opts Options) generation.Generator

NewGenerator builds a new schemacheck generator.

Types

type Options

type Options struct {
	// Disabled indicates whether the schemacheck generator is disabled or not.
	// This defaults to false as the schemacheck generator is enabled by default.
	Disabled bool

	// EnabledComparators is a list of the comparators that should be enabled.
	// If this is empty, the default comparators are enabled.
	EnabledComparators []string

	// DisabledComparators is a list of the comparators that should be disabled.
	// If this is empty, no default comparators are disabled.
	DisabledComparators []string

	// ComparisonBase is the base branch/commit to compare against.
	// This defaults to "master".
	// This is not exposed via configuration as it must be set globally.
	ComparisonBase string
}

Options contains the configuration required for the schemacheck generator.