Add Comments to Yaml

[Articdive]

I'm aware of SnakeYaml not supporting comments during the parse, however since you have your own yaml writer you can definitely support outputting comments, you would just need to bridge the YamlCommentedConfiguration's comment Map to your Writer and then when writing line for line, check if it's a node, if it is a node, add said comment for said node. Obviously you also need to calculate things such as Whitespace e.t.c and it wouldn't be the easiest solution, but it would allow for Comment output on Yaml

[Articdive]

A proof of concept would be here in the save() method.

[TheElectronWill]

Actually my "yaml writer" only exists to unwrap Config to Map<String, Object>. It then gives everything to snakeyaml, which does the real writing.

Supporting comments in yaml would indeed be very nice, both in reading and writing. However that would require more work and isn't a top priority, I'll add it to the backlog.

[Articdive]

I created my own custom implementation of this, if you are interested I can also PR it, however It's not the most efficient code and I'm nearly positive it can be improved.

[TheElectronWill]

Yep I'm interested. I would have liked to be able to read and write comments in order to preserve the configs but just writing comments is better than nothing :smiley:

[Articdive]

Yep I'm interested. I would have liked to be able to read and write comments in order to preserve the configs but just writing comments is better than nothing 😃

https://github.com/Articdive/EnumToConfiguration/tree/master/src/main/java/de/articdive/enum_to_configuration/yaml

[ArcheCraft]

Is this still being considered?

[TheElectronWill]

It is, but it won't be ready before several months because it requires some work. I know the snakeyaml's limitation is problematic.

[maurxce]

Any updates on this?

[TheElectronWill]

Not yet, I would have to write a new yaml parser :sweat_smile: