cuedebug

Documentation

Index

• func Init() error
• type Config

Functions

func Init

func Init() error

Init initializes Flags. Note: this isn't named "init" because we don't always want it to be called (for example we don't want it to be called when running "cue help"), and also because we want the failure mode to be one of error not panic, which would be the only option if it was a top level init function.

Types

type Config

type Config struct {
	// HTTP enables JSON logging per HTTP request and response made
	// when interacting with module registries.
	HTTP bool

	// Strict sets whether extra aggressive checking should be done.
	// This should typically default to true for pre-releases and default to
	// false otherwise.
	Strict bool

	// LogEval sets the log level for the evaluator.
	// There are currently only two levels:
	//
	//	0: no logging
	//	1: logging
	LogEval int

	// Sharing enables structure sharing.
	Sharing bool `envflag:"default:true"`

	// SortFields forces fields in a struct to be sorted
	// lexicographically.
	SortFields bool

	// OpenInline permits disallowed fields to be selected into literal structs
	// that would normally result in a close error. For instance,
	//
	//    #D: {a: 1}
	//    x: (#D & {b: 2}).b // allow this
	//
	// This behavior was erroneously permitted in the v2 evaluator and was fixed
	// in v3. This allows users that rely on this behavior to use v3. This
	// option also discards closedness of the resulting expression. As was
	// reported in Issue #3534, this was another erroneous behavior in v2 that
	// is otherwise fixed in v3.
	//
	// To aid the transition to v3, this is enabled by default for now.
	//
	// A possible solution for both incompatibilities would be the introduction
	// of an openAll builtin to recursive open up a cue value. For the first
	// issue, the example above could be rewritten as:
	//
	//     x: (openAll(#D) & {b: 2}).b
	//
	// For the second issue, to open up the entire result of an inline struct,
	// such an expression could be written as `openAll(expr).out`.
	OpenInline bool `envflag:"default:true"`
}

Flags holds the set of known CUE_DEBUG flags.

When adding, deleting, or modifying entries below, update cmd/cue/cmd/help.go as well for `cue help environment`.

var Flags Config

Flags holds the set of global CUE_DEBUG flags. It is initialized by Init.