Fix flaky completions for zsh

[Jasper-M]

Quotes break zsh completions.

Or more specifically, escaped quotes \' seem to break completions on zsh.

[Gedochao]

Hey, thanks for the contribution!
I tried to replicate the problem with completions and zsh and ran into something like this:

▶ scala-cli 
(eval):37: unmatched '
(eval):37: unmatched '
(eval):37: unmatched '

(scala-cli with a space and then TAB, breaks)

▶ scala-cli c
clean    -- Clean the workspace.
compile  -- Compile Scala code.
config   -- Configure global settings for Scala CLI.
console  -- Fire-up a Scala REPL.

(adding a c brings the completions back)

Is this the behaviour you're trying to fix?

[Gedochao]

We might need to add a relevant anti-regression test.
The completions integration tests are here: https://github.com/Gedochao/scala-cli/blob/main/modules/integration/src/test/scala/scala/cli/integration/CompleteTests.scala#L7

Do you have the time to add a test?
If not, I can try to look at this later.

[Gedochao]

the reference-doc check is failing on the CI, btw.
This is because reference docs haven't been regenerated in sync with your changes.

You can fix it by running

./mill -i generate-reference-doc.run

(as per CONTRIBUTING.md)

[Jasper-M]

(adding a c brings the completions back)

Indeed, once you manage to limit the output to completions that don't contain quotes in their description it works.

Is this the behaviour you're trying to fix?

Yes that's exactly it. Turns out a similar change has already been attempted in the past #893

Do you have the time to add a test?

I will give it a go.

I just noticed that completions are implemented by case-app instead of natively in scala-cli. I should probably open an issue there.

[Jasper-M]

I just noticed that completions are implemented by case-app instead of natively in scala-cli. I should probably open an issue there.

alexarchambault/case-app#475

[Gedochao]

LGTM, thanks for the contribution!