zsh completion is broken

[monester]

Bug Report

zsh completion is failing with error:

_arguments:comparguments:325: invalid option definition: (-l --linkerd-namespace)-l[Namespace in which Linkerd is installed [$LINKERD_NAMESPACE]]:

It is happening because [$LINKERD_NAMESPACE] is not escaped.

What is the issue?

Unable to use autocompletion for linkerd in zsh

How can it be reproduced?

Install zsh, add completion by running source <(linkerd completion zsh), try autocomple any linkerd command

Logs, error output, etc

None

linkerd check output

Not related

Environment

• Linkerd version: Client version: edge-19.11.3
• Zsh version: zsh 5.7.1 (x86_64-redhat-linux-gnu)

Possible solution

There is PR opened in cobra package to fix issue - https://github.com/spf13/cobra/pull/899/files but not yet merged.

Additional context

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

[grampelberg]

Looks like we're still waiting on the upstream PR to merge.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

[olix0r]

Given the state of spf13/cobra#899, should we consider cobra abandoned?

Can we pull in a fix without cobra? Or should we plan to move off of it?

[vkudryk]

Any updates on it?

[grampelberg]

@vkudrik see upstream issue.

[olix0r]

It looks like k3d recently resolved a similar issue. I wonder if we can take whatever approach they did.

[alpeb]

Update: we have updated to cobra 1.0.0 recently (to add fish completion), but that still doesn't have the zsh completion fix. They did fix that in their master branch afterwards but they haven't cut a release including it (last release was in April 🤷‍♂️ )

[alpeb]

Duplicate of #3999