add custom request gutter for intellij

Author: CppCXY

crates/emmylua_ls/src/handlers/emmy_gutter/emmy_gutter_request.rs

@@ -0,0 +1,61 @@
+use lsp_types::{Range, request::Request};
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug)]
+pub enum EmmyGutterRequest {}
+
+impl Request for EmmyGutterRequest {
+    type Params = EmmyGutterParams;
+    type Result = Option<Vec<GutterInfo>>;
+    const METHOD: &'static str = "emmy/gutter";
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct EmmyGutterParams {
+    pub uri: String,
+}
+
+// /**
+//  * Gutter information returned from LSP
+//  */
+// data class GutterInfo(
+//     val range: Range,
+//     val kind: GutterKind,
+//     val detail: String?
+// )
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+pub struct GutterInfo {
+    pub range: Range,
+    pub kind: GutterKind,
+    pub detail: Option<String>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(into = "u8", try_from = "u8")]
+pub enum GutterKind {
+    Class = 0,
+    Enum = 1,
+    Alias = 2,
+    Method = 3,
+    Module = 4,
+}
+
+impl From<GutterKind> for u8 {
+    fn from(kind: GutterKind) -> Self {
+        kind as u8
+    }
+}
+
+impl From<u8> for GutterKind {
+    fn from(value: u8) -> Self {
+        match value {
+            0 => GutterKind::Class,
+            1 => GutterKind::Enum,
+            2 => GutterKind::Alias,
+            3 => GutterKind::Method,
+            4 => GutterKind::Module,
+            _ => GutterKind::Class, // default case
+        }
+    }
+}

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

@@ -0,0 +1,66 @@
+mod emmy_gutter_request;
+
+use std::str::FromStr;
+
+use crate::{
+    context::ServerContextSnapshot,
+    handlers::emmy_gutter::emmy_gutter_request::{EmmyGutterParams, GutterInfo},
+};
+pub use emmy_gutter_request::*;
+use emmylua_code_analysis::SemanticModel;
+use emmylua_parser::{LuaAstNode, LuaDocTag};
+use lsp_types::Uri;
+use tokio_util::sync::CancellationToken;
+
+pub async fn on_emmy_gutter_handler(
+    context: ServerContextSnapshot,
+    params: EmmyGutterParams,
+    _: CancellationToken,
+) -> Option<Vec<GutterInfo>> {
+    let uri = Uri::from_str(&params.uri).ok()?;
+    let analysis = context.analysis().read().await;
+    let file_id = analysis.get_file_id(&uri)?;
+    let semantic_model = analysis.compilation.get_semantic_model(file_id)?;
+
+    build_gutter_infos(&semantic_model)
+}
+
+fn build_gutter_infos(semantic_model: &SemanticModel) -> Option<Vec<GutterInfo>> {
+    let root = semantic_model.get_root().clone();
+    let document = semantic_model.get_document();
+    let mut gutters = Vec::new();
+    for tag in root.descendants::<LuaDocTag>() {
+        match tag {
+            LuaDocTag::Alias(alias) => {
+                let range = alias.get_range();
+                let lsp_range = document.to_lsp_range(range)?;
+                gutters.push(GutterInfo {
+                    range: lsp_range,
+                    kind: GutterKind::Alias,
+                    detail: Some("type alias".to_string()),
+                });
+            }
+            LuaDocTag::Class(class) => {
+                let range = class.get_range();
+                let lsp_range = document.to_lsp_range(range)?;
+                gutters.push(GutterInfo {
+                    range: lsp_range,
+                    kind: GutterKind::Class,
+                    detail: Some("class".to_string()),
+                });
+            }
+            LuaDocTag::Enum(enm) => {
+                let range = enm.get_range();
+                let lsp_range = document.to_lsp_range(range)?;
+                gutters.push(GutterInfo {
+                    range: lsp_range,
+                    kind: GutterKind::Enum,
+                    detail: Some("enum".to_string()),
+                });
+            }
+            _ => {}
+        }
+    }
+
+    Some(gutters)
+}

crates/emmylua_ls/src/handlers/mod.rs

@@ -15,6 +15,7 @@ mod document_selection_range;
 mod document_symbol;
 mod document_type_format;
 mod emmy_annotator;
+mod emmy_gutter;
 mod fold_range;
 mod hover;
 mod implementation;

crates/emmylua_ls/src/handlers/request_handler.rs

@@ -19,6 +19,7 @@ use crate::{
     handlers::{
         diagnostic::{on_pull_document_diagnostic, on_pull_workspace_diagnostic},
         document_type_format::on_type_formatting_handler,
+        emmy_gutter::{EmmyGutterRequest, on_emmy_gutter_handler},
     },
 };
 
@@ -94,6 +95,7 @@ pub async fn on_request_handler(
         DocumentLinkRequest => on_document_link_handler,
         DocumentLinkResolve => on_document_link_resolve_handler,
         EmmyAnnotatorRequest => on_emmy_annotator_handler,
+        EmmyGutterRequest => on_emmy_gutter_handler,
         SelectionRangeRequest => on_document_selection_range_handle,
         Completion => on_completion_handler,
         ResolveCompletionItem => on_completion_resolve_handler,