feat(ext-terminal): add ShellSuggestContext class and documentation #…

…1235

docs/customize/prompt-override.md

@@ -40,4 +40,4 @@ For example, create a file named `prompts/genius/sql/sql-gen-clarify.vm`, will o
 │   └── sql-gen-design.vm
 └── sre
     └── generate-dockerfile.vm
-```
+```

docs/features/shell-suggest.md

@@ -0,0 +1,22 @@
+---
+layout: default
+title: Shell Suggest
+parent: Basic Features
+nav_order: 12
+permalink: /features/refactoring
+---
+
+## Default context
+
+```kotlin
+data class ShellSuggestContext(
+    val question: String,
+    val shellPath: String,
+    val cwd: String,
+    // today's date like 20240322
+    val date: String = SimpleDateFormat("yyyyMMdd").format(Date()),
+    // operating system name
+    val os: String = System.getProperty("os.name")
+)
+```
+

exts/ext-terminal/src/main/kotlin/cc/unitmesh/terminal/ShellCommandSuggestAction.kt

@@ -59,7 +59,8 @@ class ShellCommandSuggestAction : AnAction() {
         val options = TerminalProjectOptionsProvider.getInstance(project)
 
         templateRender.context = ShellSuggestContext(
-            data, options.shellPath, options.startingDirectory
+            data, options.shellPath,
+            options.startingDirectory
                 ?: project.guessProjectDir()?.path ?: System.getProperty("user.home")
         )
         val promptText = templateRender.renderTemplate(template)
@@ -159,4 +160,3 @@ class ShellCommandSuggestAction : AnAction() {
     }
 }
 
-data class ShellSuggestContext(val question: String, val shellPath: String, val cwd: String)

exts/ext-terminal/src/main/kotlin/cc/unitmesh/terminal/ShellSuggestContext.kt

@@ -0,0 +1,14 @@
+package cc.unitmesh.terminal
+
+import java.text.SimpleDateFormat
+import java.util.*
+
+data class ShellSuggestContext(
+    val question: String,
+    val shellPath: String,
+    val cwd: String,
+    // today's date like 20240322
+    val date: String = SimpleDateFormat("yyyyMMdd").format(Date()),
+    // operating system name
+    val os: String = System.getProperty("os.name")
+)