Add completion_query_characters in language (#27175)

Closes #18581

Now characters for completing query and word characters, which are
responsible for selecting words by double clicking or navigating, are
different. This fixes a bunch of things:

For settings.json, this improves completions to treat the whole string
as a completion query, instead of just the last word. We now added
"space" as a completion query character without it being a word
character.

For keymap.json, this improves selecting part of an action as the ":"
character is only a completion character and not a word character. So,
completions would still trigger on ":" and query capture will treat ":"
as a word, but for actions like selections and navigation, ":" will be
treated as punctuation.

Before:
Unnecessary related suggestions as query is only the last word which is
"d".
<img width="300" alt="image"
src="https://github.com/user-attachments/assets/8199a715-7521-49dd-948b-e6aaed04c488"
/>

Double clicking `ToggleFold` selects the whole action:
<img width="300" alt="image"
src="https://github.com/user-attachments/assets/c7f91a6b-06d5-45b6-9d59-61a1b2deda71"
/>

After:
Now query is "one d" and it shows only matched ones.
<img width="300" alt="image"
src="https://github.com/user-attachments/assets/1455dfbc-9906-42e8-b8aa-b3f551194ca2"
/>

Double clicking `ToggleFold` only selects part of the action, which is
more refined behavior.
<img width="300" alt="image"
src="https://github.com/user-attachments/assets/34b1c3c2-184f-402f-9dc8-73030a8c370f"
/>

Release Notes:

- Improved autocomplete suggestions in `settings.json`, now whole string
is queried instead of just last word of string, which filters out lot of
false positives.
- Improved selection of action in `keymap.json`, where now you can
double click to only select certain part of action, instead of selecting
whole action.

---------

Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
Co-authored-by: Ben Kunkle <ben@zed.dev>
This commit is contained in:
Smit Barmase 2025-03-20 16:45:35 +05:30 committed by GitHub
parent 1180b6fbc7
commit 23e8519057
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 40 additions and 18 deletions

View file

@ -12871,7 +12871,7 @@ async fn test_completions_in_languages_with_extra_word_characters(cx: &mut TestA
overrides: [( overrides: [(
"element".into(), "element".into(),
LanguageConfigOverride { LanguageConfigOverride {
word_characters: Override::Set(['-'].into_iter().collect()), completion_query_characters: Override::Set(['-'].into_iter().collect()),
..Default::default() ..Default::default()
}, },
)] )]

View file

@ -264,7 +264,7 @@ impl EditorLspTestContext {
..Default::default() ..Default::default()
}, },
block_comment: Some(("<!-- ".into(), " -->".into())), block_comment: Some(("<!-- ".into(), " -->".into())),
word_characters: ['-'].into_iter().collect(), completion_query_characters: ['-'].into_iter().collect(),
..Default::default() ..Default::default()
}, },
Some(tree_sitter_html::LANGUAGE.into()), Some(tree_sitter_html::LANGUAGE.into()),

View file

