@@ -2,14 +2,13 @@ package jsonschema
22
33import (
44 "bytes"
5- "encoding/json"
65 "errors"
76 "fmt"
87 "os"
98 "strings"
109
11- "github.com/iancoleman/orderedmap"
1210 "github.com/jesseduffield/lazycore/pkg/utils"
11+ "github.com/karimkhaleel/jsonschema"
1312 "github.com/samber/lo"
1413
1514 "gopkg.in/yaml.v3"
@@ -78,13 +77,20 @@ func prepareMarshalledConfig(buffer bytes.Buffer) []byte {
7877}
7978
8079func setComment (yamlNode * yaml.Node , description string ) {
80+ // Filter out lines containing "[dev]"; this allows us to add developer
81+ // documentation to properties that don't get included in the docs
82+ lines := strings .Split (description , "\n " )
83+ lines = lo .Filter (lines , func (s string , _ int ) bool {
84+ return ! strings .Contains (s , "[dev]" )
85+ })
86+
8187 // Workaround for the way yaml formats the HeadComment if it contains
8288 // blank lines: it renders these without a leading "#", but we want a
8389 // leading "#" even on blank lines. However, yaml respects it if the
8490 // HeadComment already contains a leading "#", so we prefix all lines
8591 // (including blank ones) with "#".
8692 yamlNode .HeadComment = strings .Join (
87- lo .Map (strings . Split ( description , " \n " ) , func (s string , _ int ) string {
93+ lo .Map (lines , func (s string , _ int ) string {
8894 if s == "" {
8995 return "#" // avoid trailing space on blank lines
9096 }
@@ -106,16 +112,7 @@ func (n *Node) MarshalYAML() (interface{}, error) {
106112 setComment (& keyNode , n .Description )
107113 }
108114
109- if n .Default != nil {
110- valueNode := yaml.Node {
111- Kind : yaml .ScalarNode ,
112- }
113- err := valueNode .Encode (n .Default )
114- if err != nil {
115- return nil , err
116- }
117- node .Content = append (node .Content , & keyNode , & valueNode )
118- } else if len (n .Children ) > 0 {
115+ if len (n .Children ) > 0 {
119116 childrenNode := yaml.Node {
120117 Kind : yaml .MappingNode ,
121118 }
@@ -136,60 +133,18 @@ func (n *Node) MarshalYAML() (interface{}, error) {
136133 childrenNode .Content = append (childrenNode .Content , childYaml .(* yaml.Node ).Content ... )
137134 }
138135 node .Content = append (node .Content , & keyNode , & childrenNode )
139- }
140-
141- return & node , nil
142- }
143-
144- func getDescription (v * orderedmap.OrderedMap ) string {
145- description , ok := v .Get ("description" )
146- if ! ok {
147- description = ""
148- }
149- return description .(string )
150- }
151-
152- func getDefault (v * orderedmap.OrderedMap ) (error , any ) {
153- defaultValue , ok := v .Get ("default" )
154- if ok {
155- return nil , defaultValue
156- }
157-
158- dataType , ok := v .Get ("type" )
159- if ok {
160- dataTypeString := dataType .(string )
161- if dataTypeString == "string" {
162- return nil , ""
136+ } else {
137+ valueNode := yaml.Node {
138+ Kind : yaml .ScalarNode ,
163139 }
140+ err := valueNode .Encode (n .Default )
141+ if err != nil {
142+ return nil , err
143+ }
144+ node .Content = append (node .Content , & keyNode , & valueNode )
164145 }
165146
166- return errors .New ("Failed to get default value" ), nil
167- }
168-
169- func parseNode (parent * Node , name string , value * orderedmap.OrderedMap ) {
170- description := getDescription (value )
171- err , defaultValue := getDefault (value )
172- if err == nil {
173- leaf := & Node {Name : name , Description : description , Default : defaultValue }
174- parent .Children = append (parent .Children , leaf )
175- }
176-
177- properties , ok := value .Get ("properties" )
178- if ! ok {
179- return
180- }
181-
182- orderedProperties := properties .(orderedmap.OrderedMap )
183-
184- node := & Node {Name : name , Description : description }
185- parent .Children = append (parent .Children , node )
186-
187- keys := orderedProperties .Keys ()
188- for _ , name := range keys {
189- value , _ := orderedProperties .Get (name )
190- typedValue := value .(orderedmap.OrderedMap )
191- parseNode (node , name , & typedValue )
192- }
147+ return & node , nil
193148}
194149
195150func writeToConfigDocs (config []byte ) error {
@@ -222,31 +177,12 @@ func writeToConfigDocs(config []byte) error {
222177 return nil
223178}
224179
225- func GenerateConfigDocs () {
226- content , err := os .ReadFile (GetSchemaDir () + "/config.json" )
227- if err != nil {
228- panic ("Error reading config.json" )
229- }
230-
231- schema := orderedmap .New ()
232-
233- err = json .Unmarshal (content , & schema )
234- if err != nil {
235- panic ("Failed to unmarshal config.json" )
236- }
237-
238- root , ok := schema .Get ("properties" )
239- if ! ok {
240- panic ("properties key not found in schema" )
180+ func GenerateConfigDocs (schema * jsonschema.Schema ) {
181+ rootNode := & Node {
182+ Children : make ([]* Node , 0 ),
241183 }
242- orderedRoot := root .(orderedmap.OrderedMap )
243184
244- rootNode := Node {}
245- for _ , name := range orderedRoot .Keys () {
246- value , _ := orderedRoot .Get (name )
247- typedValue := value .(orderedmap.OrderedMap )
248- parseNode (& rootNode , name , & typedValue )
249- }
185+ recurseOverSchema (schema , schema .Definitions ["UserConfig" ], rootNode )
250186
251187 var buffer bytes.Buffer
252188 encoder := yaml .NewEncoder (& buffer )
@@ -262,8 +198,51 @@ func GenerateConfigDocs() {
262198
263199 config := prepareMarshalledConfig (buffer )
264200
265- err = writeToConfigDocs (config )
201+ err : =writeToConfigDocs (config )
266202 if err != nil {
267203 panic (err )
268204 }
269205}
206+
207+ func recurseOverSchema (rootSchema , schema * jsonschema.Schema , parent * Node ) {
208+ if schema == nil || schema .Properties == nil || schema .Properties .Len () == 0 {
209+ return
210+ }
211+
212+ for pair := schema .Properties .Oldest (); pair != nil ; pair = pair .Next () {
213+ subSchema := getSubSchema (rootSchema , schema , pair .Key )
214+
215+ // Skip empty objects
216+ if subSchema .Type == "object" && subSchema .Properties == nil {
217+ continue
218+ }
219+
220+ // Skip empty arrays
221+ if isZeroValue (subSchema .Default ) && subSchema .Type == "array" {
222+ continue
223+ }
224+
225+ node := Node {
226+ Name : pair .Key ,
227+ Description : subSchema .Description ,
228+ Default : getZeroValue (subSchema .Default , subSchema .Type ),
229+ }
230+ parent .Children = append (parent .Children , & node )
231+ recurseOverSchema (rootSchema , subSchema , & node )
232+ }
233+ }
234+
235+ func getZeroValue (val any , t string ) any {
236+ if ! isZeroValue (val ) {
237+ return val
238+ }
239+
240+ switch t {
241+ case "string" :
242+ return ""
243+ case "boolean" :
244+ return false
245+ default :
246+ return nil
247+ }
248+ }
0 commit comments