Documentation for scripts (wip)

daniele-athome · Jan 27, 2025 · f501cbf · f501cbf
1 parent a335f51
commit f501cbf
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/src/main/kotlin/it/casaricci/hass/plugin/documentation/HassDocumentationProvider.kt b/src/main/kotlin/it/casaricci/hass/plugin/documentation/HassDocumentationProvider.kt
@@ -14,10 +14,7 @@ import com.intellij.psi.PsiElement
 import com.intellij.psi.util.childrenOfType
 import com.intellij.refactoring.suggested.createSmartPointer
 import com.intellij.util.TextWithIcon
-import it.casaricci.hass.plugin.HassKnownDomains
-import it.casaricci.hass.plugin.entityId
-import it.casaricci.hass.plugin.isActionCall
-import it.casaricci.hass.plugin.isHassConfigFile
+import it.casaricci.hass.plugin.*
 import it.casaricci.hass.plugin.services.getDomainNameFromActionName
 import org.jetbrains.yaml.psi.YAMLKeyValue
 import org.jetbrains.yaml.psi.YAMLMapping
@@ -29,9 +26,8 @@ class HassDocumentationProvider : PsiDocumentationTargetProvider {
     /**
      * This part of the API is not really well documented yet - I guess because it's relatively new.
      * This method is called in various situations and I didn't really knew how to detect each situation but by
-     * reverse-engineering the method arguments. The current code seems to handle all (2+1) situations well - for now.
+     * reverse-engineering the method arguments. The current code seems to handle all (3+1) situations well - for now.
      */
-    // TODO handle quick documentation on script itself
     override fun documentationTarget(element: PsiElement, originalElement: PsiElement?): DocumentationTarget? {
         // we still don't know when originalElement could be null, better safe than sorry
         if (originalElement == null) {
@@ -41,7 +37,8 @@ class HassDocumentationProvider : PsiDocumentationTargetProvider {
         // documentation request coming from a Home Assistant YAML file
         if (isHassConfigFile(originalElement)) {
             // documentation request coming from an action call
-            if (originalElement.parent is YAMLScalar && isActionCall(originalElement.parent as YAMLScalar)) {
+            if ((originalElement.parent is YAMLScalar && isActionCall(originalElement.parent as YAMLScalar) ||
+                        isScriptDefinition(originalElement.parent))) {
                 val resolveReference: Boolean
 
                 // documentation request from a code completion popup
@@ -54,6 +51,11 @@ class HassDocumentationProvider : PsiDocumentationTargetProvider {
                     resolveReference = true
                     element.parent
                 }
+                // documentation request on the entity definition
+                else if (element.parent is YAMLKeyValue) {
+                    resolveReference = false
+                    element.parent
+                }
                 // unhandled case?
                 else {
                     resolveReference = false

diff --git a/src/main/kotlin/it/casaricci/hass/plugin/findUsages/HassScriptFindUsagesProvider.kt b/src/main/kotlin/it/casaricci/hass/plugin/findUsages/HassScriptFindUsagesProvider.kt
@@ -5,6 +5,7 @@ import com.intellij.lang.findUsages.FindUsagesProvider
 import com.intellij.psi.PsiElement
 import it.casaricci.hass.plugin.HassKnownDomains
 import it.casaricci.hass.plugin.MyBundle
+import it.casaricci.hass.plugin.isScriptDefinition
 import org.jetbrains.yaml.YAMLWordsScanner
 import org.jetbrains.yaml.psi.YAMLKeyValue
 
@@ -43,7 +44,5 @@ class HassScriptFindUsagesProvider : FindUsagesProvider {
         return ""
     }
 
-    private fun isMyElement(element: PsiElement): Boolean = element is YAMLKeyValue &&
-            element.parent.parent is YAMLKeyValue &&
-            (element.parent.parent as YAMLKeyValue).keyText == HassKnownDomains.SCRIPT
+    private fun isMyElement(element: PsiElement): Boolean = isScriptDefinition(element)
 }
diff --git a/src/main/kotlin/it/casaricci/hass/plugin/utils.kt b/src/main/kotlin/it/casaricci/hass/plugin/utils.kt
@@ -49,6 +49,12 @@ fun isActionCall(element: YAMLScalar): Boolean {
                     (element.parent as YAMLKeyValue).keyText == "service")
 }
 
+fun isScriptDefinition(element: PsiElement): Boolean {
+    return element is YAMLKeyValue &&
+            element.parentMapping?.parent is YAMLKeyValue &&
+            (element.parentMapping?.parent as YAMLKeyValue).keyText == HassKnownDomains.SCRIPT
+}
+
 /**
  * An [InputStream] that updates a [ProgressIndicator] while being read.
  * To be used with [com.intellij.util.io.HttpRequests], handles also [CountingGZIPInputStream] for compressed streams.