Unnamed repository; edit this file 'description' to name the repository.
feat: Deprioritize completions of private but editable definitions
Lukas Wirth 2022-02-02
parent d7a544e · commit 5c41f5d
-rw-r--r--crates/ide_completion/src/completions.rs77
-rw-r--r--crates/ide_completion/src/completions/flyimport.rs2
-rw-r--r--crates/ide_completion/src/context.rs19
-rw-r--r--crates/ide_completion/src/item.rs28
-rw-r--r--crates/ide_completion/src/render.rs15
-rw-r--r--crates/ide_completion/src/render/const_.rs3
-rw-r--r--crates/ide_completion/src/render/enum_variant.rs12
-rw-r--r--crates/ide_completion/src/render/function.rs4
-rw-r--r--crates/ide_completion/src/render/macro_.rs5
-rw-r--r--crates/ide_completion/src/render/pattern.rs5
-rw-r--r--crates/ide_completion/src/render/struct_literal.rs5
-rw-r--r--crates/ide_completion/src/render/type_alias.rs3
12 files changed, 120 insertions, 58 deletions
diff --git a/crates/ide_completion/src/completions.rs b/crates/ide_completion/src/completions.rs
index a072d223e0..515200ef88 100644
--- a/crates/ide_completion/src/completions.rs
+++ b/crates/ide_completion/src/completions.rs
@@ -22,6 +22,7 @@ use hir::known;
use ide_db::SymbolKind;
use crate::{
+ context::Visible,
item::Builder,
render::{
const_::render_const,
@@ -91,7 +92,7 @@ impl Completions {
cov_mark::hit!(qualified_path_doc_hidden);
return;
}
- self.add(render_resolution(RenderContext::new(ctx), local_name, resolution));
+ self.add(render_resolution(RenderContext::new(ctx, false), local_name, resolution));
}
pub(crate) fn add_macro(
@@ -104,7 +105,7 @@ impl Completions {
Some(it) => it,
None => return,
};
- self.add(render_macro(RenderContext::new(ctx), None, name, macro_));
+ self.add(render_macro(RenderContext::new(ctx, false), None, name, macro_));
}
pub(crate) fn add_function(
@@ -113,10 +114,12 @@ impl Completions {
func: hir::Function,
local_name: Option<hir::Name>,
) {
- if !ctx.is_visible(&func) {
- return;
- }
- self.add(render_fn(RenderContext::new(ctx), None, local_name, func));
+ let is_private_editable = match ctx.is_visible(&func) {
+ Visible::Yes => false,
+ Visible::Editable => true,
+ Visible::No => return,
+ };
+ self.add(render_fn(RenderContext::new(ctx, is_private_editable), None, local_name, func));
}
pub(crate) fn add_method(
@@ -126,24 +129,36 @@ impl Completions {
receiver: Option<hir::Name>,
local_name: Option<hir::Name>,
) {
- if !ctx.is_visible(&func) {
- return;
- }
- self.add(render_method(RenderContext::new(ctx), None, receiver, local_name, func));
+ let is_private_editable = match ctx.is_visible(&func) {
+ Visible::Yes => false,
+ Visible::Editable => true,
+ Visible::No => return,
+ };
+ self.add(render_method(
+ RenderContext::new(ctx, is_private_editable),
+ None,
+ receiver,
+ local_name,
+ func,
+ ));
}
pub(crate) fn add_const(&mut self, ctx: &CompletionContext, konst: hir::Const) {
- if !ctx.is_visible(&konst) {
- return;
- }
- self.add_opt(render_const(RenderContext::new(ctx), konst));
+ let is_private_editable = match ctx.is_visible(&konst) {
+ Visible::Yes => false,
+ Visible::Editable => true,
+ Visible::No => return,
+ };
+ self.add_opt(render_const(RenderContext::new(ctx, is_private_editable), konst));
}
pub(crate) fn add_type_alias(&mut self, ctx: &CompletionContext, type_alias: hir::TypeAlias) {
- if !ctx.is_visible(&type_alias) {
- return;
- }
- self.add_opt(render_type_alias(RenderContext::new(ctx), type_alias));
+ let is_private_editable = match ctx.is_visible(&type_alias) {
+ Visible::Yes => false,
+ Visible::Editable => true,
+ Visible::No => return,
+ };
+ self.add_opt(render_type_alias(RenderContext::new(ctx, is_private_editable), type_alias));
}
pub(crate) fn add_type_alias_with_eq(
@@ -151,7 +166,7 @@ impl Completions {
ctx: &CompletionContext,
type_alias: hir::TypeAlias,
) {
- self.add_opt(render_type_alias_with_eq(RenderContext::new(ctx), type_alias));
+ self.add_opt(render_type_alias_with_eq(RenderContext::new(ctx, false), type_alias));
}
pub(crate) fn add_qualified_enum_variant(
@@ -160,7 +175,7 @@ impl Completions {
variant: hir::Variant,
path: hir::ModPath,
) {
- let item = render_variant(RenderContext::new(ctx), None, None, variant, Some(path));
+ let item = render_variant(RenderContext::new(ctx, false), None, None, variant, Some(path));
self.add(item);
}
@@ -170,7 +185,7 @@ impl Completions {
variant: hir::Variant,
local_name: Option<hir::Name>,
) {
- let item = render_variant(RenderContext::new(ctx), None, local_name, variant, None);
+ let item = render_variant(RenderContext::new(ctx, false), None, local_name, variant, None);
self.add(item);
}
@@ -181,10 +196,12 @@ impl Completions {
field: hir::Field,
ty: &hir::Type,
) {
- if !ctx.is_visible(&field) {
- return;
- }
- let item = render_field(RenderContext::new(ctx), receiver, field, ty);
+ let is_private_editable = match ctx.is_visible(&field) {
+ Visible::Yes => false,
+ Visible::Editable => true,
+ Visible::No => return,
+ };
+ let item = render_field(RenderContext::new(ctx, is_private_editable), receiver, field, ty);
self.add(item);
}
@@ -195,7 +212,7 @@ impl Completions {
path: Option<hir::ModPath>,
local_name: Option<hir::Name>,
) {
- let item = render_struct_literal(RenderContext::new(ctx), strukt, path, local_name);
+ let item = render_struct_literal(RenderContext::new(ctx, false), strukt, path, local_name);
self.add_opt(item);
}
@@ -206,7 +223,7 @@ impl Completions {
field: usize,
ty: &hir::Type,
) {
- let item = render_tuple_field(RenderContext::new(ctx), receiver, field, ty);
+ let item = render_tuple_field(RenderContext::new(ctx, false), receiver, field, ty);
self.add(item);
}
@@ -221,7 +238,7 @@ impl Completions {
variant: hir::Variant,
local_name: Option<hir::Name>,
) {
- self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, local_name, None));
+ self.add_opt(render_variant_pat(RenderContext::new(ctx, false), variant, local_name, None));
}
pub(crate) fn add_qualified_variant_pat(
@@ -230,7 +247,7 @@ impl Completions {
variant: hir::Variant,
path: hir::ModPath,
) {
- self.add_opt(render_variant_pat(RenderContext::new(ctx), variant, None, Some(path)));
+ self.add_opt(render_variant_pat(RenderContext::new(ctx, false), variant, None, Some(path)));
}
pub(crate) fn add_struct_pat(
@@ -239,7 +256,7 @@ impl Completions {
strukt: hir::Struct,
local_name: Option<hir::Name>,
) {
- self.add_opt(render_struct_pat(RenderContext::new(ctx), strukt, local_name));
+ self.add_opt(render_struct_pat(RenderContext::new(ctx, false), strukt, local_name));
}
}
diff --git a/crates/ide_completion/src/completions/flyimport.rs b/crates/ide_completion/src/completions/flyimport.rs
index 782a119c9e..8ca4634be2 100644
--- a/crates/ide_completion/src/completions/flyimport.rs
+++ b/crates/ide_completion/src/completions/flyimport.rs
@@ -193,7 +193,7 @@ pub(crate) fn import_on_the_fly(acc: &mut Completions, ctx: &CompletionContext)
})
.filter_map(|import| {
render_resolution_with_import(
- RenderContext::new(ctx),
+ RenderContext::new(ctx, false),
ImportEdit { import, scope: import_scope.clone() },
)
}),
diff --git a/crates/ide_completion/src/context.rs b/crates/ide_completion/src/context.rs
index a31a552dad..5adb0c856b 100644
--- a/crates/ide_completion/src/context.rs
+++ b/crates/ide_completion/src/context.rs
@@ -34,6 +34,11 @@ pub(crate) enum PatternRefutability {
Refutable,
Irrefutable,
}
+pub enum Visible {
+ Yes,
+ Editable,
+ No,
+}
#[derive(Copy, Clone, Debug)]
pub(super) enum PathKind {
@@ -285,7 +290,7 @@ impl<'a> CompletionContext<'a> {
}
/// Checks if an item is visible and not `doc(hidden)` at the completion site.
- pub(crate) fn is_visible<I>(&self, item: &I) -> bool
+ pub(crate) fn is_visible<I>(&self, item: &I) -> Visible
where
I: hir::HasVisibility + hir::HasAttrs + hir::HasCrate + Copy,
{
@@ -339,20 +344,24 @@ impl<'a> CompletionContext<'a> {
vis: &hir::Visibility,
attrs: &hir::Attrs,
defining_crate: hir::Crate,
- ) -> bool {
+ ) -> Visible {
let module = match self.module {
Some(it) => it,
- None => return false,
+ None => return Visible::No,
};
if !vis.is_visible_from(self.db, module.into()) {
// If the definition location is editable, also show private items
let root_file = defining_crate.root_file(self.db);
let source_root_id = self.db.file_source_root(root_file);
let is_editable = !self.db.source_root(source_root_id).is_library;
- return is_editable;
+ return if is_editable { Visible::Editable } else { Visible::No };
}
- !self.is_doc_hidden(attrs, defining_crate)
+ if self.is_doc_hidden(attrs, defining_crate) {
+ Visible::No
+ } else {
+ Visible::Yes
+ }
}
fn is_doc_hidden(&self, attrs: &hir::Attrs, defining_crate: hir::Crate) -> bool {
diff --git a/crates/ide_completion/src/item.rs b/crates/ide_completion/src/item.rs
index b2a0b04b4f..acaf17c255 100644
--- a/crates/ide_completion/src/item.rs
+++ b/crates/ide_completion/src/item.rs
@@ -141,6 +141,8 @@ pub struct CompletionRelevance {
pub is_local: bool,
/// Set for method completions of the `core::ops` and `core::cmp` family.
pub is_op_method: bool,
+ /// Set for item completions that are private but in the workspace.
+ pub is_private_editable: bool,
/// This is set in cases like these:
///
/// ```
@@ -177,7 +179,7 @@ pub enum CompletionRelevanceTypeMatch {
}
impl CompletionRelevance {
- const BASE_LINE: u32 = 1;
+ const BASE_LINE: u32 = 2;
/// Provides a relevance score. Higher values are more relevant.
///
/// The absolute value of the relevance score is not meaningful, for
@@ -190,6 +192,15 @@ impl CompletionRelevance {
pub fn score(&self) -> u32 {
let mut score = Self::BASE_LINE;
+ // score decreases
+ if self.is_op_method {
+ score -= 1;
+ }
+ if self.is_private_editable {
+ score -= 1;
+ }
+
+ // score increases
if self.exact_name_match {
score += 1;
}
@@ -201,9 +212,6 @@ impl CompletionRelevance {
if self.is_local {
score += 1;
}
- if self.is_op_method {
- score -= 1;
- }
if self.exact_postfix_snippet_match {
score += 100;
}
@@ -214,7 +222,7 @@ impl CompletionRelevance {
/// some threshold such that we think it is especially likely
/// to be relevant.
pub fn is_relevant(&self) -> bool {
- self.score() > (Self::BASE_LINE + 1)
+ self.score() > Self::BASE_LINE
}
}
@@ -564,7 +572,15 @@ mod tests {
// This test asserts that the relevance score for these items is ascending, and
// that any items in the same vec have the same score.
let expected_relevance_order = vec![
- vec![CompletionRelevance { is_op_method: true, ..CompletionRelevance::default() }],
+ vec![CompletionRelevance {
+ is_op_method: true,
+ is_private_editable: true,
+ ..CompletionRelevance::default()
+ }],
+ vec![
+ CompletionRelevance { is_private_editable: true, ..CompletionRelevance::default() },
+ CompletionRelevance { is_op_method: true, ..CompletionRelevance::default() },
+ ],
vec![CompletionRelevance::default()],
vec![
CompletionRelevance { exact_name_match: true, ..CompletionRelevance::default() },
diff --git a/crates/ide_completion/src/render.rs b/crates/ide_completion/src/render.rs
index 5feee48a96..6be2651123 100644
--- a/crates/ide_completion/src/render.rs
+++ b/crates/ide_completion/src/render.rs
@@ -28,11 +28,15 @@ use crate::{
#[derive(Debug)]
pub(crate) struct RenderContext<'a> {
completion: &'a CompletionContext<'a>,
+ is_private_editable: bool,
}
impl<'a> RenderContext<'a> {
- pub(crate) fn new(completion: &'a CompletionContext<'a>) -> RenderContext<'a> {
- RenderContext { completion }
+ pub(crate) fn new(
+ completion: &'a CompletionContext<'a>,
+ is_private_editable: bool,
+ ) -> RenderContext<'a> {
+ RenderContext { completion, is_private_editable }
}
fn snippet_cap(&self) -> Option<SnippetCap> {
@@ -47,6 +51,10 @@ impl<'a> RenderContext<'a> {
self.completion.source_range()
}
+ fn completion_relevance(&self) -> CompletionRelevance {
+ CompletionRelevance { is_private_editable: self.is_private_editable, ..Default::default() }
+ }
+
fn is_deprecated(&self, def: impl HasAttrs) -> bool {
let attrs = def.attrs(self.db());
attrs.by_key("deprecated").exists() || attrs.by_key("rustc_deprecated").exists()
@@ -582,6 +590,7 @@ fn main() { let _: m::Spam = S$0 }
),
is_local: false,
is_op_method: false,
+ is_private_editable: false,
exact_postfix_snippet_match: false,
},
trigger_call_info: true,
@@ -603,6 +612,7 @@ fn main() { let _: m::Spam = S$0 }
),
is_local: false,
is_op_method: false,
+ is_private_editable: false,
exact_postfix_snippet_match: false,
},
},
@@ -689,6 +699,7 @@ fn foo() { A { the$0 } }
),
is_local: false,
is_op_method: false,
+ is_private_editable: false,
exact_postfix_snippet_match: false,
},
},
diff --git a/crates/ide_completion/src/render/const_.rs b/crates/ide_completion/src/render/const_.rs
index 4c8258f12c..89e6c82dde 100644
--- a/crates/ide_completion/src/render/const_.rs
+++ b/crates/ide_completion/src/render/const_.rs
@@ -18,7 +18,8 @@ fn render(ctx: RenderContext<'_>, const_: hir::Const) -> Option<CompletionItem>
let mut item = CompletionItem::new(SymbolKind::Const, ctx.source_range(), name.clone());
item.set_documentation(ctx.docs(const_))
.set_deprecated(ctx.is_deprecated(const_) || ctx.is_deprecated_assoc_item(const_))
- .detail(detail);
+ .detail(detail)
+ .set_relevance(ctx.completion_relevance());
if let Some(actm) = const_.as_assoc_item(db) {
if let Some(trt) = actm.containing_trait_or_trait_impl(db) {
diff --git a/crates/ide_completion/src/render/enum_variant.rs b/crates/ide_completion/src/render/enum_variant.rs
index f0fb3c7a7f..914ace910d 100644
--- a/crates/ide_completion/src/render/enum_variant.rs
+++ b/crates/ide_completion/src/render/enum_variant.rs
@@ -23,7 +23,7 @@ pub(crate) fn render_variant(
}
fn render(
- ctx @ RenderContext { completion }: RenderContext<'_>,
+ ctx @ RenderContext { completion, .. }: RenderContext<'_>,
local_name: Option<hir::Name>,
variant: hir::Variant,
path: Option<hir::ModPath>,
@@ -58,18 +58,18 @@ fn render(
if variant_kind == hir::StructKind::Tuple {
cov_mark::hit!(inserts_parens_for_tuple_enums);
let params = Params::Anonymous(variant.fields(db).len());
- item.add_call_parens(ctx.completion, short_qualified_name, params);
+ item.add_call_parens(completion, short_qualified_name, params);
} else if qualified {
item.lookup_by(short_qualified_name);
}
- let ty = variant.parent_enum(ctx.completion.db).ty(ctx.completion.db);
+ let ty = variant.parent_enum(completion.db).ty(completion.db);
item.set_relevance(CompletionRelevance {
- type_match: compute_type_match(ctx.completion, &ty),
- ..CompletionRelevance::default()
+ type_match: compute_type_match(completion, &ty),
+ ..ctx.completion_relevance()
});
- if let Some(ref_match) = compute_ref_match(ctx.completion, &ty) {
+ if let Some(ref_match) = compute_ref_match(completion, &ty) {
item.ref_match(ref_match);
}
diff --git a/crates/ide_completion/src/render/function.rs b/crates/ide_completion/src/render/function.rs
index 224d4b054e..20c7fe657c 100644
--- a/crates/ide_completion/src/render/function.rs
+++ b/crates/ide_completion/src/render/function.rs
@@ -41,7 +41,7 @@ pub(crate) fn render_method(
}
fn render(
- ctx @ RenderContext { completion }: RenderContext<'_>,
+ ctx @ RenderContext { completion, .. }: RenderContext<'_>,
local_name: Option<hir::Name>,
func: hir::Function,
func_type: FuncType,
@@ -75,7 +75,7 @@ fn render(
type_match: compute_type_match(completion, &ret_type),
exact_name_match: compute_exact_name_match(completion, &call),
is_op_method,
- ..CompletionRelevance::default()
+ ..ctx.completion_relevance()
});
if let Some(ref_match) = compute_ref_match(completion, &ret_type) {
diff --git a/crates/ide_completion/src/render/macro_.rs b/crates/ide_completion/src/render/macro_.rs
index 8d6a634953..29bd90aec9 100644
--- a/crates/ide_completion/src/render/macro_.rs
+++ b/crates/ide_completion/src/render/macro_.rs
@@ -25,7 +25,7 @@ pub(crate) fn render_macro(
}
fn render(
- ctx @ RenderContext { completion }: RenderContext<'_>,
+ ctx @ RenderContext { completion, .. }: RenderContext<'_>,
name: hir::Name,
macro_: hir::MacroDef,
import_to_add: Option<ImportEdit>,
@@ -53,7 +53,8 @@ fn render(
);
item.set_deprecated(ctx.is_deprecated(macro_))
.set_detail(detail(&completion.sema, macro_))
- .set_documentation(docs);
+ .set_documentation(docs)
+ .set_relevance(ctx.completion_relevance());
if let Some(import_to_add) = import_to_add {
item.add_import(import_to_add);
diff --git a/crates/ide_completion/src/render/pattern.rs b/crates/ide_completion/src/render/pattern.rs
index 641a15aa65..68e29246d7 100644
--- a/crates/ide_completion/src/render/pattern.rs
+++ b/crates/ide_completion/src/render/pattern.rs
@@ -59,7 +59,10 @@ fn build_completion(
def: impl HasAttrs + Copy,
) -> CompletionItem {
let mut item = CompletionItem::new(CompletionItemKind::Binding, ctx.source_range(), name);
- item.set_documentation(ctx.docs(def)).set_deprecated(ctx.is_deprecated(def)).detail(&pat);
+ item.set_documentation(ctx.docs(def))
+ .set_deprecated(ctx.is_deprecated(def))
+ .detail(&pat)
+ .set_relevance(ctx.completion_relevance());
match ctx.snippet_cap() {
Some(snippet_cap) => item.insert_snippet(snippet_cap, pat),
None => item.insert_text(pat),
diff --git a/crates/ide_completion/src/render/struct_literal.rs b/crates/ide_completion/src/render/struct_literal.rs
index 6be7b9d43b..a3d4bcf29e 100644
--- a/crates/ide_completion/src/render/struct_literal.rs
+++ b/crates/ide_completion/src/render/struct_literal.rs
@@ -41,7 +41,10 @@ fn build_completion(
ctx.source_range(),
SmolStr::from_iter([&name, " {…}"]),
);
- item.set_documentation(ctx.docs(def)).set_deprecated(ctx.is_deprecated(def)).detail(&literal);
+ item.set_documentation(ctx.docs(def))
+ .set_deprecated(ctx.is_deprecated(def))
+ .detail(&literal)
+ .set_relevance(ctx.completion_relevance());
match ctx.snippet_cap() {
Some(snippet_cap) => item.insert_snippet(snippet_cap, literal),
None => item.insert_text(literal),
diff --git a/crates/ide_completion/src/render/type_alias.rs b/crates/ide_completion/src/render/type_alias.rs
index 5bfb4349ed..a518be87bf 100644
--- a/crates/ide_completion/src/render/type_alias.rs
+++ b/crates/ide_completion/src/render/type_alias.rs
@@ -39,7 +39,8 @@ fn render(
let mut item = CompletionItem::new(SymbolKind::TypeAlias, ctx.source_range(), name.clone());
item.set_documentation(ctx.docs(type_alias))
.set_deprecated(ctx.is_deprecated(type_alias) || ctx.is_deprecated_assoc_item(type_alias))
- .detail(detail);
+ .detail(detail)
+ .set_relevance(ctx.completion_relevance());
if let Some(actm) = type_alias.as_assoc_item(db) {
if let Some(trt) = actm.containing_trait_or_trait_impl(db) {