mod extension_snippet; pub mod format; mod registry; use std::{ path::{Path, PathBuf}, sync::Arc, time::Duration, }; use anyhow::Result; use collections::{BTreeMap, BTreeSet, HashMap}; use format::VsSnippetsFile; use fs::Fs; use futures::stream::StreamExt; use gpui::{App, AppContext as _, AsyncApp, Context, Entity, Task, WeakEntity}; pub use registry::*; use util::ResultExt; pub fn init(cx: &mut App) { SnippetRegistry::init_global(cx); extension_snippet::init(cx); } // Is `None` if the snippet file is global. type SnippetKind = Option; fn file_stem_to_key(stem: &str) -> SnippetKind { if stem == "snippets" { None } else { Some(stem.to_owned()) } } fn file_to_snippets(file_contents: VsSnippetsFile) -> Vec> { let mut snippets = vec![]; for (name, snippet) in file_contents.snippets { let snippet_name = name.clone(); let prefixes = snippet .prefix .map_or_else(move || vec![snippet_name], |prefixes| prefixes.into()); let description = snippet .description .map(|description| description.to_string()); let body = snippet.body.to_string(); if snippet::Snippet::parse(&body).log_err().is_none() { continue; }; snippets.push(Arc::new(Snippet { body, prefix: prefixes, description, name, })); } snippets } // Snippet with all of the metadata #[derive(Debug)] pub struct Snippet { pub prefix: Vec, pub body: String, pub description: Option, pub name: String, } async fn process_updates( this: WeakEntity, entries: Vec, mut cx: AsyncApp, ) -> Result<()> { let fs = this.read_with(&cx, |this, _| this.fs.clone())?; for entry_path in entries { if !entry_path .extension() .map_or(false, |extension| extension == "json") { continue; } let entry_metadata = fs.metadata(&entry_path).await; // Entry could have been removed, in which case we should no longer show completions for it. let entry_exists = entry_metadata.is_ok(); if entry_metadata.map_or(false, |entry| entry.map_or(false, |e| e.is_dir)) { // Don't process dirs. continue; } let Some(stem) = entry_path.file_stem().and_then(|s| s.to_str()) else { continue; }; let key = file_stem_to_key(stem); let contents = if entry_exists { fs.load(&entry_path).await.ok() } else { None }; this.update(&mut cx, move |this, _| { let snippets_of_kind = this.snippets.entry(key).or_default(); if entry_exists { let Some(file_contents) = contents else { return; }; let Ok(as_json) = serde_json_lenient::from_str::(&file_contents) else { return; }; let snippets = file_to_snippets(as_json); *snippets_of_kind.entry(entry_path).or_default() = snippets; } else { snippets_of_kind.remove(&entry_path); } })?; } Ok(()) } async fn initial_scan( this: WeakEntity, path: Arc, cx: AsyncApp, ) -> Result<()> { let fs = this.read_with(&cx, |this, _| this.fs.clone())?; let entries = fs.read_dir(&path).await; if let Ok(entries) = entries { let entries = entries .collect::>() .await .into_iter() .collect::>>()?; process_updates(this, entries, cx).await?; } Ok(()) } pub struct SnippetProvider { fs: Arc, snippets: HashMap>>>, watch_tasks: Vec>>, } // Watches global snippet directory, is created just once and reused across multiple projects struct GlobalSnippetWatcher(Entity); impl GlobalSnippetWatcher { fn new(fs: Arc, cx: &mut App) -> Self { let global_snippets_dir = paths::snippets_dir(); let provider = cx.new(|_cx| SnippetProvider { fs, snippets: Default::default(), watch_tasks: vec![], }); provider.update(cx, |this, cx| this.watch_directory(global_snippets_dir, cx)); Self(provider) } } impl gpui::Global for GlobalSnippetWatcher {} impl SnippetProvider { pub fn new(fs: Arc, dirs_to_watch: BTreeSet, cx: &mut App) -> Entity { cx.new(move |cx| { if !cx.has_global::() { let global_watcher = GlobalSnippetWatcher::new(fs.clone(), cx); cx.set_global(global_watcher); } let mut this = Self { fs, watch_tasks: Vec::new(), snippets: Default::default(), }; for dir in dirs_to_watch { this.watch_directory(&dir, cx); } this }) } /// Add directory to be watched for content changes fn watch_directory(&mut self, path: &Path, cx: &Context) { let path: Arc = Arc::from(path); self.watch_tasks.push(cx.spawn(async move |this, cx| { let fs = this.read_with(cx, |this, _| this.fs.clone())?; let watched_path = path.clone(); let watcher = fs.watch(&watched_path, Duration::from_secs(1)); initial_scan(this.clone(), path, cx.clone()).await?; let (mut entries, _) = watcher.await; while let Some(entries) = entries.next().await { process_updates( this.clone(), entries.into_iter().map(|event| event.path).collect(), cx.clone(), ) .await?; } Ok(()) })); } fn lookup_snippets<'a, const LOOKUP_GLOBALS: bool>( &'a self, language: &'a SnippetKind, cx: &App, ) -> Vec> { let mut user_snippets: Vec<_> = self .snippets .get(language) .cloned() .unwrap_or_default() .into_iter() .flat_map(|(_, snippets)| snippets.into_iter()) .collect(); if LOOKUP_GLOBALS { if let Some(global_watcher) = cx.try_global::() { user_snippets.extend( global_watcher .0 .read(cx) .lookup_snippets::(language, cx), ); } let Some(registry) = SnippetRegistry::try_global(cx) else { return user_snippets; }; let registry_snippets = registry.get_snippets(language); user_snippets.extend(registry_snippets); } user_snippets } pub fn snippets_for(&self, language: SnippetKind, cx: &App) -> Vec> { let mut requested_snippets = self.lookup_snippets::(&language, cx); if language.is_some() { // Look up global snippets as well. requested_snippets.extend(self.lookup_snippets::(&None, cx)); } requested_snippets } } #[cfg(test)] mod tests { use super::*; use fs::FakeFs; use gpui; use gpui::TestAppContext; use indoc::indoc; #[gpui::test] fn test_lookup_snippets_dup_registry_snippets(cx: &mut TestAppContext) { let fs = FakeFs::new(cx.background_executor.clone()); cx.update(|cx| { SnippetRegistry::init_global(cx); SnippetRegistry::global(cx) .register_snippets( "ruby".as_ref(), indoc! {r#" { "Log to console": { "prefix": "log", "body": ["console.info(\"Hello, ${1:World}!\")", "$0"], "description": "Logs to console" } } "#}, ) .unwrap(); let provider = SnippetProvider::new(fs.clone(), Default::default(), cx); cx.update_entity(&provider, |provider, cx| { assert_eq!(1, provider.snippets_for(Some("ruby".to_owned()), cx).len()); }); }); } }