Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enhance: doc gen: display attributes in table #174

Merged
merged 1 commit into from
Oct 27, 2023
Merged

enhance: doc gen: display attributes in table #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pkg/tools/gen/gendoc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,8 @@ func funcMap() template.FuncMap {
}
return false
},
"kclType": func(tpe KclOpenAPIType) string {
return tpe.GetKclTypeName(false, true)
"kclType": func(tpe KclOpenAPIType, escapeHtml bool) string {
return tpe.GetKclTypeName(false, true, escapeHtml)
},
"fullTypeName": func(tpe KclOpenAPIType) string {
if tpe.KclExtensions.XKclModelType.Import.Package != "" {
Expand All @@ -186,8 +186,11 @@ func funcMap() template.FuncMap {
"escapeHtml": func(original string, escapeHtml bool) string {
// escape html symbols if needed
if escapeHtml {
return htmlTmpl.HTMLEscapeString(original)
original = htmlTmpl.HTMLEscapeString(original)
}
original = strings.Replace(original, "|", "\\|", -1)
original = strings.Replace(original, "\n", "<br />", -1)
original = strings.Replace(original, "&#34;", "\"", -1)
return original
},
"arr": func(els ...any) []any {
Expand Down
15 changes: 10 additions & 5 deletions pkg/tools/gen/genopenapi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package gen

import (
"fmt"
htmlTmpl "html/template"
kpm "kcl-lang.io/kpm/pkg/api"

"os"
Expand Down Expand Up @@ -175,7 +176,7 @@ type XKclDecorators struct {
}

// GetKclTypeName get the string representation of a KclOpenAPIType
func (tpe *KclOpenAPIType) GetKclTypeName(omitAny bool, addLink bool) string {
func (tpe *KclOpenAPIType) GetKclTypeName(omitAny bool, addLink bool, escapeHtml bool) string {
if tpe.Ref != "" {
schemaId := Ref2SchemaId(tpe.Ref)
schemaName := schemaId[strings.LastIndex(schemaId, ".")+1:]
Expand Down Expand Up @@ -219,22 +220,26 @@ func (tpe *KclOpenAPIType) GetKclTypeName(omitAny bool, addLink bool) string {
}
return typBool
case Array:
return fmt.Sprintf("[%s]", tpe.Items.GetKclTypeName(true, addLink))
return fmt.Sprintf("[%s]", tpe.Items.GetKclTypeName(true, addLink, escapeHtml))
case Object:
if tpe.AdditionalProperties != nil {
// dict type
if tpe.KclExtensions.XKclDictKeyType.isAnyType() && tpe.AdditionalProperties.isAnyType() {
return "{}"
}
return fmt.Sprintf("{%s:%s}", tpe.KclExtensions.XKclDictKeyType.GetKclTypeName(true, addLink), tpe.AdditionalProperties.GetKclTypeName(true, addLink))
return fmt.Sprintf("{%s:%s}", tpe.KclExtensions.XKclDictKeyType.GetKclTypeName(true, addLink, escapeHtml), tpe.AdditionalProperties.GetKclTypeName(true, addLink, escapeHtml))
}
if tpe.KclExtensions != nil && len(tpe.KclExtensions.XKclUnionTypes) > 0 {
// union type
tpes := make([]string, len(tpe.KclExtensions.XKclUnionTypes))
for i, unionType := range tpe.KclExtensions.XKclUnionTypes {
tpes[i] = unionType.GetKclTypeName(true, addLink)
tpes[i] = unionType.GetKclTypeName(true, addLink, escapeHtml)
}
if escapeHtml {
return strings.Join(tpes, htmlTmpl.HTMLEscapeString(" \\| "))
} else {
return strings.Join(tpes, " | ")
}
return strings.Join(tpes, " | ")
}
if tpe.isAnyType() {
if omitAny {
Expand Down
9 changes: 3 additions & 6 deletions pkg/tools/gen/templates/doc/schemaDoc.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@
{{end}}
#### Attributes

{{range $name, $property := $Data.Properties}}**{{$name}}**{{if containsString $Data.Required $name }} *required*{{end}}{{if $property.ReadOnly}} *readOnly*{{end}}

{{kclType $property}}{{if ne $property.Description ""}}

{{escapeHtml $property.Description $EscapeHtml}}{{end}}

| 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}}|
{{end}}{{if ne (len $Data.Examples) 0}}#### Examples

{{range $name, $example := $Data.Examples}}{{if $example.Summary}}**$example.Summary**
Expand Down
19 changes: 7 additions & 12 deletions pkg/tools/gen/testdata/doc/k8s/md/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,15 @@

#### Attributes

**metadata** *required*

str

**podSpec** *required*

any

| name | type | description | default value |
| --- | --- | --- | --- |
|**metadata** `required`|str|||
|**podSpec** `required`|any|||
### PodSpec

#### Attributes

**image** *required*

str

| name | type | description | default value |
| --- | --- | --- | --- |
|**image** `required`|str|||
<!-- Auto generated by kcl-doc tool, please do not edit. -->
142 changes: 32 additions & 110 deletions pkg/tools/gen/testdata/doc/pkg/md/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,110 +17,37 @@ Container is the common user interface for long-running services.

#### Attributes

**name** *required*

str

The name of the long-running container.

| name | type | description | default value |
| --- | --- | --- | --- |
|**name** `required`|str|The name of the long-running container.||
### Server

Server is the common user interface for long-running services adopting the best practice of Kubernetes.

#### Attributes

**age** *required*

int

**antiSelf** *required*

bool

**backendWorkload** *required*

[Deployment](#deployment)

**containers** *required*

[[Container](#container)]

**dictAny** *required*

{str:}

**height** *required*

float

**labels**

{str:str}

A Server-level attribute.
The labels of the long-running service. Contains &lt;key&gt;:&lt;value&gt; pairs.
See also: kusion_models/core/v1/metadata.k.

**listAny** *required*

[]

**litBool** *required* *readOnly*

True

**litFloat** *required* *readOnly*

1.11

**litInt** *required* *readOnly*

123

**litStr** *required* *readOnly*

"abc"

**mainContainer** *required*

[Container](#container)

**name** *required*

str

A Server-level attribute.
The name of the long-running service.
See also: kusion_models/core/v1/metadata.k.

**numMultiplier** *required*

units.NumberMultiplier

**others** *required*

any

**port** *required*

int | str

**union** *required*

"abc" | 123 | True | 1.11 | [Container](#container) | units.NumberMultiplier | 1M

**union2** *required*

"abc" | "def"

**workloadType** *required*

str

Use this attribute to specify which kind of long-running service you want.
Valid values: Deployment, CafeDeployment.
See also: kusion_models/core/v1/workload_metadata.k.

| name | type | description | default value |
| --- | --- | --- | --- |
|**age** `required`|int|||
|**antiSelf** `required`|bool|||
|**backendWorkload** `required`|[Deployment](#deployment)|||
|**containers** `required`|[[Container](#container)]|||
|**dictAny** `required`|{str:}|||
|**height** `required`|float|||
|**labels**|{str:str}|A Server-level attribute.<br />The labels of the long-running service. Contains &lt;key&gt;:&lt;value&gt; pairs.<br />See also: kusion_models/core/v1/metadata.k.||
|**listAny** `required`|[]|||
|**litBool** `required` `readOnly`|True||True|
|**litFloat** `required` `readOnly`|1.11||1.11|
|**litInt** `required` `readOnly`|123||123|
|**litStr** `required` `readOnly`|"abc"||"abc"|
|**mainContainer** `required`|[Container](#container)|||
|**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|||
|**port** `required`|int \| str|||
|**union** `required`|"abc" \| 123 \| True \| 1.11 \| [Container](#container) \| units.NumberMultiplier \| 1M|||
|**union2** `required`|"abc" \| "def"||"abc"|
|**workloadType** `required`|str|Use this attribute to specify which kind of long-running service you want.<br />Valid values: Deployment, CafeDeployment.<br />See also: kusion_models/core/v1/workload_metadata.k.|"Deployment"|
#### Examples

```
Expand All @@ -133,20 +60,15 @@ myCustomApp = AppConfiguration {

#### Attributes

**metadata** *required*

str

**podSpec** *required*

[PodSpec](#podspec)

| name | type | description | default value |
| --- | --- | --- | --- |
|**metadata** `required`|str|||
|**podSpec** `required`|[PodSpec](#podspec)|||
### PodSpec

#### Attributes

**image** *required*

str

| name | type | description | default value |
| --- | --- | --- | --- |
|**image** `required`|str|||
<!-- Auto generated by kcl-doc tool, please do not edit. -->
21 changes: 9 additions & 12 deletions pkg/tools/gen/testdata/doc/reimport/md/main.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,21 @@

#### Attributes

**attr** *required*

[Deployment](#deployment)

| name | type | description | default value |
| --- | --- | --- | --- |
|**attr** `required`|[Deployment](#deployment)|||
### B

#### Attributes

**attr** *required*

[Deployment](#deployment)

| name | type | description | default value |
| --- | --- | --- | --- |
|**attr** `required`|[Deployment](#deployment)|||
### Deployment

#### Attributes

**metadata** *required*

str

| name | type | description | default value |
| --- | --- | --- | --- |
|**metadata** `required`|str|||
<!-- Auto generated by kcl-doc tool, please do not edit. -->
Loading