newman
newman copied to clipboard
Missing Bash Completion
Issue
- newman is missing bash completion. This can lead to some initial problems for newcomers.
- One might not be able to understand or sometimes forget the arguments.
to solve
- We can add omelette for autocompletion.
- Or write custom bash script for autocompletion. (but issue with this is other shells such as fish or zsh will require their own specific completion)
- So using such packages can help to create more user friendly experience especially for newcomers.
Also I would like to work on this issue as well.
@SwapnilSoni1999 This would be indeed useful. Can you create a proposal ( A small comment, indicating how the completion would work ) for us to review ?
Proposal
- Create a command and subcommand/arguments list
- Create a documentation for each respectively
- Use omelettelib and write bash completion code
- Test and publish
How will it work
- users can just press
tab
key in their terminal whennewman
is written - after pressing
tab
a bash completion/suggestion will appear in terminal - so users can select desired argument/command to execute.
- Each arg will be displayed with its small, one line documentation/instruction.
If you are interested then I can submit a proposal over Gsoc. :)
Hey @SwapnilSoni1999 did you submit the proposal?
Hey @SwapnilSoni1999 did you submit the proposal?
No I haven't but I'm still gonna contribute to this after a week or so
I would love to help, this seems to be a great feature. We can work together, if that's ok?
I would love to help, this seems to be a great feature. We can work together, if that's ok?
Sure man, I'll comment here once I start working on it
Bash completion is a simple functionality, and we don't want to package another dependency for it, due to package size and LICENSE management reasons.
cc @codenirvana
Bash completion is a simple functionality, and we don't want to package another dependency for it, due to package size and LICENSE management reasons.
cc @codenirvana
Alright then I'll go for dependency-less approach 👍
Hows the research coming @SwapnilSoni1999 , want some help with it? Also, I had this idea if we keep an option for users to use this feature or not and according to that, we can install the extra package into the main library! I mean the package won't come under dependency but can be installed by the user for further assistance with the cli. Can we try something like this @mohitranka cc @codenirvana .