Add fish tab completion capabilities #721

jlprat · 2018-11-15T21:37:55Z

Refs: #695
Adds documentation on how to install
Adds documentation for developers when changing commands
Provides a file to generate tab completions for fish

Disclaimer on the approach: fish tab completions take a more descriptive approach than the one Bash or zsh have. The common way to write such tab completion files for fish is usually by listing all possible sub-commands and flags in such files.

I'm not sure if some other areas would need to be touched, like the installation script for example

jlprat · 2018-11-15T21:56:31Z

This test (Test bloop.tasks.JsTestSpec) failed on CI, but I don't know how this is related to my changes.

jvican

Excellent work @jlprat, nevermind the CI errors, I'll fix them myself. Thanks for this high-quality solution, generators are always the way to go 😉

jlprat · 2018-11-16T10:06:20Z

You're welcome @jvican ! What about the installation scripts? Will the new file under etc/fish/bloop.fish be "magically" copied to .bloop/fish/bloop.fish?

jvican · 2018-11-19T17:43:23Z

You're welcome @jvican ! What about the installation scripts? Will the new file under etc/fish/bloop.fish be "magically" copied to .bloop/fish/bloop.fish?

They won't be magically copied, you need to modify two files:

The python script in bin/install.py for multi-OS installation
The contents of the ReleaseUtils brew installation script which we use to install bloop in OSX (https://github.com/scalacenter/bloop/blob/master/project/ReleaseUtils.scala#L98)

One question that comes to mind: can we avoid generating this file and instead let the server reply to the fish's autocompletion engine? The following SO question has two relevant answers that hint that this is possible. One reason why I prefer this approach is because it's likely that this file will go outdated.

jlprat · 2018-11-19T18:18:31Z

Without being an expert in fish, letting the server respond will only work if the bloop server is running when the shell starts.
If we don't consider this, then it is possible to have everything scripted and never be outdated.

The main probles comes with the flag completion, where we need to have 1 complete per flag. I the server is down, the loop won't generate any entry.

I also didn't line this solution, but as it's being used already to keep the docs up, I guessed it won't be outdated that easily.

PS: you forgot the SO link 😉

jvican · 2018-11-19T21:02:29Z

you forgot the SO link

https://stackoverflow.com/questions/20838284/how-can-i-provide-tab-completions-to-fish-shell-from-my-own-script

Without being an expert in fish, letting the server respond will only work if the bloop server is running when the shell starts.

I would favor talking to the server to get the autocompletions directly since that's the way bash and zsh autocompletions work in bloop now. It's true that autocompletions won't work if the server is not running, but that's OK since you can do nothing when the server is down (the best way to ensure that this doesn't happen is that you have brew services/systemd enabled in your system).

jlprat · 2018-11-19T21:08:18Z

If this is an acceptable case, then I can rewrite it to use the autocompletions directly from server.
The only problem I can image is, if somebody starts bloop manually, they would need to restart fish to get the completions working. But I guess, is an acceptable compromise.

PR update will come during next days.

jvican · 2018-11-20T08:54:37Z

if somebody starts bloop manually, they would need to restart fish to get the completions working.

Is this a fish-specific limitation? I've never had such issues with zsh/bash.

PR update will come during next days.

Thanks Josep!

jlprat · 2018-11-20T09:30:56Z

Is this a fish-specific limitation? I've never had such issues with zsh/bash.

If I understand zsh completion correctly, one defines a syntax for the command with the functions that will provide the completions. This is way more flexible and fits better to bloop's way of working. On the other hand, as far as my understanding of fish goes, yes, it is a fish limitation. Fish tab completions are designed to be generated from man pages, additionally and all the examples I saw around are upfront definitions. Nothing like the zsh style.

There are conditionals on the complete command and some interesting things can be done this way, like:
complete -c bloop -f -n "__assert_args_count 0" -a '(_commands)'
But you would need a complete command for each flag and subcommand, and this is where the things get trickier.

The main problem is that in fish, one can't define multiple flags (or options in fish naming convention) in one single complete command. This, together with the fact that bloop autocomplete only works when the server is started (obviously) make it more challenging. I have a way to overcome this I think.

jlprat · 2018-11-21T20:47:43Z

bin/install.py

@@ -62,7 +62,7 @@
    help="Tell the location of the ivy home.")
 parser.add_argument(
    '--bloop-home',
-    help="Tell the location of the ivy home.")


Fixed a typo here

jlprat · 2018-11-21T20:48:38Z

etc/fish/bloop.fish

+
+
+# Nothing has been provided yet. Complete with commands
+complete -c bloop -f -n "__assert_args_count 0" -a '(_commands)'


This will recover if bloop server is not running and then started.

jlprat · 2018-11-21T20:48:42Z

etc/fish/bloop.fish

+complete -c bloop -f -n "__assert_args_count 0" -a '(_commands)'
+
+# Only a project command has been provided
+complete -c bloop -f -n "__assert_args_count 1; and __fish_seen_subcommand_from_project_commands" -a '(_projects)'


This will recover if bloop server is not running and then started.

jlprat · 2018-11-21T20:49:06Z

etc/fish/bloop.fish

+    set -l flags (_flags_for_command $cmd)
+    for flag in $flags
+        set -l parsed (string split '#' $flag)
+        if test -n $parsed[1] -a -n $parsed[2] -a -n $parsed[3]


These will not recover if bloop server is not running and then started.

jvican

@jlprat Thanks! This looks great, I love that we reuse the same machinery than zsh and bash do. I've just left one comment.

Can you rebase the PR so that I can merge after the comment is addressed?

jvican · 2018-11-22T10:16:44Z

website/content/docs/installation.md

+#### Fish completions
+
+To get the command line completions with fish shell, navigate to your local completion location (e.g.: `~/.config/fish/completions`)
+and create a symlink to the file provided in the Bloop distribution:


Shall we mention here what to do if the bloop server is not running and how to get the fish completions to work after the user manually starts the server?

Agree, makes sense to do so.

Great, whenever you make the change, please rebase the PR so that i can merge it right away.

Change done, and rebased against master.

Refs: scalacenter#695 Adds documentation on how to install Adds documentation for developers when changing commands Provides a file to generate tab completions for fish Disclaimer on the approach: fish tab completions take a more descriptive approach than the one Bash or zsh have. The common way to write such tab completion files for fish is usually by listing all possible sub-commands and flags in such files.

Adds fish format for CliParsers

Remove echo that was used for debugging purposes

jvican · 2018-11-22T20:16:10Z

🙇

jvican approved these changes Nov 16, 2018

View reviewed changes

jvican added cli ergonomics Any change that affects developer ergonomics and the easiness of use of bloop. community Any change or proposal that is contributed by the Open Source Community. labels Nov 16, 2018

jlprat commented Nov 21, 2018

View reviewed changes

jvican approved these changes Nov 22, 2018

View reviewed changes

jlprat force-pushed the fish-tab-completion branch from ee9feb3 to b5c8651 Compare November 22, 2018 19:37

jlprat added 5 commits November 22, 2018 20:39

Run tab completion by getting completions from server

914e504

Adds fish format for CliParsers

Adapt install scripts to copy over fish tab completion file

b65f15f

Clean up previous attempt

b037ad9

Add info on how to troubleshoot when bloop server is not running

f100f84

Remove echo that was used for debugging purposes

jlprat force-pushed the fish-tab-completion branch from b5c8651 to f100f84 Compare November 22, 2018 19:39

jvican merged commit 14a7989 into scalacenter:master Nov 22, 2018

jlprat deleted the fish-tab-completion branch November 22, 2018 20:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fish tab completion capabilities #721

Add fish tab completion capabilities #721

jlprat commented Nov 15, 2018

jlprat commented Nov 15, 2018

jvican left a comment

jlprat commented Nov 16, 2018

jvican commented Nov 19, 2018

jlprat commented Nov 19, 2018

jvican commented Nov 19, 2018

jlprat commented Nov 19, 2018 •

edited

Loading

jvican commented Nov 20, 2018

jlprat commented Nov 20, 2018

jlprat Nov 21, 2018

jlprat Nov 21, 2018

jlprat Nov 21, 2018

jlprat Nov 21, 2018

jvican left a comment

jvican Nov 22, 2018

jlprat Nov 22, 2018

jvican Nov 22, 2018

jlprat Nov 22, 2018

jvican commented Nov 22, 2018



		# Nothing has been provided yet. Complete with commands
		complete -c bloop -f -n "__assert_args_count 0" -a '(_commands)'

Add fish tab completion capabilities #721

Add fish tab completion capabilities #721

Conversation

jlprat commented Nov 15, 2018

jlprat commented Nov 15, 2018

jvican left a comment

Choose a reason for hiding this comment

jlprat commented Nov 16, 2018

jvican commented Nov 19, 2018

jlprat commented Nov 19, 2018

jvican commented Nov 19, 2018

jlprat commented Nov 19, 2018 • edited Loading

jvican commented Nov 20, 2018

jlprat commented Nov 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvican left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jvican commented Nov 22, 2018

jlprat commented Nov 19, 2018 •

edited

Loading