Vscode-yaml: Formatting document should not destroy comments

[teohhanhui]

If yaml.format.enable is true, using the "Format Document" function destroys YAML comments.

[JPinkney]

This is an issue with the underlying parser. Currently there is not a parser (that I can find) that supports comment nodes. if one becomes available then I would happily switch the formatter to use that to preserve the comments.

[teohhanhui]

We should follow this issue then: https://github.com/mulesoft-labs/yaml-ast-parser/issues/27

[caub]

@JPinkney do you think the parser can be updated to https://github.com/eemeli/yaml?, that's what the issue above leads to, it supports fully comments

[JPinkney]

Only the formatter needs to be updated to use that parser instead. If we do that then a better formatter can be built ontop of that.

[GuidoS]

Can you share a link to the formatter?

[JPinkney]

The current one? Its just this

[JPinkney]

Hi! we've replaced the formatter with a new one that doesn't strip comments!

[frezbo]

@JPinkney I still see comments getting removed, any thoughts?

[JPinkney]

Which version are you on and can you post an example

[frezbo]

@JPinkney I'm on [email protected] . The comments in YAML get removed when calling Format Document

[JPinkney]

Is there any particular case that the comment gets removed?

Formatting

# First Comment
hello: world

#Second Comment
cwd: /hello
scripts: #Third Comment
  postinstall: test #Fourth Comment
  #Fifth comment

doesn't remove any comments for me. Do you have any other YAML related extensions installed?

[frezbo]

@JPinkney thanks for helping me out, had another YAML formatter installed. :+1:

[JPinkney]

No worries! I'm glad to see that we could get the issue resolved :)