Vibe.UI.SlashCommands.Command behaviour (vibe v0.2.0)

Slash command: /command — run a shell command.

Summary

Types

result()

spec()

Callbacks

run(t, t)

selector_action(term, t)

spec()

Types

result()

@type result() ::
  {:events, [Vibe.UI.Event.t()]}
  | {:command, atom() | {atom(), map()}}
  | :compact
  | :ignore

spec()

@type spec() ::
  Vibe.UI.SlashCommands.Spec.t()
  | %{
      :name => String.t(),
      optional(:aliases) => [String.t()],
      optional(:description) => String.t(),
      optional(:selectors) => [atom()]
    }

Callbacks

run(t, t)

@callback run(String.t(), Vibe.UI.State.t()) :: result()

selector_action(term, t)

(optional)

@callback selector_action(term(), Vibe.UI.State.t()) :: result() | {:command, String.t()}

spec()

@callback spec() :: spec()