format

Documentation

Overview

Package format implements formatting of Rego source files.

Index

• func ArityFormatMismatchError(operands []*ast.Term, operator string, loc *ast.Location, f *types.Function) *ast.Error
• func Ast(x interface{}) ([]byte, error)
• func AstWithOpts(x interface{}, opts Opts) ([]byte, error)
• func MustAst(x interface{}) []byte
• func MustAstWithOpts(x interface{}, opts Opts) []byte
• func Source(filename string, src []byte) ([]byte, error)
• func SourceWithOpts(filename string, src []byte, opts Opts) ([]byte, error)
• type ArityFormatErrDetail
  • func (d *ArityFormatErrDetail) Lines() []string
• type Opts

Functions

func ArityFormatMismatchError

func ArityFormatMismatchError(operands []*ast.Term, operator string, loc *ast.Location, f *types.Function) *ast.Error

arityMismatchError but for `fmt` checks since the compiler has not run yet.

func Ast

func Ast(x interface{}) ([]byte, error)

Ast formats a Rego AST element. If the passed value is not a valid AST element, Ast returns nil and an error. If AST nodes are missing locations an arbitrary location will be used.

func AstWithOpts

func AstWithOpts(x interface{}, opts Opts) ([]byte, error)

func MustAst

func MustAst(x interface{}) []byte

MustAst is a helper function to format a Rego AST element. If any errors occurs this function will panic. This is mostly used for test

func MustAstWithOpts

func MustAstWithOpts(x interface{}, opts Opts) []byte

MustAstWithOpts is a helper function to format a Rego AST element. If any errors occurs this function will panic. This is mostly used for test

func Source

func Source(filename string, src []byte) ([]byte, error)

Source formats a Rego source file. The bytes provided must describe a complete Rego module. If they don't, Source will return an error resulting from the attempt to parse the bytes.

func SourceWithOpts

func SourceWithOpts(filename string, src []byte, opts Opts) ([]byte, error)

Types

type ArityFormatErrDetail

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

ArgErrDetail but for `fmt` checks since compiler has not run yet.

func (*ArityFormatErrDetail) Lines

func (d *ArityFormatErrDetail) Lines() []string

Lines returns the string representation of the detail.

type Opts

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

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

	// DropV0Imports instructs the formatter to drop all v0 imports from the module; i.e. 'rego.v1' and 'future.keywords' imports.
	// Imports are only removed if [Opts.RegoVersion] makes them redundant.
	DropV0Imports bool
}

Opts lets you control the code formatting via `AstWithOpts()`.