refactor

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 refactor implements different refactoring operations over Rego modules.

Index

• type Error
• type MoveQuery
• type MoveQueryResult
• type Refactor
  • func New() *Refactor

Types

type Error

type Error = v1.Error

Error defines the structure of errors returned by refactor.

type MoveQuery

type MoveQuery = v1.MoveQuery

MoveQuery holds the set of Rego modules whose package paths and other references are to be rewritten as per the mapping defined in SrcDstMapping. If validate is true, the moved modules will be compiled to ensure they are valid.

type MoveQueryResult

type MoveQueryResult = v1.MoveQueryResult

MoveQueryResult defines the output of a move query and holds the rewritten modules with updated packages paths and references.

type Refactor

type Refactor = v1.Refactor

Refactor implements different refactoring operations over Rego modules eg. renaming packages.

func New

func New() *Refactor

New returns a new Refactor object.