postmanlabs / newman

Newman is a command-line collection runner for Postman

https://www.postman.com

Apache License 2.0

6.82k stars 1.15k forks source link

Missing Bash Completion #2691

Open SwapnilSoni1999 opened 3 years ago

SwapnilSoni1999 commented 3 years ago

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.

mohitranka commented 3 years ago

@SwapnilSoni1999 This would be indeed useful. Can you create a proposal ( A small comment, indicating how the completion would work ) for us to review ?

SwapnilSoni1999 commented 3 years ago

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 when newman 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. :)

nimit2801 commented 3 years ago

Hey @SwapnilSoni1999 did you submit the proposal?

SwapnilSoni1999 commented 3 years ago

Hey @SwapnilSoni1999 did you submit the proposal?

No I haven't but I'm still gonna contribute to this after a week or so

nimit2801 commented 3 years ago

I would love to help, this seems to be a great feature. We can work together, if that's ok?

SwapnilSoni1999 commented 3 years ago

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

mohitranka commented 3 years ago

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

SwapnilSoni1999 commented 3 years ago

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 👍

nimit2801 commented 3 years ago

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 .