metadoc

Documentation

Index

• type Import
  • func (imp Import) String() string
• type RegoMeta
  • func RegoMetaFromPath(path string) (*RegoMeta, error)
  • func RegoMetaFromString(str string) (*RegoMeta, error)
  • func (rego *RegoMeta) HasMetadoc() bool
  • func (rego *RegoMeta) String() string

Types

type Import

type Import struct {
	Path string
	As   string
}

func (Import) String

func (imp Import) String() string

type RegoMeta

type RegoMeta struct {
	PackageName string // Optional package name

	Imports map[Import]struct{} // Imports (without aliases)

	Id                 string
	Title              string
	Description        string
	Severity           string
	Controls           map[string][]string
	Families           []string
	Providers          []string
	RuleRemediationDoc string

	ResourceType string // Resource type

	InputType string // Input type
	// contains filtered or unexported fields
}

Utility to modify metadata of rego files.

You can load this using `RegoMetaFromPath` or `RegoMetaFromString`.

Then, you read and/or modify the public fields of this structure. When you're done, you can turn it into a string again using `String()` and pass it to OPA or write it to disk.

func RegoMetaFromPath

func RegoMetaFromPath(path string) (*RegoMeta, error)

func RegoMetaFromString

func RegoMetaFromString(str string) (*RegoMeta, error)

func (*RegoMeta) HasMetadoc

func (rego *RegoMeta) HasMetadoc() bool

HasMetadoc returns true if the rego file has a metadoc section.

func (*RegoMeta) String

func (rego *RegoMeta) String() string