Merge pull request #123 from splunk/hover

Inline hover
splunk · May 21, 2024 · 2371de9 · 2371de9
2 parents 1db02ec + 0da8757
commit 2371de9
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 2 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -31,20 +31,22 @@
 			"preLaunchTask": "${defaultBuildTask}"
 		},
         {
+			"name": "Mocha Tests",
+			"type": "node",
             "args": [
                 "--timeout",
                 "999999",
                 "--colors",
                 "${workspaceFolder}/test"
             ],
             "internalConsoleOptions": "openOnSessionStart",
-            "name": "Mocha Tests",
+
             "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
             "request": "launch",
             "skipFiles": [
                 "<node_internals>/**"
             ],
-            "type": "node"
+			"preLaunchTask": "npm: install"
         },
 		{
 			"name": "Extension Functional Tests",

diff --git a/out/extension.js b/out/extension.js
@@ -316,6 +316,9 @@ function handleSplunkDocument(context) {
         // Register Setting completion items for this spec
         let trimWhitespace = vscode.workspace.getConfiguration().get('splunk.spec.trimEqualSignWhitespace')
         context.subscriptions.push(provideSettingCompletionItems(specConfig, trimWhitespace));
+
+        // Register Hovers
+        context.subscriptions.push(provideHovers(specConfig));
     }
 
     // Set up diagnostics (linting)
@@ -403,6 +406,55 @@ function checkSpecFilePath(specFilePath) {
     return specFilePath;
 }
 
+function provideHovers(specConfig) {
+
+    let enableHover = vscode.workspace.getConfiguration().get('splunk.showDocumentationOnHover');
+    if(!enableHover) {
+        return;
+    }
+
+    // Get the currently open document
+    let currentDocument = path.basename(vscode.window.activeTextEditor.document.uri.fsPath);
+
+    vscode.languages.registerHoverProvider({ language: 'splunk', pattern: `**/${currentDocument}`}, {
+
+        provideHover(document, position, token) {
+
+            const range = document.getWordRangeAtPosition(position, /\w[-\w\.]*/g);
+            const word = document.getText(range);
+
+            if((document.lineAt(position.line).text.startsWith('['))) {
+                // This is a stanza
+
+                // Get stanzas for this .spec file
+                // Find the hovered word
+                // Add a hover for the value
+                let stanza = specConfig["stanzas"].find(item => item.stanzaName === word)
+                if(stanza) {
+                    let hoverContent = new vscode.MarkdownString(stanza["docString"])
+                    hoverContent.isTrusted = true;
+                    return new vscode.Hover(hoverContent);
+                }
+            } else {
+                // This might be a setting
+                let parentStanza = getParentStanza(document, position.line);
+                if(parentStanza) {
+                    let stanzaSettings = splunkSpec.getStanzaSettings(specConfig, parentStanza)
+                    let setting = stanzaSettings.find(item => item.name === word)
+                    if(setting) {
+                        let hoverContent = new vscode.MarkdownString(setting["docString"])
+                        hoverContent.isTrusted = true;
+                        return new vscode.Hover(hoverContent);
+                    }
+                }
+            }
+        }
+
+    })
+
+    return null
+}
+
 function provideStanzaCompletionItems(specConfig) {
 
     // Get the currently open document

diff --git a/out/spec.js b/out/spec.js
@@ -419,6 +419,15 @@ function getStanzaType(stanza) {
     return stanzaType
 }
 
+function addDefaultsAndGlobals(settings, defaults) {
+    // Add [default] or [global] settings to a stanza if they do not already exist
+    for(let i=0; i < defaults.length; i++) {
+        if(!settings.find(o => o.name === defaults[i].name && o.value === defaults[i].value)) {
+            settings.push(defaults[i])
+        }
+    }
+}
+
 function getStanzaSettings(specConfig, stanzaName) {
     // Given a stanzaName, return its settings
     // Stanzas could follow one of these syntaxes:
@@ -439,6 +448,7 @@ function getStanzaSettings(specConfig, stanzaName) {
     }
 
     let defaultSettings = getStanzaSettingsByStanzaName(specConfig, "[default]")
+    let globalSettings = getStanzaSettingsByStanzaName(specConfig, "[global]")
     let stanzaType = getStanzaType(stanzaName)
     if((stanzaName == "[default]") && (!specConfig.allowsFreeformStanzas)) { return defaultSettings }
 
@@ -465,6 +475,7 @@ function getStanzaSettings(specConfig, stanzaName) {
 
             if(settings) {
                 settings.push(...defaultSettings)
+                addDefaultsAndGlobals(settings, globalSettings)
                 return settings
             }
             break

diff --git a/package.json b/package.json
@@ -75,6 +75,9 @@
                 ]
             }
         ],
+        "capabilities": {
+            "hoverProvider": "true"
+        },
         "grammars": [
             {
                 "language": "splunk",
@@ -218,6 +221,13 @@
                     "default": true,
                     "order": 14,
                     "description": "[SPL2] Automatically update to the latest version of the SPL2 language server."
+                },
+                "splunk.showDocumentationOnHover": {
+                    "type": "boolean",
+                    "scope": "machine",
+                    "default": true,
+                    "order": 15,
+                    "description": "Show .conf file documentation when hovering over settings."
                 }
             }
         },