fix: fix a bug that aqua g -i removes comments in packages (#3325)

* fix: fix a bug that aqua g -i removes comments in packages

* fix: fix a lint error

.github/workflows/wc-integration-test.yaml

@@ -84,6 +84,13 @@ jobs:
       - name: output fish completion
         run: aqua completion fish
 
+      - name: Test aqua g -i
+        run: aqua g -i suzuki-shunsuke/[email protected] suzuki-shunsuke/[email protected] suzuki-shunsuke/[email protected]
+        working-directory: tests/insert
+      - name: compare aqua.yaml and expect.yaml
+        run: diff aqua.yaml expect.yaml
+        working-directory: tests/insert
+
       - run: aqua g -i suzuki-shunsuke/tfcmt
         working-directory: tests/main
       - name: add duplicated package

pkg/controller/generate/output/insert.go

@@ -61,30 +61,33 @@ func (o *Outputter) getAppendedTxt(cfgFilePath string, file *ast.File, pkgs []*a
 	return file.String(), nil
 }
 
-func appendPkgsNode(mapValue *ast.MappingValueNode, node ast.Node) error {
-	switch mapValue.Value.Type() {
+func updateASTFile(values *ast.MappingValueNode, pkgs []*aqua.Package) error {
+	node, err := yaml.ValueToNode(pkgs)
+	if err != nil {
+		return fmt.Errorf("convert packages to node: %w", err)
+	}
+
+	switch values.Value.Type() {
 	case ast.NullType:
-		mapValue.Value = node
+		values.Value = node
 		return nil
 	case ast.SequenceType:
-		if err := ast.Merge(mapValue.Value, node); err != nil {
+		if err := ast.Merge(values.Value, node); err != nil {
 			return fmt.Errorf("merge packages: %w", err)
 		}
+		seq, ok := values.Value.(*ast.SequenceNode)
+		if ok {
+			for range pkgs {
+				// https://github.com/goccy/go-yaml/issues/502#issuecomment-2515981600
+				seq.ValueHeadComments = append(seq.ValueHeadComments, nil)
+			}
+		}
 		return nil
 	default:
 		return errors.New("packages must be null or array")
 	}
 }
 
-func updateASTFile(values *ast.MappingValueNode, pkgs []*aqua.Package) error {
-	node, err := yaml.ValueToNode(pkgs)
-	if err != nil {
-		return fmt.Errorf("convert packages to node: %w", err)
-	}
-
-	return appendPkgsNode(values, node)
-}
-
 func (o *Outputter) appendPkgsTxt(cfgFilePath string, pkgs []*aqua.Package) (string, error) {
 	a, err := yaml.Marshal(struct {
 		Packages []*aqua.Package `yaml:"packages"`

tests/insert/aqua.yaml

@@ -0,0 +1,10 @@
+registries:
+  - type: standard
+    ref: v4.267.0 # renovate: depName=aquaproj/aqua-registry
+
+packages:
+  # foo
+  - name: suzuki-shunsuke/[email protected]
+  # hello
+  - name: suzuki-shunsuke/[email protected]
+  - name: suzuki-shunsuke/[email protected]

tests/insert/expect.yaml

@@ -0,0 +1,13 @@
+registries:
+  - type: standard
+    ref: v4.267.0 # renovate: depName=aquaproj/aqua-registry
+
+packages:
+  # foo
+  - name: suzuki-shunsuke/[email protected]
+  # hello
+  - name: suzuki-shunsuke/[email protected]
+  - name: suzuki-shunsuke/[email protected]
+  - name: suzuki-shunsuke/[email protected]
+  - name: suzuki-shunsuke/[email protected]
+  - name: suzuki-shunsuke/[email protected]