Blank Line Comments skipped

[DeltaOrion]

Version: 6.0.1
Issue: If a key has a comment with no content inside of the comment then that line and any above lines will not be counted as apart of comments for that node

When reading the following yaml file

#comment line 1
#comment line 2
#
#comment line 4
key: value

When reading the comments from the node key using YamlNode#comment()#value() It only returns [comment line 4]. I believe it should return all 4 comment lines that being, [comment line 1, comment line 2, , comment line 4]

However, when reading this yaml file

#comment line 1
#comment line 2
#abc
#comment line 4
key: value

Reading the comments from the node key using YamlNode#comment#value() returns all 4 comment lines correctly that being [comment line 1, comment line 2, abc, comment line 4]

[zoeself]

@DeltaOrion thank you for reporting this. I'll assign someone to take care of it soon.

[zoeself]

@amihaiemil I couldn't find any assignee for this task. This is either because there are no contributors with role DEV available or because the project does not have enough funds.

Please, make sure there is at least one available contributor with the required role and the project can afford to pay them.

[amihaiemil]

@DeltaOrion I'm no sure this is a bug. If I remember well, this was intended behaviour: blank lines and blank comment lines are ignored. Let's leave it open for a while and see if someone else has this issue or other opinion :D

[DeltaOrion]

https://yaml.org/spec/1.2.2/#comments

According to the YAML spec comments aren't associated to a particular node. But for having any kind of comment support it is only natural that it is attached to a node because comments are almost always there to describe the purpose of the node. Thus, As to whether this is intended behavior would really depend on your requirements. It seems more natural to me that all of the consecutive comment lines above the node are counted as comments whether or not the comment line has content or not but at the end of the day it is up to your teams requirements.

But blank lines aren't really ignored because

When reading

#comment line 1
#comment line 2
#comment line 3

key: value

It produces the output [comment line 1, comment line 2, comment line 3] despite the blank line gap

But when reading

#comment line 1
#comment line 2
#comment line 3
#
key: value

It produces the output ``

[zoeself]

@amihaiemil I couldn't find any assignee for this task. This is either because there are no contributors with role DEV available or because the project does not have enough funds.

Please, make sure there is at least one available contributor with the required role and the project can afford to pay them.

[zoeself]

@amihaiemil I couldn't find any assignee for this task. This is either because there are no contributors with role DEV available or because the project does not have enough funds.

Please, make sure there is at least one available contributor with the required role and the project can afford to pay them.

[robross0606]

I hit this as well. If the comments are like this:

# Comment line 1
# Comment line 2
#
# Comment line 3
field: value

And you do a simple "round-trip" where you ingest this YAML and then print it, what you get back is:

# Comment line 3
field: value

It doesn't just "ignore blank lines". It loses entire chunks of the comment.

[zoeself]

@amihaiemil I couldn't find any assignee for this task. This is either because there are no contributors with role DEV available or because the project does not have enough funds.

Please, make sure there is at least one available contributor with the required role and the project can afford to pay them.