feat: add command completion by prodanlabs · Pull Request #650 · devstream-io/devstream

prodanlabs · 2022-06-01T16:07:16Z

Signed-off-by: prodan pengshihaoren@gmail.com

Pre-Checklist

Note: please complete ALL items in the following checklist.

I have read through the CONTRIBUTING.md documentation.
My code has the necessary comments and documentation (if needed).
I have added relevant tests

Description

Auto-completion help, take bash as an example

$ ./dtm completion bash -h
generate autocompletion script for bash

Usage:
  dtm completion bash [flags]

Examples:
Load is completions in the current shell session:
# source <(dtm completion bash)

load completions for every new session:
(in Linux)# dtm completion bash > /etc/bash_completion.d/dtm
(in MacOS)# dtm completion bash > /usr/local/etc/bash_completion.d/dtm

Flags:
  -h, --help   help for bash

Global Flags:
      --debug   debug level log

1、Flags autocomplete

prodan@ubuntu:~/Desktop$ ./dtm show [TAB][TAB]
config  status  
prodan@ubuntu:~/Desktop$ ./dtm show config -[TAB][TAB]
--debug    -p         --plugin   --plugin=  
prodan@ubuntu:~/Desktop$ ./dtm show config -p [TAB][TAB] 
argocd                          githubactions-python            hashicorp-vault                 openldap
argocdapp                       github-repo-scaffolding-golang  helm-generic                    trello
devlake                         gitlabci-generic                jenkins                         trello-github-integ
githubactions-golang            gitlabci-golang                 jira-github-integ               
githubactions-nodejs            gitlab-repo-scaffolding-golang  kube-prometheus                 
prodan@ubuntu:~/Desktop$ ./dtm show config -p gitlab[TAB][TAB]
gitlabci-generic                gitlabci-golang                 gitlab-repo-scaffolding-golang  
prodan@ubuntu:~/Desktop$ ./dtm show config -p gitlab

2、Args autocomplete

prodan@ubuntu:~/Desktop$ ./dtm list plugins [TAB][TAB]
argocd                          githubactions-python            hashicorp-vault                 openldap
argocdapp                       github-repo-scaffolding-golang  helm-generic                    trello
devlake                         gitlabci-generic                jenkins                         trello-github-integ
githubactions-golang            gitlabci-golang                 jira-github-integ               
githubactions-nodejs            gitlab-repo-scaffolding-golang  kube-prometheus                 
prodan@ubuntu:~/Desktop$ ./dtm list plugins argocd[TAB][TAB]
argocd     argocdapp  
prodan@ubuntu:~/Desktop$ ./dtm list plugins argocd

3、Autocompletion when binary name is not dtm

prodan@ubuntu:~/Desktop$ source <(./dtm-linux-amd64 completion bash)
prodan@ubuntu:~/Desktop$ ./dtm-linux-amd64 [TAB][TAB]
apply       completion  delete      destroy     develop     help        init        list        show        verify      version     
prodan@ubuntu:~/Desktop$ ./dtm-linux-amd64 show [TAB][TAB]
config  status  
prodan@ubuntu:~/Desktop$ ./dtm-linux-amd64 show config -p [TAB][TAB]
argocd                          githubactions-python            hashicorp-vault                 openldap
argocdapp                       github-repo-scaffolding-golang  helm-generic                    trello
devlake                         gitlabci-generic                jenkins                         trello-github-integ
githubactions-golang            gitlabci-golang                 jira-github-integ               
githubactions-nodejs            gitlab-repo-scaffolding-golang  kube-prometheus                 
prodan@ubuntu:~/Desktop$ ./dtm-linux-amd64 show config -p

Related Issues

#642

New Behavior (screenshots if needed)

daniel-hutao · 2022-06-03T12:45:18Z

Hi @prodanlabs, This pr is great! Please fix the ci error, then we will finish the review and merge as soon as possible!

daniel-hutao · 2022-06-03T12:45:53Z

@imxw Would you please help to take a review at this pr too?

imxw · 2022-06-03T13:15:12Z

@imxw Would you please help to take a review at this pr too?

Of course, it's my pleasure.

prodanlabs · 2022-06-04T02:03:24Z

