Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make slash commands more discoverable (#12480)

Browse source 
<img width="648" alt="image"
src="https://github.com/zed-industries/zed/assets/482957/a63df904-fbbe-4e0a-80b2-c98ebee90690">

Release Notes:

- N/A

Co-authored-by: Nathan <nathan@zed.dev>
This commit is contained in:
Antonio Scandurra 2024-05-30 16:45:05 +02:00 • committed by GitHub
parent 436a8fa0ce
commit a259042f92
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 172 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

185
crates/assistant/src/assistant_panel.rs
View file

@ -18,9 +18,9 @@ use anyhow::{anyhow, Result};
use assistant_slash_command::{SlashCommandOutput, SlashCommandOutputSection};
use client::telemetry::Telemetry;
use collections::{hash_map, BTreeSet, HashMap, HashSet, VecDeque};
use editor::actions::UnfoldAt;
use editor::actions::ShowCompletions;
use editor::{
actions::{FoldAt, MoveDown, MoveUp},
actions::{FoldAt, MoveDown, MoveToEndOfLine, MoveUp, Newline, UnfoldAt},
display_map::{
BlockContext, BlockDisposition, BlockId, BlockProperties, BlockStyle, Flap, ToDisplayPoint,
},
@ -212,15 +212,20 @@ impl AssistantPanel {
let slash_command_registry = SlashCommandRegistry::global(cx);
slash_command_registry.register_command(file_command::FileSlashCommand);
slash_command_registry.register_command(file_command::FileSlashCommand, true);
slash_command_registry.register_command(
prompt_command::PromptSlashCommand::new(prompt_library.clone()),
true,
);
slash_command_registry.register_command(active_command::ActiveSlashCommand);
slash_command_registry.register_command(tabs_command::TabsSlashCommand);
slash_command_registry.register_command(project_command::ProjectSlashCommand);
slash_command_registry.register_command(search_command::SearchSlashCommand);
slash_command_registry.register_command(rustdoc_command::RustdocSlashCommand);
slash_command_registry
.register_command(active_command::ActiveSlashCommand, true);
slash_command_registry.register_command(tabs_command::TabsSlashCommand, true);
slash_command_registry
.register_command(project_command::ProjectSlashCommand, true);
slash_command_registry
.register_command(search_command::SearchSlashCommand, true);
slash_command_registry
.register_command(rustdoc_command::RustdocSlashCommand, false);
Self {
workspace: workspace_handle,
@ -943,6 +948,14 @@ impl AssistantPanel {
self.model_menu_handle.toggle(cx);
}
fn insert_command(&mut self, name: &str, cx: &mut ViewContext<Self>) {
if let Some(conversation_editor) = self.active_conversation_editor() {
conversation_editor.update(cx, |conversation_editor, cx| {
conversation_editor.insert_command(name, cx)
});
}
}
fn active_conversation_editor(&self) -> Option<&View<ConversationEditor>> {
Some(&self.active_conversation_editor.as_ref()?.editor)
}
@ -980,52 +993,65 @@ impl AssistantPanel {
})
}
fn render_inject_context_menu(&self, _cx: &mut ViewContext<Self>) -> impl Element {
let workspace = self.workspace.clone();
fn render_inject_context_menu(&self, cx: &mut ViewContext<Self>) -> impl Element {
let commands = self.slash_commands.clone();
let assistant_panel = cx.view().downgrade();
let active_editor_focus_handle = self.workspace.upgrade().and_then(|workspace| {
Some(
workspace
.read(cx)
.active_item_as::<Editor>(cx)?
.focus_handle(cx),
)
});
popover_menu("inject-context-menu")
.trigger(IconButton::new("trigger", IconName::Quote).tooltip(|cx| {
// Tooltip::with_meta("Insert Context", None, "Type # to insert via keyboard", cx)
Tooltip::text("Insert Context", cx)
Tooltip::with_meta("Insert Context", None, "Type / to insert via keyboard", cx)
}))
.menu(move |cx| {
ContextMenu::build(cx, |menu, _cx| {
// menu.entry("Insert Search", None, {
// let assistant = assistant.clone();
// move |_cx| {}
// })
// .entry("Insert Docs", None, {
// let assistant = assistant.clone();
// move |cx| {}
// })
menu.entry("Quote Selection", None, {
let workspace = workspace.clone();
move |cx| {
workspace
.update(cx, |workspace, cx| {
ConversationEditor::quote_selection(
workspace,
&Default::default(),
cx,
)
})
.ok();
ContextMenu::build(cx, |mut menu, _cx| {
for command_name in commands.featured_command_names() {
if let Some(command) = commands.command(&command_name) {
let menu_text = SharedString::from(Arc::from(command.menu_text()));
menu = menu.custom_entry(
{
let command_name = command_name.clone();
move |_cx| {
h_flex()
.w_full()
.justify_between()
.child(Label::new(menu_text.clone()))
.child(
div().ml_4().child(
Label::new(format!("/{command_name}"))
.color(Color::Muted),
),
)
.into_any()
}
},
{
let assistant_panel = assistant_panel.clone();
move |cx| {
assistant_panel
.update(cx, |assistant_panel, cx| {
assistant_panel.insert_command(&command_name, cx)
})
.ok();
}
},
)
}
})
// .entry("Insert Active Prompt", None, {
// let workspace = workspace.clone();
// move |cx| {
// workspace
// .update(cx, |workspace, cx| {
// ConversationEditor::insert_active_prompt(
// workspace,
// &Default::default(),
// cx,
// )
// })
// .ok();
// }
// })
}
if let Some(active_editor_focus_handle) = active_editor_focus_handle.clone() {
menu = menu
.context(active_editor_focus_handle)
.action("Quote Selection", Box::new(QuoteSelection));
}
menu
})
.into()
})
@ -1720,7 +1746,6 @@ impl Conversation {
let pending_command = PendingSlashCommand {
name: name.to_string(),
argument: argument.map(ToString::to_string),
tooltip_text: command.tooltip_text().into(),
source_range,
status: PendingSlashCommandStatus::Idle,
};
@ -2517,7 +2542,6 @@ struct PendingSlashCommand {
argument: Option<String>,
status: PendingSlashCommandStatus,
source_range: Range<language::Anchor>,
tooltip_text: SharedString,
}
#[derive(Clone)]
@ -2690,11 +2714,47 @@ impl ConversationEditor {
.collect()
}
fn insert_command(&mut self, name: &str, cx: &mut ViewContext<Self>) {
if let Some(command) = self.slash_command_registry.command(name) {
self.editor.update(cx, |editor, cx| {
editor.transact(cx, |editor, cx| {
editor.change_selections(Some(Autoscroll::fit()), cx, |s| s.try_cancel());
let snapshot = editor.buffer().read(cx).snapshot(cx);
let newest_cursor = editor.selections.newest::<Point>(cx).head();
if newest_cursor.column > 0
|| snapshot
.chars_at(newest_cursor)
.next()
.map_or(false, |ch| ch != '\n')
{
editor.move_to_end_of_line(
&MoveToEndOfLine {
stop_at_soft_wraps: false,
},
cx,
);
editor.newline(&Newline, cx);
}
editor.insert(&format!("/{name}"), cx);
if command.requires_argument() {
editor.insert(" ", cx);
editor.show_completions(&ShowCompletions, cx);
}
});
});
if !command.requires_argument() {
self.confirm_command(&ConfirmCommand, cx);
}
}
}
pub fn confirm_command(&mut self, _: &ConfirmCommand, cx: &mut ViewContext<Self>) {
let selections = self.editor.read(cx).selections.disjoint_anchors();
let mut commands_by_range = HashMap::default();
let workspace = self.workspace.clone();
self.conversation.update(cx, |conversation, cx| {
conversation.reparse_slash_commands(cx);
for selection in selections.iter() {
if let Some(command) =
conversation.pending_command_for_position(selection.head().text_anchor, cx)
@ -2851,9 +2911,8 @@ impl ConversationEditor {
let confirm_command = confirm_command.clone();
let command = command.clone();
move |row, _, _, _cx: &mut WindowContext| {
render_pending_slash_command_toggle(
render_pending_slash_command_gutter_decoration(
row,
command.tooltip_text.clone(),
command.status.clone(),
confirm_command.clone(),
)
@ -3680,14 +3739,13 @@ fn render_slash_command_output_toggle(
.into_any_element()
}
fn render_pending_slash_command_toggle(
fn render_pending_slash_command_gutter_decoration(
row: MultiBufferRow,
tooltip_text: SharedString,
status: PendingSlashCommandStatus,
confirm_command: Arc<dyn Fn(&mut WindowContext)>,
) -> AnyElement {
let mut icon = IconButton::new(
("slash-command-output-fold-indicator", row.0),
("slash-command-gutter-decoration", row.0),
ui::IconName::TriangleRight,
)
.on_click(move |_e, cx| confirm_command(cx))
@ -3696,14 +3754,10 @@ fn render_pending_slash_command_toggle(
match status {
PendingSlashCommandStatus::Idle => {
icon = icon
.icon_color(Color::Muted)
.tooltip(move |cx| Tooltip::text(tooltip_text.clone(), cx));
icon = icon.icon_color(Color::Muted);
}
PendingSlashCommandStatus::Running { .. } => {
icon = icon
.selected(true)
.tooltip(move |cx| Tooltip::text(tooltip_text.clone(), cx));
icon = icon.selected(true);
}
PendingSlashCommandStatus::Error(error) => {
icon = icon
@ -4126,10 +4180,11 @@ mod tests {
let prompt_library = Arc::new(PromptLibrary::default());
let slash_command_registry = SlashCommandRegistry::new();
slash_command_registry.register_command(file_command::FileSlashCommand);
slash_command_registry.register_command(prompt_command::PromptSlashCommand::new(
prompt_library.clone(),
));
slash_command_registry.register_command(file_command::FileSlashCommand, false);
slash_command_registry.register_command(
prompt_command::PromptSlashCommand::new(prompt_library.clone()),
false,
);
let registry = Arc::new(LanguageRegistry::test(cx.executor()));
let conversation = cx

4
crates/assistant/src/slash_command/active_command.rs
View file

@ -19,8 +19,8 @@ impl SlashCommand for ActiveSlashCommand {
"insert active tab".into()
}
fn tooltip_text(&self) -> String {
"insert active tab".into()
fn menu_text(&self) -> String {
"Insert Active Tab".into()
}
fn complete_argument(

6
crates/assistant/src/slash_command/file_command.rs
View file

@ -86,11 +86,11 @@ impl SlashCommand for FileSlashCommand {
}
fn description(&self) -> String {
"insert a file".into()
"insert file".into()
}
fn tooltip_text(&self) -> String {
"insert file".into()
fn menu_text(&self) -> String {
"Insert File".into()
}
fn requires_argument(&self) -> bool {

6
crates/assistant/src/slash_command/project_command.rs
View file

@ -94,11 +94,11 @@ impl SlashCommand for ProjectSlashCommand {
}
fn description(&self) -> String {
"insert current project context".into()
"insert project metadata".into()
}
fn tooltip_text(&self) -> String {
"insert current project context".into()
fn menu_text(&self) -> String {
"Insert Project Metadata".into()
}
fn complete_argument(

6
crates/assistant/src/slash_command/prompt_command.rs
View file

@ -25,11 +25,11 @@ impl SlashCommand for PromptSlashCommand {
}
fn description(&self) -> String {
"insert a prompt from the library".into()
"insert prompt from library".into()
}
fn tooltip_text(&self) -> String {
"insert prompt".into()
fn menu_text(&self) -> String {
"Insert Prompt from Library".into()
}
fn requires_argument(&self) -> bool {

6
crates/assistant/src/slash_command/rustdoc_command.rs
View file

@ -51,11 +51,11 @@ impl SlashCommand for RustdocSlashCommand {
}
fn description(&self) -> String {
"insert the docs for a Rust crate".into()
"insert Rust docs".into()
}
fn tooltip_text(&self) -> String {
"insert rustdoc".into()
fn menu_text(&self) -> String {
"Insert Rust Documentation".into()
}
fn requires_argument(&self) -> bool {

6
crates/assistant/src/slash_command/search_command.rs
View file

@ -32,11 +32,11 @@ impl SlashCommand for SearchSlashCommand {
}
fn description(&self) -> String {
"semantically search files".into()
"semantic search".into()
}
fn tooltip_text(&self) -> String {
"search".into()
fn menu_text(&self) -> String {
"Semantic Search".into()
}
fn requires_argument(&self) -> bool {

6
crates/assistant/src/slash_command/tabs_command.rs
View file

@ -17,11 +17,11 @@ impl SlashCommand for TabsSlashCommand {
}
fn description(&self) -> String {
"insert content from open tabs".into()
"insert open tabs".into()
}
fn tooltip_text(&self) -> String {
"insert open tabs".into()
fn menu_text(&self) -> String {
"Insert Open Tabs".into()
}
fn requires_argument(&self) -> bool {

2
crates/assistant_slash_command/src/assistant_slash_command.rs
View file

@ -20,7 +20,7 @@ pub trait SlashCommand: 'static + Send + Sync {
CodeLabel::plain(self.name(), None)
}
fn description(&self) -> String;
fn tooltip_text(&self) -> String;
fn menu_text(&self) -> String;
fn complete_argument(
&self,
query: String,

26
crates/assistant_slash_command/src/slash_command_registry.rs
View file

@ -1,6 +1,6 @@
use std::sync::Arc;
use collections::HashMap;
use collections::{BTreeSet, HashMap};
use derive_more::{Deref, DerefMut};
use gpui::Global;
use gpui::{AppContext, ReadGlobal};
@ -16,6 +16,7 @@ impl Global for GlobalSlashCommandRegistry {}
#[derive(Default)]
struct SlashCommandRegistryState {
commands: HashMap<Arc<str>, Arc<dyn SlashCommand>>,
featured_commands: BTreeSet<Arc<str>>,
}
#[derive(Default)]
@ -40,16 +41,19 @@ impl SlashCommandRegistry {
Arc::new(Self {
state: RwLock::new(SlashCommandRegistryState {
commands: HashMap::default(),
featured_commands: BTreeSet::default(),
}),
})
}
/// Registers the provided [`SlashCommand`].
pub fn register_command(&self, command: impl SlashCommand) {
self.state
.write()
.commands
.insert(command.name().into(), Arc::new(command));
pub fn register_command(&self, command: impl SlashCommand, is_featured: bool) {
let mut state = self.state.write();
let command_name: Arc<str> = command.name().into();
if is_featured {
state.featured_commands.insert(command_name.clone());
}
state.commands.insert(command_name, Arc::new(command));
}
/// Returns the names of registered [`SlashCommand`]s.
@ -57,6 +61,16 @@ impl SlashCommandRegistry {
self.state.read().commands.keys().cloned().collect()
}
/// Returns the names of registered, featured [`SlashCommand`]s.
pub fn featured_command_names(&self) -> Vec<Arc<str>> {
self.state
.read()
.featured_commands
.iter()
.cloned()
.collect()
}
/// Returns the [`SlashCommand`] with the given name.
pub fn command(&self, name: &str) -> Option<Arc<dyn SlashCommand>> {
self.state.read().commands.get(name).cloned()

2
crates/editor/src/actions.rs
View file

@ -41,7 +41,7 @@ pub struct MovePageDown {
#[derive(PartialEq, Clone, Deserialize, Default)]
pub struct MoveToEndOfLine {
#[serde(default = "default_true")]
pub(super) stop_at_soft_wraps: bool,
pub stop_at_soft_wraps: bool,
}
#[derive(PartialEq, Clone, Deserialize, Default)]

2
crates/editor/src/editor.rs
View file

@ -3761,7 +3761,7 @@ impl Editor {
}))
}
fn show_completions(&mut self, _: &ShowCompletions, cx: &mut ViewContext<Self>) {
pub fn show_completions(&mut self, _: &ShowCompletions, cx: &mut ViewContext<Self>) {
if self.pending_rename.is_some() {
return;
}

2
crates/extension/src/extension_slash_command.rs
View file

@ -27,7 +27,7 @@ impl SlashCommand for ExtensionSlashCommand {
self.command.description.clone()
}
fn tooltip_text(&self) -> String {
fn menu_text(&self) -> String {
self.command.tooltip_text.clone()
}

8
crates/extension/src/extension_store.rs
View file

@ -1178,8 +1178,8 @@ impl ExtensionStore {
}
for (slash_command_name, slash_command) in &manifest.slash_commands {
this.slash_command_registry
.register_command(ExtensionSlashCommand {
this.slash_command_registry.register_command(
ExtensionSlashCommand {
command: crate::wit::SlashCommand {
name: slash_command_name.to_string(),
description: slash_command.description.to_string(),
@ -1188,7 +1188,9 @@ impl ExtensionStore {
},
extension: wasm_extension.clone(),
host: this.wasm_host.clone(),
});
},
false,
);
}
}
this.wasm_extensions.extend(wasm_extensions);

2
crates/ui/src/components/context_menu.rs
View file

@ -357,7 +357,7 @@ impl Render for ContextMenu {
.unwrap_or_else(|| {
KeyBinding::for_action(&**action, cx)
})
.map(|binding| div().ml_1().child(binding))
.map(|binding| div().ml_4().child(binding))
})),
)
.on_click(move |_, cx| {

3
crates/ui/src/components/keybinding.rs
View file

@ -77,13 +77,14 @@ impl RenderOnce for KeyBinding {
.join(" ")
)
})
.gap(rems(0.125))
.flex_none()
.children(self.key_binding.keystrokes().iter().map(|keystroke| {
let key_icon = Self::icon_for_key(keystroke);
h_flex()
.flex_none()
.p_0p5()
.py_0p5()
.rounded_sm()
.text_color(cx.theme().colors().text_muted)
.when(keystroke.modifiers.function, |el| {