Apply indentation before emitting comments on new lines

[alexprabhat99]

Fixes: #1392

[alexprabhat99]

@SGSSGene I have fixed for failing tests and formatting.

[SGSSGene]

@alexprabhat99 thank you for this contribution.

@jbeder this is a behavior change, without any formal specification from yaml-specs. What are your thoughts on this?

[jbeder]

I think this is fine, it's a pure ergonomic thing and the spec doesn't specify what to do here.

I'd make sure it's well tested, though.

[SGSSGene]

@alexprabhat99
This PR looks good, but I think we should cover it with some more unit test.

like double nested comment

map1:
  map2:
    # nested comment
    foo: bar

map1:
  map2:
    foo: bar
    # nested comment at the end

map1:
  map2:
    foo: bar 
  # nested comment outside of map2

since you also correctly specified it in your code, I would check that FlowBlock isn't being influenced. (I am not even sure what to expect, can we even comment inside a FlowBlock?)

some_map: { foo: bar
  # comment
  key2: value2 }
  

[SGSSGene]

@alexprabhat99 Any chance you could add the additional unit tests?

[alexprabhat99]

Hi @SGSSGene ,
Sorry for the delay, I got caught up with a few things. I've updated the PR with additional tests. Whenever you have a chance, I'd really appreciate it if you could take another look.
Thank you!

[alexprabhat99]

Hi @SGSSGene
All checks are successful now.
Thanks!