feat: doc gen html escape for default value (#218)

Signed-off-by: peefy <[email protected]>
kcl-lang · Jan 24, 2024 · 771f644 · 771f644
1 parent ba06a22
commit 771f644
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/pkg/tools/gen/templates/doc/schemaDoc.gotmpl b/pkg/tools/gen/templates/doc/schemaDoc.gotmpl
@@ -10,7 +10,7 @@
 
 | name | type | description | default value |
 | --- | --- | --- | --- |
-{{range $name, $property := $Data.Properties}}|**{{$name}}**{{if containsString $Data.Required $name }} `required`{{end}}{{if $property.ReadOnly}} `readOnly`{{end}}|{{kclType $property $EscapeHtml}}|{{if ne $property.Description ""}}{{escapeHtml $property.Description $EscapeHtml}}{{end}}|{{$property.Default}}|
+{{range $name, $property := $Data.Properties}}|**{{$name}}**{{if containsString $Data.Required $name }} `required`{{end}}{{if $property.ReadOnly}} `readOnly`{{end}}|{{kclType $property $EscapeHtml}}|{{if ne $property.Description ""}}{{escapeHtml $property.Description $EscapeHtml}}{{end}}|{{escapeHtml $property.Default $EscapeHtml}}|
 {{end}}{{if ne (len $Data.Examples) 0}}#### Examples
 
 {{range $name, $example := $Data.Examples}}{{if $example.Summary}}**$example.Summary**

diff --git a/pkg/tools/gen/testdata/doc/pkg/container.k b/pkg/tools/gen/testdata/doc/pkg/container.k
@@ -8,3 +8,4 @@ schema Container:
         The name of the long-running container.
     """
     name: str
+    image: str
diff --git a/pkg/tools/gen/testdata/doc/pkg/md/main.md b/pkg/tools/gen/testdata/doc/pkg/md/main.md
@@ -19,6 +19,7 @@ Container is the common user interface for long-running services.
 
 | name | type | description | default value |
 | --- | --- | --- | --- |
+|**image** `required`|str|||
 |**name** `required`|str|The name of the long-running container.||
 ### Server
 
@@ -40,7 +41,7 @@ Server is the common user interface for long-running services adopting the best
 |**litFloat** `required` `readOnly`|1.11||1.11|
 |**litInt** `required` `readOnly`|123||123|
 |**litStr** `required` `readOnly`|"abc"||"abc"|
-|**mainContainer** `required`|[Container](#container)|||
+|**mainContainer** `required`|[Container](#container)||Container {<br />    name = "main"<br />    image = "image"<br />}|
 |**name** `required`|str|A Server-level attribute.<br />The name of the long-running service.<br />See also: kusion_models/core/v1/metadata.k.||
 |**numMultiplier** `required`|units.NumberMultiplier||1M|
 |**others** `required`|any|||

diff --git a/pkg/tools/gen/testdata/doc/pkg/server.k b/pkg/tools/gen/testdata/doc/pkg/server.k
@@ -35,7 +35,10 @@ schema Server:
     age: int
     height: float
     port: int | str
-    mainContainer: Container
+    mainContainer: Container = Container {
+        name = "main"
+        image = "image"
+    }
     antiSelf: bool
     others: any
     litStr: "abc"