Added auto-completion for shells #147

TheRustyPickle · 2023-02-28T14:03:24Z

#63 Added auto-completion support (Linux only) for Bash, Zsh, and Fish shells on Tab press. Gets initialized at the start of the program run

24seconds · 2023-03-01T00:56:31Z

[Question]
I also want to test the auto completion. But.. I have no idea how to do that.
Could you provide some detail guide so that I can reproduce like the image you attach? @TheRustyPickle

TheRustyPickle · 2023-03-01T01:04:27Z

@24seconds running the app once will add autocompletion for the shell which was used.

24seconds

Thank you for the work! I'm still reading some material related to clap_autocomplete and how autocompletion works for the review.

Here is the in the middle of review results. Please take a look 🙇

src/autocomplete.rs

24seconds · 2023-03-01T00:39:47Z

Cargo.toml

 reqwest = { version = "0.11", features = ["json"] }
 colored = "2"
 bincode = { version = "2.0.0-rc.1", features = ["alloc"]}
+clap_complete = "3.2.2"


[Question]
Currently clap_complete's latest version is 4.1.4. (doc link) Is there a reason to use the version 3.2.2? Maybe rust-cli-pomodoro's clap version is 3.2.22 ?

Correct, it's related to the clap's version. If I use the latest version I get some kind of error with generate which I don't understand. Something to do with the clap's main command generation

src/autocomplete.rs

24seconds · 2023-03-02T04:12:36Z

Thank you for handling the comment and leave comments. I didn't check the comment yet..
This week I'm quite busy. I will take a look on Friday night or Saturday after noon (KST). @TheRustyPickle

24seconds

I'm still understanding the auto completion.. 🙇 . I left some comments.

src/autocomplete.rs

24seconds · 2023-03-05T04:15:57Z

src/autocomplete.rs

