Support comment for RawValues (#127)

* adding comment support for rawValues handler Signed-off-by: GitHub <[email protected]> * fix vendor Signed-off-by: GitHub <[email protected]> --------- Signed-off-by: GitHub <[email protected]>
mercari · Jul 23, 2024 · ec532a0 · ec532a0
1 parent fd745ac
commit ec532a0
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/hcledit_test.go b/hcledit_test.go
@@ -176,6 +176,26 @@ object1 = {
     attribute1 = "str1"
   }
 }
+`,
+		},
+
+		"Raw with Comment": {
+			input: `
+`,
+			query: "object1",
+			opts:  []hcledit.Option{hcledit.WithComment("# test comment for raw")},
+			value: hcledit.RawVal(`{
+  object2 = {
+    attribute1 = "str1"
+  }
+}`),
+			want: `
+# test comment for raw
+object1 = {
+  object2 = {
+    attribute1 = "str1"
+  }
+}
 `,
 		},
 	}

diff --git a/internal/handler/handler.go b/internal/handler/handler.go
@@ -20,7 +20,7 @@ func New(input interface{}, comment, afterKey string, beforeNewline bool) (Handl
 	case *BlockVal:
 		return newBlockHandler(v.Labels, comment)
 	case *RawVal:
-		return newRawHandler(v.RawString)
+		return newRawHandler(v.RawString, comment, beforeNewline)
 	}
 
 	ctyType, err := gocty.ImpliedType(input)

diff --git a/internal/handler/raw.go b/internal/handler/raw.go
@@ -13,9 +13,10 @@ type RawVal struct {
 
 type rawHandler struct {
 	rawTokens hclwrite.Tokens
+	beforeTokens hclwrite.Tokens
 }
 
-func newRawHandler(rawString string) (Handler, error) {
+func newRawHandler(rawString, comment string, beforeNewline bool) (Handler, error) {
 	return &rawHandler{
 		// NOTE(tcnksm):
 		rawTokens: hclwrite.Tokens{
@@ -24,11 +25,17 @@ func newRawHandler(rawString string) (Handler, error) {
 				Bytes: []byte(rawString),
 			},
 		},
+		beforeTokens: beforeTokens(comment, beforeNewline),
 	}, nil
 }
 
 func (h *rawHandler) HandleBody(body *hclwrite.Body, name string, _ []string) error {
 	body.SetAttributeRaw(name, h.rawTokens)
+	if len(h.beforeTokens) > 0 {
+		tokens := body.GetAttribute(name).BuildTokens(h.beforeTokens)
+		body.RemoveAttribute(name)
+		body.AppendUnstructuredTokens(tokens)
+	}
 	return nil
 }