mirror of
https://github.com/mikefarah/yq.git
synced 2026-06-30 09:11:40 +00:00
feat(toml): fix JSON to TOML root scope and null handling (#2689)
Ensure root-level TOML attributes are emitted before table sections so fields like sort remain root-scoped. Skip null-valued object fields during TOML encoding
instead of converting them to empty strings.
This commit is contained in:
parent
e9acb9b734
commit
fcb79822dd
@ -132,12 +132,23 @@ func (te *tomlEncoder) encodeRootMapping(w io.Writer, node *CandidateNode) error
|
||||
}
|
||||
}
|
||||
|
||||
// Preserve existing order by iterating Content
|
||||
for i := 0; i < len(node.Content); i += 2 {
|
||||
keyNode := node.Content[i]
|
||||
valNode := node.Content[i+1]
|
||||
if err := te.encodeTopLevelEntry(w, []string{keyNode.Value}, valNode); err != nil {
|
||||
return err
|
||||
if isTomlAttribute(valNode) {
|
||||
if err := te.encodeTopLevelEntry(w, []string{keyNode.Value}, valNode); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for i := 0; i < len(node.Content); i += 2 {
|
||||
keyNode := node.Content[i]
|
||||
valNode := node.Content[i+1]
|
||||
if !isTomlAttribute(valNode) {
|
||||
if err := te.encodeTopLevelEntry(w, []string{keyNode.Value}, valNode); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
@ -170,8 +181,13 @@ func (te *tomlEncoder) encodeTopLevelEntry(w io.Writer, path []string, node *Can
|
||||
if allMaps {
|
||||
key := path[len(path)-1]
|
||||
quotedKey := tomlKey(key)
|
||||
if te.wroteRootAttr {
|
||||
if _, err := w.Write([]byte("\n")); err != nil {
|
||||
return err
|
||||
}
|
||||
te.wroteRootAttr = false
|
||||
}
|
||||
for _, it := range node.Content {
|
||||
// [[key]] then body
|
||||
if _, err := w.Write([]byte("[[" + quotedKey + "]]\n")); err != nil {
|
||||
return err
|
||||
}
|
||||
@ -210,7 +226,18 @@ func isTomlArrayOfTables(seq *CandidateNode) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
func isTomlAttribute(node *CandidateNode) bool {
|
||||
if node.Kind == ScalarNode {
|
||||
return true
|
||||
}
|
||||
return node.Kind == SequenceNode && !isTomlArrayOfTables(node)
|
||||
}
|
||||
|
||||
func (te *tomlEncoder) writeAttribute(w io.Writer, key string, value *CandidateNode) error {
|
||||
if value.Tag == "!!null" {
|
||||
return nil
|
||||
}
|
||||
|
||||
te.wroteRootAttr = true // Mark that we wrote a root attribute
|
||||
|
||||
// Write head comment before the attribute
|
||||
@ -406,6 +433,9 @@ func (te *tomlEncoder) mappingToInlineTable(m *CandidateNode) (string, error) {
|
||||
v := m.Content[i+1]
|
||||
switch v.Kind {
|
||||
case ScalarNode:
|
||||
if v.Tag == "!!null" {
|
||||
continue
|
||||
}
|
||||
parts = append(parts, fmt.Sprintf("%s = %s", tomlKey(k), te.formatScalar(v)))
|
||||
case SequenceNode:
|
||||
// inline array in inline table
|
||||
@ -468,7 +498,7 @@ func (te *tomlEncoder) encodeSeparateMapping(w io.Writer, path []string, m *Cand
|
||||
hasAttrs := false
|
||||
for i := 0; i < len(m.Content); i += 2 {
|
||||
v := m.Content[i+1]
|
||||
if v.Kind == ScalarNode {
|
||||
if v.Kind == ScalarNode && v.Tag != "!!null" {
|
||||
hasAttrs = true
|
||||
break
|
||||
}
|
||||
@ -509,6 +539,12 @@ func (te *tomlEncoder) encodeSeparateMapping(w io.Writer, path []string, m *Cand
|
||||
// If sequence of maps, emit [[path.k]] per element
|
||||
if isTomlArrayOfTables(v) {
|
||||
key := tomlDottedKey(append(append([]string{}, path...), k))
|
||||
if te.wroteRootAttr {
|
||||
if _, err := w.Write([]byte("\n")); err != nil {
|
||||
return err
|
||||
}
|
||||
te.wroteRootAttr = false
|
||||
}
|
||||
for _, it := range v.Content {
|
||||
if _, err := w.Write([]byte("[[" + key + "]]\n")); err != nil {
|
||||
return err
|
||||
|
||||
@ -892,6 +892,60 @@ func TestTomlScenarios(t *testing.T) {
|
||||
documentScenarios(t, "usage", "toml", genericScenarios, documentTomlScenario)
|
||||
}
|
||||
|
||||
func TestTomlEncodeJsonKeepsRootArrayBeforeTables(t *testing.T) {
|
||||
scenario := formatScenario{
|
||||
description: "Encode: JSON root array stays outside later tables",
|
||||
input: `{
|
||||
"_source": {
|
||||
"cookie": [
|
||||
{
|
||||
"Domain": "",
|
||||
"Expires": "0001-01-01T00:00:00Z",
|
||||
"HttpOnly": false,
|
||||
"MaxAge": 0,
|
||||
"Name": "name",
|
||||
"Path": "",
|
||||
"Raw": "",
|
||||
"RawExpires": "",
|
||||
"SameSite": 0,
|
||||
"Secure": false,
|
||||
"Unparsed": null,
|
||||
"Value": "value"
|
||||
}
|
||||
]
|
||||
},
|
||||
"highlight": {
|
||||
"did": [
|
||||
"did"
|
||||
]
|
||||
},
|
||||
"sort": [
|
||||
1
|
||||
]
|
||||
}`,
|
||||
expected: `sort = [1]
|
||||
|
||||
[[_source.cookie]]
|
||||
Domain = ""
|
||||
Expires = "0001-01-01T00:00:00Z"
|
||||
HttpOnly = false
|
||||
MaxAge = 0
|
||||
Name = "name"
|
||||
Path = ""
|
||||
Raw = ""
|
||||
RawExpires = ""
|
||||
SameSite = 0
|
||||
Secure = false
|
||||
Value = "value"
|
||||
|
||||
[highlight]
|
||||
did = ["did"]
|
||||
`,
|
||||
}
|
||||
|
||||
test.AssertResultWithContext(t, scenario.expected, mustProcessFormatScenario(scenario, NewJSONDecoder(), NewTomlEncoder()), scenario.description)
|
||||
}
|
||||
|
||||
// TestTomlColourization tests that colourization correctly distinguishes
|
||||
// between table section headers and inline arrays
|
||||
func TestTomlColourization(t *testing.T) {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user