M0.6: command registry, guard, theme tokens, app.about and app.quit
Command trait with static spec, enabled check and run; Registry rejects duplicate ids; Engine::execute runs every command inside the guard, which turns panics into EngineError::Internal and keeps the engine usable. Effects (Quit) are applied by the host. Theme tokens for Lutra Dark and Lutra Light render as --lt-* CSS variables and a webview init script. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
50bcc95006
commit
b382f9fae7
12 changed files with 758 additions and 1 deletions
111
crates/engine/src/command.rs
Normal file
111
crates/engine/src/command.rs
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
//! The command abstraction: static metadata, the run contract and the
|
||||
//! effects a command asks its host to carry out.
|
||||
|
||||
use serde::Serialize;
|
||||
use serde_json::Value;
|
||||
|
||||
use crate::{EngineError, State};
|
||||
|
||||
/// Static metadata of a command.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||
pub struct CommandSpec {
|
||||
/// Unique id, `area.action` in camelCase, e.g. `app.about`.
|
||||
pub id: &'static str,
|
||||
/// Label for menus and the command palette, in English.
|
||||
pub label: &'static str,
|
||||
/// Menu path with `/` separators, e.g. `Help/About Lutra`.
|
||||
pub menu_path: Option<&'static str>,
|
||||
/// Default shortcut in Lutra notation; `Mod` is Ctrl, or Cmd on macOS.
|
||||
pub default_shortcut: Option<&'static str>,
|
||||
/// Documentation of the params object, `none` if the command takes none.
|
||||
pub params: &'static str,
|
||||
}
|
||||
|
||||
/// Something the engine asks its host to do after a command returns,
|
||||
/// because it needs a layer the engine cannot reach (windows, the process).
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(tag = "kind", rename_all = "camelCase")]
|
||||
pub enum Effect {
|
||||
/// Quit the application.
|
||||
Quit,
|
||||
}
|
||||
|
||||
/// Result of a successful command.
|
||||
#[derive(Debug, Clone, PartialEq, Default)]
|
||||
pub struct Outcome {
|
||||
/// JSON result returned to the caller.
|
||||
pub value: Value,
|
||||
/// Effects for the host to apply, in order.
|
||||
pub effects: Vec<Effect>,
|
||||
}
|
||||
|
||||
impl Outcome {
|
||||
/// An outcome with a value and no effects.
|
||||
pub fn value(value: Value) -> Self {
|
||||
Self {
|
||||
value,
|
||||
effects: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
/// An outcome with a null value and one effect.
|
||||
pub fn effect(effect: Effect) -> Self {
|
||||
Self {
|
||||
value: Value::Null,
|
||||
effects: vec![effect],
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A user-visible action.
|
||||
///
|
||||
/// Implementations are stateless; everything they change lives in [`State`].
|
||||
pub trait Command: Send + Sync {
|
||||
/// Static metadata.
|
||||
fn spec(&self) -> &CommandSpec;
|
||||
|
||||
/// Whether the command can run in the given state. Defaults to always.
|
||||
fn enabled(&self, _state: &State) -> bool {
|
||||
true
|
||||
}
|
||||
|
||||
/// Runs the command.
|
||||
///
|
||||
/// # Errors
|
||||
/// Returns [`EngineError::InvalidParams`] for params that don't match
|
||||
/// [`CommandSpec::params`], and [`EngineError::Failed`] when the action
|
||||
/// itself fails.
|
||||
fn run(&self, state: &mut State, params: Value) -> Result<Outcome, EngineError>;
|
||||
}
|
||||
|
||||
/// Description of a command for menus, the palette, keymaps and agents.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct CommandInfo {
|
||||
/// Command id.
|
||||
pub id: String,
|
||||
/// Label.
|
||||
pub label: String,
|
||||
/// Menu path, if the command is in a menu.
|
||||
pub menu_path: Option<String>,
|
||||
/// Default shortcut, if any.
|
||||
pub default_shortcut: Option<String>,
|
||||
/// Params documentation.
|
||||
pub params: String,
|
||||
/// Whether the command can run in the current state.
|
||||
pub enabled: bool,
|
||||
}
|
||||
|
||||
impl CommandInfo {
|
||||
/// Builds the description from a spec and the current enabled state.
|
||||
pub fn new(spec: &CommandSpec, enabled: bool) -> Self {
|
||||
Self {
|
||||
id: spec.id.to_string(),
|
||||
label: spec.label.to_string(),
|
||||
menu_path: spec.menu_path.map(str::to_string),
|
||||
default_shortcut: spec.default_shortcut.map(str::to_string),
|
||||
params: spec.params.to_string(),
|
||||
enabled,
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue