add module/type description when completion

Author: CppCXY

crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs

@@ -7,6 +7,8 @@ use crate::{
     util::module_name_convert,
 };
 
+use super::module_path_provider::get_module_description;
+
 pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
     if builder.is_cancelled() {
         return None;
@@ -74,6 +76,7 @@ fn add_module_completion_item(
         return None;
     }
 
+    let db = builder.semantic_model.get_db();
     let completion_item = CompletionItem {
         label: completion_name,
         kind: Some(lsp_types::CompletionItemKind::MODULE),
@@ -87,6 +90,7 @@ fn add_module_completion_item(
             module_info.file_id,
             position,
         )),
+        documentation: get_module_description(db, module_info.file_id),
         ..Default::default()
     };
 

crates/emmylua_ls/src/handlers/completion/providers/doc_type_provider.rs

@@ -1,6 +1,6 @@
 use emmylua_code_analysis::LuaTypeDeclId;
 use emmylua_parser::{LuaAstNode, LuaDocNameType, LuaSyntaxKind, LuaTokenKind};
-use lsp_types::CompletionItem;
+use lsp_types::{CompletionItem, Documentation, MarkupContent};
 
 use crate::handlers::completion::completion_builder::CompletionBuilder;
 
@@ -91,8 +91,26 @@ fn add_type_completion_item(
     let completion_item = CompletionItem {
         label: name.to_string(),
         kind: Some(kind),
+        documentation: get_documentation(builder, type_decl),
         ..CompletionItem::default()
     };
 
     builder.add_completion_item(completion_item)
 }
+
+fn get_documentation(
+    builder: &CompletionBuilder,
+    type_decl: Option<LuaTypeDeclId>,
+) -> Option<Documentation> {
+    let db = builder.semantic_model.get_db();
+    let semantic_id = type_decl?.into();
+    let property = db.get_property_index().get_property(&semantic_id)?;
+    if let Some(description) = &property.description {
+        return Some(Documentation::MarkupContent(MarkupContent {
+            kind: lsp_types::MarkupKind::Markdown,
+            value: description.to_string(),
+        }));
+    }
+
+    None
+}

crates/emmylua_ls/src/handlers/completion/providers/module_path_provider.rs

@@ -1,8 +1,8 @@
-use emmylua_code_analysis::Emmyrc;
+use emmylua_code_analysis::{DbIndex, FileId};
 use emmylua_parser::{
-    LuaAstNode, LuaAstToken, LuaCallArgList, LuaCallExpr, LuaExpr, LuaLiteralExpr, LuaStringToken,
+    LuaAstNode, LuaAstToken, LuaCallArgList, LuaCallExpr, LuaLiteralExpr, LuaStringToken,
 };
-use lsp_types::{CompletionItem, CompletionTextEdit, TextEdit};
+use lsp_types::{CompletionItem, CompletionTextEdit, Documentation, MarkupContent, TextEdit};
 
 use crate::handlers::completion::completion_builder::CompletionBuilder;
 
@@ -14,21 +14,14 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
     }
 
     let string_token = LuaStringToken::cast(builder.trigger_token.clone())?;
-    let call_expr_prefix = string_token
+    let call_expr = string_token
         .get_parent::<LuaLiteralExpr>()?
         .get_parent::<LuaCallArgList>()?
-        .get_parent::<LuaCallExpr>()?
-        .get_prefix_expr()?;
+        .get_parent::<LuaCallExpr>()?;
 
     let emmyrc = builder.semantic_model.get_emmyrc();
-    match call_expr_prefix {
-        LuaExpr::NameExpr(name_expr) => {
-            let name = name_expr.get_name_text()?;
-            if !is_require_call(emmyrc, &name) {
-                return None;
-            }
-        }
-        _ => return None,
+    if !call_expr.is_require() {
+        return None;
     }
 
     let version_number = emmyrc.runtime.version.to_lua_version_number();
@@ -72,6 +65,7 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
                     filter_text: Some(filter_text.clone()),
                     text_edit: Some(CompletionTextEdit::Edit(text_edit)),
                     detail: Some(uri.to_string()),
+                    documentation: get_module_description(db, *child_file_id),
                     ..Default::default()
                 };
                 module_completions.push(completion_item);
@@ -98,12 +92,16 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> {
     Some(())
 }
 
-fn is_require_call(emmyrc: &Emmyrc, name: &str) -> bool {
-    for fun in &emmyrc.runtime.require_like_function {
-        if name == fun {
-            return true;
-        }
+pub fn get_module_description(db: &DbIndex, file_id: FileId) -> Option<Documentation> {
+    let module_info = db.get_module_index().get_module(file_id)?;
+    let semantic_id = module_info.property_owner_id.clone()?;
+    let property = db.get_property_index().get_property(&semantic_id)?;
+    if let Some(description) = &property.description {
+        return Some(Documentation::MarkupContent(MarkupContent {
+            kind: lsp_types::MarkupKind::Markdown,
+            value: description.to_string(),
+        }));
     }
 
-    name == "require"
+    None
 }

crates/emmylua_ls/src/handlers/definition/goto_module_file.rs

@@ -8,8 +8,7 @@ pub fn goto_module_file(
     semantic_model: &SemanticModel,
     string_token: LuaStringToken,
 ) -> Option<GotoDefinitionResponse> {
-    let emmyrc = semantic_model.get_emmyrc();
-    if !is_require_path(string_token.clone(), &emmyrc).unwrap_or(false) {
+    if !is_require_path(string_token.clone()).unwrap_or(false) {
         return None;
     }
 

crates/emmylua_ls/src/handlers/document_link/build_link.rs

@@ -2,7 +2,7 @@ use std::path::PathBuf;
 
 use emmylua_code_analysis::{file_path_to_uri, DbIndex, Emmyrc, LuaDocument};
 use emmylua_parser::{
-    LuaAstNode, LuaAstToken, LuaCallArgList, LuaCallExpr, LuaExpr, LuaLiteralExpr, LuaStringToken,
+    LuaAstNode, LuaAstToken, LuaCallArgList, LuaCallExpr, LuaLiteralExpr, LuaStringToken,
     LuaSyntaxNode,
 };
 use lsp_types::DocumentLink;
@@ -33,7 +33,7 @@ fn try_build_file_link(
     result: &mut Vec<DocumentLink>,
     emmyrc: &Emmyrc,
 ) -> Option<()> {
-    if is_require_path(token.clone(), emmyrc).unwrap_or(false) {
+    if is_require_path(token.clone()).unwrap_or(false) {
         try_build_module_link(db, token, document, result);
         return Some(());
     }
@@ -103,25 +103,11 @@ fn try_build_module_link(
     Some(())
 }
 
-pub fn is_require_path(token: LuaStringToken, emmyrc: &Emmyrc) -> Option<bool> {
-    let call_expr_prefix = token
+pub fn is_require_path(token: LuaStringToken) -> Option<bool> {
+    let call_expr = token
         .get_parent::<LuaLiteralExpr>()?
         .get_parent::<LuaCallArgList>()?
-        .get_parent::<LuaCallExpr>()?
-        .get_prefix_expr()?;
+        .get_parent::<LuaCallExpr>()?;
 
-    if let LuaExpr::NameExpr(name_expr) = call_expr_prefix {
-        let name = name_expr.get_name_text()?;
-        if name == "require" {
-            return Some(true);
-        }
-
-        for require_like_function in &emmyrc.runtime.require_like_function {
-            if name == *require_like_function {
-                return Some(true);
-            }
-        }
-    }
-
-    Some(false)
+    Some(call_expr.is_require())
 }