cc /@daniel-hutao

IronCore864 · 2022-06-06T01:12:04Z

+	return cmd
+}
+
+func completionBash(out io.Writer, cmd *cobra.Command) error {


We follow the Standard Go Project Layout, and the cmd directory is better not to contain a lot of logic:

Don't put a lot of code in the application directory. If you think the code can be imported and used in other projects, then it should live in the /pkg directory. If the code is not reusable or if you don't want others to reuse it, put that code in the /internal directory. You'll be surprised what others will do, so be explicit about your intentions!

Based on this, I suggest we move the code from line 63 to the end of this file to another place, like internal/pkg/completion/xxx.go (only an example/a suggestion.)

IronCore864 · 2022-06-06T01:13:04Z

+	"github.com/spf13/cobra"
+)
+
+// completionCMD represents the completion command


This seems to be a little bit redundant information. I think it's fine if we don't have this comment at all.

IronCore864 · 2022-06-06T01:16:40Z

@prodanlabs thanks for this great feature. I reviewed and added two little comments.

IronCore864 · 2022-06-06T01:46:31Z

After some testing, there is another comment I would like to add:

On macOS, given how bash-completion is installed, the default location of completion scripts isn't necessarily always /usr/local/etc/bash_completion.d/dtm.

For example, if auto-completion@2 is installed with brew, it seems the default location is /opt/homebrew/etc/bash_completion.d.

So, it's not accurate to put a default location (especially for macOS, considering how many people are using brew) in the help doc. Maybe we can give some extra information in the help doc.

Another issue is, there are two versions of bash-completion, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. I didn't test if the dtm completion script works with Bash 3.2 or not. I think it's best to tell macOS users how to upgrade to Bash 4.1+ (maybe brew install) and to install auto-completion@2.

K8s has a decent doc on auto-completion: https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-mac/

We could also write a blog about it. Are you interested? @prodanlabs

prodanlabs · 2022-06-06T01:50:40Z

Changes have been made as suggested by the comments, but I haven't seen this style cobra project.

prodanlabs · 2022-06-06T02:03:10Z

After some testing, there is another comment I would like to add:

On macOS, given how bash-completion is installed, the default location of completion scripts isn't necessarily always /usr/local/etc/bash_completion.d/dtm.

For example, if auto-completion@2 is installed with brew, it seems the default location is /opt/homebrew/etc/bash_completion.d.

So, it's not accurate to put a default location (especially for macOS, considering how many people are using brew) in the help doc. Maybe we can give some extra information in the help doc.

Another issue is, there are two versions of bash-completion, v1 and v2. V1 is for Bash 3.2 (which is the default on macOS), and v2 is for Bash 4.1+. I didn't test if the dtm completion script works with Bash 3.2 or not. I think it's best to tell macOS users how to upgrade to Bash 4.1+ (maybe brew install) and to install auto-completion@2.

K8s has a decent doc on auto-completion: https://kubernetes.io/docs/tasks/tools/included/optional-kubectl-configs-bash-mac/

We could also write a blog about it. Are you interested? @prodanlabs

Personally, I think Example should be generic, as for other cases, I think you are right, you should write a document description. But unfortunately I can't do it because I don't have MacOS

imxw · 2022-06-06T08:27:34Z

@prodanlabs Thanks for your contribution, I like your idea! After testing, I have left a few comments. In addition, I wonder if you'd be interested in implementing this completion feature, where [TAB][TAB] only shows yaml type files when using -f flag.

imxw · 2022-06-06T06:29:34Z

+func completionCMD(out io.Writer) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:                   "completion",
+		Short:                 "Generate the autocompletion script for dtm for the specified shell.",


This is not a problem, but to unify other help information styles, I don’t know if you mind removing the period at the end of the help info.

imxw · 2022-06-06T08:05:05Z

