Skip to content

Commit

Permalink
Merge pull request #18939 from Veykril/push-wztmylkyqttu
Browse files Browse the repository at this point in the history
Flip on typing config to be opt-in, better defaults
  • Loading branch information
Veykril authored Jan 15, 2025
2 parents 9384cee + 557c467 commit 96f8bc8
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 32 deletions.
2 changes: 1 addition & 1 deletion crates/hir/src/semantics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1756,7 +1756,7 @@ impl<'db> SemanticsImpl<'db> {
let file_id = self.lookup(&root_node).unwrap_or_else(|| {
panic!(
"\n\nFailed to lookup {:?} in this Semantics.\n\
Make sure to use only query nodes, derived from this instance of Semantics.\n\
Make sure to only query nodes derived from this instance of Semantics.\n\
root node: {:?}\n\
known nodes: {}\n\n",
node,
Expand Down
11 changes: 8 additions & 3 deletions crates/ide-db/src/search.rs
Original file line number Diff line number Diff line change
Expand Up @@ -953,14 +953,19 @@ impl<'a> FindUsages<'a> {

// Search for occurrences of the items name
for offset in Self::match_indices(&text, finder, search_range) {
tree.token_at_offset(offset).for_each(|token| {
let Some(str_token) = ast::String::cast(token.clone()) else { return };
let ret = tree.token_at_offset(offset).any(|token| {
let Some(str_token) = ast::String::cast(token.clone()) else { return false };
if let Some((range, Some(nameres))) =
sema.check_for_format_args_template(token, offset)
{
if self.found_format_args_ref(file_id, range, str_token, nameres, sink) {}
return self
.found_format_args_ref(file_id, range, str_token, nameres, sink);
}
false
});
if ret {
return;
}

for name in
Self::find_nodes(sema, name, &tree, offset).filter_map(ast::NameLike::cast)
Expand Down
6 changes: 0 additions & 6 deletions crates/ide/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -404,17 +404,11 @@ impl Analysis {
&self,
position: FilePosition,
char_typed: char,
chars_to_exclude: Option<String>,
) -> Cancellable<Option<SourceChange>> {
// Fast path to not even parse the file.
if !typing::TRIGGER_CHARS.contains(char_typed) {
return Ok(None);
}
if let Some(chars_to_exclude) = chars_to_exclude {
if chars_to_exclude.contains(char_typed) {
return Ok(None);
}
}

self.with_db(|db| typing::on_char_typed(db, position, char_typed))
}
Expand Down
16 changes: 12 additions & 4 deletions crates/rust-analyzer/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -326,8 +326,16 @@ config_data! {
/// Show documentation.
signatureInfo_documentation_enable: bool = true,

/// Specify the characters to exclude from triggering typing assists. The default trigger characters are `.`, `=`, `<`, `>`, `{`, and `(`.
typing_excludeChars: Option<String> = Some("|<".to_owned()),
/// Specify the characters allowed to invoke special on typing triggers.
/// - typing `=` after `let` tries to smartly add `;` if `=` is followed by an existing expression
/// - typing `=` between two expressions adds `;` when in statement position
/// - typing `=` to turn an assignment into an equality comparison removes `;` when in expression position
/// - typing `.` in a chain method call auto-indents
/// - typing `{` or `(` in front of an expression inserts a closing `}` or `)` after the expression
/// - typing `{` in a use item adds a closing `}` in the right place
/// - typing `>` to complete a return type `->` will insert a whitespace after it
/// - typing `<` in a path or type position inserts a closing `>` after the path or type.
typing_triggerChars: Option<String> = Some("=.".to_owned()),


/// Enables automatic discovery of projects using [`DiscoverWorkspaceConfig::command`].
Expand Down Expand Up @@ -2251,8 +2259,8 @@ impl Config {
}
}

pub fn typing_exclude_chars(&self) -> Option<String> {
self.typing_excludeChars().clone()
pub fn typing_trigger_chars(&self) -> &str {
self.typing_triggerChars().as_deref().unwrap_or_default()
}

// VSCode is our reference implementation, so we allow ourselves to work around issues by
Expand Down
17 changes: 6 additions & 11 deletions crates/rust-analyzer/src/handlers/request.rs
Original file line number Diff line number Diff line change
Expand Up @@ -434,29 +434,24 @@ pub(crate) fn handle_on_type_formatting(
params: lsp_types::DocumentOnTypeFormattingParams,
) -> anyhow::Result<Option<Vec<lsp_ext::SnippetTextEdit>>> {
let _p = tracing::info_span!("handle_on_type_formatting").entered();
let char_typed = params.ch.chars().next().unwrap_or('\0');
if !snap.config.typing_trigger_chars().contains(char_typed) {
return Ok(None);
}

let mut position = from_proto::file_position(&snap, params.text_document_position)?;
let line_index = snap.file_line_index(position.file_id)?;

// in `ide`, the `on_type` invariant is that
// `text.char_at(position) == typed_char`.
position.offset -= TextSize::of('.');
let char_typed = params.ch.chars().next().unwrap_or('\0');

let text = snap.analysis.file_text(position.file_id)?;
if stdx::never!(!text[usize::from(position.offset)..].starts_with(char_typed)) {
return Ok(None);
}

// We have an assist that inserts ` ` after typing `->` in `fn foo() ->{`,
// but it requires precise cursor positioning to work, and one can't
// position the cursor with on_type formatting. So, let's just toggle this
// feature off here, hoping that we'll enable it one day, 😿.
if char_typed == '>' {
return Ok(None);
}
let chars_to_exclude = snap.config.typing_exclude_chars();

let edit = snap.analysis.on_char_typed(position, char_typed, chars_to_exclude)?;
let edit = snap.analysis.on_char_typed(position, char_typed)?;
let edit = match edit {
Some(it) => it,
None => return Ok(None),
Expand Down
16 changes: 12 additions & 4 deletions docs/user/generated_config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1051,10 +1051,18 @@ Show full signature of the callable. Only shows parameters if disabled.
--
Show documentation.
--
[[rust-analyzer.typing.excludeChars]]rust-analyzer.typing.excludeChars (default: `"|<"`)::
+
--
Specify the characters to exclude from triggering typing assists. The default trigger characters are `.`, `=`, `<`, `>`, `{`, and `(`.
[[rust-analyzer.typing.triggerChars]]rust-analyzer.typing.triggerChars (default: `"=."`)::
+
--
Specify the characters allowed to invoke special on typing triggers.
- typing `=` after `let` tries to smartly add `;` if `=` is followed by an existing expression
- typing `=` between two expressions adds `;` when in statement position
- typing `=` to turn an assignment into an equality comparison removes `;` when in expression position
- typing `.` in a chain method call auto-indents
- typing `{` or `(` in front of an expression inserts a closing `}` or `)` after the expression
- typing `{` in a use item adds a closing `}` in the right place
- typing `>` to complete a return type `->` will insert a whitespace after it
- typing `<` in a path or type position inserts a closing `>` after the path or type.
--
[[rust-analyzer.vfs.extraIncludes]]rust-analyzer.vfs.extraIncludes (default: `[]`)::
+
Expand Down
6 changes: 3 additions & 3 deletions editors/code/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2745,9 +2745,9 @@
{
"title": "typing",
"properties": {
"rust-analyzer.typing.excludeChars": {
"markdownDescription": "Specify the characters to exclude from triggering typing assists. The default trigger characters are `.`, `=`, `<`, `>`, `{`, and `(`.",
"default": "|<",
"rust-analyzer.typing.triggerChars": {
"markdownDescription": "Specify the characters allowed to invoke special on typing triggers.\n- typing `=` after `let` tries to smartly add `;` if `=` is followed by an existing expression\n- typing `=` between two expressions adds `;` when in statement position\n- typing `=` to turn an assignment into an equality comparison removes `;` when in expression position\n- typing `.` in a chain method call auto-indents\n- typing `{` or `(` in front of an expression inserts a closing `}` or `)` after the expression\n- typing `{` in a use item adds a closing `}` in the right place\n- typing `>` to complete a return type `->` will insert a whitespace after it\n- typing `<` in a path or type position inserts a closing `>` after the path or type.",
"default": "=.",
"type": [
"null",
"string"
Expand Down

0 comments on commit 96f8bc8

Please sign in to comment.