render godocs from parsed comments (#57)

* render godocs from parsed comments * update examples with comments
webrpc · Mar 11, 2024 · 3f1f017 · 3f1f017
1 parent d2cd495
commit 3f1f017
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 17 deletions.
diff --git a/_examples/golang-basics/example.gen.go b/_examples/golang-basics/example.gen.go
diff --git a/_examples/golang-basics/example.ridl b/_examples/golang-basics/example.ridl
@@ -4,15 +4,22 @@ name = example          # name of your backend app
 version = v0.0.1        # version of your schema
 
 
+# user role
+# which defines which type of operations user can do
 enum Kind: uint32
-  - USER
+  - USER # user can only see number of transactions
+    # admin permissions
+    # can manage transactions
+    # revert transactions
+    # see analytics dashboard
   - ADMIN
 
 enum Intent: string
   - openSession
   - closeSession
   - validateSession
 
+# Defines users within out wallet app
 struct User
   - id: uint64
     + go.field.name = ID
@@ -23,7 +30,8 @@ struct User
     + go.field.type = uuid.UUID
     + go.type.import = github.com/google/uuid
 
-  - username: string
+  # unique identifier of the user
+  - username: string # must be unique !
     + json = USERNAME
     + go.tag.db = username
 

diff --git a/_examples/golang-imports/api.gen.go b/_examples/golang-imports/api.gen.go
diff --git a/enum.go.tmpl b/enum.go.tmpl
@@ -10,8 +10,13 @@ type {{$name}} {{$type}}
 {{- end }}
 
 const (
-{{- range $fields}}
-	{{$name}}_{{.Name}} {{$name}} = {{.Value}}
+{{- range $_, $field := $fields }}
+	{{- if gt (len $field.Comments) 0 -}}
+		{{- range $_, $comment := $field.Comments }}
+			// {{ replaceAll $comment "\"" "'" }}
+		{{- end }}
+	{{- end }}
+	{{$name}}_{{.Name}} {{$name}} = {{$field.Value}}
 {{- end}}
 )
 

diff --git a/field.go.tmpl b/field.go.tmpl
@@ -48,7 +48,6 @@
     []{{template "field" dict "Name" $name "Type" (listElemType $type) "TypeMap" $typeMap "TypePrefix" $typePrefix "TypeMeta" $typeMeta}}
 
 {{- else if isCoreType $type -}}
-
     {{if $optional}}*{{end}}{{ get $typeMap $type }}
 
 {{- else -}}{{- /* structs */ -}}

diff --git a/struct.go.tmpl b/struct.go.tmpl
@@ -6,8 +6,13 @@
 {{- $typePrefix := .TypePrefix -}}
 
 type {{$name}} struct {
-{{range $_, $field := $fields -}}
-	{{template "field" dict "Name" $field.Name "PrintName" true "Type" $field.Type "Optional" $field.Optional "TypeMap" $typeMap "TypePrefix" $typePrefix "TypeMeta" $field.Meta "JsonTags" true "StructTags" true}}
-{{end -}}
+{{- range $_, $field := $fields -}}
+	{{- if gt (len $field.Comments) 0 -}}
+		{{- range $_, $comment := $field.Comments }}
+			// {{ replaceAll $comment "\"" "'" }}
+		{{- end }}
+	{{- end }}
+	{{template "field" dict "Name" $field.Name "PrintName" true "Type" $field.Type "Optional" $field.Optional "TypeMap" $typeMap "TypePrefix" $typePrefix "TypeMeta" $field.Meta "JsonTags" true "StructTags" true }}
+{{- end }}
 }
 {{- end }}
diff --git a/types.go.tmpl b/types.go.tmpl
@@ -20,6 +20,11 @@
 {{ end -}}
 
 {{- if and (eq $type.Kind "struct") $opts.types }}
+{{- if gt (len $type.Comments) 0 }}
+	{{- range $_, $comment := $type.Comments }}
+		// {{ replaceAll $comment "\"" "'" }}
+	{{- end }}
+{{- end }}
 {{template "struct" dict "Name" $type.Name "TypeMap" $typeMap "TypePrefix" $typePrefix "Fields" $type.Fields}}
 {{ end -}}