Support LSP features for Markdown/RST in comments

Author: taminomara

crates/emmylua_code_analysis/resources/schema.json

@@ -50,7 +50,8 @@
       "$ref": "#/$defs/EmmyrcDoc",
       "default": {
         "knownTags": [],
-        "privateName": []
+        "privateName": [],
+        "syntax": "none"
       }
     },
     "documentColor": {
@@ -123,7 +124,8 @@
     "semanticTokens": {
       "$ref": "#/$defs/EmmyrcSemanticToken",
       "default": {
-        "enable": true
+        "enable": true,
+        "renderDocumentationMarkup": false
       }
     },
     "signature": {
@@ -442,6 +444,15 @@
         }
       ]
     },
+    "DocSyntax": {
+      "type": "string",
+      "enum": [
+        "none",
+        "md",
+        "myst",
+        "rst"
+      ]
+    },
     "EmmyrcCodeAction": {
       "type": "object",
       "properties": {
@@ -611,6 +622,25 @@
           "items": {
             "type": "string"
           }
+        },
+        "rstDefaultRole": {
+          "description": "When `syntax` is `Myst` or `Rst`, specifies default role used\nwith RST processor.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "rstPrimaryDomain": {
+          "description": "When `syntax` is `Myst` or `Rst`, specifies primary domain used\nwith RST processor.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "syntax": {
+          "description": "Syntax for highlighting documentation.",
+          "$ref": "#/$defs/DocSyntax",
+          "default": "none"
         }
       }
     },
@@ -934,6 +964,12 @@
           "type": "boolean",
           "default": true,
           "x-vscode-setting": true
+        },
+        "renderDocumentationMarkup": {
+          "description": "Render Markdown/RST in documentation. Set `doc.syntax` for this option to have effect.",
+          "type": "boolean",
+          "default": false,
+          "x-vscode-setting": true
         }
       }
     },

crates/emmylua_code_analysis/src/config/configs/doc.rs

@@ -4,20 +4,52 @@ use serde::{Deserialize, Serialize};
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct EmmyrcDoc {
-    #[serde(default)]
     /// Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located.
+    #[serde(default)]
     pub private_name: Vec<String>,
 
     /// List of known documentation tags.
     #[serde(default)]
     pub known_tags: Vec<String>,
+
+    /// Syntax for highlighting documentation.
+    #[serde(default)]
+    pub syntax: DocSyntax,
+
+    /// When `syntax` is `Myst` or `Rst`, specifies primary domain used
+    /// with RST processor.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub rst_primary_domain: Option<String>,
+
+    /// When `syntax` is `Myst` or `Rst`, specifies default role used
+    /// with RST processor.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub rst_default_role: Option<String>,
 }
 
 impl Default for EmmyrcDoc {
     fn default() -> Self {
         Self {
             private_name: Default::default(),
             known_tags: Default::default(),
+            syntax: Default::default(),
+            rst_primary_domain: None,
+            rst_default_role: None,
         }
     }
 }
+
+#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)]
+#[serde(rename_all = "kebab-case")]
+pub enum DocSyntax {
+    None,
+    Md,
+    Myst,
+    Rst,
+}
+
+impl Default for DocSyntax {
+    fn default() -> Self {
+        DocSyntax::None
+    }
+}

crates/emmylua_code_analysis/src/config/configs/mod.rs

@@ -20,7 +20,7 @@ pub use code_action::EmmyrcCodeAction;
 pub use codelen::EmmyrcCodeLens;
 pub use completion::{EmmyrcCompletion, EmmyrcFilenameConvention};
 pub use diagnostics::EmmyrcDiagnostic;
-pub use doc::EmmyrcDoc;
+pub use doc::{DocSyntax, EmmyrcDoc};
 pub use document_color::EmmyrcDocumentColor;
 pub use hover::EmmyrcHover;
 pub use inlayhint::EmmyrcInlayHint;

crates/emmylua_code_analysis/src/config/configs/semantictoken.rs

@@ -8,12 +8,18 @@ pub struct EmmyrcSemanticToken {
     #[serde(default = "default_true")]
     #[schemars(extend("x-vscode-setting" = true))]
     pub enable: bool,
+
+    /// Render Markdown/RST in documentation. Set `doc.syntax` for this option to have effect.
+    #[serde(default)]
+    #[schemars(extend("x-vscode-setting" = true))]
+    pub render_documentation_markup: bool,
 }
 
 impl Default for EmmyrcSemanticToken {
     fn default() -> Self {
         Self {
             enable: default_true(),
+            render_documentation_markup: false,
         }
     }
 }

