Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
snippets: Strip path separators from language snippet file names (#61421)
Ibrahim Khanc3422b97a9e7
diff --git a/crates/editor/src/completions.rs b/crates/editor/src/completions.rsindex 8ad37dcfd63..e649c6dd623 100644--- a/crates/editor/src/completions.rs+++ b/crates/editor/src/completions.rs@@ -1140,7 +1140,7 @@ fn has_strong_snippet_prefix_match(languages.iter().any(|language| {snippet_store- .snippets_for(Some(language.lsp_id()), cx)+ .snippets_for(Some(language.snippet_scope_id()), cx).iter().flat_map(|snippet| snippet.prefix.iter()).flat_map(|prefix| snippet_candidate_suffixes(prefix, &is_word_char))@@ -1161,7 +1161,7 @@ fn snippet_completions(let scopes: Vec<_> = languages.iter().filter_map(|language| {- let language_name = language.lsp_id();+ let language_name = language.snippet_scope_id();let snippets = snippet_store.snippets_for(Some(language_name), cx);if snippets.is_empty() {diff --git a/crates/language/src/language.rs b/crates/language/src/language.rsindex 9a031347ec0..e88e6a4d1ef 100644--- a/crates/language/src/language.rs+++ b/crates/language/src/language.rs@@ -1165,6 +1165,10 @@ impl Language {self.config.name.lsp_id()}+ pub fn snippet_scope_id(&self) -> String {+ self.config.name.snippet_scope_id()+ }+pub fn prettier_parser_name(&self) -> Option<&str> {self.config.prettier_parser_name.as_deref()}diff --git a/crates/language_core/src/language_name.rs b/crates/language_core/src/language_name.rsindex 14528435d91..97ffa3166e5 100644--- a/crates/language_core/src/language_name.rs+++ b/crates/language_core/src/language_name.rs@@ -51,6 +51,16 @@ impl LanguageName {language_name => language_name.to_lowercase(),}}++ /// Identifier used to name and look up this language's snippet file.+ ///+ /// Path separators are stripped from the `lsp_id` because the snippet file+ /// is stored as a flat file directly under the snippets directory; a `/`+ /// (or `\`) would otherwise place it in a subdirectory that is never+ /// scanned, making the snippet impossible to use.+ pub fn snippet_scope_id(&self) -> String {+ self.lsp_id().replace(['/', '\\'], "")+ }}impl From<LanguageName> for SharedString {@@ -107,3 +117,26 @@ impl From<LanguageName> for String {Self::from(value)}}++#[cfg(test)]+mod tests {+ use super::*;++ #[test]+ fn snippet_scope_id_strips_path_separators() {+ // A `/` or `\` in the language name would route the snippet file into a+ // subdirectory that is never scanned (see issue #59620).+ assert_eq!(LanguageName::new("PL/X").snippet_scope_id(), "plx");+ assert_eq!(LanguageName::new("a\\b").snippet_scope_id(), "ab");+ // Names without separators are unchanged beyond `lsp_id`'s lowercasing.+ assert_eq!(LanguageName::new("Rust").snippet_scope_id(), "rust");+ assert_eq!(+ LanguageName::new("Shell Script").snippet_scope_id(),+ "shell script"+ );+ assert_eq!(+ LanguageName::new("Plain Text").snippet_scope_id(),+ "plaintext"+ );+ }+}diff --git a/crates/snippets_ui/src/snippets_ui.rs b/crates/snippets_ui/src/snippets_ui.rsindex 22d77bb71f1..5f5a26faa4a 100644--- a/crates/snippets_ui/src/snippets_ui.rs+++ b/crates/snippets_ui/src/snippets_ui.rs@@ -220,7 +220,7 @@ impl PickerDelegate for ScopeSelectorDelegate {cx.spawn_in(window, async move |_, cx| {let scope_file_name = ScopeFileName(match scope_name.to_lowercase().as_str() {GLOBAL_SCOPE_NAME => Cow::Borrowed(GLOBAL_SCOPE_FILE_NAME),- _ => Cow::Owned(language.await?.lsp_id()),+ _ => Cow::Owned(language.await?.snippet_scope_id()),});workspace.update_in(cx, |workspace, window, cx| {@@ -322,7 +322,7 @@ impl PickerDelegate for ScopeSelectorDelegate {let name_label = mat.string.clone();let scope_name = ScopeName(Cow::Owned(- LanguageName::new(&self.candidates[mat.candidate_id].string).lsp_id(),+ LanguageName::new(&self.candidates[mat.candidate_id].string).snippet_scope_id(),));let file_label = if self.existing_scopes.contains(&scope_name) {Some(ScopeFileName::from(scope_name).with_extension())diff --git a/docs/src/snippets.md b/docs/src/snippets.mdindex d0852052910..96f00700c7d 100644--- a/docs/src/snippets.md+++ b/docs/src/snippets.md@@ -39,6 +39,8 @@ The scope is determined by the language name in lowercase e.g. `python.json` forTo create JSX snippets you have to use `javascript.json` snippets file, instead of `jsx.json`, but this does not apply to TSX and TypeScript which follow the above rule.+Path separators (`/` and `\`) are removed from the file name, so a language named `PL/X` uses `plx.json`.+## Known Limitations- Only the first prefix is used when a list of prefixes is passed in.