format

Documentation

Overview

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

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
• 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 = v1.ArityFormatErrDetail

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

type Opts

type Opts = v1.Opts

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