24c94d474e
Instead of a menagerie of macros for implementing `Action`, now there are just two: * `actions!(editor, [MoveLeft, MoveRight])` * `#[derive(..., Action)]` with `#[action(namespace = editor)]` In both contexts, `///` doc comments can be provided and will be used in `JsonSchema`. In both contexts, parameters can provided in `#[action(...)]`: - `namespace = some_namespace` sets the namespace. In Zed this is required. - `name = "ActionName"` overrides the action's name. This must not contain "::". - `no_json` causes the `build` method to always error and `action_json_schema` to return `None` and allows actions not implement `serde::Serialize` and `schemars::JsonSchema`. - `no_register` skips registering the action. This is useful for implementing the `Action` trait while not supporting invocation by name or JSON deserialization. - `deprecated_aliases = ["editor::SomeAction"]` specifies deprecated old names for the action. These action names should *not* correspond to any actions that are registered. These old names can then still be used to refer to invoke this action. In Zed, the keymap JSON schema will accept these old names and provide warnings. - `deprecated = "Message about why this action is deprecation"` specifies a deprecation message. In Zed, the keymap JSON schema will cause this to be displayed as a warning. This is a new feature. Also makes the following changes since this seems like a good time to make breaking changes: * In `zed.rs` tests adds a test with an explicit list of namespaces. The rationale for this is that there is otherwise no checking of `namespace = ...` attributes. * `Action::debug_name` renamed to `name_for_type`, since its only difference with `name` was that it * `Action::name` now returns `&'static str` instead of `&str` to match the return of `name_for_type`. This makes the action trait more limited, but the code was already assuming that `name_for_type` is the same as `name`, and it requires `&'static`. So really this just makes the trait harder to misuse. * Various action reflection methods now use `&'static str` instead of `SharedString`. Release Notes: - N/A
53 lines
1.2 KiB
Rust
53 lines
1.2 KiB
Rust
use gpui::{Action, actions};
|
|
use gpui_macros::register_action;
|
|
use schemars::JsonSchema;
|
|
use serde_derive::Deserialize;
|
|
|
|
#[test]
|
|
fn test_action_macros() {
|
|
actions!(
|
|
test_only,
|
|
[
|
|
SomeAction,
|
|
/// Documented action
|
|
SomeActionWithDocs,
|
|
]
|
|
);
|
|
|
|
#[derive(PartialEq, Clone, Deserialize, JsonSchema, Action)]
|
|
#[action(namespace = test_only)]
|
|
struct AnotherSomeAction;
|
|
|
|
#[derive(PartialEq, Clone, gpui::private::serde_derive::Deserialize)]
|
|
struct RegisterableAction {}
|
|
|
|
register_action!(RegisterableAction);
|
|
|
|
impl gpui::Action for RegisterableAction {
|
|
fn boxed_clone(&self) -> Box<dyn gpui::Action> {
|
|
unimplemented!()
|
|
}
|
|
|
|
fn partial_eq(&self, _action: &dyn gpui::Action) -> bool {
|
|
unimplemented!()
|
|
}
|
|
|
|
fn name(&self) -> &'static str {
|
|
unimplemented!()
|
|
}
|
|
|
|
fn name_for_type() -> &'static str
|
|
where
|
|
Self: Sized,
|
|
{
|
|
unimplemented!()
|
|
}
|
|
|
|
fn build(_value: serde_json::Value) -> anyhow::Result<Box<dyn gpui::Action>>
|
|
where
|
|
Self: Sized,
|
|
{
|
|
unimplemented!()
|
|
}
|
|
}
|
|
}
|