editor

package

v0.1.12 Latest Latest Go to latest Published: Feb 12, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package editor provides functionality to edit YAML files while preserving comments.

This section is empty.

This section is empty.

This section is empty.

type YAML struct {
	File file.File
	// contains filtered or unexported fields
}

YAML is a struct that provides methods to edit YAML files while preserving comments.

func New(file file.File) *YAML

New creates a new YAML editor instance with the specified file.

func (y *YAML) Load() error

Load loads the YAML file along with its comments into the editor.

func (y *YAML) Merge(input map[string]any) error

Merge updates the YAML file with the provided map. It reads the existing YAML file, and merges the input map into it.

func (y *YAML) Save() error

Save writes the current data back to the YAML file, preserving comments.

func (y *YAML) Write(input map[string]any) error

Write updates the YAML file with the provided map.