format

Documentation

Overview

Package format implements formatting of Rego source files.

Index

• func Ast(x interface{}) (formatted []byte, err error)
• func Bytes(src []byte) ([]byte, error)
• func MustAst(x interface{}) []byte
• func Source(filename string, src []byte) ([]byte, error)

Functions

func Ast

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

Ast formats a Rego AST element. If the passed value is not a valid AST element, Ast returns nil and an error. Ast relies on all AST elements having non-nil Location values. If an AST element with a nil Location value is encountered, a default location will be set on the AST node.

func Bytes

func Bytes(src []byte) ([]byte, error)

Bytes formats Rego source code. The bytes provided do not have to be an entire source file, but they must be parse-able. If the bytes are not parse-able, Bytes will return an error resulting from the attempt to parse them.

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 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.