controlroom/plugin

import { validate, register, reset, … } from 'controlroom/plugin';

FunctionsCopy Anchor Link

registerCopy Anchor Link

Validate, then keep every keymap and pane. A later entry of the same name replaces an earlier one.

function register(plugin: unknown): void;

Returns void

registeredCopy Anchor Link

Copies of what has been registered: the only way in is register().

function registered(): {
    keymaps: Map<string, Required<KeymapDef>>;
    panes: Map<string, PaneDef>;
};

Returns { keymaps: Map<string, Required<KeymapDef>>; panes: Map<string, PaneDef>; }

resetCopy Anchor Link

Forget every registration, the built-ins included: they come back on the next use. For tests.

function reset(): void;

Returns void

validateCopy Anchor Link

Refuse what the schema refuses, and say why.

function validate(plugin: unknown): asserts plugin is Plugin;

Returns asserts plugin is Plugin

ClassesCopy Anchor Link

PluginErrorCopy Anchor Link

A refused plugin says what is wrong, where, and what to do about it.

class PluginError extends Error {
    readonly code: PluginErrorCode;
    readonly fix: string;
    constructor(code: PluginErrorCode, message: string, fix: string);
}

ConstantsCopy Anchor Link

CONTRACTCopy Anchor Link

const CONTRACT = 1;

InterfacesCopy Anchor Link

KeymapDefCopy Anchor Link

A keymap: key spec → action name, and the label each action shows in the hint line.

interface KeymapDef {
    keys: Readonly<Record<string, string>>;
    labels?: Readonly<Record<string, string>>;
}

PaneDefCopy Anchor Link

A pane as data: the flagstaff component that draws it, and the label a static projection prints.

interface PaneDef {
    component: string;
    label?: string;
}

PluginCopy Anchor Link

interface Plugin {
    name: string;
    contract?: number;
    keymaps?: Readonly<Record<string, KeymapDef>>;
    panes?: Readonly<Record<string, PaneDef>>;
}

TypesCopy Anchor Link

PluginErrorCodeCopy Anchor Link

The family's refusal vocabulary, the members this host can raise.

type PluginErrorCode = 'E_PLUGIN_SCHEMA' | 'E_PLUGIN_CONTRACT' | 'E_NO_CONTRIBUTION';