598: Add function signature to CompletionItem detail r=matklad a=kjeremy



Co-authored-by: Jeremy A. Kolb <jkolb@ara.com>
This commit is contained in:
bors[bot] 2019-01-23 07:27:09 +00:00
commit 488326ffa7
15 changed files with 92 additions and 31 deletions

View File

@ -1,7 +1,10 @@
use hir::PerNs;
use crate::completion::completion_context::CompletionContext;
use ra_syntax::TextRange;
use ra_syntax::{
ast::{self, AstNode},
TextRange
};
use ra_text_edit::TextEdit;
/// `CompletionItem` describes a single completion variant in the editor pop-up.
@ -263,6 +266,10 @@ impl Builder {
self.documentation = Some(docs);
}
if let Some(label) = function_label(ctx, function) {
self.detail = Some(label);
}
self.kind = Some(CompletionItemKind::Function);
self
}
@ -299,6 +306,26 @@ impl Into<Vec<CompletionItem>> for Completions {
}
}
fn function_label(ctx: &CompletionContext, function: hir::Function) -> Option<String> {
let node = function.source(ctx.db).1;
let label: String = if let Some(body) = node.body() {
let body_range = body.syntax().range();
let label: String = node
.syntax()
.children()
.filter(|child| !child.range().is_subrange(&body_range)) // Filter out body
.filter(|child| ast::Comment::cast(child).is_none()) // Filter out comments
.map(|node| node.text().to_string())
.collect();
label
} else {
node.syntax().text().to_string()
};
Some(label.trim().to_owned())
}
#[cfg(test)]
pub(crate) fn check_completion(test_name: &str, code: &str, kind: CompletionKind) {
use crate::mock_analysis::{single_file_with_position, analysis_and_position};

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.858540400+00:00"
created: "2019-01-22T15:38:19.841148300+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -25,7 +25,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn quux()"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.860535200+00:00"
created: "2019-01-22T15:38:19.863089100+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -39,7 +39,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn quux()"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.871506600+00:00"
created: "2019-01-22T15:38:19.881041600+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -39,7 +39,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn quux(x: i32)"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.797704900+00:00"
created: "2019-01-22T15:38:19.788294+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn main()"
),
documentation: None,
lookup: None,
insert_text: None,
@ -25,7 +27,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn frobnicate()"
),
documentation: None,
lookup: None,
insert_text: None,

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.801693300+00:00"
created: "2019-01-22T15:38:19.815217100+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"pub fn foo()"
),
documentation: None,
lookup: None,
insert_text: None,

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.912397100+00:00"
created: "2019-01-22T15:38:19.914951100+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -25,7 +25,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn foo() ->"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.932343200+00:00"
created: "2019-01-22T15:38:19.919937+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn no_args()"
),
documentation: None,
lookup: None,
insert_text: Some(
@ -27,7 +29,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn main()"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.995180+00:00"
created: "2019-01-22T15:38:19.996733+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn main()"
),
documentation: None,
lookup: None,
insert_text: Some(
@ -27,7 +29,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn with_args(x: i32, y: String)"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.546394900+00:00"
created: "2019-01-22T15:38:19.541947400+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Method
),
detail: None,
detail: Some(
"fn the_method(&self)"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.874497400+00:00"
created: "2019-01-22T15:38:19.896999400+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn quux()"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.875495300+00:00"
created: "2019-01-22T15:38:19.896002200+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -11,7 +11,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn quux()"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -25,7 +25,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Function
),
detail: None,
detail: Some(
"fn x() ->"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.552379600+00:00"
created: "2019-01-22T15:38:19.541947400+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -27,7 +27,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Method
),
detail: None,
detail: Some(
"fn foo(&self)"
),
documentation: None,
lookup: None,
insert_text: Some(

View File

@ -1,5 +1,5 @@
---
created: "2019-01-22T14:45:00.552379600+00:00"
created: "2019-01-22T15:38:19.541947400+00:00"
creator: insta@0.4.0
expression: kind_completions
source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
@ -27,7 +27,9 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
kind: Some(
Method
),
detail: None,
detail: Some(
"fn foo(self)"
),
documentation: None,
lookup: None,
insert_text: Some(