Support option to keep comments from YAML input

[bennycode]

It was brought to my attention that "js-yaml" removes comments from sorted YAML code. I created a little snippet which proves that: https://runkit.com/bennyn/js-yaml-comment

const yaml = require('js-yaml');
const text = `variables:
  MY_VARIABLE: 'true'    # Comment 1
  OTHER_VARIABLE: 'true' # Comment 2
  BEST_VARIABLE: 'true'  # Comment 3
`;
const doc = yaml.load(text, {sortKeys: true});
console.log(yaml.dump(doc));

Output:

"variables:\n  MY_VARIABLE: 'true'\n  OTHER_VARIABLE: 'true'\n  BEST_VARIABLE: 'true'\n"

Is there the possibility to add an option to protect comments?

[perlpunk]

https://github.com/nodeca/js-yaml/issues?q=is%3Aissue+comments+is%3Aclosed
#624
#549
#494

[perlpunk]

You might want to try https://github.com/eemeli/yaml instead

[bennycode]

Thanks for the hint! 👍

Using "yaml" worked:

import {ParsedNode, parseDocument, YAMLMap, YAMLSeq} from 'yaml';

function sortDeep(node: ParsedNode | null): void {
  if (node instanceof YAMLMap) {
    node.items.sort((itemA, itemB) => (itemA.key < itemB.key ? -1 : itemA.key > itemB.key ? 1 : 0));
    node.items.forEach(item => sortDeep(item.value));
  } else if (node instanceof YAMLSeq) {
    node.items.forEach(item => sortDeep(item));
  }
}

const document = parseDocument(yamlString);
sortDeep(document.contents);
console.log(document.toString());

[timestee]

any update on this issue?

as a basic library, "yaml" has more requirements, like: eemeli/yaml#394, it should be compatible with lower node or webpack version.