Switch to shtab for shell completion

[casperdcl]

• fix tldr: error: argument command: invalid choice #134 invalid choice
• autocompletion improvements (using shtab)
  • support zsh
  • faster completion
  • update documentation
• automate the usage: message close Set --help usage line to match node client #149 --help message

[sbrl]

Looks ok to me, but I'm not a Python expert.

/cc @MasterOdin for checking, I think this one slipped through the net.

[MasterOdin]

Sorry for not reviewing this sooner. I do not have much of an opinion on argcomplete vs shtab, and I've found that both work well on my oh-my-zsh installation on my macOS.

However, I am not keen on adding a dependency that has a classifier of Development Status :: 3 - Alpha (shtab) over one marked Development Status :: 5 - Production/Stable (argcomplete).

The usage string not being automated is on purpose, and should not be changed. I've opened #149 to make the usage string a bit simpler to maintain and with explanation on why its manually done instead of leaving it to argparse for automation.

[casperdcl]

@MasterOdin shtab is actually faster than argcomplete and has no side effects (it doesn't execute the program every time <TAB> is pressed). It also supports all zsh features natively in addition to bash.

I think shtab is now mature enough that it could be classified as stable or at least beta. It's used by https://github.com/iterative/dvc.

Feel free to modify this PR (e.g. merge #149 into #135) if you'd like.

[casperdcl]

just tagged shtab as Development Status :: 4 - Beta and merged in #149 :)

[casperdcl]

not sure why the 3.5 build is failing - shtab's pyproject.toml clearly states setuptools>=42 but for some reason https://github.com/tldr-pages/tldr-python-client/pull/135/checks?check_run_id=1618096569 is complaining about setuptools<30.4.

EDIT: ah I see, the way the tests were run they circumvent the setuptools version check. Just fixed.

[MasterOdin]

Testing this out, I get the following error:

tldr <TAB>
_arguments:comparguments:325: doubled rest argument definition: *::args:->args

I am on macOS 11, using zsh 5.8 and oh-my-zsh.

[casperdcl]

@bl-ue just rebased

[bl-ue]

ping @MasterOdin — did you forget about this?

[MasterOdin]

Sorry @casperdcl for not following up here. Will run through with a comparison of shtab and argcomplete again soon.

[casperdcl]

Sure, also just released a new shtab version (v1.3.10) so both bash & zsh completion should work perfectly now

[casperdcl]

just rebased & added cmd completion too (ebe5548)

[MasterOdin]

Hm, looks like having flake errors. I think to resolve them, will need to double escape the sequence \\W? Not sure, will look at this shortly.

[casperdcl]

@MasterOdin yes, fixed.

[MasterOdin]

Sorry it's taken so long to get this merged. I really appreciate your contribution and follow through here to get this merged!