Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli: bump the cobra dependency and add autocompletion for fish #63839

Merged
merged 1 commit into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions DEPS.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,14 @@ def go_deps():
sum = "h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk=",
version = "v1.0.10",
)
go_repository(
name = "com_github_cpuguy83_go_md2man_v2",
build_file_proto_mode = "disable_global",
importpath = "github.com/cpuguy83/go-md2man/v2",
sum = "h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM=",
version = "v2.0.0",
)

go_repository(
name = "com_github_creack_pty",
build_file_proto_mode = "disable_global",
Expand Down Expand Up @@ -3270,6 +3278,14 @@ def go_deps():
sum = "h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=",
version = "v1.5.2",
)
go_repository(
name = "com_github_russross_blackfriday_v2",
build_file_proto_mode = "disable_global",
importpath = "github.com/russross/blackfriday/v2",
sum = "h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=",
version = "v2.0.1",
)

go_repository(
name = "com_github_ryanuber_columnize",
build_file_proto_mode = "disable_global",
Expand Down Expand Up @@ -3425,8 +3441,8 @@ def go_deps():
name = "com_github_spf13_cobra",
build_file_proto_mode = "disable_global",
importpath = "github.com/spf13/cobra",
sum = "h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=",
version = "v0.0.5",
sum = "h1:xghbfqPkxzxP3C/f3n5DdpAbdKLj4ZE4BWQI362l53M=",
version = "v1.1.3",
)
go_repository(
name = "com_github_spf13_jwalterweatherman",
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ require (
github.com/sasha-s/go-deadlock v0.2.0
github.com/shirou/gopsutil v2.20.9+incompatible
github.com/shopspring/decimal v1.2.0 // indirect
github.com/spf13/cobra v0.0.5
github.com/spf13/cobra v1.1.3
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.6.1
github.com/twpayne/go-geom v1.3.7-0.20210228220813-9d9885b50d3e
Expand Down
10 changes: 8 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,8 @@ github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfc
github.com/corpix/uarand v0.1.1/go.mod h1:SFKZvkcRoLqVRFZ4u25xPmp6m9ktANfbpXZ7SJ0/FNU=
github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk=
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
github.com/cpuguy83/go-md2man/v2 v2.0.0 h1:EoUDS0afbrsXAZ9YQ9jdu/mZ2sXgT1/2yyNng4PGlyM=
github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
Expand Down Expand Up @@ -568,7 +570,6 @@ github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e h1:1r7pUrabqp18h
github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/mock v1.2.0/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/mock v1.3.1 h1:qGJ6qTW+x6xX/my+8YUVl4WNpX9B7+/l2tRsHGZ7f2s=
github.com/golang/mock v1.3.1/go.mod h1:sBzyDLLjw3U8JLTeZvSv8jJB+tU5PVekmnlKIyFUx0Y=
github.com/golang/mock v1.4.0/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
github.com/golang/mock v1.4.1/go.mod h1:UOMv5ysSaYNkG+OFQykRIcU/QvvxJf3p21QfJ2Bt3cw=
Expand Down Expand Up @@ -1123,6 +1124,8 @@ github.com/rs/zerolog v1.13.0/go.mod h1:YbFCdg8HfsridGWAh22vktObvhZbQsZXe4/zB0OK
github.com/rs/zerolog v1.15.0/go.mod h1:xYTKnLHcpfU2225ny5qZjxnj9NvkumZYjJHlAThCjNc=
github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
github.com/samuel/go-zookeeper v0.0.0-20200724154423-2164a8ac840e/go.mod h1:gi+0XIa01GRL2eRQVjQkKGqKF3SF9vZR/HnPullcV2E=
Expand All @@ -1140,6 +1143,7 @@ github.com/shirou/gopsutil v2.20.9+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu
github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24/go.mod h1:M+9NzErvs504Cn4c5DxATwIqPbtswREoFCre64PpcG4=
github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ=
github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
github.com/sirupsen/logrus v1.4.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
Expand All @@ -1163,8 +1167,9 @@ github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkU
github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng=
github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=
github.com/spf13/cobra v0.0.5 h1:f0B+LkLX6DtmRH1isoNA9VTtNUK9K8xYd28JNNfOv/s=
github.com/spf13/cobra v0.0.5/go.mod h1:3K3wKZymM7VvHMDS9+Akkh4K60UwM26emMESw8tLCHU=
github.com/spf13/cobra v1.1.3 h1:xghbfqPkxzxP3C/f3n5DdpAbdKLj4ZE4BWQI362l53M=
github.com/spf13/cobra v1.1.3/go.mod h1:pGADOWyqRD/YMrPZigI/zbliZ2wVD/23d+is3pSWzOo=
github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb68N+wFjFa4jdeBTo=
github.com/spf13/jwalterweatherman v1.1.0 h1:ue6voC5bR5F8YxI5S67j9i582FU4Qvo2bmqnqMYADFk=
github.com/spf13/jwalterweatherman v1.1.0/go.mod h1:aNWZUN0dPAAO/Ljvb5BEdw96iTZ0EXowPYD95IqWIGo=
Expand All @@ -1174,6 +1179,7 @@ github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnIn
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
github.com/spf13/viper v1.7.0/go.mod h1:8WkrPz2fc9jxqZNCJI/76HCieCp4Q8HaLFoCha5qpdg=
github.com/spf13/viper v1.7.1 h1:pM5oEahlgWv/WnHXpgbKz7iLIxRf65tye2Ci+XFK5sk=
github.com/spf13/viper v1.7.1/go.mod h1:8WkrPz2fc9jxqZNCJI/76HCieCp4Q8HaLFoCha5qpdg=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
Expand Down
1 change: 1 addition & 0 deletions pkg/cli/cli_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1549,6 +1549,7 @@ func TestGenAutocomplete(t *testing.T) {
}{
{shell: ""},
{shell: "bash"},
{shell: "fish"},
{shell: "zsh"},
{shell: "bad", expErr: `invalid argument "bad" for "cockroach gen autocomplete"`},
} {
Expand Down
9 changes: 9 additions & 0 deletions pkg/cli/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,15 @@ func init() {
pf.AddFlag(flag)
})

{
// Since cobra v0.0.7, cobra auto-adds `-v` if not defined. We don't
// want that: we will likely want to add --verbose for some sub-commands,
// and -v should remain reserved as an alias for --verbose.
var unused bool
pf.BoolVarP(&unused, "verbose", "v", false, "")
_ = pf.MarkHidden("verbose")
}

// Logging flags common to all commands.
{
// Logging configuration.
Expand Down
10 changes: 8 additions & 2 deletions pkg/cli/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,16 @@ var genAutocompleteCmd = &cobra.Command{
Long: `Generate autocompletion script for CockroachDB.

If no arguments are passed, or if 'bash' is passed, a bash completion file is
written to ./cockroach.bash. If 'zsh' is passed, a zsh completion file is written
written to ./cockroach.bash. If 'fish' is passed, a fish completion file
is written to ./cockroach.fish. If 'zsh' is passed, a zsh completion file is written
to ./_cockroach. Use "--out=/path/to/file" to override the output file location.

Note that for the generated file to work on OS X with bash, you'll need to install
Homebrew's bash-completion package (or an equivalent) and follow the post-install
instructions.
`,
Args: cobra.OnlyValidArgs,
ValidArgs: []string{"bash", "zsh"},
ValidArgs: []string{"bash", "zsh", "fish"},
RunE: MaybeDecorateGRPCError(runGenAutocompleteCmd),
}

Expand All @@ -112,6 +113,11 @@ func runGenAutocompleteCmd(cmd *cobra.Command, args []string) error {
autoCompletePath = "cockroach.bash"
}
err = cmd.Root().GenBashCompletionFile(autoCompletePath)
case "fish":
if autoCompletePath == "" {
autoCompletePath = "cockroach.fish"
}
err = cmd.Root().GenFishCompletionFile(autoCompletePath, true /* include description */)
case "zsh":
if autoCompletePath == "" {
autoCompletePath = "_cockroach"
Expand Down
2 changes: 1 addition & 1 deletion vendor
Submodule vendor updated 59 files
+0 −20 github.com/cpuguy83/go-md2man/md2man/md2man.go
+0 −285 github.com/cpuguy83/go-md2man/md2man/roff.go
+0 −0 github.com/cpuguy83/go-md2man/v2/LICENSE.md
+14 −0 github.com/cpuguy83/go-md2man/v2/md2man/md2man.go
+345 −0 github.com/cpuguy83/go-md2man/v2/md2man/roff.go
+0 −32 github.com/russross/blackfriday/doc.go
+0 −1 github.com/russross/blackfriday/go.mod
+0 −938 github.com/russross/blackfriday/html.go
+0 −334 github.com/russross/blackfriday/latex.go
+0 −0 github.com/russross/blackfriday/v2/.gitignore
+2 −2 github.com/russross/blackfriday/v2/.travis.yml
+0 −0 github.com/russross/blackfriday/v2/LICENSE.txt
+24 −102 github.com/russross/blackfriday/v2/README.md
+476 −360 github.com/russross/blackfriday/v2/block.go
+18 −0 github.com/russross/blackfriday/v2/doc.go
+34 −0 github.com/russross/blackfriday/v2/esc.go
+1 −0 github.com/russross/blackfriday/v2/go.mod
+949 −0 github.com/russross/blackfriday/v2/html.go
+320 −246 github.com/russross/blackfriday/v2/inline.go
+351 −342 github.com/russross/blackfriday/v2/markdown.go
+354 −0 github.com/russross/blackfriday/v2/node.go
+83 −56 github.com/russross/blackfriday/v2/smartypants.go
+16 −0 github.com/shurcooL/sanitized_anchor_name/.travis.yml
+21 −0 github.com/shurcooL/sanitized_anchor_name/LICENSE
+36 −0 github.com/shurcooL/sanitized_anchor_name/README.md
+1 −0 github.com/shurcooL/sanitized_anchor_name/go.mod
+29 −0 github.com/shurcooL/sanitized_anchor_name/main.go
+3 −2 github.com/spf13/cobra/.gitignore
+48 −0 github.com/spf13/cobra/.golangci.yml
+13 −16 github.com/spf13/cobra/.travis.yml
+51 −0 github.com/spf13/cobra/CHANGELOG.md
+37 −0 github.com/spf13/cobra/CONDUCT.md
+50 −0 github.com/spf13/cobra/CONTRIBUTING.md
+40 −0 github.com/spf13/cobra/Makefile
+119 −100 github.com/spf13/cobra/README.md
+9 −1 github.com/spf13/cobra/args.go
+207 −73 github.com/spf13/cobra/bash_completions.go
+8 −173 github.com/spf13/cobra/bash_completions.md
+17 −2 github.com/spf13/cobra/cobra.go
+140 −68 github.com/spf13/cobra/command.go
+557 −0 github.com/spf13/cobra/custom_completions.go
+12 −0 github.com/spf13/cobra/doc/README.md
+18 −20 github.com/spf13/cobra/doc/man_docs.go
+5 −9 github.com/spf13/cobra/doc/md_docs.go
+1 −1 github.com/spf13/cobra/doc/md_docs.md
+1 −1 github.com/spf13/cobra/doc/util.go
+5 −0 github.com/spf13/cobra/doc/yaml_docs.go
+207 −0 github.com/spf13/cobra/fish_completions.go
+4 −0 github.com/spf13/cobra/fish_completions.md
+4 −5 github.com/spf13/cobra/go.mod
+285 −23 github.com/spf13/cobra/go.sum
+254 −69 github.com/spf13/cobra/powershell_completions.go
+1 −12 github.com/spf13/cobra/powershell_completions.md
+38 −0 github.com/spf13/cobra/projects_using_cobra.md
+26 −27 github.com/spf13/cobra/shell_completions.go
+483 −0 github.com/spf13/cobra/shell_completions.md
+214 −310 github.com/spf13/cobra/zsh_completions.go
+48 −39 github.com/spf13/cobra/zsh_completions.md
+7 −5 modules.txt