Enabling autocomplete without requiring step from user

[knownasilya]

So in the readme you have something like:

./githubber --completion >> ~/githubber.completion.sh
echo 'source ~/githubber.completion.sh' >> .bash_profile

And the user has to do this. Is there a way to automate this, because it's going to be hard to get the user to run something like that for every cli tool they want to use..

[f]

Hi!

Great feature to have. But I need to put the files /etc/bash_completion.d but it has super-user requirement and it would be insecure to have.

Third party libs that being used with omelette should be installed the example above.

[knownasilya]

Can we write to .bash_profile for the user? Maybe with a confirmation from the user, like: "Would you like to enable autocompletion for this CLI tool (this will modify your ~/.bash_profile)?"

[f]

Hmm, maybe it can be a good idea.

But, you also can do it in your program. Or, I can add a simple parameter support like --install-completion so you can ask user to run yourprogram --install-completion and I can ask that questions and copy these files to the folders. What do you think?

[knownasilya]

@f I think the best thing would be to provide a method, like omelette.setup(profilePath) that the developer can utilize to ask the user or do it automatically. Since omelette doesn't ask the user anything by default and it would be difficult to incorporate with other tools that do (like inquirerjs).

maybe something more complete like:

omelette.setup({
  shell: 'bash' // or `zsh`,
  profilePath: '~/.bash_profile'
});

Or if it could detect the shell, that would be even better, so then only require to set the path to the profile.

[f]

This is what you are looking for I guess: 095f1f5

It detects the shell (if it's zsh or bash, since it supports just them).

Also I named the function setupShellInitFile instead of setup to be more clear.

Can you test it? 😄

[knownasilya]

@f looking good, although if you have two completions (if you have a short and long form of the command - see #2) the last one that you do setup for is the one that is written. Also it adds two slashes to the .bash_profile and duplicates the user dir: ~//Users/myuser/.myprogram/completion.sh

[f]

Yep, it should be fixed now.

It now supports shortnames 👍 With multiple names:

omelette "githubber|ghb|gh|g <user> <repo> <action>"

I also added Debugging feature. Now if you add --debug parameter, it will create a function called omelette-debug-<programname> and when you run it, it will create aliases (all of program names, including shortnames, etc) for your application. If you write omelette-nodebug-<programname>, it will unalias all of them.

I updated readme file, you can check it out :)

[knownasilya]

Nice!

One more thing, is it possible for the setupShellInitFile to do source ~/.bash_profile? Or do you think that's too much?

[f]

I think it's not possible. You cannot run a command on the upper process. :/

[knownasilya]

Ah, so we probably just need to note that source still needs to be called for the completions to take effect.

[f]

Yes, actually "restart console" is less confusing for normal users :)

Since we already add source to init file.

[knownasilya]

I say this is complete.. 😄

[f]

Thank you for your contribution 👍 This become great with you 😄