+	if len(args) == 1 {
+		var choices []string
+		for _, pluginName := range list.PluginsNameSlice() {
+			if strings.HasPrefix(pluginName, args[0]) {


The purpose of dtm list plugins is to show all available plugins, so why filter the specified plugins here?

same as dtm list plugins -r, filter plugin by regex.

same as dtm list plugins -r, filter plugin by regex.

There is one difference, the result of dtm list plugins -r is the result of regular matching, but here only the operation [TAB][TAB] will filter out the relevant plugin name, the execution of the command does not affect the output, it is still all available plugins.

Yes, do [TAB][TAB] to match or complete. complete is always like this.

Yes, do [TAB][TAB] to match or complete. complete is always like this.

Yeah, but plugins here are not args or subcommands. It's just like kubectl plugin list.

I don't think this is the problem. When the user wants to know how many plugins are related to argocd, they can simply do dtm list plugins argocd[TAB][TAB] to filter them out. I believe this is also the purpose of dtm list plugins -r.

@prodanlabs the only ways to use the list plugins subcommand are:

dtm list plugins which shows all the plugins

dtm list plugins -r argo which shows the plugins whose names match "argo"

So, even if the user types dtm list plugins argo [tab][tab] and it shows dtm list plugins argocd, it's not useful, because the user can't execute this command.

I think that's why @imxw thought this isn't necessary.

imxw · 2022-06-06T08:59:59Z

+
+Load completions for every new session:
+(in Linux)# %s completion bash > /etc/bash_completion.d/dtm
+(in MacOS)# %s completion bash > /usr/local/etc/bash_completion.d/dtm`, binary, binary, binary)


/usr/local can be changed to $(brew --prefix), because only Mac computers with Intel processors is /usr/local, but M1 is /opt/homebrew

prodanlabs · 2022-06-06T16:03:57Z

@prodanlabs Thanks for your contribution, I like your idea! After testing, I have left a few comments. In addition, I wonder if you'd be interested in implementing this completion feature, where [TAB][TAB] only shows yaml type files when using -f flag.

I don't think it makes much sense, to be honest.

prodanlabs · 2022-06-06T18:16:24Z

Configuration file completion

prodan@ubuntu:~/Desktop$ tree ./
./
├── 11.yaml
├── 22.yaml
├── dtm
├── t1.josn
├── test
│   ├── 33.yaml
│   ├── 44.yaml
│   ├── t3.txt
│   └── t4.log
└── t.josn

1 directory, 9 files
prodan@ubuntu:~/Desktop$ ./dtm apply -f [TAB][TAB]
11.yaml  22.yaml  test/    
prodan@ubuntu:~/Desktop$ ./dtm apply -f test/[TAB][TAB]
33.yaml  44.yaml  
prodan@ubuntu:~/Desktop$ ./dtm apply -f test/

imxw · 2022-06-07T01:28:55Z

@prodanlabs Thanks for your contribution, I like your idea! After testing, I have left a few comments. In addition, I wonder if you'd be interested in implementing this completion feature, where [TAB][TAB] only shows yaml type files when using -f flag.

I don't think it makes much sense, to be honest.

It's okay, it's not mandatory to achieve.

imxw · 2022-06-07T03:17:50Z

+	}
+}
+
+func FlagConfigFileCompletion(cmd *cobra.Command) {


As I said before, it's not mandatory to achieve and you also didn't think it is necessary to achieve, but since you have achieved it, I refer to the official documentation and found that this implementation is not applicable to Fish and PowerShell

Fish doesn't support BashCompFilenameExt

Powershell doesn't support BashCompFilenameExt

A more generic implementation is as follows.

https://github.com/spf13/cobra/blob/d8184d32696bee36f682bcb3ace5642af54cd7ad/shell_completions.md#specify-valid-filename-extensions-for-flags-that-take-a-filename

Of course, if you still don't think it's necessary to implement this feature, you can just remove the relevant code. Thanks again.

imxw · 2022-06-07T06:57:25Z

+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
+func ArgsPluginsCompletion(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {


I don't think this is the problem. When the user wants to know how many plugins are related to argocd, they can simply do dtm list plugins argocd[TAB][TAB] to filter them out. I believe this is also the purpose of dtm list plugins -r.

I agree that we need to allow users to filter plugins. So dtm list plugins -r should be accepted. However, in my opinion, the premise dtm list plugins argocd[TAB][TAB] can be accepted is that dtm list plugins accepts the plugin name as arg or subcommand. I don't know if you understand what I mean.

I think dtm list plugins -r xxx is good. The result can be used as stdin for other commands. For example

dtm list plugins -r "\bargocd\b" | dtm show config dtm show config $(dtm list plugins -r "\bargocd\b")

The results of dtm list plugins argocd are the same as dtm list plugins. In addition, we have to clean up the command manually before executing the next command.

In summary, why do we need dtm list plugins argocd[TAB][TAB].

What do you think? @daniel-hutao @IronCore864

Right, the dtm list plugins argocd command does not exist; dtm list plugins is used to print all plugins, and this command has no further subcommands, it only has flags, like -r. So dtm list plugins [tag] should not output specific plugin names.

imxw · 2022-06-07T07:29:44Z

The current zsh completion generated by cobra does not work, but the problem has been solved in this pr, we can fix it by go get github.com/spf13/cobra@master or wait for cobra's version 1.5.0 @prodanlabs @daniel-hutao @IronCore864

daniel-hutao

This discussion took too long, everyone worked hard!

@imxw please help to add the documentation after this pr is merged in.

Signed-off-by: prodan <pengshihaoren@gmail.com>

daniel-hutao · 2022-06-10T04:40:18Z

The current zsh completion generated by cobra does not work, but the problem has been solved in this pr, we can fix it by go get github.com/spf13/cobra@master or wait for cobra's version 1.5.0 @prodanlabs @daniel-hutao @IronCore864

Please continue to follow up on this issue, I suggest using cobra stable version, please wait for the 1.5.0 version release to fix it.

daniel-hutao requested review from IronCore864, daniel-hutao and imxw June 3, 2022 12:43

daniel-hutao mentioned this pull request Jun 3, 2022

🍀 Proposal: dtm command auto-completion #642

Closed

prodanlabs changed the title ~~dtm command completion~~ feat: add command completion Jun 4, 2022

IronCore864 requested changes Jun 6, 2022

View reviewed changes

prodanlabs requested a review from IronCore864 June 6, 2022 01:49

imxw reviewed Jun 6, 2022

View reviewed changes

prodanlabs requested a review from imxw June 6, 2022 09:14

imxw requested changes Jun 7, 2022

View reviewed changes

prodanlabs mentioned this pull request Jun 9, 2022

🍀 Proposal: Add a plugin to create a Jenkins pipeline #582

Closed

imxw approved these changes Jun 10, 2022

View reviewed changes

daniel-hutao reviewed Jun 10, 2022

View reviewed changes

prodanlabs requested a review from a team as a code owner June 10, 2022 04:31

feat: add command completion

fcfcb58

Signed-off-by: prodan <pengshihaoren@gmail.com>

daniel-hutao approved these changes Jun 10, 2022

View reviewed changes

daniel-hutao merged commit 1546a6f into devstream-io:main Jun 10, 2022

prodanlabs deleted the feat-command-completion branch June 24, 2022 06:20

Conversation

prodanlabs commented Jun 1, 2022

Pre-Checklist

Description

Related Issues

New Behavior (screenshots if needed)

Uh oh!

daniel-hutao commented Jun 3, 2022

Uh oh!

daniel-hutao commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

imxw commented Jun 3, 2022

Uh oh!

prodanlabs commented Jun 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IronCore864 commented Jun 6, 2022

Uh oh!

IronCore864 commented Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prodanlabs commented Jun 6, 2022

Uh oh!

prodanlabs commented Jun 6, 2022

Uh oh!

imxw commented Jun 6, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imxw Jun 6, 2022 • 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!

prodanlabs commented Jun 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

prodanlabs commented Jun 6, 2022

Uh oh!

imxw commented Jun 7, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imxw commented Jun 7, 2022

Uh oh!

daniel-hutao left a comment

Choose a reason for hiding this comment

Uh oh!

daniel-hutao commented Jun 10, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

daniel-hutao commented Jun 3, 2022 •

edited

Loading

prodanlabs commented Jun 4, 2022 •

edited

Loading

IronCore864 commented Jun 6, 2022 •

edited

Loading

imxw Jun 6, 2022 •

edited

Loading

prodanlabs commented Jun 6, 2022 •

edited

Loading