Skip to main content

Module manifest

Module manifest 

Source
Expand description

Plugin manifest types, discovery, and validation.

A plugin is a directory under the plugins root whose name equals its manifest id, containing a manifest.json and the executable its entry points name. Discovery is deliberately forgiving: one broken manifest produces a warning and is skipped, never blocking the discovery of its neighbours. A plugin is never spawned as a side effect of discovery — the host spawns only what the enabled set names, which is what makes “lands disabled” structural.

Structs§

ActionContribution
One action a plugin contributes to the command palette when it declares the KIND_ACTION_CONTRIBUTOR kind.
DiscoveredPlugin
A plugin that passed validation, with confinement-checked paths.
DiscoveryWarning
Why a candidate plugin directory was skipped.
OverlayCapability
Capabilities an overlay-kind manifest may claim.
PluginEntryPoint
One named executable entry point. command is relative to the plugin directory only — never a PATH lookup, never allowed to escape the directory (enforced by discover_plugins).
PluginManifest
A parsed manifest.json.
SettingSchemaEntry
One typed setting declared by a plugin’s settings schema.
StatusBarWidgetKind
The statusBarWidget manifest block: how a status-bar-widget plugin presents itself and what the user can configure.

Enums§

PluginActivation
Activation policy declared by the manifest.
SettingType
A setting’s value type, as declared in a manifest’s settings schema.

Constants§

ENTRY_POINT_ACTION_CONTRIBUTOR
Entry-point map key for the KIND_ACTION_CONTRIBUTOR kind.
ENTRY_POINT_OVERLAY
Entry-point map key for the KIND_OVERLAY kind.
ENTRY_POINT_PANEL
Entry-point map key for the KIND_PANEL kind.
ENTRY_POINT_STATUS_BAR_WIDGET
Entry-point map key for the KIND_STATUS_BAR_WIDGET kind.
KIND_ACTION_CONTRIBUTOR
The action-contributor plugin kind: the plugin contributes entries to the command palette.
KIND_OVERLAY
The overlay plugin kind: the plugin owns a persistent surface drawn over the terminal through the SetOverlay/ClearOverlay protocol commands (design: docs/plans/2026-09-24-overlay-plugin-design.md). Phase 1 is display-only; interactive requires the overlay.interactive capability and is forced off without it.
KIND_PANEL
The panel plugin kind: the plugin pushes markdown panel content through the SetPanel/ClearPanel protocol commands (the same surface a tab script’s SetPanel drives), rendered in the Settings plugins section.
KIND_STATUS_BAR_WIDGET
The status-bar-widget plugin kind. Unknown kinds in a manifest skip the whole plugin with a visible warning rather than loading partially.

Functions§

discover_plugins
Scan a plugins root for valid plugin directories.
validate_settings
Validate persisted settings against a manifest schema.