Use LCN defined highlights and introduce CodeLensDisplay config (#1144)

Author: martskins

autoload/LanguageClient.vim

@@ -14,6 +14,35 @@ let s:POPUP_WINDOW_AVAILABLE = exists('*popup_atcursor')
 " timers to control throttling
 let s:timers = {}
 
+if !hlexists('LanguageClientCodeLens')
+  hi link LanguageClientCodeLens Title
+endif
+
+if !hlexists('LanguageClientWarningSign')
+  hi link LanguageClientWarningSign todo
+endif
+
+if !hlexists('LanguageClientWarning')
+  hi link LanguageClientWarning SpellCap
+endif
+
+if !hlexists('LanguageClientInfoSign')
+  hi link LanguageClientInfoSign LanguageClientWarningSign
+endif
+
+if !hlexists('LanguageClientInfo')
+  hi link LanguageClientInfo LanguageClientWarning
+endif
+
+if !hlexists('LanguageClientErrorSign')
+  hi link LanguageClientErrorSign error
+endif
+
+if !hlexists('LanguageClientError')
+  hi link LanguageClientError SpellBad
+endif
+
+
 function! s:AddPrefix(message) abort
     return '[LC] ' . a:message
 endfunction

doc/LanguageClient.txt

@@ -103,30 +103,30 @@ Default: >
     {
         1: {
             "name": "Error",
-            "texthl": "ALEError",
+            "texthl": "LanguageClientError",
             "signText": "✖",
-            "signTexthl": "ALEErrorSign",
+            "signTexthl": "LanguageClientErrorSign",
             "virtualTexthl": "Error",
         },
         2: {
             "name": "Warning",
-            "texthl": "ALEWarning",
+            "texthl": "LanguageClientWarning",
             "signText": "⚠",
-            "signTexthl": "ALEWarningSign",
+            "signTexthl": "LanguageClientWarningSign",
             "virtualTexthl": "Todo",
         },
         3: {
             "name": "Information",
-            "texthl": "ALEInfo",
+            "texthl": "LanguageClientInfo",
             "signText": "ℹ",
-            "signTexthl": "ALEInfoSign",
+            "signTexthl": "LanguageClientInfoSign",
             "virtualTexthl": "Todo",
         },
         4: {
             "name": "Hint",
-            "texthl": "ALEInfo",
+            "texthl": "LanguageClientInfo",
             "signText": "➤",
-            "signTexthl": "ALEInfoSign",
+            "signTexthl": "LanguageClientInfoSign",
             "virtualTexthl": "Todo",
         },
     }
@@ -629,11 +629,14 @@ The default value for this config, or the absence of this config, enables extens
 
 Default: v:null
 
-2.41 g:LanguageClient_codeLensHighlightGroup          *g:LanguageClient_codeLensHighlightGroup*
+2.41 g:LanguageClient_codeLensDisplay          *g:LanguageClient_codeLensDisplay*
 
-Highlight group to be used for code lens.
+Control how code lenses are displayed.
 
-Default: 'Comment'
+Default: >
+  {
+    "virtualTexthl": "LanguageClientCodeLens",
+  }
 
 2.42 g:LanguageClient_hoverMarginSize        *g:LanguageClient_hoverMarginSize*
 

src/language_server_protocol.rs

@@ -179,7 +179,7 @@ impl LanguageClient {
             preferred_markup_kind,
             hide_virtual_texts_on_insert,
             enable_extensions,
-            code_lens_hl_group,
+            code_lens_display,
         ): (
             Option<usize>,
             String,
@@ -194,7 +194,7 @@ impl LanguageClient {
             Option<Vec<MarkupKind>>,
             u8,
             Option<HashMap<String, bool>>,
-            String,
+            Value,
         ) = self.vim()?.eval(
             [
                 "get(g:, 'LanguageClient_diagnosticsSignsMax', v:null)",
@@ -210,7 +210,7 @@ impl LanguageClient {
                 "get(g:, 'LanguageClient_preferredMarkupKind', v:null)",
                 "s:GetVar('LanguageClient_hideVirtualTextsOnInsert', 0)",
                 "get(g:, 'LanguageClient_enableExtensions', v:null)",
-                "get(g:, 'LanguageClient_codeLensHighlightGroup', 'Comment')",
+                "get(g:, 'LanguageClient_codeLensDisplay', v:null)",
             ]
             .as_ref(),
         )?;
@@ -337,7 +337,9 @@ impl LanguageClient {
             state.is_nvim = is_nvim;
             state.preferred_markup_kind = preferred_markup_kind;
             state.enable_extensions = enable_extensions;
-            state.code_lens_hl_group = code_lens_hl_group;
+            state.code_lens_display = serde_json::from_value(
+                serde_json::to_value(&state.code_lens_display)?.combine(&code_lens_display),
+            )?;
             state.max_restart_retries = max_restart_retries;
             state.restart_on_crash = restart_on_crash == 1;
 
@@ -3208,7 +3210,7 @@ impl LanguageClient {
         let mut virtual_texts = vec![];
         let code_lenses =
             self.get(|state| state.code_lens.get(filename).cloned().unwrap_or_default())?;
-        let code_lens_hl_group = self.get(|state| state.code_lens_hl_group.clone())?;
+        let code_lens_display = self.get(|state| state.code_lens_display.clone())?;
 
         for cl in code_lenses {
             if let Some(command) = cl.command {
@@ -3225,7 +3227,7 @@ impl LanguageClient {
                     None => virtual_texts.push(VirtualText {
                         line,
                         text,
-                        hl_group: code_lens_hl_group.clone(),
+                        hl_group: code_lens_display.virtual_texthl.clone(),
                     }),
                 }
             }

src/types.rs

@@ -155,7 +155,7 @@ pub struct State {
     pub diagnostics: HashMap<String, Vec<Diagnostic>>,
     // filename => codeLens.
     pub code_lens: HashMap<String, Vec<CodeLens>>,
-    pub code_lens_hl_group: String,
+    pub code_lens_display: CodeLensDisplay,
     #[serde(skip_serializing)]
     pub line_diagnostics: HashMap<(String, u64), String>,
     pub namespace_ids: HashMap<String, i64>,
@@ -291,7 +291,7 @@ impl State {
             server_stderr: None,
             preferred_markup_kind: None,
             enable_extensions: None,
-            code_lens_hl_group: "Comment".into(),
+            code_lens_display: CodeLensDisplay::default(),
             restart_on_crash: true,
             max_restart_retries: 5,
 
@@ -401,6 +401,20 @@ impl FromStr for DiagnosticsList {
     }
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct CodeLensDisplay {
+    pub virtual_texthl: String,
+}
+
+impl Default for CodeLensDisplay {
+    fn default() -> Self {
+        CodeLensDisplay {
+            virtual_texthl: "LanguageClientCodeLens".into(),
+        }
+    }
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct DiagnosticsDisplay {
@@ -418,39 +432,39 @@ impl DiagnosticsDisplay {
             1,
             Self {
                 name: "Error".to_owned(),
-                texthl: "ALEError".to_owned(),
+                texthl: "LanguageClientError".to_owned(),
                 sign_text: "✖".to_owned(),
-                sign_texthl: "ALEErrorSign".to_owned(),
+                sign_texthl: "LanguageClientErrorSign".to_owned(),
                 virtual_texthl: "Error".to_owned(),
             },
         );
         map.insert(
             2,
             Self {
                 name: "Warning".to_owned(),
-                texthl: "ALEWarning".to_owned(),
+                texthl: "LanguageClientWarning".to_owned(),
                 sign_text: "⚠".to_owned(),
-                sign_texthl: "ALEWarningSign".to_owned(),
+                sign_texthl: "LanguageClientWarningSign".to_owned(),
                 virtual_texthl: "Todo".to_owned(),
             },
         );
         map.insert(
             3,
             Self {
                 name: "Information".to_owned(),
-                texthl: "ALEInfo".to_owned(),
+                texthl: "LanguageClientInfo".to_owned(),
                 sign_text: "ℹ".to_owned(),
-                sign_texthl: "ALEInfoSign".to_owned(),
+                sign_texthl: "LanguageClientInfoSign".to_owned(),
                 virtual_texthl: "Todo".to_owned(),
             },
         );
         map.insert(
             4,
             Self {
                 name: "Hint".to_owned(),
-                texthl: "ALEInfo".to_owned(),
+                texthl: "LanguageClientInfo".to_owned(),
                 sign_text: "➤".to_owned(),
-                sign_texthl: "ALEInfoSign".to_owned(),
+                sign_texthl: "LanguageClientInfoSign".to_owned(),
                 virtual_texthl: "Todo".to_owned(),
             },
         );