feat(devins-lang): add docs support for built-in command examples #100

phodal · phodal · commit ebacccd26177 · 2024-03-28T15:05:37.000+08:00
diff --git a/exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/documentation/DevInsDocumentationProvider.kt b/exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/documentation/DevInsDocumentationProvider.kt
@@ -24,8 +24,11 @@ class DevInsDocumentationProvider : AbstractDocumentationProvider() {
             }
 
             DevInTypes.COMMAND_ID -> {
-                BuiltinCommand.all().find { it.commandName == element.text }?.description
+                val command = BuiltinCommand.all().find { it.commandName == element.text } ?: return null
+                val example = BuiltinCommand.example(command)
+                "${command.description}\n\nExample:\n```devin\n$example\n```\n"
             }
+
             DevInTypes.VARIABLE_ID -> {
                 CustomVariable.all().find { it.variable == element.text }?.description
             }

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,11 @@ class DevInsDocumentationProvider : AbstractDocumentationProvider() {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`DevInTypes.COMMAND_ID -> {`
`27`		`- BuiltinCommand.all().find { it.commandName == element.text }?.description`
	`27`	`+ val command = BuiltinCommand.all().find { it.commandName == element.text } ?: return null`
	`28`	`+ val example = BuiltinCommand.example(command)`
	`29`	+ "${command.description}\n\nExample:\n```devin\n$example\n```\n"
`28`	`30`	`}`
	`31`	`+`
`29`	`32`	`DevInTypes.VARIABLE_ID -> {`
`30`	`33`	`CustomVariable.all().find { it.variable == element.text }?.description`
`31`	`34`	`}`