click-completion icon indicating copy to clipboard operation
click-completion copied to clipboard

Clarify whether this repo is deprecated or not

Open zbentley opened this issue 3 years ago • 5 comments

This repo appears to duplicate (and maybe pre-date?) the official Click completion functionality.

Is this the predecessor to that/was that rolled into Click core at some point? If so, it might be good to:

  • Indicate that this is deprecated/rolled into core at the top of the README.
  • Contact the authors of open bugs and PRs on this repo and suggest that they move their issues to Click core if they're still applicable.
  • Maybe archive this repository?

If this is not a dupe of the click core functionality, and is instead an alternative implementation (or internal implementation component of the Click core func), it would be good to indicate that prominently in the README.

zbentley avatar Jun 04 '21 15:06 zbentley

yup. probably dead

tmax22 avatar Jan 29 '24 18:01 tmax22

I understand part of the answer is here https://github.com/click-contrib/click-completion/issues/37

Click's completion system has been rewritten [...] Due to all these changes, the click-completion won't work with the next release of Click. We've talked about merging this project into Click before, but I think we pretty much have what we want in core at this point. One option is to make a release that specifies click<8 in install_requires, then have the next version specify click>=8 and continue to support the parts that Click doesn't provide.

So

  • yes, this is mostly an alternative implementation of click's core shell-completion features that didn't exist before
  • no, this was never rolled into core
  • both features are incompatible so this project should restrict to click<=7
  • this project could still aim to support the features that are considered out-of-scope in click>=8 (namely: powershell support, completion install command, shell detection)

But ~~this is still to be done and~~ the project feels very stale. I guess the release of click 8 removed most of the interest on maintaining click-completion for both the maintainers and the community.

So: ping @glehmann @Konubinix , sorry to bother you. A word about this? IMHO one of the following should happen

  • ~~you just state that a PR (most probably a scratch-rewrite) to support click>=8 is welcome if anyone is willing to work on that and reboot the extra features in click-completion~~ this was already addressed https://github.com/click-contrib/click-completion/pull/45
  • the repsitory is archieved
  • new maintainers are involved in the project

Thanks!

n1ngu avatar Jan 30 '24 08:01 n1ngu

To me, it is dead. In my projects, I try to use the native completion as much as possible and suggest you do the same.

I agree with your suggestions. I leave to @glehmann to make actions he deems appropriate.

Konubinix avatar Jan 30 '24 08:01 Konubinix

click's native completion should be used with click 8.0. This one is for click before 8.0.

If click's completion is not as complete as this one, we (as a community) should work on the missing features directly in click.

I'll add a notice at the top of the README and update the required click version to < 8.0

glehmann avatar Jan 30 '24 12:01 glehmann

please tag a maintenance release

a-detiste avatar May 04 '24 12:05 a-detiste