Skip to content

feat: Make flyimport respect #[doc(hidden)] #9719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions crates/hir/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1599,6 +1599,21 @@ impl ItemInNs {
ItemInNs::Macros(_) => None,
}
}

/// Returns the crate defining this item (or `None` if `self` is built-in).
pub fn krate(&self, db: &dyn HirDatabase) -> Option<Crate> {
match self {
ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate()),
ItemInNs::Macros(id) => id.module(db).map(|m| m.krate()),
}
}

pub fn attrs(&self, db: &dyn HirDatabase) -> Option<AttrsWithOwner> {
match self {
ItemInNs::Types(it) | ItemInNs::Values(it) => it.attrs(db),
ItemInNs::Macros(it) => Some(it.attrs(db)),
}
}
}

/// Invariant: `inner.as_assoc_item(db).is_some()`
Expand Down
42 changes: 42 additions & 0 deletions crates/ide_completion/src/completions/flyimport.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@ pub(crate) fn import_on_the_fly(acc: &mut Completions, ctx: &CompletionContext)
import_assets
.search_for_imports(&ctx.sema, ctx.config.insert_use.prefix_kind)
.into_iter()
.filter(|import| {
!ctx.is_item_hidden(&import.item_to_import)
&& !ctx.is_item_hidden(&import.original_item)
})
.sorted_by_key(|located_import| {
compute_fuzzy_completion_order_key(
&located_import.import_path,
Expand Down Expand Up @@ -1147,4 +1151,42 @@ mod bar {
expect![[r#""#]],
);
}

#[test]
fn respects_doc_hidden() {
check(
r#"
//- /lib.rs crate:lib deps:dep
fn f() {
().fro$0
}

//- /dep.rs crate:dep
#[doc(hidden)]
pub trait Private {
fn frob(&self) {}
}

impl<T> Private for T {}
"#,
expect![[r#""#]],
);
check(
r#"
//- /lib.rs crate:lib deps:dep
fn f() {
().fro$0
}

//- /dep.rs crate:dep
pub trait Private {
#[doc(hidden)]
fn frob(&self) {}
}

impl<T> Private for T {}
"#,
expect![[r#""#]],
);
}
}
9 changes: 9 additions & 0 deletions crates/ide_completion/src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,15 @@ impl<'a> CompletionContext<'a> {
false
}

pub(crate) fn is_item_hidden(&self, item: &hir::ItemInNs) -> bool {
let attrs = item.attrs(self.db);
let krate = item.krate(self.db);
match (attrs, krate) {
(Some(attrs), Some(krate)) => self.is_doc_hidden(&attrs, krate),
_ => false,
}
}

/// A version of [`SemanticsScope::process_all_names`] that filters out `#[doc(hidden)]` items.
pub(crate) fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef)) {
self.scope.process_all_names(&mut |name, def| {
Expand Down