SwaggerEditor@next: provide completion for $ref field starting with # character.

[char0n]

Originally discussed in #3216 (comment)

# is control character for starting of the YAML comment. Thus it's dropped from the resulting AST. We have to escape it with single or double quotes to represent the value, and then the proper completion is displayed.

$ref: #<cursor CTRL+b>

Steps To Reproduce

ref-yaml-comment.mp4

Notes

Now this might be a bit tricky to implement. When ApiDOM YAML 1.2 parser adapter parses the YAML string, we only collect YAML comments from the YAML stream. The rest of the comments are discarded as insignificant white space.

We have a tracking ApiDOM issue which, tracks the support for YAML comments outside of YAML stream. This issue will first need to be processed before this issue can be fix.