Merge #621

621: Completion docs for code model r=kjeremy a=kjeremy

Adds a way to access documentation through the code model and exposes it to completions. Also allows us to document enum variants.

Co-authored-by: Jeremy A. Kolb <[email protected]>
Co-authored-by: Jeremy Kolb <[email protected]>

3 files changed, 48 insertions, 28 deletions

diff --git a/crates/ra_ide_api/src/completion/complete_path.rs b/crates/ra_ide_api/src/completion/complete_path.rs
index 6bed299d2..e44b76c4a 100644
--- a/crates/ra_ide_api/src/completion/complete_path.rs
+++ b/crates/ra_ide_api/src/completion/complete_path.rs
@@ -2,6 +2,8 @@ use crate::{
     completion::{CompletionItem, CompletionItemKind, Completions, CompletionKind, CompletionContext},
 };
 
+use hir::Docs;
+
 pub(super) fn complete_path(acc: &mut Completions, ctx: &CompletionContext) {
     let (path, module) = match (&ctx.path_prefix, &ctx.module) {
         (Some(path), Some(module)) => (path.clone(), module),
@@ -27,13 +29,14 @@ pub(super) fn complete_path(acc: &mut Completions, ctx: &CompletionContext) {
         hir::Def::Enum(e) => {
             e.variants(ctx.db)
                 .into_iter()
-                .for_each(|(variant_name, _variant)| {
+                .for_each(|(variant_name, variant)| {
                     CompletionItem::new(
                         CompletionKind::Reference,
                         ctx.source_range(),
                         variant_name.to_string(),
                     )
                     .kind(CompletionItemKind::EnumVariant)
+                    .set_documentation(variant.docs(ctx.db))
                     .add_to(acc)
                 });
         }
@@ -116,7 +119,13 @@ mod tests {
             "reference_completion",
             "
             //- /lib.rs
-            enum E { Foo, Bar(i32) }
+            /// An enum
+            enum E {
+                /// Foo Variant
+                Foo,
+                /// Bar Variant with i32
+                Bar(i32)
+            }
             fn foo() { let _ = E::<|> }
             ",
         );
diff --git a/crates/ra_ide_api/src/completion/completion_item.rs b/crates/ra_ide_api/src/completion/completion_item.rs
index e3bf82304..18c151932 100644
--- a/crates/ra_ide_api/src/completion/completion_item.rs
+++ b/crates/ra_ide_api/src/completion/completion_item.rs
@@ -1,4 +1,4 @@
-use hir::PerNs;
+use hir::{Docs, Documentation, PerNs};
 
 use crate::completion::completion_context::CompletionContext;
 use ra_syntax::{
@@ -19,7 +19,7 @@ pub struct CompletionItem {
     label: String,
     kind: Option<CompletionItemKind>,
     detail: Option<String>,
-    documentation: Option<String>,
+    documentation: Option<Documentation>,
     lookup: Option<String>,
     insert_text: Option<String>,
     insert_text_format: InsertTextFormat,
@@ -98,7 +98,7 @@ impl CompletionItem {
     }
     /// A doc-comment
     pub fn documentation(&self) -> Option<&str> {
-        self.documentation.as_ref().map(|it| it.as_str())
+        self.documentation.as_ref().map(|it| it.contents())
     }
     /// What string is used for filtering.
     pub fn lookup(&self) -> &str {
@@ -137,7 +137,7 @@ pub(crate) struct Builder {
     insert_text: Option<String>,
     insert_text_format: InsertTextFormat,
     detail: Option<String>,
-    documentation: Option<String>,
+    documentation: Option<Documentation>,
     lookup: Option<String>,
     kind: Option<CompletionItemKind>,
     text_edit: Option<TextEdit>,
@@ -197,10 +197,10 @@ impl Builder {
         self
     }
     #[allow(unused)]
-    pub(crate) fn documentation(self, docs: impl Into<String>) -> Builder {
+    pub(crate) fn documentation(self, docs: Documentation) -> Builder {
         self.set_documentation(Some(docs))
     }
-    pub(crate) fn set_documentation(mut self, docs: Option<impl Into<String>>) -> Builder {
+    pub(crate) fn set_documentation(mut self, docs: Option<Documentation>) -> Builder {
         self.documentation = docs.map(Into::into);
         self
     }
@@ -210,35 +210,35 @@ impl Builder {
         resolution: &hir::Resolution,
     ) -> Builder {
         let resolved = resolution.def_id.map(|d| d.resolve(ctx.db));
-        let kind = match resolved {
+        let (kind, docs) = match resolved {
             PerNs {
                 types: Some(hir::Def::Module(..)),
                 ..
-            } => CompletionItemKind::Module,
+            } => (CompletionItemKind::Module, None),
             PerNs {
-                types: Some(hir::Def::Struct(..)),
+                types: Some(hir::Def::Struct(s)),
                 ..
-            } => CompletionItemKind::Struct,
+            } => (CompletionItemKind::Struct, s.docs(ctx.db)),
             PerNs {
-                types: Some(hir::Def::Enum(..)),
+                types: Some(hir::Def::Enum(e)),
                 ..
-            } => CompletionItemKind::Enum,
+            } => (CompletionItemKind::Enum, e.docs(ctx.db)),
             PerNs {
-                types: Some(hir::Def::Trait(..)),
+                types: Some(hir::Def::Trait(t)),
                 ..
-            } => CompletionItemKind::Trait,
+            } => (CompletionItemKind::Trait, t.docs(ctx.db)),
             PerNs {
-                types: Some(hir::Def::Type(..)),
+                types: Some(hir::Def::Type(t)),
                 ..
-            } => CompletionItemKind::TypeAlias,
+            } => (CompletionItemKind::TypeAlias, t.docs(ctx.db)),
             PerNs {
-                values: Some(hir::Def::Const(..)),
+                values: Some(hir::Def::Const(c)),
                 ..
-            } => CompletionItemKind::Const,
+            } => (CompletionItemKind::Const, c.docs(ctx.db)),
             PerNs {
-                values: Some(hir::Def::Static(..)),
+                values: Some(hir::Def::Static(s)),
                 ..
-            } => CompletionItemKind::Static,
+            } => (CompletionItemKind::Static, s.docs(ctx.db)),
             PerNs {
                 values: Some(hir::Def::Function(function)),
                 ..
@@ -246,6 +246,8 @@ impl Builder {
             _ => return self,
         };
         self.kind = Some(kind);
+        self.documentation = docs;
+
         self
     }
 
@@ -265,6 +267,7 @@ impl Builder {
             }
             self.insert_text_format = InsertTextFormat::Snippet;
         }
+
         if let Some(docs) = function.docs(ctx.db) {
             self.documentation = Some(docs);
         }
diff --git a/crates/ra_ide_api/src/completion/snapshots/completion_item__reference_completion.snap b/crates/ra_ide_api/src/completion/snapshots/completion_item__reference_completion.snap
index 0180a4f44..e46f7807b 100644
--- a/crates/ra_ide_api/src/completion/snapshots/completion_item__reference_completion.snap
+++ b/crates/ra_ide_api/src/completion/snapshots/completion_item__reference_completion.snap
@@ -1,6 +1,6 @@
 ---
-created: "2019-01-22T14:45:00.717917+00:00"
-creator: insta@0.4.0
+created: "2019-01-23T23:49:43.278245900+00:00"
+creator: insta@0.5.1
 expression: kind_completions
 source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
 ---
@@ -12,11 +12,15 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
             EnumVariant
         ),
         detail: None,
-        documentation: None,
+        documentation: Some(
+            Documentation(
+                "Foo Variant"
+            )
+        ),
         lookup: None,
         insert_text: None,
         insert_text_format: PlainText,
-        source_range: [47; 47),
+        source_range: [116; 116),
         text_edit: None
     },
     CompletionItem {
@@ -26,11 +30,15 @@ source: "crates\\ra_ide_api\\src\\completion\\completion_item.rs"
             EnumVariant
         ),
         detail: None,
-        documentation: None,
+        documentation: Some(
+            Documentation(
+                "Bar Variant with i32"
+            )
+        ),
         lookup: None,
         insert_text: None,
         insert_text_format: PlainText,
-        source_range: [47; 47),
+        source_range: [116; 116),
         text_edit: None
     }
 ]