search

denisidoro / navi

An interactive cheatsheet tool for the command-line
Apache License 2.0
14.93k stars 498 forks source link

Allow multi line command description #809

Open wiredolphin opened 1 year ago

wiredolphin commented 1 year ago

Beforehand, thank you very much to the author and all of the contributors of this wonderful tool, I think I cannot live anymore without it :blush:

I noticed that if a command, specially least used ones, needs some long description and such description length does not fit within the terminal window width, the description itself is truncated.

It would be gratefoul to know if someone is already working on a way to allow multiple lines command descriptions, or perhaps make them flow to the next line if the descriptions is too long.

For multiple lines descriptions I mean something like that: # Description line 1 # Description line 2 # Description line 3 command options

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! In case you're facing a bug, please update navi to the latest version first. Maybe the bug is already solved! :)

denisidoro commented 1 year ago

That would be challenging to implement because the height of the command preview window is always equal to 2 lines:

shot 2023-03-03 at 08 37 00

Multiline comments would either get clipped or the preview window would need to be unnecessarily tall.

wiredolphin commented 1 year ago

Hallo and thank you very much for your reply. I know that implementing it on the fly regarding to the current comment lines would be very hard and maybe not the right approach as the preview window height will change continously scrolling entries. Maybe a configuration entry to set the lines extent of the preview window. This way users can configure the appearence of navi according to the tallest comment of their cheatsheets.