Is there an example of using parseDocument to update the values in a yaml and then convert it back to a yaml string while preserving comments?

[tyler-dunkel]

Hi! Thank you so much for your work on this library. I am wondering if there are any code examples for doing the following (which I imagine is a fairly typical usecase)

1. take existing yaml file
2. convert its values to json so that new values can be added or existing values updated
3. convert it back to a yaml file while maintaining the comments from the original yaml file.

I saw this lib: https://github.com/paul-soporan/enhanced-yaml is doing something similar but with a much older version of the library and using certain exports that are no longer available like createNode.

Thanks!

[tyler-dunkel]

Nvm I figured this out. If anyone else wants an example here ya go:

import * as YAML from "yaml";

const yamlString = `
# values is a required top-level key
values:
  example:
    setting: changeme
  example2:
    setting: test
  example3:
    setting: changeagain
    setting2: changingit
  # ---------------------------------------------------------------------------------------
  # Big blcok comment
  # ---------------------------------------------------------------------------------------

  # Some other comment
  otherVars:
    EXAMPLE_SETTING: mytestval
  # some comment
  someConfig:
    example: mytestval
`;

const out = YAML.parseDocument(yamlString);
const edited = {
  values: {
    example: { setting: "newValue" },
    example2: { setting: "example.newSetting" },
    example3: { setting: "changeagain", setting2: "changingit" },
    otherVars: { EXAMPLE_SETTING: "example.setting" },
    someConfig: { example: "example.setting" },
    newKey: { test: "hello" },
  },
  otherKey: {
    test: 'hello'
  }
};

function update(obj, updates, path = []) {
  for (const [key, value] of Object.entries(updates)) {
      if (typeof value === 'object' && !Array.isArray(value) && value !== null) {
          if (!obj.getIn([...path, key])) {
            obj.setIn([...path, key], value)
          } else {
            update(obj, value, path.concat(key));
          }
      } else {
          obj.setIn([...path, key], value);
      }
  }
}

update(out, edited)

console.log(out.toJSON());

console.log('-----------')

console.log(out.toString())