Escape dollar signs in completion snippets

[Soupstraw]

This PR adds sanitization to completion snippets. It does that by introducing the Snippet type and a snippetToText function that converts a Snippet to a syntactically valid snippet string.

close #4363

[sgillespie]

It looks like there are some tests to update:

ghcide
  completion
    topLevel
      recordsConstructor: FAIL (1.06s)
        ghcide-test/exe/CompletionTests.hs:112:
        expected: [("XyRecord",Just CompletionItemKind_Constructor,Just "XyRecord",Nothing),("XyRecord",Just CompletionItemKind_Snippet,Just "XyRecord {x=${1:_x}, y=${2:_y}}",Nothing)]
         but got: [("XyRecord",Just CompletionItemKind_Constructor,Just "XyRecord",Nothing),("XyRecord",Just CompletionItemKind_Snippet,Just "XyRecord {x=\\${1:_x}, y=\\${2:_y}}",Nothing)]

[Soupstraw]

Oh well, I think I'm gonna have to do this properly after all 😃

Completely forgot about record snippets..

[Soupstraw]

Should be good now, I think the test failures are from flaky tests @sgillespie.

[fendor]

@Soupstraw Do you want to upstream the StructuredCompletionItem to lsp or do you want to rather merge it into HLS as is and think about it later in follow-up work?

If possible, I want to merge this PR before the next HLS release, which will be soon ™️

[fendor]

LGTM, I am happy to merge once SnippetAny has some docs.

[Soupstraw]

@Soupstraw Do you want to upstream the StructuredCompletionItem to lsp or do you want to rather merge it into HLS as is and think about it later in follow-up work?

If possible, I want to merge this PR before the next HLS release, which will be soon ™️

@fendor I made an issue in the lsp repo about upstreaming this work (haskell/lsp#626 (comment)). I think I'd rather have this PR merged now and then doing a follow-up once it's available upstream.

[fendor]

Perfect, thank you very much! If you find the time, could you open a ticket in HLS as well that we want rather the lsp stuff merged and use that?

[Soupstraw]

Perfect, thank you very much! If you find the time, could you open a ticket in HLS as well that we want rather the lsp stuff merged and use that?

Done: #4772