Add option to select default choices

[fnky]

This PR adds a default option to allow certain items in a list to be selected by default.

For a single-choice list, it will select the given item defined in default. For a multi-choice list, it will select the given choices separated by space ( ) within quotations.

This is especially helpful in for example selecting the current branch in a list of branches:

$ git branch -a | ipt -D "$(git rev-parse --abbrev-ref HEAD)"

or for example auto-selecting already merged branches:

$ git branch -a | ipt -m -D "$(git branch -a --merged ${1-master} | xargs)"

[ruyadorno]

-				.split(' ')
+				.split(options['default-separator'] || options.separator)

I'd much rather have a default-separator option for people to be able to customize and default to separator

it would also remove the need for the extra | xargs from your example 😊

[ruyadorno]

PS: it would also mean we would need to enforce a default value for options.separator in src/cli.js

right now it can be undefined

[fnky]

I agree, I'll make some changes and add this extra option :)

[fnky]

I think it would make more sense if the default value of the separator is similar to this line using os.EOL (e.g. \n in Unix).

This way you can easily pass file contents, separated by new lines and won't require you to always specify default-separator in such occasions.

[fnky]

Also, do you think it is necessary with an alias? There's no letters that matches with the naming default-separator. I tried using P, but it seemed too unclear.

[ruyadorno]

hi @fnky many thanks for taking the time! Really impressive contribution! I didn't knew how much I want to have a default option until I saw this 😂

One consideration, I actually checked out the code to try it out locally and for me the first example wasn't working at first since git branch -a preppends a * to the current branch name (I wonder if that kind of mismatching can be annoying when using the default option? I think a possible solution would be to sanitize the input first 🤔 ) , anyways for me this quick change made it work:

-$ git branch -a | ipt -D "$(git rev-parse --abbrev-ref HEAD)"
+$ git branch -a | ipt -D "* $(git rev-parse --abbrev-ref HEAD)"

[ruyadorno]

I couldn't get the multiple options example to work though 😞 I wonder if we have mismatching git versions 🤔 I have:

git --version
git version 2.15.0

here, what about you?

[fnky]

first example wasn't working at first since git branch -a preppends a * to the current branch name

Ah, I thought it was something to do with my git config. But you can use --format "%(refname:short)" to avoid the default formatting. A bit cumbersome, but with aliases this could be make it less verbose.

This is what I tested with originally:

Select a single choice:

git branch -a --format "%(refname:short)" | ipt -m -D "master"

Select multiple choices:

git branch -a --format "%(refname:short)" | ipt -m -D "$(git branch -a --merged ${1-master} --format "%(refname:short)" | xargs)"

I am also using git 2.15.0

git --version
git version 2.15.0

[fnky]

I have added the default-separator option, which falls back to separator, otherwise to os.EOL. This allows you to easily input files, delimited by new lines:

$ echo "foo\nbar\nbaz" | ipt -m -D "$(echo "foo\nbaz")"

Note that if you pass newlines directly, it won't work:

$ echo "foo\nbar\nbaz" | ipt -m -D "foo\nbaz"

To use newline separator directly, use default-separator:

$ echo "foo\nbar\nbaz" | ipt -m --default-separator="\n" -D "foo\nbaz"

[fnky]

I don't know whether it makes sense to have an alias for default-separator.

[fnky]

This falls back to separator, otherwise os.EOL, similar to this line.

[ruyadorno]

oh yeah!!! works like a charm now 😍

MANY MANY THANKS! this is the best contribution I ever received in an OSS project 😊

[ruyadorno]

@fnky I would also suggest you to share reusable workflows as npm packages for easy-sharing across the community 😊

Here are some simple examples I put together, feel free to use them as templates:

• https://github.com/ruyadorno/itrash
• https://github.com/ruyadorno/git-iadd
• https://github.com/ruyadorno/git-ishow

[fnky]

My pleasure, love to help out! Thanks for the workflow suggestions, I’ll take a look when I have the time!

Cheers 🍺