snippets: Add icons and file names to snippet scope selector (#30212)

I added the language icons to the snippet scope selector so that it
matches the language selector.

The file names are displayed for each scope where there is a existing
snippets file since it wasn't clear if a scope had a file already or
not.

| Before | After |
| - | - |
|
![before](https://github.com/user-attachments/assets/89f62889-d4a9-4681-999a-00c00f7bec3b)|
![after](https://github.com/user-attachments/assets/2d64f04c-ef8f-40f5-aedd-eca239c960e9)
|


Release Notes:

- Added language icons and file names to snippet scope selector

---------

Co-authored-by: Kirill Bulatov <kirill@zed.dev>
This commit is contained in:
loczek 2025-05-26 15:44:09 +02:00 committed by GitHub
parent 2a973109d4
commit d4926626d8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 134 additions and 21 deletions

3
Cargo.lock generated
View file

@ -14675,11 +14675,14 @@ dependencies = [
name = "snippets_ui" name = "snippets_ui"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"file_finder",
"file_icons",
"fuzzy", "fuzzy",
"gpui", "gpui",
"language", "language",
"paths", "paths",
"picker", "picker",
"settings",
"ui", "ui",
"util", "util",
"workspace", "workspace",

View file

@ -1023,7 +1023,7 @@ impl Project {
let (tx, rx) = mpsc::unbounded(); let (tx, rx) = mpsc::unbounded();
cx.spawn(async move |this, cx| Self::send_buffer_ordered_messages(this, rx, cx).await) cx.spawn(async move |this, cx| Self::send_buffer_ordered_messages(this, rx, cx).await)
.detach(); .detach();
let global_snippets_dir = paths::config_dir().join("snippets"); let global_snippets_dir = paths::snippets_dir().to_owned();
let snippets = let snippets =
SnippetProvider::new(fs.clone(), BTreeSet::from_iter([global_snippets_dir]), cx); SnippetProvider::new(fs.clone(), BTreeSet::from_iter([global_snippets_dir]), cx);

View file

@ -144,15 +144,13 @@ struct GlobalSnippetWatcher(Entity<SnippetProvider>);
impl GlobalSnippetWatcher { impl GlobalSnippetWatcher {
fn new(fs: Arc<dyn Fs>, cx: &mut App) -> Self { fn new(fs: Arc<dyn Fs>, cx: &mut App) -> Self {
let global_snippets_dir = paths::config_dir().join("snippets"); let global_snippets_dir = paths::snippets_dir();
let provider = cx.new(|_cx| SnippetProvider { let provider = cx.new(|_cx| SnippetProvider {
fs, fs,
snippets: Default::default(), snippets: Default::default(),
watch_tasks: vec![], watch_tasks: vec![],
}); });
provider.update(cx, |this, cx| { provider.update(cx, |this, cx| this.watch_directory(global_snippets_dir, cx));
this.watch_directory(&global_snippets_dir, cx)
});
Self(provider) Self(provider)
} }
} }

View file

@ -12,12 +12,15 @@ workspace = true
path = "src/snippets_ui.rs" path = "src/snippets_ui.rs"
[dependencies] [dependencies]
file_finder.workspace = true
file_icons.workspace = true
fuzzy.workspace = true fuzzy.workspace = true
gpui.workspace = true gpui.workspace = true
language.workspace = true language.workspace = true
paths.workspace = true paths.workspace = true
picker.workspace = true picker.workspace = true
settings.workspace = true
ui.workspace = true ui.workspace = true
util.workspace = true util.workspace = true
workspace.workspace = true
workspace-hack.workspace = true workspace-hack.workspace = true
workspace.workspace = true

View file

@ -1,16 +1,59 @@
use file_finder::file_finder_settings::FileFinderSettings;
use file_icons::FileIcons;
use fuzzy::{StringMatch, StringMatchCandidate, match_strings}; use fuzzy::{StringMatch, StringMatchCandidate, match_strings};
use gpui::{ use gpui::{
App, Context, DismissEvent, Entity, EventEmitter, Focusable, ParentElement, Render, Styled, App, Context, DismissEvent, Entity, EventEmitter, Focusable, ParentElement, Render, Styled,
WeakEntity, Window, actions, WeakEntity, Window, actions,
}; };
use language::LanguageRegistry; use language::{LanguageMatcher, LanguageName, LanguageRegistry};
use paths::config_dir; use paths::snippets_dir;
use picker::{Picker, PickerDelegate}; use picker::{Picker, PickerDelegate};
use std::{borrow::Borrow, fs, sync::Arc}; use settings::Settings;
use std::{
borrow::{Borrow, Cow},
collections::HashSet,
fs,
path::Path,
sync::Arc,
};
use ui::{HighlightedLabel, ListItem, ListItemSpacing, prelude::*}; use ui::{HighlightedLabel, ListItem, ListItemSpacing, prelude::*};
use util::ResultExt; use util::ResultExt;
use workspace::{ModalView, OpenOptions, OpenVisible, Workspace, notifications::NotifyResultExt}; use workspace::{ModalView, OpenOptions, OpenVisible, Workspace, notifications::NotifyResultExt};
#[derive(Eq, Hash, PartialEq)]
struct ScopeName(Cow<'static, str>);
struct ScopeFileName(Cow<'static, str>);
impl ScopeFileName {
fn with_extension(self) -> String {
format!("{}.json", self.0)
}
}
const GLOBAL_SCOPE_NAME: &str = "global";
const GLOBAL_SCOPE_FILE_NAME: &str = "snippets";
impl From<ScopeName> for ScopeFileName {
fn from(value: ScopeName) -> Self {
if value.0 == GLOBAL_SCOPE_NAME {
ScopeFileName(Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME))
} else {
ScopeFileName(value.0)
}
}
}
impl From<ScopeFileName> for ScopeName {
fn from(value: ScopeFileName) -> Self {
if value.0 == GLOBAL_SCOPE_FILE_NAME {
ScopeName(Cow::Borrowed(GLOBAL_SCOPE_NAME))
} else {
ScopeName(value.0)
}
}
}
actions!(snippets, [ConfigureSnippets, OpenFolder]); actions!(snippets, [ConfigureSnippets, OpenFolder]);
pub fn init(cx: &mut App) { pub fn init(cx: &mut App) {
@ -42,8 +85,8 @@ fn open_folder(
_: &mut Window, _: &mut Window,
cx: &mut Context<Workspace>, cx: &mut Context<Workspace>,
) { ) {
fs::create_dir_all(config_dir().join("snippets")).notify_err(workspace, cx); fs::create_dir_all(snippets_dir()).notify_err(workspace, cx);
cx.open_with_system(config_dir().join("snippets").borrow()); cx.open_with_system(snippets_dir().borrow());
} }
pub struct ScopeSelector { pub struct ScopeSelector {
@ -89,6 +132,7 @@ pub struct ScopeSelectorDelegate {
candidates: Vec<StringMatchCandidate>, candidates: Vec<StringMatchCandidate>,
matches: Vec<StringMatch>, matches: Vec<StringMatch>,
selected_index: usize, selected_index: usize,
existing_scopes: HashSet<ScopeName>,
} }
impl ScopeSelectorDelegate { impl ScopeSelectorDelegate {
@ -97,7 +141,7 @@ impl ScopeSelectorDelegate {
scope_selector: WeakEntity<ScopeSelector>, scope_selector: WeakEntity<ScopeSelector>,
language_registry: Arc<LanguageRegistry>, language_registry: Arc<LanguageRegistry>,
) -> Self { ) -> Self {
let candidates = Vec::from(["Global".to_string()]).into_iter(); let candidates = Vec::from([GLOBAL_SCOPE_NAME.to_string()]).into_iter();
let languages = language_registry.language_names().into_iter(); let languages = language_registry.language_names().into_iter();
let candidates = candidates let candidates = candidates
@ -106,15 +150,44 @@ impl ScopeSelectorDelegate {
.map(|(candidate_id, name)| StringMatchCandidate::new(candidate_id, &name)) .map(|(candidate_id, name)| StringMatchCandidate::new(candidate_id, &name))
.collect::<Vec<_>>(); .collect::<Vec<_>>();
let mut existing_scopes = HashSet::new();
if let Some(read_dir) = fs::read_dir(snippets_dir()).log_err() {
for entry in read_dir {
if let Some(entry) = entry.log_err() {
let path = entry.path();
if let (Some(stem), Some(extension)) = (path.file_stem(), path.extension()) {
if extension.to_os_string().to_str() == Some("json") {
if let Ok(file_name) = stem.to_os_string().into_string() {
existing_scopes
.insert(ScopeName::from(ScopeFileName(Cow::Owned(file_name))));
}
}
}
}
}
}
Self { Self {
workspace, workspace,
scope_selector, scope_selector,
language_registry, language_registry,
candidates, candidates,
matches: vec![], matches: Vec::new(),
selected_index: 0, selected_index: 0,
existing_scopes,
} }
} }
fn scope_icon(&self, matcher: &LanguageMatcher, cx: &App) -> Option<Icon> {
matcher
.path_suffixes
.iter()
.find_map(|extension| FileIcons::get_icon(Path::new(extension), cx))
.or(FileIcons::get(cx).get_icon_for_type("default", cx))
.map(Icon::from_path)
.map(|icon| icon.color(Color::Muted))
}
} }
impl PickerDelegate for ScopeSelectorDelegate { impl PickerDelegate for ScopeSelectorDelegate {
@ -135,15 +208,15 @@ impl PickerDelegate for ScopeSelectorDelegate {
if let Some(workspace) = self.workspace.upgrade() { if let Some(workspace) = self.workspace.upgrade() {
cx.spawn_in(window, async move |_, cx| { cx.spawn_in(window, async move |_, cx| {
let scope = match scope_name.as_str() { let scope_file_name = ScopeFileName(match scope_name.to_lowercase().as_str() {
"Global" => "snippets".to_string(), GLOBAL_SCOPE_NAME => Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME),
_ => language.await?.lsp_id(), _ => Cow::Owned(language.await?.lsp_id()),
}; });
workspace.update_in(cx, |workspace, window, cx| { workspace.update_in(cx, |workspace, window, cx| {
workspace workspace
.open_abs_path( .open_abs_path(
config_dir().join("snippets").join(scope + ".json"), snippets_dir().join(scope_file_name.with_extension()),
OpenOptions { OpenOptions {
visible: Some(OpenVisible::None), visible: Some(OpenVisible::None),
..Default::default() ..Default::default()
@ -228,17 +301,53 @@ impl PickerDelegate for ScopeSelectorDelegate {
ix: usize, ix: usize,
selected: bool, selected: bool,
_window: &mut Window, _window: &mut Window,
_: &mut Context<Picker<Self>>, cx: &mut Context<Picker<Self>>,
) -> Option<Self::ListItem> { ) -> Option<Self::ListItem> {
let mat = &self.matches[ix]; let mat = &self.matches[ix];
let label = mat.string.clone(); let name_label = mat.string.clone();
let scope_name = ScopeName(Cow::Owned(
LanguageName::new(&self.candidates[mat.candidate_id].string).lsp_id(),
));
let file_label = if self.existing_scopes.contains(&scope_name) {
Some(ScopeFileName::from(scope_name).with_extension())
} else {
None
};
let language_icon = if FileFinderSettings::get_global(cx).file_icons {
let language_name = LanguageName::new(mat.string.as_str());
self.language_registry
.available_language_for_name(language_name.as_ref())
.and_then(|available_language| self.scope_icon(available_language.matcher(), cx))
.or_else(|| {
Some(
Icon::from_path(IconName::Globe.path())
.map(|icon| icon.color(Color::Muted)),
)
})
} else {
None
};
Some( Some(
ListItem::new(ix) ListItem::new(ix)
.inset(true) .inset(true)
.spacing(ListItemSpacing::Sparse) .spacing(ListItemSpacing::Sparse)
.toggle_state(selected) .toggle_state(selected)
.child(HighlightedLabel::new(label, mat.positions.clone())), .start_slot::<Icon>(language_icon)
.child(
h_flex()
.gap_x_2()
.child(HighlightedLabel::new(name_label, mat.positions.clone()))
.when_some(file_label, |item, path_label| {
item.child(
Label::new(path_label)
.color(Color::Muted)
.size(LabelSize::Small),
)
}),
),
) )
} }
} }