Add tests!

[ewels]

Suddenly a lot of people seem to be interested in using this package, and I'm now responsible for not breaking stuff.

Breaking up the code into smaller functions and writing some tests would certainly help my confidence when making changes..

[willmcgugan]

The price of success!

[Jorricks]

I agree.
I also think that splitting up the new help function into smaller functions will greatly improve the extensibility.
For my use-case, I have a CLI for people who are truly new to CLIs xD
They need some more guidance than you'd put in a normal CLI, so I basically prepare this small text fragment in the help to include some sample commands for them and some context.

To be more in line with the rest of the CLI I also wish to use a rich panel for this, but in order to be able to do that, I need to extend the help code of course :p
If I would the do that now, I need to copy-paste 200+ lines and make a small edit in there instead of just overwrite a 20 line function (which is much more visible how my change comes in).

Still, I think you are doing a great job.
Personally, I wouldn't mind helping you out with this refactor.
Just let me know if you are already working on it or not. 👍

[ewels]

@Jorricks sounds like a fascinating use case! I'd love to see a mockup of the kind of thing you're aiming for. Maybe this could be added to the library somehow as some kind of opt-in thing? (I'm already keen on extending default click functionality in a few places, eg. #11).

But yes, code refactoring is needed really. If you fancy making a start that would be much appreciated! If you do start rearranging code, please try to do it in small PRs for a little bit at a time, to make it easy to review. This kind of refactoring can easily end up with huge diffs where the entire package is moving and those are a nightmare to look over.