+}
+
+/// Adds auto completion for the shell that is being used
+pub fn add_autocomplete() -> Result<(), Box<dyn std::error::Error>> {


[Suggestion]
For the better error message, how about define custom error for auto completion?
rust-cli-pomodoro defines many custom errors in error.rs file.

Link:

rust-cli-pomodoro/src/error.rs

Line 1 in 0ab2e16

use bincode::error::{DecodeError, EncodeError};

src/autocomplete.rs

24seconds · 2023-03-05T04:28:37Z

src/autocomplete.rs

+
+/// Returns the current shell
+fn get_current_shell() -> Result<Shell, Box<dyn std::error::Error>> {
+    if cfg!(target_os = "linux") {


[Question]
Is there a reason to target only linux? How about mac or window?

I don't have a mac or windows. I don't know if the process would be the same over there.

24seconds · 2023-03-05T11:36:39Z

How completion works

So far I looked up the tab completion or autocompletion. And how completion works can be summarized below.

for the cli application, we need to generate completion script. For example, in zsh shell, the usuall completion script filename should be _your_application_name. In our case, it's _pomodoro.
And we should put the completion script to proper path so that the zsh shell can figure out. It seems that the completion script should be placed in $fpath.
- zsh completion explanation link: https://github.com/zsh-users/zsh-completions/blob/98ea8e685c1a9630a21b39a1596cb94794d1cb3c/zsh-completions-howto.org?plain=1#L31
Other shells work same.

Suggestion

I found good example of completion. It's rustup. rustup supoprts completion command. You can run rustup completions --help and see the contents. Or check the installation doc link - https://github.com/rust-lang/rustup/blob/affbdfe0a37d92444e7c3c111043cd336e2f7728/doc/src/installation/index.md?plain=1#L68.

In this PR, the code tries to do two things.

create completion script
move completion script to proper path

I think we should approach similar to rustup. Let completion be optional. By doing this, user can choose whether installing the completion script or not. rust-cli-pomodoro only provides completion script generation command like rustup. And with the ease of adoption, we can write kind guidance.
Another good example of guidance is nvm I guess. It provides code snippet for shell profile file - link: https://github.com/nvm-sh/nvm/blob/edacf8275e3bef4a80971625ed89df13a9af427c/README.md?plain=1#L240.

To sum up, I suggest

provide completions command very similar to rustup
write guidance - (I'm not sure which guidance is preferred way - rustup or nvm?)

What do you think? @TheRustyPickle

TheRustyPickle · 2023-03-05T12:53:57Z

Sounds good @24seconds. I liked the rustup's approach better and I think is easier to understand. If I understood you right, the new approach will have a command like this instead of detecting the shell manually:

pomodoro completions fish > path

where generate will return a stdout, reducing most of the complexity. If I have the green light I can try working on this.

24seconds · 2023-03-05T12:55:48Z

You are right. Thank you @TheRustyPickle !

TheRustyPickle · 2023-03-05T12:58:40Z

Thank you @24seconds! I'm not very familiar with clap yet but will try to commit the new changes as soon as I am able.

TheRustyPickle · 2023-03-06T00:14:40Z

Hello @24seconds, correct me here if I am wrong here.

If I don't enter the pomodoro cli interface by typing pomodoro or cargo run and try to pass args like this pomodoro create -d, it tries to connect to/create UDS.

If we want to use pomodoro completions fish > path or how it was done in rustup and use the stdout, it needs to be done without entering the pomodoro cli interface.

I'm not sure if it was expected or whether this side is incomplete, I'm getting this error:

Error: Os { code: 111, kind: ConnectionRefused, message: "Connection refused" }

Alternatively, I was able to achieve this

Get shell name via the cli interface pomodoro completions <shell>
Create and move the autocomplete script to the relevant place

or

Take a path via pomodoro completions <shell> <path>
Create the file at the given path

Kindly advise on how to proceed here. I'm quite confused and not sure how things are working on the UDS side and if the error is exclusive to my device. Thank you for your time.

24seconds · 2023-03-06T00:41:00Z

I understand the situation.

Ah.. rust-cli-pomodoro architecture is quite unusual. There are two modes.
For more information, check this section -

rust-cli-pomodoro/README.md

Line 24 in 0ab2e16

## Architecture

Single mode: Run rust-cli-pomodoro by typing the pomodoro command. Then the app is running in terminal and you can type some commands in that terminal.
Communication mode: I found that it's burdensome for me - whenever I type, I need to go to that terminal. Usually I opened multiple terminal tabs. That is why ipc is used. If we type command in another terminal, then the already running rust-cli-pomodoro listens and serves command. (It works like client-server)

Therefore, to determine which mode it is, we have a function named detect_command_type.
Link:

rust-cli-pomodoro/src/main.rs

Line 162 in 0ab2e16

async fn detect_command_type() -> Result<CommandType, ConfigurationError> {

Currently there are two command type - StarUP and UdsClient. Now I guess it's time to add one more command type - completion ? autocomplete? something like this (please suggest command naming).

Suggestion

refactor detect_command_type so that we can distinguish which command type it is. Currently detect_comamnd_type naively determines command type
Write some logic in main.rs depending on detect_command_type result.

Then you can achieve what you wanted I guess. Please ask question @TheRustyPickle if something is unclear 🙇

TheRustyPickle · 2023-03-06T10:39:49Z

Thank you for the kind explanation, @24seconds! It is much clearer for me and I have some ideas on what to work on now🙏

TheRustyPickle · 2023-03-06T21:54:06Z

@24seconds when you have the time, please take a look at the new changes and let me know your thoughts. Thank you!

You should be able to do this and it does not make use of the UDS client

pomodoro completion fish > pomodoro.fish.

24seconds

Looks good to me!! Super!

Thank you for the patient and long long communication. Because of you, I can understand this feature and rust-cli-pomodoro now has tab completion!

I will update version soon. Again, thank you!

24seconds · 2023-03-07T14:31:42Z

Confirm that it works well in zsh, macOS

24seconds · 2023-03-07T14:34:53Z

[next step]
For the general usage, maybe rust-cli-pomodoro needs guidance like rustup. Let me work on it if I'm available.

TheRustyPickle · 2023-03-07T14:55:12Z

Thank you so much for being so helpful and patient throughout the process, @24seconds! 🙏

TheRustyPickle added 2 commits February 28, 2023 19:58

Added clap_complete

e5f3720

Added shell completion for fish, zsh and bash

19d5319

24seconds linked an issue Mar 1, 2023 that may be closed by this pull request

Feature: command auto complete #63

Closed

24seconds added the enhancement New feature or request label Mar 1, 2023

24seconds assigned TheRustyPickle Mar 1, 2023

24seconds self-requested a review March 1, 2023 00:25

24seconds reviewed Mar 1, 2023

View reviewed changes

Fixed clippy and zsh double append

f76376f

24seconds reviewed Mar 5, 2023

View reviewed changes

TheRustyPickle added 4 commits March 7, 2023 03:44

Remove old autocomplete file

c828045

Add util for parsing shell type

b645b47

Add new completion command

fd9910e

Added autocomplete handling with > symbol

af72382

24seconds approved these changes Mar 7, 2023

View reviewed changes

24seconds merged commit 7227d36 into 24seconds:main Mar 7, 2023

TheRustyPickle deleted the shell_autocomplete branch March 7, 2023 15:04

Added auto-completion for shells #147

Added auto-completion for shells #147

Uh oh!

Conversation

TheRustyPickle commented Feb 28, 2023

Uh oh!

24seconds commented Mar 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheRustyPickle commented Mar 1, 2023

Uh oh!

24seconds left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

24seconds Mar 1, 2023

Choose a reason for hiding this comment

Uh oh!

TheRustyPickle Mar 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

24seconds commented Mar 2, 2023

Uh oh!

24seconds left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

24seconds Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

24seconds Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

TheRustyPickle Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

24seconds commented Mar 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How completion works

Suggestion

Uh oh!

TheRustyPickle commented Mar 5, 2023

Uh oh!

24seconds commented Mar 5, 2023

Uh oh!

TheRustyPickle commented Mar 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheRustyPickle commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

24seconds commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheRustyPickle commented Mar 6, 2023

Uh oh!

TheRustyPickle commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

24seconds left a comment

Choose a reason for hiding this comment

Uh oh!

24seconds commented Mar 7, 2023

Uh oh!

24seconds commented Mar 7, 2023

Uh oh!

TheRustyPickle commented Mar 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

24seconds commented Mar 1, 2023 •

edited

Loading

TheRustyPickle Mar 1, 2023 •

edited

Loading

24seconds commented Mar 5, 2023 •

edited

Loading

TheRustyPickle commented Mar 5, 2023 •

edited

Loading

TheRustyPickle commented Mar 6, 2023 •

edited

Loading

24seconds commented Mar 6, 2023 •

edited

Loading

TheRustyPickle commented Mar 6, 2023 •

edited

Loading