Provide an option to hide deprecated items from completion

Author: ChayimFriedman2

crates/ide-completion/src/completions.rs

@@ -50,9 +50,10 @@ use crate::{
 };
 
 /// Represents an in-progress set of completions being built.
-#[derive(Debug, Default)]
+#[derive(Debug)]
 pub struct Completions {
     buf: Vec<CompletionItem>,
+    hide_deprecated: bool,
 }
 
 impl From<Completions> for Vec<CompletionItem> {
@@ -70,13 +71,19 @@ impl Builder {
 }
 
 impl Completions {
+    pub(crate) fn new(hide_deprecated: bool) -> Completions {
+        Completions { buf: Vec::new(), hide_deprecated }
+    }
+
     fn add(&mut self, item: CompletionItem) {
-        self.buf.push(item)
+        if !item.deprecated || !self.hide_deprecated {
+            self.buf.push(item);
+        }
     }
 
     fn add_opt(&mut self, item: Option<CompletionItem>) {
         if let Some(item) = item {
-            self.buf.push(item)
+            self.add(item)
         }
     }
 

crates/ide-completion/src/config.rs

@@ -26,6 +26,7 @@ pub struct CompletionConfig {
     pub prefer_absolute: bool,
     pub snippets: Vec<Snippet>,
     pub limit: Option<usize>,
+    pub hide_deprecated: bool,
 }
 
 #[derive(Clone, Debug, PartialEq, Eq)]

crates/ide-completion/src/lib.rs

@@ -150,7 +150,7 @@ pub fn completions(
     trigger_character: Option<char>,
 ) -> Option<Vec<CompletionItem>> {
     let (ctx, analysis) = &CompletionContext::new(db, position, config)?;
-    let mut completions = Completions::default();
+    let mut completions = Completions::new(config.hide_deprecated);
 
     // prevent `(` from triggering unwanted completion noise
     if trigger_character == Some('(') {

crates/ide-completion/src/tests.rs

@@ -83,6 +83,7 @@ pub(crate) const TEST_CONFIG: CompletionConfig = CompletionConfig {
     prefer_absolute: false,
     snippets: Vec::new(),
     limit: None,
+    hide_deprecated: false,
 };
 
 pub(crate) fn completion_list(ra_fixture: &str) -> String {
@@ -326,3 +327,26 @@ Some multi-line comment$0
         String::new(),
     );
 }
+
+#[test]
+fn hide_deprecated_if_requested() {
+    assert_eq!(
+        completion_list_with_config(
+            CompletionConfig { hide_deprecated: true, ..TEST_CONFIG },
+            r#"
+#[deprecated]
+fn foo() {}
+
+fn test() {
+    foo$0
+}
+"#,
+            false,
+            None
+        ),
+        "\
+fn test() fn()
+bt u32    u32
+",
+    );
+}

crates/ide-completion/src/tests/flyimport.rs

@@ -10,7 +10,7 @@ fn check(ra_fixture: &str, expect: Expect) {
     let (db, position) = crate::tests::position(ra_fixture);
     let (ctx, analysis) = crate::context::CompletionContext::new(&db, position, &config).unwrap();
 
-    let mut acc = crate::completions::Completions::default();
+    let mut acc = crate::completions::Completions::new(false);
     if let CompletionAnalysis::Name(NameContext { kind: NameKind::IdentPat(pat_ctx), .. }) =
         &analysis
     {

crates/rust-analyzer/src/config.rs

@@ -512,6 +512,8 @@ config_data! {
         completion_termSearch_enable: bool = false,
         /// Term search fuel in "units of work" for autocompletion (Defaults to 1000).
         completion_termSearch_fuel: usize = 1000,
+        /// Whether to omit deprecated items from autocompletion. By default they are marked as deprecated but not hidden.
+        completions_hideDeprecated: bool = false,
 
         /// Controls file watching implementation.
         files_watcher: FilesWatcherDef = FilesWatcherDef::Client,
@@ -1432,6 +1434,7 @@ impl Config {
             limit: self.completion_limit().to_owned(),
             enable_term_search: self.completion_termSearch_enable().to_owned(),
             term_search_fuel: self.completion_termSearch_fuel().to_owned() as u64,
+            hide_deprecated: *self.completions_hideDeprecated(),
         }
     }
 

crates/rust-analyzer/src/integrated_benchmarks.rs

@@ -167,6 +167,7 @@ fn integrated_completion_benchmark() {
             prefer_absolute: false,
             snippets: Vec::new(),
             limit: None,
+            hide_deprecated: false,
         };
         let position =
             FilePosition { file_id, offset: TextSize::try_from(completion_offset).unwrap() };
@@ -213,6 +214,7 @@ fn integrated_completion_benchmark() {
             prefer_absolute: false,
             snippets: Vec::new(),
             limit: None,
+            hide_deprecated: false,
         };
         let position =
             FilePosition { file_id, offset: TextSize::try_from(completion_offset).unwrap() };
@@ -257,6 +259,7 @@ fn integrated_completion_benchmark() {
             prefer_absolute: false,
             snippets: Vec::new(),
             limit: None,
+            hide_deprecated: false,
         };
         let position =
             FilePosition { file_id, offset: TextSize::try_from(completion_offset).unwrap() };

docs/user/generated_config.adoc

@@ -358,6 +358,11 @@ Whether to enable term search based snippets like `Some(foo.bar().baz())`.
 --
 Term search fuel in "units of work" for autocompletion (Defaults to 1000).
 --
+[[rust-analyzer.completions.hideDeprecated]]rust-analyzer.completions.hideDeprecated (default: `false`)::
++
+--
+Whether to omit deprecated items from autocompletion. By default they are marked as deprecated but not hidden.
+--
 [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
 +
 --

editors/code/package.json

@@ -1182,6 +1182,16 @@
                     }
                 }
             },
+            {
+                "title": "completions",
+                "properties": {
+                    "rust-analyzer.completions.hideDeprecated": {
+                        "markdownDescription": "Whether to omit deprecated items from autocompletion. By default they are marked as deprecated but not hidden.",
+                        "default": false,
+                        "type": "boolean"
+                    }
+                }
+            },
             {
                 "title": "diagnostics",
                 "properties": {