crates/emmylua_code_analysis/src/config/mod.rs

@@ -9,13 +9,13 @@ use std::{
 
 pub use crate::config::configs::{EmmyrcExternalTool, EmmyrcReformat};
 pub use config_loader::{load_configs, load_configs_raw};
+pub use configs::{DocSyntax, EmmyrcFilenameConvention, EmmyrcLuaVersion};
 use configs::{
     EmmyrcCodeAction, EmmyrcCodeLens, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcDoc,
     EmmyrcDocumentColor, EmmyrcHover, EmmyrcInlayHint, EmmyrcInlineValues, EmmyrcReference,
     EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken, EmmyrcSignature, EmmyrcStrict,
     EmmyrcWorkspace,
 };
-pub use configs::{EmmyrcFilenameConvention, EmmyrcLuaVersion};
 use emmylua_parser::{LuaLanguageLevel, LuaNonStdSymbolSet, ParserConfig, SpecialFunction};
 use regex::Regex;
 use rowan::NodeCache;

crates/emmylua_code_analysis/src/semantic/mod.rs

@@ -40,7 +40,7 @@ pub use visibility::check_export_visibility;
 use visibility::check_visibility;
 
 use crate::semantic::member::find_members_with_key;
-use crate::{Emmyrc, LuaDocument, LuaSemanticDeclId, db_index::LuaTypeDeclId};
+use crate::{Emmyrc, LuaDocument, LuaSemanticDeclId, ModuleInfo, db_index::LuaTypeDeclId};
 use crate::{
     FileId,
     db_index::{DbIndex, LuaType},
@@ -87,6 +87,10 @@ impl<'a> SemanticModel<'a> {
         self.db.get_vfs().get_document(&self.file_id).unwrap()
     }
 
+    pub fn get_module(&self) -> Option<&ModuleInfo> {
+        self.db.get_module_index().get_module(self.file_id)
+    }
+
     pub fn get_document_by_file_id(&self, file_id: FileId) -> Option<LuaDocument> {
         self.db.get_vfs().get_document(&file_id)
     }
@@ -256,6 +260,10 @@ impl<'a> SemanticModel<'a> {
         &self.emmyrc
     }
 
+    pub fn get_emmyrc_arc(&self) -> Arc<Emmyrc> {
+        self.emmyrc.clone()
+    }
+
     pub fn get_root(&self) -> &LuaChunk {
         &self.root
     }

crates/emmylua_ls/src/handlers/completion/completion_builder.rs

@@ -3,6 +3,7 @@ use std::collections::HashSet;
 use emmylua_code_analysis::SemanticModel;
 use emmylua_parser::LuaSyntaxToken;
 use lsp_types::{CompletionItem, CompletionTriggerKind};
+use rowan::TextSize;
 use tokio_util::sync::CancellationToken;
 
 pub struct CompletionBuilder<'a> {
@@ -15,6 +16,7 @@ pub struct CompletionBuilder<'a> {
     pub trigger_kind: CompletionTriggerKind,
     /// 是否为空格字符触发的补全(非主动触发)
     pub is_space_trigger_character: bool,
+    pub position_offset: TextSize,
 }
 
 impl<'a> CompletionBuilder<'a> {
@@ -23,6 +25,7 @@ impl<'a> CompletionBuilder<'a> {
         semantic_model: SemanticModel<'a>,
         cancel_token: CancellationToken,
         trigger_kind: CompletionTriggerKind,
+        position_offset: TextSize,
     ) -> Self {
         let is_space_trigger_character = if trigger_kind == CompletionTriggerKind::TRIGGER_CHARACTER
         {
@@ -40,6 +43,7 @@ impl<'a> CompletionBuilder<'a> {
             stopped: false,
             trigger_kind,
             is_space_trigger_character,
+            position_offset,
         }
     }
 

crates/emmylua_ls/src/handlers/completion/mod.rs

@@ -80,9 +80,14 @@ pub fn completion(
         }
     };
 
-    let mut builder = CompletionBuilder::new(token, semantic_model, cancel_token, trigger_kind);
-    let emmyrc = analysis.get_emmyrc();
-    add_completions(&mut builder, &emmyrc);
+    let mut builder = CompletionBuilder::new(
+        token,
+        semantic_model,
+        cancel_token,
+        trigger_kind,
+        position_offset,
+    );
+    add_completions(&mut builder);
     Some(CompletionResponse::Array(builder.get_completion_items()))
 }