providers

Documentation

Index

• type BuiltIns
  • func (*BuiltIns) Name() string
  • func (*BuiltIns) Run(_ context.Context, c *cache.Cache, params types.CompletionParams, ...) ([]types.CompletionItem, error)
• type Input
  • func (*Input) Name() string
  • func (*Input) Run(_ context.Context, c *cache.Cache, params types.CompletionParams, _ *Options) ([]types.CompletionItem, error)
• type Options
• type PackageRefs
  • func (*PackageRefs) Name() string
  • func (*PackageRefs) Run(_ context.Context, c *cache.Cache, params types.CompletionParams, _ *Options) ([]types.CompletionItem, error)
• type Policy
  • func NewPolicy(ctx context.Context, store storage.Store) *Policy
  • func (*Policy) Name() string
  • func (p *Policy) Run(ctx context.Context, c *cache.Cache, params types.CompletionParams, ...) ([]types.CompletionItem, error)
• type RuleHead
  • func (*RuleHead) Name() string
  • func (*RuleHead) Run(_ context.Context, c *cache.Cache, params types.CompletionParams, _ *Options) ([]types.CompletionItem, error)
• type RuleHeadKeyword
  • func (*RuleHeadKeyword) Name() string
  • func (*RuleHeadKeyword) Run(_ context.Context, c *cache.Cache, params types.CompletionParams, _ *Options) ([]types.CompletionItem, error)

Types

type BuiltIns

type BuiltIns struct{}

func (*BuiltIns) Name

func (*BuiltIns) Name() string

func (*BuiltIns) Run

func (*BuiltIns) Run(
	_ context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	opts *Options,
) ([]types.CompletionItem, error)

type Input

type Input struct{}

Input is a simple completion provider that returns the input keyword as a completion item at suitable times.

func (*Input) Name

func (*Input) Name() string

func (*Input) Run

func (*Input) Run(
	_ context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	_ *Options,
) ([]types.CompletionItem, error)

type Options

type Options struct {
	// Builtins is a map of built-in functions to their definitions required in
	// the context of the current completion request.
	Builtins         map[string]*ast.Builtin
	RootURI          string
	ClientIdentifier clients.Identifier
}

type PackageRefs

type PackageRefs struct{}

PackageRefs is a completion provider that returns completions when importing packages.

func (*PackageRefs) Name

func (*PackageRefs) Name() string

func (*PackageRefs) Run

func (*PackageRefs) Run(
	_ context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	_ *Options,
) ([]types.CompletionItem, error)

type Policy

type Policy struct {
	// contains filtered or unexported fields
}

Policy provides suggestions that have been determined by Rego policy.

func NewPolicy

func NewPolicy(ctx context.Context, store storage.Store) *Policy

NewPolicy creates a new Policy provider. This provider is distinctly different from the other providers as it acts like the entrypoint for all Rego-based providers, and not a single provider "function" like the Go providers do.

func (*Policy) Name

func (*Policy) Name() string

func (*Policy) Run

func (p *Policy) Run(
	ctx context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	opts *Options,
) ([]types.CompletionItem, error)

type RuleHead

type RuleHead struct{}

RuleHead is a completion provider that returns completions for rules found in the same package at the start of a line, so when adding new heads, the user can easily add new ones.

func (*RuleHead) Name

func (*RuleHead) Name() string

func (*RuleHead) Run

func (*RuleHead) Run(
	_ context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	_ *Options,
) ([]types.CompletionItem, error)

type RuleHeadKeyword

type RuleHeadKeyword struct{}

RuleHeadKeyword will return completions for the keywords when starting a new rule. The current cases are supported: - [rule-name] if - [rule-name] := - [rule-name] contains - [rule-name] contains if These completions are mandatory, that means they are the only ones to be shown.

func (*RuleHeadKeyword) Name

func (*RuleHeadKeyword) Name() string

func (*RuleHeadKeyword) Run

func (*RuleHeadKeyword) Run(
	_ context.Context,
	c *cache.Cache,
	params types.CompletionParams,
	_ *Options,
) ([]types.CompletionItem, error)