@ -4727,23 +4727,27 @@ impl CharClassifier {
} }
pub fn kind_with(&self, c: char, ignore_punctuation: bool) -> CharKind { pub fn kind_with(&self, c: char, ignore_punctuation: bool) -> CharKind {
if c.is_whitespace() { if c.is_alphanumeric() || c == '_' {
return CharKind::Whitespace;
} else if c.is_alphanumeric() || c == '_' {
return CharKind::Word; return CharKind::Word;
} }
if let Some(scope) = &self.scope { if let Some(scope) = &self.scope {
if let Some(characters) = scope.word_characters() { let characters = if self.for_completion {
scope.completion_query_characters()
} else {
scope.word_characters()
};
if let Some(characters) = characters {
if characters.contains(&c) { if characters.contains(&c) {
if c == '-' && !self.for_completion && !ignore_punctuation {
return CharKind::Punctuation;
}
return CharKind::Word; return CharKind::Word;
} }
} }
} }
if c.is_whitespace() {
return CharKind::Whitespace;
}
if ignore_punctuation { if ignore_punctuation {
CharKind::Word CharKind::Word
} else { } else {

View file

@ -700,6 +700,9 @@ pub struct LanguageConfig {
/// If configured, this language contains JSX style tags, and should support auto-closing of those tags. /// If configured, this language contains JSX style tags, and should support auto-closing of those tags.
#[serde(default)] #[serde(default)]
pub jsx_tag_auto_close: Option<JsxTagAutoCloseConfig>, pub jsx_tag_auto_close: Option<JsxTagAutoCloseConfig>,
/// A list of characters that Zed should treat as word characters for completion queries.
#[serde(default)]
pub completion_query_characters: HashSet<char>,
} }
#[derive(Clone, Debug, Serialize, Deserialize, Default, JsonSchema)] #[derive(Clone, Debug, Serialize, Deserialize, Default, JsonSchema)]
@ -765,6 +768,8 @@ pub struct LanguageConfigOverride {
#[serde(default)] #[serde(default)]
pub word_characters: Override<HashSet<char>>, pub word_characters: Override<HashSet<char>>,
#[serde(default)] #[serde(default)]
pub completion_query_characters: Override<HashSet<char>>,
#[serde(default)]
pub opt_into_language_servers: Vec<LanguageServerName>, pub opt_into_language_servers: Vec<LanguageServerName>,
} }
@ -816,6 +821,7 @@ impl Default for LanguageConfig {
prettier_parser_name: None, prettier_parser_name: None,
hidden: false, hidden: false,
jsx_tag_auto_close: None, jsx_tag_auto_close: None,
completion_query_characters: Default::default(),
} }
} }
} }
@ -1705,6 +1711,16 @@ impl LanguageScope {
) )
} }
/// Returns a list of language-specific characters that are considered part of
/// a completion query.
pub fn completion_query_characters(&self) -> Option<&HashSet<char>> {
Override::as_option(
self.config_override()
.map(|o| &o.completion_query_characters),
Some(&self.language.config.completion_query_characters),
)
}
/// Returns a list of bracket pairs for a given language with an additional /// Returns a list of bracket pairs for a given language with an additional
/// piece of information about whether the particular bracket pair is currently active for a given language. /// piece of information about whether the particular bracket pair is currently active for a given language.
pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> { pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {

View file

@ -9,6 +9,6 @@ brackets = [
{ start = "\"", end = "\"", close = true, newline = false, not_in = ["string", "comment"] }, { start = "\"", end = "\"", close = true, newline = false, not_in = ["string", "comment"] },
{ start = "'", end = "'", close = true, newline = false, not_in = ["string", "comment"] }, { start = "'", end = "'", close = true, newline = false, not_in = ["string", "comment"] },
] ]
word_characters = ["-"] completion_query_characters = ["-"]
block_comment = ["/* ", " */"] block_comment = ["/* ", " */"]
prettier_parser_name = "css" prettier_parser_name = "css"

View file

@ -32,5 +32,5 @@ block_comment = ["{/* ", " */}"]
opt_into_language_servers = ["emmet-language-server"] opt_into_language_servers = ["emmet-language-server"]
[overrides.string] [overrides.string]
word_characters = ["-"] completion_query_characters = ["-"]
opt_into_language_servers = ["tailwindcss-language-server"] opt_into_language_servers = ["tailwindcss-language-server"]

View file

@ -12,4 +12,4 @@ tab_size = 2
prettier_parser_name = "json" prettier_parser_name = "json"
[overrides.string] [overrides.string]
word_characters = [":"] completion_query_characters = [":", " "]

View file

@ -12,4 +12,4 @@ tab_size = 2
prettier_parser_name = "jsonc" prettier_parser_name = "jsonc"
[overrides.string] [overrides.string]
word_characters = [":"] completion_query_characters = [":", " "]

View file

@ -1,7 +1,7 @@
name = "Markdown" name = "Markdown"
grammar = "markdown" grammar = "markdown"
path_suffixes = ["md", "mdx", "mdwn", "markdown", "MD"] path_suffixes = ["md", "mdx", "mdwn", "markdown", "MD"]
word_characters = ["-"] completion_query_characters = ["-"]
block_comment = ["<!-- ", " -->"] block_comment = ["<!-- ", " -->"]
autoclose_before = "}])>" autoclose_before = "}])>"
brackets = [ brackets = [

View file

@ -30,5 +30,5 @@ block_comment = ["{/* ", " */}"]
opt_into_language_servers = ["emmet-language-server"] opt_into_language_servers = ["emmet-language-server"]
[overrides.string] [overrides.string]
word_characters = ["-"] completion_query_characters = ["-"]
opt_into_language_servers = ["tailwindcss-language-server"] opt_into_language_servers = ["tailwindcss-language-server"]

View file

@ -223,7 +223,9 @@ Note that we couldn't use JSON as an example here because it doesn't support lan
The `overrides.scm` file defines syntactic _scopes_ that can be used to override certain editor settings within specific language constructs. The `overrides.scm` file defines syntactic _scopes_ that can be used to override certain editor settings within specific language constructs.
For example, there is a language-specific setting called `word_characters` that controls which non-alphabetic characters are considered part of a word, for filtering autocomplete suggestions. In JavaScript, "$" and "#" are considered word characters. But when your cursor is within a _string_ in JavaScript, "-" is _also_ considered a word character. To achieve this, the JavaScript `overrides.scm` file contains the following pattern: For example, there is a language-specific setting called `word_characters` that controls which non-alphabetic characters are considered part of a word, for example when you double click to select a variable. In JavaScript, "$" and "#" are considered word characters.
There is also a language-specific setting called `completion_query_characters` that controls which characters trigger autocomplete suggestions. In JavaScript, when your cursor is within a _string_, "-" is should be considered a completion query character. To achieve this, the JavaScript `overrides.scm` file contains the following pattern:
```scheme ```scheme
[ [
@ -238,7 +240,7 @@ And the JavaScript `config.toml` contains this setting:
word_characters = ["#", "$"] word_characters = ["#", "$"]
[overrides.string] [overrides.string]
word_characters = ["-"] completion_query_characters = ["-"]
``` ```
You can also disable certain auto-closing brackets in a specific scope. For example, to prevent auto-closing `'` within strings, you could put the following in the JavaScript `config.toml`: You can also disable certain auto-closing brackets in a specific scope. For example, to prevent auto-closing `'` within strings, you could put the following in the JavaScript `config.toml`:

View file

@ -11,5 +11,5 @@ brackets = [
{ start = "<", end = ">", close = false, newline = true, not_in = ["comment", "string"] }, { start = "<", end = ">", close = false, newline = true, not_in = ["comment", "string"] },
{ start = "!--", end = " --", close = true, newline = false, not_in = ["comment", "string"] }, { start = "!--", end = " --", close = true, newline = false, not_in = ["comment", "string"] },
] ]
word_characters = ["-"] completion_query_characters = ["-"]
prettier_parser_name = "html" prettier_parser_name = "html"