docs: Make null booleans falsy in the docs helper

gohugoio · Jan 31, 2024 · 5161544 · 5161544
1 parent bd66d30
commit 5161544
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/commands/gen.go b/commands/gen.go
@@ -195,7 +195,7 @@ url: %s
 				configProvider := func() docshelper.DocProvider {
 					conf := hugolib.DefaultConfig()
 					conf.CacheDir = "" // The default value does not make sense in the docs.
-					defaultConfig := parser.LowerCaseCamelJSONMarshaller{Value: conf}
+					defaultConfig := parser.NullBoolJSONMarshaller{Wrapped: parser.LowerCaseCamelJSONMarshaller{Value: conf}}
 					return docshelper.DocProvider{"config": defaultConfig}
 				}
 

diff --git a/docs/data/docs.yaml b/docs/data/docs.yaml
@@ -1076,9 +1076,9 @@ config:
         wrapStandAloneImageWithinParagraph: true
       renderHooks:
         image:
-          enableDefault: null
+          enableDefault: false
         link:
-          enableDefault: null
+          enableDefault: false
       renderer:
         hardWraps: false
         unsafe: false

diff --git a/parser/lowercase_camel_json.go b/parser/lowercase_camel_json.go
@@ -25,9 +25,23 @@ import (
 
 // Regexp definitions
 var (
-	keyMatchRegex = regexp.MustCompile(`\"(\w+)\":`)
+	keyMatchRegex       = regexp.MustCompile(`\"(\w+)\":`)
+	nullEnableBoolRegex = regexp.MustCompile(`\"(enable\w+)\":null`)
 )
 
+type NullBoolJSONMarshaller struct {
+	Wrapped json.Marshaler
+}
+
+func (c NullBoolJSONMarshaller) MarshalJSON() ([]byte, error) {
+	b, err := c.Wrapped.MarshalJSON()
+	if err != nil {
+		return nil, err
+	}
+	i := bytes.Index(b, []byte("enableDefault"))
+	return nullEnableBoolRegex.ReplaceAll(b, []byte(`"$1": false`)), nil
+}
+
 // Code adapted from https://gist.github.com/piersy/b9934790a8892db1a603820c0c23e4a7
 type LowerCaseCamelJSONMarshaller struct {
 	Value any