technofab/docsonnet
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/docsonnet.git synced 2026-02-02 07:35:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(render): argument formatting

Browse source 
Printed go internals previously, now works properly with Jsonnet representation
This commit is contained in:
sh0rez 2020-05-13 12:30:05 +02:00
parent 66a158a8f2
commit 0d8cf83b56
No known key found for this signature in database
GPG key ID: 87C71DF9F8181FF1
3 changed files with 62 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

56
pkg/render/render.go
View file

@ -1,11 +1,13 @@
package render
import (
"encoding/json"
"fmt"
"path"
"sort"
"strings"
"github.com/google/go-jsonnet/formatter"
"github.com/sh0rez/docsonnet/pkg/docsonnet"
"github.com/sh0rez/docsonnet/pkg/md"
"github.com/sh0rez/docsonnet/pkg/slug"
@ -24,6 +26,9 @@ func render(pkg docsonnet.Package, parents []string, root bool, urlPrefix string
if root {
link = path.Join("/", urlPrefix)
}
if !strings.HasSuffix(link, "/") {
link = link + "/"
}
// head
elems := []md.Elem{
@ -146,20 +151,37 @@ func renderApi(api docsonnet.Fields, path string) []md.Elem {
}
func sortFields(api docsonnet.Fields) []string {
keys := make([]string, len(api))
keys := make([]string, 0, len(api))
for k := range api {
keys = append(keys, k)
}
aFn := func(a, b string) bool {
return api[a].Function != nil && api[b].Function == nil
}
aNew := func(a, b string) bool {
a = strings.ToLower(a)
b = strings.ToLower(b)
return strings.HasPrefix(a, "new") && !strings.HasPrefix(b, "new")
}
sort.Slice(keys, func(i, j int) bool {
iK, jK := keys[i], keys[j]
if api[iK].Function != nil && api[jK].Function == nil {
a, b := keys[i], keys[j]
if aNew(a, b) {
return true
}
if api[iK].Function == nil && api[jK].Function != nil {
} else if aNew(b, a) {
return false
}
return iK < jK
if aFn(a, b) {
return true
} else if aFn(b, a) {
return false
}
return a < b
})
return keys
@ -170,10 +192,30 @@ func renderParams(a []docsonnet.Argument) string {
for _, a := range a {
arg := a.Name
if a.Default != nil {
arg = fmt.Sprintf("%s=%v", arg, a.Default)
arg = fmt.Sprintf("%s=%v", arg, jsonParam(a.Default))
}
args = append(args, arg)
}
return strings.Join(args, ", ")
}
func jsonParam(i interface{}) string {
d, err := json.Marshal(i)
if err != nil {
panic(err)
}
s, err := formatter.Format("(jsonParam)", string(d), formatter.Options{
PadObjects: false,
PadArrays: false,
PrettyFieldNames: true,
StringStyle: formatter.StringStyleSingle,
})
if err != nil {
panic(err)
}
return strings.TrimSpace(s)
}