bash completion has syntax errors

[danielhoherd]

• I am on the latest Poetry version.

• I have searched the issues of this repo and believe that this is not a duplicate.

• If an exception occurs when executing a command, I executed it again in debug mode (-vvv option).

• OS version and name: raspios, macos

• Poetry version: 1.2.0

• Link of a Gist with the contents of your pyproject.toml file: N/A, this is just for the completion code

• Bash versions tested:

  • GNU bash, version 5.1.16(1)-release (aarch64-apple-darwin21.1.0)
  • GNU bash, version 3.2.57(1)-release (arm64-apple-darwin21)
  • GNU bash, version 5.1.4(1)-release (aarch64-unknown-linux-gnu)

Issue

poetry completions bash generates syntactically incorrect bash code.

Steps to reproduce

$ poetry completions bash > poetry-completion.sh
$ source poetry-completion.sh
-bash: poetry-completion.sh: line 40: syntax error near unexpected token `clear'
-bash: poetry-completion.sh: line 40: `            (cache clear)'
$ shellcheck poetry-completion.sh

In poetry-completion.sh line 26:
        case "$com" in
        ^-- SC1009 (info): The mentioned syntax error was in this case expression.


In poetry-completion.sh line 40:
            (cache clear)
            ^-- SC1073 (error): Couldn't parse this case item. Fix to allow more checks.
                   ^-- SC1072 (error): Expected ) to open a new case item. Fix any mentioned problems and try again.
                   ^-- SC1085 (error): Did you forget to move the ;; after extending this case item?

For more information:
  https://www.shellcheck.net/wiki/SC1085 -- Did you forget to move the ;; aft...
  https://www.shellcheck.net/wiki/SC1072 -- Expected ) to open a new case ite...
  https://www.shellcheck.net/wiki/SC1073 -- Couldn't parse this case item. Fi...

[danielhoherd]

I see a few issues with the completion code.

First, bash case statement items are not wrapped in parenthesis, they are delimited by a closing parenthesis.

        case "$com" in
            (about)
            opts="${opts} "
            ;;

Should be

        case "$com" in
            about)
            opts="${opts} "
            ;;

Secondly, and a bigger problem to solve, the comparisons being made in the case statement are trying to compare multiple words when only one word is being checked. This is a problem both syntactically and in terms of how the code is structured.

            cache clear)
            opts="${opts} --all"
            ;;

That code is syntactically invalid because there is unquoted whitespace in it. cache clear) is an invalid case match. "cache clear") would work, but that would be wrong for poetry, requiring users to run poetry "cache clear" or equivalent. EG:

#!/usr/bin/env bash
# cat example-1.sh
case "$1" in
  "cache clear")
    echo "1 is $1"
    ;;
  *)
    echo "default target"
    ;;
esac

$ shellcheck example-1.sh ; echo $? ;
0
$ ./example-1.sh cache clear
default target
$ ./example-1.sh "cache clear"
1 is cache clear

So the way this needs to be structured is to check each word individually, then any more words beyond that one, in a tree structure of completions rather than a flat list of possible completions:

#!/usr/bin/env bash
# example-2.sh
case "$1" in
  cache)
    echo "1 is $1"
    case "$2" in
      clear)
        echo "2 is $2"
        ;;
      *)
        echo "default cache target"
        ;;
      esac
    ;;
  *)
    echo "default target"
    ;;
esac

$ shellcheck example-2.sh ; echo $? ;
0
$ ./example-2.sh cache clear
1 is cache
2 is clear
$ ./example-2.sh cache jklsjdfk
1 is cache
default cache target

[dimbleby]

duplicate #4572, and the several other duplicates linked from that

[Secrus]

As mentioned in the previous comment, it's a duplicate. What's more, a fix was made upstream in cleo, pending release.

[danielhoherd]

My bad. This search didn't turn up any of the duplicates or #4572 "https://github.com/python-poetry/poetry/issues?q=is%3Aissue+is%3Aopen+%22cache+clear%22+%22completion%22"

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.