Add description to modules in configuration screen

mac-cleanup / mac-cleanup-py

👨‍💻 Python cleanup script for macOS

Apache License 2.0

1.63k stars 64 forks source link

Add description to modules in configuration screen #80

Open efa2d19 opened 1 year ago

efa2d19 commented 1 year ago

Is your feature request related to a problem? Please describe.

It's kinda hard to understand what modules will do when you select them. Opening default_modules.py every time isn't the solution here.

Describe the solution you'd like

Add some kind of banner on top of the modules selection screen with some info about them. Maybe inquirer has something to offer.

Describe alternatives you've considered

Switch from inquirer to something else if implementation would be hard or impossible.

rizkyarlin commented 1 year ago

Hi @Drugsosos I already created a PR in inquirer but I'm not sure how long it's gonna take. How about providing -v to make the Checkbox choices also in verbose mode. We will do some mapping between module and its description anyway, CMIIW

efa2d19 commented 1 year ago

Hi @Drugsosos I already created a PR in inquirer but I'm not sure how long it's gonna take. How about providing -v to make the Checkbox choices also in verbose mode. We will do some mapping between module and its description anyway, CMIIW

Hey. Thanks for your contribution 💙 Not fully understood about verbose mode, can you elaborate?

rizkyarlin commented 1 year ago

like when they run mac-cleanup -v

The checkbox will be: [ ] adobe: Clearing Adobe Cache at ~/Library/Application Support/Adobe/Common/Media Cache Files/ [ ] chrome: Clearing Google Chrome Cache at ~/Library/Application Support/Google/Chrome/Default/Application Cache/ ......

efa2d19 commented 1 year ago

like when they run mac-cleanup -v

The checkbox will be: [ ] adobe: Clearing Adobe Cache at ~/Library/Application Support/Adobe/Common/Media Cache Files/ [ ] chrome: Clearing Google Chrome Cache at ~/Library/Application Support/Google/Chrome/Default/Application Cache/ ......

Good idea actually, but with technical difficulties: I don't think it'll fit inside 100x30 (approx. default terminal unmaximized window size) and soft wraps don't look good imho. I'll create a new issue for that or you can if you wish 😉

rizkyarlin commented 1 year ago

Good call. I didn't think about the terminal size since I always open a big terminal window 🤣

efa2d19 commented 1 year ago

@rizkyarlin Assigned this one to you 😉