Support for comments

[Weasy666]

Right now, comments are lost when deserializing a YAML file.
Would you consider adding comment support to this library?

There is a open issue for this in yaml-rust: chyh1990/yaml-rust#146
And even a pull request which implements half of it: chyh1990/yaml-rust#181

[zevisert]

Popping in since I'm shopping around for a yaml crate for a project right now. Comment support is (IMV) a very important feature for a library like this, as anyone building a tool which needs to update (formatters, linters, configuration updaters, etc) a yaml document will probably want their tool to be a no-op if nothing needs to be changed.

Consider a formatter, if, say, indentation and flow styles already meet the desired format, the formatter should certainly not strip comments! It may also be useful to inform the formatter about content in the file, with directives either at the top of the file, or on specific lines

[Ethiraric]

Comments will come one day. This will have to be addressed in the parser first.

Regarding the formatter, there's a lot more to be done here to write one with saphyr. For instance, we currently do not extract whether collections use flow style or the style of scalar that was used (fold, literal, plain, ...).

[vengestone-dragoon]

I am attempting to create a sort of yaml editor using iced-rs which i want to show comments in, so i want comment support as well
I am not sure of all the details of the parser, but currently the comments arent kept so they must be found and ignored/removed? Again, im not sure how things work right now, but i would think that if the comments werent stored with the yaml data structure they could be stored separately in their own map that kept association with the surrounding yaml data? perhaps being a different function that gets both the yaml data with the comment tree?

[mert-kurttutan]

Just here to ask if there is already progress on this feature. Otherwise, I can start working on this.

[c9d5e1]

Is this in development? This feature would be useful for cloud-init autoinstall files and Ansible files.
There's currently no alternatives out there.

[Ethiraric]

This is not my current focus. It is planned, that is sure, but it will be a time-consuming task. I think my efforts for now are better spent on enhancing borrowing and performance.

Maybe @mert-kurttutan has worked on it? I just realized I haven't replied to them :(