docs(intentions): add description for AutoSqlAction

phodal · phodal · commit cdd56d465c80 · 2024-02-27T08:59:41.000+08:00
Add a detailed description for the AutoSqlAction intention.
diff --git a/exts/database/src/main/kotlin/cc/unitmesh/database/actions/AutoSqlAction.kt b/exts/database/src/main/kotlin/cc/unitmesh/database/actions/AutoSqlAction.kt
@@ -26,7 +26,8 @@ class AutoSqlAction : ChatBaseIntention() {
 
     override fun isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean {
         DbPsiFacade.getInstance(project).dataSources.firstOrNull() ?: return false
-        return true
+        val hasSelectionText = editor?.selectionModel?.selectedText
+        return hasSelectionText != null
     }
 
     override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {
diff --git a/src/main/resources/intentionDescriptions/AutoSqlAction/description.html b/src/main/resources/intentionDescriptions/AutoSqlAction/description.html
@@ -0,0 +1,27 @@
+<html>
+<body>
+Write your description here.
+Start the description with a verb in 3rd person singular, like reports, detects, highlights.
+In the first sentence, briefly explain what exactly the inspection helps you detect.
+Make sure the sentence is not very long and complicated.
+<p>
+    The first sentence must be in a dedicated paragraph separated from the rest of the text. This will make the
+    description easier to read.
+    Make sure the description doesn’t just repeat the inspection title.
+</p>
+<p>
+    See https://jetbrains.design/intellij/text/inspections/#descriptions for more information.
+</p>
+<p>
+    Embed code snippets:
+</p>
+<pre><code>
+// automatically highlighted according to inspection registration 'language' attribute
+</code></pre>
+<!-- tooltip end -->
+<p>Text after this comment will only be shown in the settings of the inspection.</p>
+
+<p>To open related settings directly from the description, add a link with `settings://$` optionally followed by `?$` to
+    pre-select a UI element.</p>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,8 @@ class AutoSqlAction : ChatBaseIntention() {`
`26`	`26`
`27`	`27`	`override fun isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean {`
`28`	`28`	`DbPsiFacade.getInstance(project).dataSources.firstOrNull() ?: return false`
`29`		`- return true`
	`29`	`+ val hasSelectionText = editor?.selectionModel?.selectedText`
	`30`	`+ return hasSelectionText != null`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {`