plugin

package
v0.0.0-...-bbcbdef Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2023 License: Unlicense Imports: 6 Imported by: 0

Documentation

Overview

Package plugin contains logic for registering and binding plugins with vidar. While designing plugins, we noticed that any change to the functionality in a common import between vidar and the plugin would cause the plugin to fail to load.

As a result, you'll see several very small sub-packages containing only interface types that are used either as parameters or return types for methods. This allows plugins to import those small sub-packages, which change far less frequently than the main packages.

When you see one of these small sub-packages, consider them packages that plugins should feel comfortable importing with a very low risk of needing to be rebuilt for new versions of vidar.

A plugin must export a single function, named Bindables, which returns all bind.Bindables that the plugin provides. It must accept arguments of type command.Commander, gxui.Driver, and gxui.Theme, and its return type must be []bind.Bindable.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bindables

func Bindables(cmdr command.Commander, driver gxui.Driver, theme gxui.Theme) []bind.Bindable

Bindables returns all bindables that are found via plugins in the plugin directory.

For each plugin, Bindables will look up a Bindables function and expect it to accept a Commander, a gxui.Driver, and a gxui.Theme as arguments.

Types

This section is empty.

Directories

Path Synopsis
Package command contains types that plugins use to access functionality of the commander.Commander.
Package command contains types that plugins use to access functionality of the commander.Commander.
Package comments contains logic for working with comments.
Package comments contains logic for working with comments.
Package godef contains logc for interacting with the godef command line tool.
Package godef contains logc for interacting with the godef command line tool.
Package license contains plugins for working with project licenses.
Package license contains plugins for working with project licenses.
Package status contains types that plugins can make use of in their bindables for displaying status to the user.
Package status contains types that plugins can make use of in their bindables for displaying status to the user.
Package vfmt contains logic for performing 'v fmt' on vlang files.
Package vfmt contains logic for performing 'v fmt' on vlang files.
Package vsyntax implements plugins for syntax highlighting and parsing for the v language (vlang.io).
Package vsyntax implements plugins for syntax highlighting and parsing for the v language (vlang.io).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL