format

type ArityFormatErrDetail struct {
	Have []string `json:"have"`
	Want []string `json:"want"`
}

type Opts struct {
	// IgnoreLocations instructs the formatter not to use the AST nodes' locations
	// into account when laying out the code: notably, when the input is the result
	// of partial evaluation, arguments maybe have been shuffled around, but still
	// carry along their original source locations.
	IgnoreLocations bool

	// RegoVersion is the version of Rego to format code for.
	RegoVersion ast.RegoVersion

	// RegoVersionSpan is the span of Rego versions the formatted code must parse at: [v0, v2] for code
	// compatible with both Rego v0 and v2, [v2, v2] for Rego v2 only. A span reaching v2 from an older
	// version adds the 'rego.v2' import. If defined, it takes precedence over [Opts.RegoVersion].
	RegoVersionSpan ast.RegoVersionSpan

	// ParserOptions is the parser options used when parsing the module to be formatted.
	ParserOptions *ast.ParserOptions

	// DropRedundantDirectiveImports instructs the formatter to drop directive imports, which change how
	// a module is parsed rather than bring anything into scope: 'rego.*' and 'future.*'.
	// Imports are only removed if [Opts.RegoVersion] or [Opts.RegoVersionSpan] makes them redundant.
	// Regardless of this option, 'rego.v1' is dropped from a module that imports 'rego.v2'.
	DropRedundantDirectiveImports bool

	// DropV0Imports is equivalent to [Opts.DropRedundantDirectiveImports]; either setting drops the imports.
	//
	// Deprecated: Use [Opts.DropRedundantDirectiveImports] instead.
	DropV0Imports bool

	// SkipDefensiveCopying, if true, will avoid deep-copying the AST before formatting it.
	// This is true by default for all Source* functions, but false by default for Ast* functions,
	// as some formatting operations may otherwise mutate the AST.
	SkipDefensiveCopying bool

	// FailFast instructs the formatter to stop at the first element whose formatted form differs from the
	// source text, and return an [UnformattedError] instead of laying out the rest of the module.
	// Only the Source* functions honour this option, as they alone have source text to compare against.
	// Not returning an [UnformattedError] doesn't promise that the output matches the source: FailFast never
	// reports a formatted module as unformatted, but it doesn't catch every difference either.
	FailFast bool

	Capabilities *ast.Capabilities
	// contains filtered or unexported fields
}

type UnformattedError struct {
	Loc *ast.Location
}