Liking cljdoc? Tell your friends :D

hive-addon.runtime.schema

Value objects for CLIENT RUNTIMES: the editor-side code an addon ships (a Vim runtime directory, and later elisp) and what a host does to make a client load it when the addon is injected.

A RuntimeDecl is data an addon carries in its mount manifest under :addon/runtime, or that a host supplies for an addon that does not. A ClientProfile says where a client kind autoloads code from. An Effect is one step of a provisioning plan; plans are pure data run by hive-addon.runtime.boundary.

Rationale lives in hive memory (KG-linked), not here.

Value objects for CLIENT RUNTIMES: the editor-side code an addon ships (a
Vim runtime directory, and later elisp) and what a host does to make a
client load it when the addon is injected.

A RuntimeDecl is data an addon carries in its mount manifest under
:addon/runtime, or that a host supplies for an addon that does not. A
ClientProfile says where a client kind autoloads code from. An Effect is one
step of a provisioning plan; plans are pure data run by
hive-addon.runtime.boundary.

Rationale lives in hive memory (KG-linked), not here.
raw docstring

Bindingclj/s

A value substituted for {{name}} in on-load commands: a literal, or a hook of the injected addon resolved after initialize!.

A value substituted for {{name}} in on-load commands: a literal, or a hook
of the injected addon resolved after initialize!.
sourceraw docstring

BindingKeyclj/s

The name a {{placeholder}} refers to: an unqualified lower-case keyword.

The name a {{placeholder}} refers to: an unqualified lower-case keyword.
sourceraw docstring

ClientKindclj/s

Which client loads the runtime. Open: a new client kind is a new profile.

Which client loads the runtime. Open: a new client kind is a new profile.
sourceraw docstring

ClientProfileclj/s

Where a client kind autoloads runtimes from, where the generated loader sits inside an installed runtime, and which loader kind renders it (the dispatch value of hive-addon.runtime.plan/loader-source). :profile/install-root may start with ~/.

Where a client kind autoloads runtimes from, where the generated loader sits
inside an installed runtime, and which loader kind renders it (the dispatch
value of hive-addon.runtime.plan/loader-source). :profile/install-root may
start with ~/.
sourceraw docstring

Effectclj/s

One provisioning step. Filesystem effects are run through IRuntimeFs; :client/eval sends commands to clients that are already running.

One provisioning step. Filesystem effects are run through IRuntimeFs;
:client/eval sends commands to clients that are already running.
sourceraw docstring

explain-declclj/s

(explain-decl x)
source

Outcomeclj/s

What running one effect did. :skipped? marks effects not run because an earlier one failed.

What running one effect did. :skipped? marks effects not run because an
earlier one failed.
sourceraw docstring

Planclj/s

source

ProvisionReportclj/s

Outcome of provisioning (or deprovisioning) every runtime of one addon. :error is set when the provisioner itself failed before any runtime ran.

Outcome of provisioning (or deprovisioning) every runtime of one addon.
:error is set when the provisioner itself failed before any runtime ran.
sourceraw docstring

RuntimeDeclclj/s

One client runtime of one addon. :runtime/on-load are client commands (Vim Ex commands for :vim and :nvim) run once the client has loaded the runtime: at startup for a client started later, immediately for one already running.

One client runtime of one addon. :runtime/on-load are client commands (Vim
Ex commands for :vim and :nvim) run once the client has loaded the runtime:
at startup for a client started later, immediately for one already running.
sourceraw docstring

RuntimeDeclsclj/s

source

RuntimeIdclj/s

A directory-safe name: it becomes one path segment under the client's install root, so it can never contain a separator or start with a dot.

A directory-safe name: it becomes one path segment under the client's
install root, so it can never contain a separator or start with a dot.
sourceraw docstring

RuntimeReportclj/s

Outcome of provisioning one runtime. :ok? is the install; :live-ok? is present only when activation in running clients was attempted.

Outcome of provisioning one runtime. :ok? is the install; :live-ok? is
present only when activation in running clients was attempted.
sourceraw docstring

Sourceclj/s

Where the runtime files come from. :source/dir is an absolute directory; :source/hook names a hook of the injected addon whose value (or zero-arg fn result) is that directory, known only after initialize!.

Where the runtime files come from. :source/dir is an absolute directory;
:source/hook names a hook of the injected addon whose value (or zero-arg fn
result) is that directory, known only after initialize!.
sourceraw docstring

valid-decl?clj/s

(valid-decl? x)
source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close