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/Axot017/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 any) ([]byte, error)
- func AstWithOpts(x any, opts Opts) ([]byte, error)
- func MustAst(x any) []byte
- func MustAstWithOpts(x any, 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 ¶
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 MustAst ¶
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 ¶
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
Types ¶
type ArityFormatErrDetail ¶
type ArityFormatErrDetail = v1.ArityFormatErrDetail
ArgErrDetail but for `fmt` checks since compiler has not run yet.
Source Files