mirror of
https://github.com/spf13/cobra
synced 2024-09-28 19:06:26 +00:00
Merge branch 'main' into nushell
This commit is contained in:
commit
aaf5cf8177
19
.github/labeler.yml
vendored
19
.github/labeler.yml
vendored
|
@ -1,17 +1,24 @@
|
||||||
# changes to documentation generation
|
# changes to documentation generation
|
||||||
"area/docs-generation": doc/**/*
|
"area/docs-generation":
|
||||||
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: 'doc/**'
|
||||||
|
|
||||||
# changes to the core cobra command
|
# changes to the core cobra command
|
||||||
"area/cobra-command":
|
"area/cobra-command":
|
||||||
- any: ['./cobra.go', './cobra_test.go', './*command*.go']
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: ['./cobra.go', './cobra_test.go', './*command*.go']
|
||||||
|
|
||||||
# changes made to command flags/args
|
# changes made to command flags/args
|
||||||
"area/flags": ./args*.go
|
"area/flags":
|
||||||
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: './args*.go'
|
||||||
|
|
||||||
# changes to Github workflows
|
# changes to Github workflows
|
||||||
"area/github": .github/**/*
|
"area/github":
|
||||||
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: '.github/**'
|
||||||
|
|
||||||
# changes to shell completions
|
# changes to shell completions
|
||||||
"area/shell-completion":
|
"area/shell-completion":
|
||||||
- ./*completions*
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: './*completions*'
|
||||||
|
|
2
.github/workflows/labeler.yml
vendored
2
.github/workflows/labeler.yml
vendored
|
@ -12,7 +12,7 @@ jobs:
|
||||||
pull-requests: write # for actions/labeler to add labels to PRs
|
pull-requests: write # for actions/labeler to add labels to PRs
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/labeler@v4
|
- uses: actions/labeler@v5
|
||||||
with:
|
with:
|
||||||
repo-token: "${{ github.token }}"
|
repo-token: "${{ github.token }}"
|
||||||
|
|
||||||
|
|
56
.github/workflows/stale.yml
vendored
56
.github/workflows/stale.yml
vendored
|
@ -1,56 +0,0 @@
|
||||||
name: Mark stale issues and pull requests
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "0 0 * * *"
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
stale:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
issues: write # for actions/stale to close stale issues
|
|
||||||
pull-requests: write # for actions/stale to close stale PRs
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/stale@v6
|
|
||||||
with:
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
stale-issue-message: "The Cobra project currently lacks enough contributors to adequately respond to all issues.
|
|
||||||
This bot triages issues and PRs according to the following rules:
|
|
||||||
|
|
||||||
- After 60d of inactivity, lifecycle/stale is applied.
|
|
||||||
- After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the issue is closed.
|
|
||||||
|
|
||||||
You can:
|
|
||||||
|
|
||||||
- Make a comment to remove the stale label and show your support. The 60 days reset.
|
|
||||||
- If an issue has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening"
|
|
||||||
|
|
||||||
stale-pr-message: "The Cobra project currently lacks enough contributors to adequately respond to all PRs.
|
|
||||||
This bot triages issues and PRs according to the following rules:
|
|
||||||
|
|
||||||
- After 60d of inactivity, lifecycle/stale is applied.
|
|
||||||
- After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed.
|
|
||||||
|
|
||||||
You can:
|
|
||||||
|
|
||||||
- Make a comment to remove the stale label and show your support. The 60 days reset.
|
|
||||||
- If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening."
|
|
||||||
|
|
||||||
days-before-stale: 60
|
|
||||||
days-before-close: 30
|
|
||||||
stale-issue-label: 'lifecycle/stale'
|
|
||||||
stale-pr-label: 'lifecycle/stale'
|
|
||||||
exempt-issue-labels: 'lifecycle/frozen'
|
|
||||||
exempt-pr-labels: 'lifecycle/frozen'
|
|
||||||
close-issue-label: 'lifecycle/rotten'
|
|
||||||
close-pr-label: 'lifecycle/rotten'
|
|
||||||
|
|
||||||
# Since cobra has so many legacy issues and PRs that need to be triaged,
|
|
||||||
# only label new PRs and issues.
|
|
||||||
start-date: '2022-02-01T00:00:00Z'
|
|
||||||
|
|
39
.github/workflows/test.yml
vendored
39
.github/workflows/test.yml
vendored
|
@ -18,14 +18,14 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- run: >-
|
- run: >-
|
||||||
docker run
|
docker run
|
||||||
-v $(pwd):/wrk -w /wrk
|
-v $(pwd):/wrk -w /wrk
|
||||||
ghcr.io/google/addlicense
|
ghcr.io/google/addlicense
|
||||||
-c 'The Cobra Authors'
|
-c 'The Cobra Authors'
|
||||||
-y '2013-2022'
|
-y '2013-2023'
|
||||||
-l apache
|
-l apache
|
||||||
-ignore '.github/**'
|
-ignore '.github/**'
|
||||||
-check
|
-check
|
||||||
|
@ -39,17 +39,15 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- uses: actions/setup-go@v3
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: '^1.19'
|
go-version: '^1.22'
|
||||||
check-latest: true
|
check-latest: true
|
||||||
cache: true
|
cache: true
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
- uses: golangci/golangci-lint-action@v4.0.0
|
||||||
|
|
||||||
- uses: golangci/golangci-lint-action@v3.2.0
|
|
||||||
with:
|
with:
|
||||||
version: latest
|
version: latest
|
||||||
args: --verbose
|
args: --verbose
|
||||||
|
@ -63,32 +61,29 @@ jobs:
|
||||||
- ubuntu
|
- ubuntu
|
||||||
- macOS
|
- macOS
|
||||||
go:
|
go:
|
||||||
- 15
|
|
||||||
- 16
|
|
||||||
- 17
|
- 17
|
||||||
- 18
|
- 18
|
||||||
- 19
|
- 19
|
||||||
|
- 20
|
||||||
|
- 21
|
||||||
|
- 22
|
||||||
name: '${{ matrix.platform }} | 1.${{ matrix.go }}.x'
|
name: '${{ matrix.platform }} | 1.${{ matrix.go }}.x'
|
||||||
runs-on: ${{ matrix.platform }}-latest
|
runs-on: ${{ matrix.platform }}-latest
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- uses: actions/setup-go@v3
|
- uses: actions/setup-go@v5
|
||||||
with:
|
with:
|
||||||
go-version: 1.${{ matrix.go }}.x
|
go-version: 1.${{ matrix.go }}.x
|
||||||
cache: true
|
cache: true
|
||||||
|
|
||||||
- run: |
|
- run: |
|
||||||
export GOBIN=$HOME/go/bin
|
export GOBIN=$HOME/go/bin
|
||||||
case "${{ matrix.go }}" in
|
go install github.com/kyoh86/richgo@latest
|
||||||
14|15) _version='';;
|
go install github.com/mitchellh/gox@latest
|
||||||
*) _version='@latest';;
|
|
||||||
esac
|
|
||||||
go install github.com/kyoh86/richgo"${_version}"
|
|
||||||
go install github.com/mitchellh/gox"${_version}"
|
|
||||||
|
|
||||||
- run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin/:$PATH make test
|
- run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin/:$PATH make richtest
|
||||||
|
|
||||||
|
|
||||||
test-win:
|
test-win:
|
||||||
|
@ -112,9 +107,9 @@ jobs:
|
||||||
unzip
|
unzip
|
||||||
mingw-w64-x86_64-go
|
mingw-w64-x86_64-go
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- uses: actions/cache@v3
|
- uses: actions/cache@v4
|
||||||
with:
|
with:
|
||||||
path: ~/go/pkg/mod
|
path: ~/go/pkg/mod
|
||||||
key: ${{ runner.os }}-${{ matrix.go }}-${{ hashFiles('**/go.sum') }}
|
key: ${{ runner.os }}-${{ matrix.go }}-${{ hashFiles('**/go.sum') }}
|
||||||
|
@ -125,4 +120,4 @@ jobs:
|
||||||
go install github.com/kyoh86/richgo@latest
|
go install github.com/kyoh86/richgo@latest
|
||||||
go install github.com/mitchellh/gox@latest
|
go install github.com/mitchellh/gox@latest
|
||||||
|
|
||||||
- run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin:$PATH make test
|
- run: RICHGO_FORCE_COLOR=1 PATH=$HOME/go/bin:$PATH make richtest
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Copyright 2013-2022 The Cobra Authors
|
# Copyright 2013-2023 The Cobra Authors
|
||||||
#
|
#
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
# you may not use this file except in compliance with the License.
|
# you may not use this file except in compliance with the License.
|
||||||
|
@ -19,7 +19,7 @@ linters:
|
||||||
disable-all: true
|
disable-all: true
|
||||||
enable:
|
enable:
|
||||||
#- bodyclose
|
#- bodyclose
|
||||||
- deadcode
|
# - deadcode ! deprecated since v1.49.0; replaced by 'unused'
|
||||||
#- depguard
|
#- depguard
|
||||||
#- dogsled
|
#- dogsled
|
||||||
#- dupl
|
#- dupl
|
||||||
|
@ -29,7 +29,7 @@ linters:
|
||||||
- gas
|
- gas
|
||||||
#- gochecknoinits
|
#- gochecknoinits
|
||||||
- goconst
|
- goconst
|
||||||
#- gocritic
|
- gocritic
|
||||||
#- gocyclo
|
#- gocyclo
|
||||||
#- gofmt
|
#- gofmt
|
||||||
- goimports
|
- goimports
|
||||||
|
@ -37,7 +37,7 @@ linters:
|
||||||
#- gomnd
|
#- gomnd
|
||||||
#- goprintffuncname
|
#- goprintffuncname
|
||||||
#- gosec
|
#- gosec
|
||||||
#- gosimple
|
- gosimple
|
||||||
- govet
|
- govet
|
||||||
- ineffassign
|
- ineffassign
|
||||||
- interfacer
|
- interfacer
|
||||||
|
@ -51,12 +51,12 @@ linters:
|
||||||
#- rowserrcheck
|
#- rowserrcheck
|
||||||
#- scopelint
|
#- scopelint
|
||||||
#- staticcheck
|
#- staticcheck
|
||||||
- structcheck
|
#- structcheck ! deprecated since v1.49.0; replaced by 'unused'
|
||||||
#- stylecheck
|
#- stylecheck
|
||||||
#- typecheck
|
#- typecheck
|
||||||
- unconvert
|
- unconvert
|
||||||
#- unparam
|
#- unparam
|
||||||
#- unused
|
- unused
|
||||||
- varcheck
|
# - varcheck ! deprecated since v1.49.0; replaced by 'unused'
|
||||||
#- whitespace
|
#- whitespace
|
||||||
fast: false
|
fast: false
|
||||||
|
|
8
Makefile
8
Makefile
|
@ -5,10 +5,6 @@ ifeq (, $(shell which golangci-lint))
|
||||||
$(warning "could not find golangci-lint in $(PATH), run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh")
|
$(warning "could not find golangci-lint in $(PATH), run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh")
|
||||||
endif
|
endif
|
||||||
|
|
||||||
ifeq (, $(shell which richgo))
|
|
||||||
$(warning "could not find richgo in $(PATH), run: go install github.com/kyoh86/richgo@latest")
|
|
||||||
endif
|
|
||||||
|
|
||||||
.PHONY: fmt lint test install_deps clean
|
.PHONY: fmt lint test install_deps clean
|
||||||
|
|
||||||
default: all
|
default: all
|
||||||
|
@ -25,6 +21,10 @@ lint:
|
||||||
|
|
||||||
test: install_deps
|
test: install_deps
|
||||||
$(info ******************** running tests ********************)
|
$(info ******************** running tests ********************)
|
||||||
|
go test -v ./...
|
||||||
|
|
||||||
|
richtest: install_deps
|
||||||
|
$(info ******************** running tests with kyoh86/richgo ********************)
|
||||||
richgo test -v ./...
|
richgo test -v ./...
|
||||||
|
|
||||||
install_deps:
|
install_deps:
|
||||||
|
|
10
README.md
10
README.md
|
@ -1,12 +1,12 @@
|
||||||
![cobra logo](https://cloud.githubusercontent.com/assets/173412/10886352/ad566232-814f-11e5-9cd0-aa101788c117.png)
|
![cobra logo](assets/CobraMain.png)
|
||||||
|
|
||||||
Cobra is a library for creating powerful modern CLI applications.
|
Cobra is a library for creating powerful modern CLI applications.
|
||||||
|
|
||||||
Cobra is used in many Go projects such as [Kubernetes](https://kubernetes.io/),
|
Cobra is used in many Go projects such as [Kubernetes](https://kubernetes.io/),
|
||||||
[Hugo](https://gohugo.io), and [GitHub CLI](https://github.com/cli/cli) to
|
[Hugo](https://gohugo.io), and [GitHub CLI](https://github.com/cli/cli) to
|
||||||
name a few. [This list](./projects_using_cobra.md) contains a more extensive list of projects using Cobra.
|
name a few. [This list](site/content/projects_using_cobra.md) contains a more extensive list of projects using Cobra.
|
||||||
|
|
||||||
[![](https://img.shields.io/github/workflow/status/spf13/cobra/Test?longCache=tru&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/spf13/cobra/actions?query=workflow%3ATest)
|
[![](https://img.shields.io/github/actions/workflow/status/spf13/cobra/test.yml?branch=main&longCache=true&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/spf13/cobra/actions?query=workflow%3ATest)
|
||||||
[![Go Reference](https://pkg.go.dev/badge/github.com/spf13/cobra.svg)](https://pkg.go.dev/github.com/spf13/cobra)
|
[![Go Reference](https://pkg.go.dev/badge/github.com/spf13/cobra.svg)](https://pkg.go.dev/github.com/spf13/cobra)
|
||||||
[![Go Report Card](https://goreportcard.com/badge/github.com/spf13/cobra)](https://goreportcard.com/report/github.com/spf13/cobra)
|
[![Go Report Card](https://goreportcard.com/badge/github.com/spf13/cobra)](https://goreportcard.com/report/github.com/spf13/cobra)
|
||||||
[![Slack](https://img.shields.io/badge/Slack-cobra-brightgreen)](https://gophers.slack.com/archives/CD3LP1199)
|
[![Slack](https://img.shields.io/badge/Slack-cobra-brightgreen)](https://gophers.slack.com/archives/CD3LP1199)
|
||||||
|
@ -105,8 +105,8 @@ go install github.com/spf13/cobra-cli@latest
|
||||||
|
|
||||||
For complete details on using the Cobra-CLI generator, please read [The Cobra Generator README](https://github.com/spf13/cobra-cli/blob/main/README.md)
|
For complete details on using the Cobra-CLI generator, please read [The Cobra Generator README](https://github.com/spf13/cobra-cli/blob/main/README.md)
|
||||||
|
|
||||||
For complete details on using the Cobra library, please read the [The Cobra User Guide](user_guide.md).
|
For complete details on using the Cobra library, please read the [The Cobra User Guide](site/content/user_guide.md).
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
|
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -17,15 +17,14 @@ package cobra
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
activeHelpMarker = "_activeHelp_ "
|
activeHelpMarker = "_activeHelp_ "
|
||||||
// The below values should not be changed: programs will be using them explicitly
|
// The below values should not be changed: programs will be using them explicitly
|
||||||
// in their user documentation, and users will be using them explicitly.
|
// in their user documentation, and users will be using them explicitly.
|
||||||
activeHelpEnvVarSuffix = "_ACTIVE_HELP"
|
activeHelpEnvVarSuffix = "ACTIVE_HELP"
|
||||||
activeHelpGlobalEnvVar = "COBRA_ACTIVE_HELP"
|
activeHelpGlobalEnvVar = configEnvVarGlobalPrefix + "_" + activeHelpEnvVarSuffix
|
||||||
activeHelpGlobalDisable = "0"
|
activeHelpGlobalDisable = "0"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -42,7 +41,7 @@ func AppendActiveHelp(compArray []string, activeHelpStr string) []string {
|
||||||
|
|
||||||
// GetActiveHelpConfig returns the value of the ActiveHelp environment variable
|
// GetActiveHelpConfig returns the value of the ActiveHelp environment variable
|
||||||
// <PROGRAM>_ACTIVE_HELP where <PROGRAM> is the name of the root command in upper
|
// <PROGRAM>_ACTIVE_HELP where <PROGRAM> is the name of the root command in upper
|
||||||
// case, with all - replaced by _.
|
// case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
// It will always return "0" if the global environment variable COBRA_ACTIVE_HELP
|
// It will always return "0" if the global environment variable COBRA_ACTIVE_HELP
|
||||||
// is set to "0".
|
// is set to "0".
|
||||||
func GetActiveHelpConfig(cmd *Command) string {
|
func GetActiveHelpConfig(cmd *Command) string {
|
||||||
|
@ -55,9 +54,7 @@ func GetActiveHelpConfig(cmd *Command) string {
|
||||||
|
|
||||||
// activeHelpEnvVar returns the name of the program-specific ActiveHelp environment
|
// activeHelpEnvVar returns the name of the program-specific ActiveHelp environment
|
||||||
// variable. It has the format <PROGRAM>_ACTIVE_HELP where <PROGRAM> is the name of the
|
// variable. It has the format <PROGRAM>_ACTIVE_HELP where <PROGRAM> is the name of the
|
||||||
// root command in upper case, with all - replaced by _.
|
// root command in upper case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
func activeHelpEnvVar(name string) string {
|
func activeHelpEnvVar(name string) string {
|
||||||
// This format should not be changed: users will be using it explicitly.
|
return configEnvVar(name, activeHelpEnvVarSuffix)
|
||||||
activeHelpEnvVar := strings.ToUpper(fmt.Sprintf("%s%s", name, activeHelpEnvVarSuffix))
|
|
||||||
return strings.ReplaceAll(activeHelpEnvVar, "-", "_")
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
8
args.go
8
args.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -21,7 +21,7 @@ import (
|
||||||
|
|
||||||
type PositionalArgs func(cmd *Command, args []string) error
|
type PositionalArgs func(cmd *Command, args []string) error
|
||||||
|
|
||||||
// Legacy arg validation has the following behaviour:
|
// legacyArgs validation has the following behaviour:
|
||||||
// - root commands with no subcommands can take arbitrary arguments
|
// - root commands with no subcommands can take arbitrary arguments
|
||||||
// - root commands with subcommands will do subcommand validity checking
|
// - root commands with subcommands will do subcommand validity checking
|
||||||
// - subcommands will always accept arbitrary arguments
|
// - subcommands will always accept arbitrary arguments
|
||||||
|
@ -52,9 +52,9 @@ func OnlyValidArgs(cmd *Command, args []string) error {
|
||||||
if len(cmd.ValidArgs) > 0 {
|
if len(cmd.ValidArgs) > 0 {
|
||||||
// Remove any description that may be included in ValidArgs.
|
// Remove any description that may be included in ValidArgs.
|
||||||
// A description is following a tab character.
|
// A description is following a tab character.
|
||||||
var validArgs []string
|
validArgs := make([]string, 0, len(cmd.ValidArgs))
|
||||||
for _, v := range cmd.ValidArgs {
|
for _, v := range cmd.ValidArgs {
|
||||||
validArgs = append(validArgs, strings.Split(v, "\t")[0])
|
validArgs = append(validArgs, strings.SplitN(v, "\t", 2)[0])
|
||||||
}
|
}
|
||||||
for _, v := range args {
|
for _, v := range args {
|
||||||
if !stringInSlice(v, validArgs) {
|
if !stringInSlice(v, validArgs) {
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
BIN
assets/CobraMain.png
Normal file
BIN
assets/CobraMain.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -85,7 +85,7 @@ __%[1]s_handle_go_custom_completion()
|
||||||
local out requestComp lastParam lastChar comp directive args
|
local out requestComp lastParam lastChar comp directive args
|
||||||
|
|
||||||
# Prepare the command to request completions for the program.
|
# Prepare the command to request completions for the program.
|
||||||
# Calling ${words[0]} instead of directly %[1]s allows to handle aliases
|
# Calling ${words[0]} instead of directly %[1]s allows handling aliases
|
||||||
args=("${words[@]:1}")
|
args=("${words[@]:1}")
|
||||||
# Disable ActiveHelp which is not supported for bash completion v1
|
# Disable ActiveHelp which is not supported for bash completion v1
|
||||||
requestComp="%[8]s=0 ${words[0]} %[2]s ${args[*]}"
|
requestComp="%[8]s=0 ${words[0]} %[2]s ${args[*]}"
|
||||||
|
@ -532,7 +532,7 @@ func writeLocalNonPersistentFlag(buf io.StringWriter, flag *pflag.Flag) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Setup annotations for go completions for registered flags
|
// prepareCustomAnnotationsForFlags setup annotations for go completions for registered flags
|
||||||
func prepareCustomAnnotationsForFlags(cmd *Command) {
|
func prepareCustomAnnotationsForFlags(cmd *Command) {
|
||||||
flagCompletionMutex.RLock()
|
flagCompletionMutex.RLock()
|
||||||
defer flagCompletionMutex.RUnlock()
|
defer flagCompletionMutex.RUnlock()
|
||||||
|
@ -597,19 +597,16 @@ func writeRequiredFlag(buf io.StringWriter, cmd *Command) {
|
||||||
if nonCompletableFlag(flag) {
|
if nonCompletableFlag(flag) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
for key := range flag.Annotations {
|
if _, ok := flag.Annotations[BashCompOneRequiredFlag]; ok {
|
||||||
switch key {
|
format := " must_have_one_flag+=(\"--%s"
|
||||||
case BashCompOneRequiredFlag:
|
if flag.Value.Type() != "bool" {
|
||||||
format := " must_have_one_flag+=(\"--%s"
|
format += "="
|
||||||
if flag.Value.Type() != "bool" {
|
}
|
||||||
format += "="
|
format += cbn
|
||||||
}
|
WriteStringAndCheck(buf, fmt.Sprintf(format, flag.Name))
|
||||||
format += cbn
|
|
||||||
WriteStringAndCheck(buf, fmt.Sprintf(format, flag.Name))
|
|
||||||
|
|
||||||
if len(flag.Shorthand) > 0 {
|
if len(flag.Shorthand) > 0 {
|
||||||
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_flag+=(\"-%s"+cbn, flag.Shorthand))
|
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_flag+=(\"-%s"+cbn, flag.Shorthand))
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
@ -621,7 +618,7 @@ func writeRequiredNouns(buf io.StringWriter, cmd *Command) {
|
||||||
for _, value := range cmd.ValidArgs {
|
for _, value := range cmd.ValidArgs {
|
||||||
// Remove any description that may be included following a tab character.
|
// Remove any description that may be included following a tab character.
|
||||||
// Descriptions are not supported by bash completion.
|
// Descriptions are not supported by bash completion.
|
||||||
value = strings.Split(value, "\t")[0]
|
value = strings.SplitN(value, "\t", 2)[0]
|
||||||
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_noun+=(%q)\n", value))
|
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_noun+=(%q)\n", value))
|
||||||
}
|
}
|
||||||
if cmd.ValidArgsFunction != nil {
|
if cmd.ValidArgsFunction != nil {
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -57,7 +57,7 @@ __%[1]s_get_completion_results() {
|
||||||
local requestComp lastParam lastChar args
|
local requestComp lastParam lastChar args
|
||||||
|
|
||||||
# Prepare the command to request completions for the program.
|
# Prepare the command to request completions for the program.
|
||||||
# Calling ${words[0]} instead of directly %[1]s allows to handle aliases
|
# Calling ${words[0]} instead of directly %[1]s allows handling aliases
|
||||||
args=("${words[@]:1}")
|
args=("${words[@]:1}")
|
||||||
requestComp="${words[0]} %[2]s ${args[*]}"
|
requestComp="${words[0]} %[2]s ${args[*]}"
|
||||||
|
|
||||||
|
@ -101,6 +101,7 @@ __%[1]s_process_completion_results() {
|
||||||
local shellCompDirectiveNoFileComp=%[5]d
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
local shellCompDirectiveFilterFileExt=%[6]d
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
local shellCompDirectiveFilterDirs=%[7]d
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveKeepOrder=%[8]d
|
||||||
|
|
||||||
if (((directive & shellCompDirectiveError) != 0)); then
|
if (((directive & shellCompDirectiveError) != 0)); then
|
||||||
# Error code. No completion.
|
# Error code. No completion.
|
||||||
|
@ -115,6 +116,19 @@ __%[1]s_process_completion_results() {
|
||||||
__%[1]s_debug "No space directive not supported in this version of bash"
|
__%[1]s_debug "No space directive not supported in this version of bash"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
if (((directive & shellCompDirectiveKeepOrder) != 0)); then
|
||||||
|
if [[ $(type -t compopt) == builtin ]]; then
|
||||||
|
# no sort isn't supported for bash less than < 4.4
|
||||||
|
if [[ ${BASH_VERSINFO[0]} -lt 4 || ( ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 4 ) ]]; then
|
||||||
|
__%[1]s_debug "No sort directive not supported in this version of bash"
|
||||||
|
else
|
||||||
|
__%[1]s_debug "Activating keep order"
|
||||||
|
compopt -o nosort
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
__%[1]s_debug "No sort directive not supported in this version of bash"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
if (((directive & shellCompDirectiveNoFileComp) != 0)); then
|
if (((directive & shellCompDirectiveNoFileComp) != 0)); then
|
||||||
if [[ $(type -t compopt) == builtin ]]; then
|
if [[ $(type -t compopt) == builtin ]]; then
|
||||||
__%[1]s_debug "Activating no file completion"
|
__%[1]s_debug "Activating no file completion"
|
||||||
|
@ -183,7 +197,7 @@ __%[1]s_process_completion_results() {
|
||||||
# Separate activeHelp lines from real completions.
|
# Separate activeHelp lines from real completions.
|
||||||
# Fills the $activeHelp and $completions arrays.
|
# Fills the $activeHelp and $completions arrays.
|
||||||
__%[1]s_extract_activeHelp() {
|
__%[1]s_extract_activeHelp() {
|
||||||
local activeHelpMarker="%[8]s"
|
local activeHelpMarker="%[9]s"
|
||||||
local endIndex=${#activeHelpMarker}
|
local endIndex=${#activeHelpMarker}
|
||||||
|
|
||||||
while IFS='' read -r comp; do
|
while IFS='' read -r comp; do
|
||||||
|
@ -360,7 +374,7 @@ fi
|
||||||
# ex: ts=4 sw=4 et filetype=sh
|
# ex: ts=4 sw=4 et filetype=sh
|
||||||
`, name, compCmd,
|
`, name, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs,
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder,
|
||||||
activeHelpMarker))
|
activeHelpMarker))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
21
cobra.go
21
cobra.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -43,12 +43,13 @@ var initializers []func()
|
||||||
var finalizers []func()
|
var finalizers []func()
|
||||||
|
|
||||||
const (
|
const (
|
||||||
defaultPrefixMatching = false
|
defaultPrefixMatching = false
|
||||||
defaultCommandSorting = true
|
defaultCommandSorting = true
|
||||||
defaultCaseInsensitive = false
|
defaultCaseInsensitive = false
|
||||||
|
defaultTraverseRunHooks = false
|
||||||
)
|
)
|
||||||
|
|
||||||
// EnablePrefixMatching allows to set automatic prefix matching. Automatic prefix matching can be a dangerous thing
|
// EnablePrefixMatching allows setting automatic prefix matching. Automatic prefix matching can be a dangerous thing
|
||||||
// to automatically enable in CLI tools.
|
// to automatically enable in CLI tools.
|
||||||
// Set this to true to enable it.
|
// Set this to true to enable it.
|
||||||
var EnablePrefixMatching = defaultPrefixMatching
|
var EnablePrefixMatching = defaultPrefixMatching
|
||||||
|
@ -60,6 +61,10 @@ var EnableCommandSorting = defaultCommandSorting
|
||||||
// EnableCaseInsensitive allows case-insensitive commands names. (case sensitive by default)
|
// EnableCaseInsensitive allows case-insensitive commands names. (case sensitive by default)
|
||||||
var EnableCaseInsensitive = defaultCaseInsensitive
|
var EnableCaseInsensitive = defaultCaseInsensitive
|
||||||
|
|
||||||
|
// EnableTraverseRunHooks executes persistent pre-run and post-run hooks from all parents.
|
||||||
|
// By default this is disabled, which means only the first run hook to be found is executed.
|
||||||
|
var EnableTraverseRunHooks = defaultTraverseRunHooks
|
||||||
|
|
||||||
// MousetrapHelpText enables an information splash screen on Windows
|
// MousetrapHelpText enables an information splash screen on Windows
|
||||||
// if the CLI is started from explorer.exe.
|
// if the CLI is started from explorer.exe.
|
||||||
// To disable the mousetrap, just set this variable to blank string ("").
|
// To disable the mousetrap, just set this variable to blank string ("").
|
||||||
|
@ -167,8 +172,8 @@ func appendIfNotPresent(s, stringToAppend string) string {
|
||||||
|
|
||||||
// rpad adds padding to the right of a string.
|
// rpad adds padding to the right of a string.
|
||||||
func rpad(s string, padding int) string {
|
func rpad(s string, padding int) string {
|
||||||
template := fmt.Sprintf("%%-%ds", padding)
|
formattedString := fmt.Sprintf("%%-%ds", padding)
|
||||||
return fmt.Sprintf(template, s)
|
return fmt.Sprintf(formattedString, s)
|
||||||
}
|
}
|
||||||
|
|
||||||
// tmpl executes the given template text on data, writing the result to w.
|
// tmpl executes the given template text on data, writing the result to w.
|
||||||
|
@ -188,8 +193,6 @@ func ld(s, t string, ignoreCase bool) int {
|
||||||
d := make([][]int, len(s)+1)
|
d := make([][]int, len(s)+1)
|
||||||
for i := range d {
|
for i := range d {
|
||||||
d[i] = make([]int, len(t)+1)
|
d[i] = make([]int, len(t)+1)
|
||||||
}
|
|
||||||
for i := range d {
|
|
||||||
d[i][0] = i
|
d[i][0] = i
|
||||||
}
|
}
|
||||||
for j := range d[0] {
|
for j := range d[0] {
|
||||||
|
|
184
cobra_test.go
184
cobra_test.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -40,3 +40,185 @@ func TestAddTemplateFunctions(t *testing.T) {
|
||||||
t.Errorf("Expected UsageString: %v\nGot: %v", expected, got)
|
t.Errorf("Expected UsageString: %v\nGot: %v", expected, got)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLevenshteinDistance(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
s string
|
||||||
|
t string
|
||||||
|
ignoreCase bool
|
||||||
|
expected int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Equal strings (case-sensitive)",
|
||||||
|
s: "hello",
|
||||||
|
t: "hello",
|
||||||
|
ignoreCase: false,
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Equal strings (case-insensitive)",
|
||||||
|
s: "Hello",
|
||||||
|
t: "hello",
|
||||||
|
ignoreCase: true,
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Different strings (case-sensitive)",
|
||||||
|
s: "kitten",
|
||||||
|
t: "sitting",
|
||||||
|
ignoreCase: false,
|
||||||
|
expected: 3,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Different strings (case-insensitive)",
|
||||||
|
s: "Kitten",
|
||||||
|
t: "Sitting",
|
||||||
|
ignoreCase: true,
|
||||||
|
expected: 3,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty strings",
|
||||||
|
s: "",
|
||||||
|
t: "",
|
||||||
|
ignoreCase: false,
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "One empty string",
|
||||||
|
s: "abc",
|
||||||
|
t: "",
|
||||||
|
ignoreCase: false,
|
||||||
|
expected: 3,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Both empty strings",
|
||||||
|
s: "",
|
||||||
|
t: "",
|
||||||
|
ignoreCase: true,
|
||||||
|
expected: 0,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Act
|
||||||
|
got := ld(tt.s, tt.t, tt.ignoreCase)
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
if got != tt.expected {
|
||||||
|
t.Errorf("Expected ld: %v\nGot: %v", tt.expected, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestStringInSlice(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
a string
|
||||||
|
list []string
|
||||||
|
expected bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "String in slice (case-sensitive)",
|
||||||
|
a: "apple",
|
||||||
|
list: []string{"orange", "banana", "apple", "grape"},
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "String not in slice (case-sensitive)",
|
||||||
|
a: "pear",
|
||||||
|
list: []string{"orange", "banana", "apple", "grape"},
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "String in slice (case-insensitive)",
|
||||||
|
a: "APPLE",
|
||||||
|
list: []string{"orange", "banana", "apple", "grape"},
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty slice",
|
||||||
|
a: "apple",
|
||||||
|
list: []string{},
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty string",
|
||||||
|
a: "",
|
||||||
|
list: []string{"orange", "banana", "apple", "grape"},
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty strings match",
|
||||||
|
a: "",
|
||||||
|
list: []string{"orange", ""},
|
||||||
|
expected: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty string in empty slice",
|
||||||
|
a: "",
|
||||||
|
list: []string{},
|
||||||
|
expected: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Act
|
||||||
|
got := stringInSlice(tt.a, tt.list)
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
if got != tt.expected {
|
||||||
|
t.Errorf("Expected stringInSlice: %v\nGot: %v", tt.expected, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRpad(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
inputString string
|
||||||
|
padding int
|
||||||
|
expected string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Padding required",
|
||||||
|
inputString: "Hello",
|
||||||
|
padding: 10,
|
||||||
|
expected: "Hello ",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "No padding required",
|
||||||
|
inputString: "World",
|
||||||
|
padding: 5,
|
||||||
|
expected: "World",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Empty string",
|
||||||
|
inputString: "",
|
||||||
|
padding: 8,
|
||||||
|
expected: " ",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Zero padding",
|
||||||
|
inputString: "cobra",
|
||||||
|
padding: 0,
|
||||||
|
expected: "cobra",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
// Act
|
||||||
|
got := rpad(tt.inputString, tt.padding)
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
if got != tt.expected {
|
||||||
|
t.Errorf("Expected rpad: %v\nGot: %v", tt.expected, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
131
command.go
131
command.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -30,12 +30,15 @@ import (
|
||||||
flag "github.com/spf13/pflag"
|
flag "github.com/spf13/pflag"
|
||||||
)
|
)
|
||||||
|
|
||||||
const FlagSetByCobraAnnotation = "cobra_annotation_flag_set_by_cobra"
|
const (
|
||||||
|
FlagSetByCobraAnnotation = "cobra_annotation_flag_set_by_cobra"
|
||||||
|
CommandDisplayNameAnnotation = "cobra_annotation_command_display_name"
|
||||||
|
)
|
||||||
|
|
||||||
// FParseErrWhitelist configures Flag parse errors to be ignored
|
// FParseErrWhitelist configures Flag parse errors to be ignored
|
||||||
type FParseErrWhitelist flag.ParseErrorsWhitelist
|
type FParseErrWhitelist flag.ParseErrorsWhitelist
|
||||||
|
|
||||||
// Structure to manage groups for commands
|
// Group Structure to manage groups for commands
|
||||||
type Group struct {
|
type Group struct {
|
||||||
ID string
|
ID string
|
||||||
Title string
|
Title string
|
||||||
|
@ -47,7 +50,7 @@ type Group struct {
|
||||||
// definition to ensure usability.
|
// definition to ensure usability.
|
||||||
type Command struct {
|
type Command struct {
|
||||||
// Use is the one-line usage message.
|
// Use is the one-line usage message.
|
||||||
// Recommended syntax is as follow:
|
// Recommended syntax is as follows:
|
||||||
// [ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.
|
// [ ] identifies an optional argument. Arguments that are not enclosed in brackets are required.
|
||||||
// ... indicates that you can specify multiple values for the previous argument.
|
// ... indicates that you can specify multiple values for the previous argument.
|
||||||
// | indicates mutually exclusive information. You can use the argument to the left of the separator or the
|
// | indicates mutually exclusive information. You can use the argument to the left of the separator or the
|
||||||
|
@ -99,7 +102,7 @@ type Command struct {
|
||||||
Deprecated string
|
Deprecated string
|
||||||
|
|
||||||
// Annotations are key/value pairs that can be used by applications to identify or
|
// Annotations are key/value pairs that can be used by applications to identify or
|
||||||
// group commands.
|
// group commands or set special options.
|
||||||
Annotations map[string]string
|
Annotations map[string]string
|
||||||
|
|
||||||
// Version defines the version for this command. If this value is non-empty and the command does not
|
// Version defines the version for this command. If this value is non-empty and the command does not
|
||||||
|
@ -115,6 +118,8 @@ type Command struct {
|
||||||
// * PostRun()
|
// * PostRun()
|
||||||
// * PersistentPostRun()
|
// * PersistentPostRun()
|
||||||
// All functions get the same args, the arguments after the command name.
|
// All functions get the same args, the arguments after the command name.
|
||||||
|
// The *PreRun and *PostRun functions will only be executed if the Run function of the current
|
||||||
|
// command has been declared.
|
||||||
//
|
//
|
||||||
// PersistentPreRun: children of this command will inherit and execute.
|
// PersistentPreRun: children of this command will inherit and execute.
|
||||||
PersistentPreRun func(cmd *Command, args []string)
|
PersistentPreRun func(cmd *Command, args []string)
|
||||||
|
@ -149,8 +154,10 @@ type Command struct {
|
||||||
// pflags contains persistent flags.
|
// pflags contains persistent flags.
|
||||||
pflags *flag.FlagSet
|
pflags *flag.FlagSet
|
||||||
// lflags contains local flags.
|
// lflags contains local flags.
|
||||||
|
// This field does not represent internal state, it's used as a cache to optimise LocalFlags function call
|
||||||
lflags *flag.FlagSet
|
lflags *flag.FlagSet
|
||||||
// iflags contains inherited flags.
|
// iflags contains inherited flags.
|
||||||
|
// This field does not represent internal state, it's used as a cache to optimise InheritedFlags function call
|
||||||
iflags *flag.FlagSet
|
iflags *flag.FlagSet
|
||||||
// parentsPflags is all persistent flags of cmd's parents.
|
// parentsPflags is all persistent flags of cmd's parents.
|
||||||
parentsPflags *flag.FlagSet
|
parentsPflags *flag.FlagSet
|
||||||
|
@ -181,6 +188,9 @@ type Command struct {
|
||||||
// versionTemplate is the version template defined by user.
|
// versionTemplate is the version template defined by user.
|
||||||
versionTemplate string
|
versionTemplate string
|
||||||
|
|
||||||
|
// errPrefix is the error message prefix defined by user.
|
||||||
|
errPrefix string
|
||||||
|
|
||||||
// inReader is a reader defined by the user that replaces stdin
|
// inReader is a reader defined by the user that replaces stdin
|
||||||
inReader io.Reader
|
inReader io.Reader
|
||||||
// outWriter is a writer defined by the user that replaces stdout
|
// outWriter is a writer defined by the user that replaces stdout
|
||||||
|
@ -321,7 +331,7 @@ func (c *Command) SetHelpCommand(cmd *Command) {
|
||||||
c.helpCommand = cmd
|
c.helpCommand = cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetHelpCommandGroup sets the group id of the help command.
|
// SetHelpCommandGroupID sets the group id of the help command.
|
||||||
func (c *Command) SetHelpCommandGroupID(groupID string) {
|
func (c *Command) SetHelpCommandGroupID(groupID string) {
|
||||||
if c.helpCommand != nil {
|
if c.helpCommand != nil {
|
||||||
c.helpCommand.GroupID = groupID
|
c.helpCommand.GroupID = groupID
|
||||||
|
@ -330,7 +340,7 @@ func (c *Command) SetHelpCommandGroupID(groupID string) {
|
||||||
c.helpCommandGroupID = groupID
|
c.helpCommandGroupID = groupID
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetCompletionCommandGroup sets the group id of the completion command.
|
// SetCompletionCommandGroupID sets the group id of the completion command.
|
||||||
func (c *Command) SetCompletionCommandGroupID(groupID string) {
|
func (c *Command) SetCompletionCommandGroupID(groupID string) {
|
||||||
// completionCommandGroupID is used if no completion command is defined by the user
|
// completionCommandGroupID is used if no completion command is defined by the user
|
||||||
c.Root().completionCommandGroupID = groupID
|
c.Root().completionCommandGroupID = groupID
|
||||||
|
@ -346,6 +356,11 @@ func (c *Command) SetVersionTemplate(s string) {
|
||||||
c.versionTemplate = s
|
c.versionTemplate = s
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SetErrPrefix sets error message prefix to be used. Application can use it to set custom prefix.
|
||||||
|
func (c *Command) SetErrPrefix(s string) {
|
||||||
|
c.errPrefix = s
|
||||||
|
}
|
||||||
|
|
||||||
// SetGlobalNormalizationFunc sets a normalization function to all flag sets and also to child commands.
|
// SetGlobalNormalizationFunc sets a normalization function to all flag sets and also to child commands.
|
||||||
// The user should not have a cyclic dependency on commands.
|
// The user should not have a cyclic dependency on commands.
|
||||||
func (c *Command) SetGlobalNormalizationFunc(n func(f *flag.FlagSet, name string) flag.NormalizedName) {
|
func (c *Command) SetGlobalNormalizationFunc(n func(f *flag.FlagSet, name string) flag.NormalizedName) {
|
||||||
|
@ -595,6 +610,18 @@ func (c *Command) VersionTemplate() string {
|
||||||
`
|
`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ErrPrefix return error message prefix for the command
|
||||||
|
func (c *Command) ErrPrefix() string {
|
||||||
|
if c.errPrefix != "" {
|
||||||
|
return c.errPrefix
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.HasParent() {
|
||||||
|
return c.parent.ErrPrefix()
|
||||||
|
}
|
||||||
|
return "Error:"
|
||||||
|
}
|
||||||
|
|
||||||
func hasNoOptDefVal(name string, fs *flag.FlagSet) bool {
|
func hasNoOptDefVal(name string, fs *flag.FlagSet) bool {
|
||||||
flag := fs.Lookup(name)
|
flag := fs.Lookup(name)
|
||||||
if flag == nil {
|
if flag == nil {
|
||||||
|
@ -681,7 +708,7 @@ Loop:
|
||||||
// This is not a flag or a flag value. Check to see if it matches what we're looking for, and if so,
|
// This is not a flag or a flag value. Check to see if it matches what we're looking for, and if so,
|
||||||
// return the args, excluding the one at this position.
|
// return the args, excluding the one at this position.
|
||||||
if s == x {
|
if s == x {
|
||||||
ret := []string{}
|
ret := make([]string, 0, len(args)-1)
|
||||||
ret = append(ret, args[:pos]...)
|
ret = append(ret, args[:pos]...)
|
||||||
ret = append(ret, args[pos+1:]...)
|
ret = append(ret, args[pos+1:]...)
|
||||||
return ret
|
return ret
|
||||||
|
@ -692,7 +719,7 @@ Loop:
|
||||||
}
|
}
|
||||||
|
|
||||||
func isFlagArg(arg string) bool {
|
func isFlagArg(arg string) bool {
|
||||||
return ((len(arg) >= 3 && arg[1] == '-') ||
|
return ((len(arg) >= 3 && arg[0:2] == "--") ||
|
||||||
(len(arg) >= 2 && arg[0] == '-' && arg[1] != '-'))
|
(len(arg) >= 2 && arg[0] == '-' && arg[1] != '-'))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -729,14 +756,14 @@ func (c *Command) findSuggestions(arg string) string {
|
||||||
if c.SuggestionsMinimumDistance <= 0 {
|
if c.SuggestionsMinimumDistance <= 0 {
|
||||||
c.SuggestionsMinimumDistance = 2
|
c.SuggestionsMinimumDistance = 2
|
||||||
}
|
}
|
||||||
suggestionsString := ""
|
var sb strings.Builder
|
||||||
if suggestions := c.SuggestionsFor(arg); len(suggestions) > 0 {
|
if suggestions := c.SuggestionsFor(arg); len(suggestions) > 0 {
|
||||||
suggestionsString += "\n\nDid you mean this?\n"
|
sb.WriteString("\n\nDid you mean this?\n")
|
||||||
for _, s := range suggestions {
|
for _, s := range suggestions {
|
||||||
suggestionsString += fmt.Sprintf("\t%v\n", s)
|
_, _ = fmt.Fprintf(&sb, "\t%v\n", s)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return suggestionsString
|
return sb.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Command) findNext(next string) *Command {
|
func (c *Command) findNext(next string) *Command {
|
||||||
|
@ -752,7 +779,9 @@ func (c *Command) findNext(next string) *Command {
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(matches) == 1 {
|
if len(matches) == 1 {
|
||||||
return matches[0]
|
// Temporarily disable gosec G602, which produces a false positive.
|
||||||
|
// See https://github.com/securego/gosec/issues/1005.
|
||||||
|
return matches[0] // #nosec G602
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
|
@ -910,15 +939,31 @@ func (c *Command) execute(a []string) (err error) {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
parents := make([]*Command, 0, 5)
|
||||||
for p := c; p != nil; p = p.Parent() {
|
for p := c; p != nil; p = p.Parent() {
|
||||||
|
if EnableTraverseRunHooks {
|
||||||
|
// When EnableTraverseRunHooks is set:
|
||||||
|
// - Execute all persistent pre-runs from the root parent till this command.
|
||||||
|
// - Execute all persistent post-runs from this command till the root parent.
|
||||||
|
parents = append([]*Command{p}, parents...)
|
||||||
|
} else {
|
||||||
|
// Otherwise, execute only the first found persistent hook.
|
||||||
|
parents = append(parents, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, p := range parents {
|
||||||
if p.PersistentPreRunE != nil {
|
if p.PersistentPreRunE != nil {
|
||||||
if err := p.PersistentPreRunE(c, argWoFlags); err != nil {
|
if err := p.PersistentPreRunE(c, argWoFlags); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
break
|
if !EnableTraverseRunHooks {
|
||||||
|
break
|
||||||
|
}
|
||||||
} else if p.PersistentPreRun != nil {
|
} else if p.PersistentPreRun != nil {
|
||||||
p.PersistentPreRun(c, argWoFlags)
|
p.PersistentPreRun(c, argWoFlags)
|
||||||
break
|
if !EnableTraverseRunHooks {
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if c.PreRunE != nil {
|
if c.PreRunE != nil {
|
||||||
|
@ -955,10 +1000,14 @@ func (c *Command) execute(a []string) (err error) {
|
||||||
if err := p.PersistentPostRunE(c, argWoFlags); err != nil {
|
if err := p.PersistentPostRunE(c, argWoFlags); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
break
|
if !EnableTraverseRunHooks {
|
||||||
|
break
|
||||||
|
}
|
||||||
} else if p.PersistentPostRun != nil {
|
} else if p.PersistentPostRun != nil {
|
||||||
p.PersistentPostRun(c, argWoFlags)
|
p.PersistentPostRun(c, argWoFlags)
|
||||||
break
|
if !EnableTraverseRunHooks {
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1048,7 +1097,7 @@ func (c *Command) ExecuteC() (cmd *Command, err error) {
|
||||||
c = cmd
|
c = cmd
|
||||||
}
|
}
|
||||||
if !c.SilenceErrors {
|
if !c.SilenceErrors {
|
||||||
c.PrintErrln("Error:", err.Error())
|
c.PrintErrln(c.ErrPrefix(), err.Error())
|
||||||
c.PrintErrf("Run '%v --help' for usage.\n", c.CommandPath())
|
c.PrintErrf("Run '%v --help' for usage.\n", c.CommandPath())
|
||||||
}
|
}
|
||||||
return c, err
|
return c, err
|
||||||
|
@ -1077,7 +1126,7 @@ func (c *Command) ExecuteC() (cmd *Command, err error) {
|
||||||
// If root command has SilenceErrors flagged,
|
// If root command has SilenceErrors flagged,
|
||||||
// all subcommands should respect it
|
// all subcommands should respect it
|
||||||
if !cmd.SilenceErrors && !c.SilenceErrors {
|
if !cmd.SilenceErrors && !c.SilenceErrors {
|
||||||
c.PrintErrln("Error:", err.Error())
|
c.PrintErrln(cmd.ErrPrefix(), err.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
// If root command has SilenceUsage flagged,
|
// If root command has SilenceUsage flagged,
|
||||||
|
@ -1140,10 +1189,11 @@ func (c *Command) InitDefaultHelpFlag() {
|
||||||
c.mergePersistentFlags()
|
c.mergePersistentFlags()
|
||||||
if c.Flags().Lookup("help") == nil {
|
if c.Flags().Lookup("help") == nil {
|
||||||
usage := "help for "
|
usage := "help for "
|
||||||
if c.Name() == "" {
|
name := c.displayName()
|
||||||
|
if name == "" {
|
||||||
usage += "this command"
|
usage += "this command"
|
||||||
} else {
|
} else {
|
||||||
usage += c.Name()
|
usage += name
|
||||||
}
|
}
|
||||||
c.Flags().BoolP("help", "h", false, usage)
|
c.Flags().BoolP("help", "h", false, usage)
|
||||||
_ = c.Flags().SetAnnotation("help", FlagSetByCobraAnnotation, []string{"true"})
|
_ = c.Flags().SetAnnotation("help", FlagSetByCobraAnnotation, []string{"true"})
|
||||||
|
@ -1189,7 +1239,7 @@ func (c *Command) InitDefaultHelpCmd() {
|
||||||
Use: "help [command]",
|
Use: "help [command]",
|
||||||
Short: "Help about any command",
|
Short: "Help about any command",
|
||||||
Long: `Help provides help for any command in the application.
|
Long: `Help provides help for any command in the application.
|
||||||
Simply type ` + c.Name() + ` help [path to command] for full details.`,
|
Simply type ` + c.displayName() + ` help [path to command] for full details.`,
|
||||||
ValidArgsFunction: func(c *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
ValidArgsFunction: func(c *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
var completions []string
|
var completions []string
|
||||||
cmd, _, e := c.Root().Find(args)
|
cmd, _, e := c.Root().Find(args)
|
||||||
|
@ -1296,7 +1346,7 @@ func (c *Command) AllChildCommandsHaveGroup() bool {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
// ContainGroups return if groupID exists in the list of command groups.
|
// ContainsGroup return if groupID exists in the list of command groups.
|
||||||
func (c *Command) ContainsGroup(groupID string) bool {
|
func (c *Command) ContainsGroup(groupID string) bool {
|
||||||
for _, x := range c.commandgroups {
|
for _, x := range c.commandgroups {
|
||||||
if x.ID == groupID {
|
if x.ID == groupID {
|
||||||
|
@ -1380,16 +1430,24 @@ func (c *Command) CommandPath() string {
|
||||||
if c.HasParent() {
|
if c.HasParent() {
|
||||||
return c.Parent().CommandPath() + " " + c.Name()
|
return c.Parent().CommandPath() + " " + c.Name()
|
||||||
}
|
}
|
||||||
|
return c.displayName()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) displayName() string {
|
||||||
|
if displayName, ok := c.Annotations[CommandDisplayNameAnnotation]; ok {
|
||||||
|
return displayName
|
||||||
|
}
|
||||||
return c.Name()
|
return c.Name()
|
||||||
}
|
}
|
||||||
|
|
||||||
// UseLine puts out the full usage for a given command (including parents).
|
// UseLine puts out the full usage for a given command (including parents).
|
||||||
func (c *Command) UseLine() string {
|
func (c *Command) UseLine() string {
|
||||||
var useline string
|
var useline string
|
||||||
|
use := strings.Replace(c.Use, c.Name(), c.displayName(), 1)
|
||||||
if c.HasParent() {
|
if c.HasParent() {
|
||||||
useline = c.parent.CommandPath() + " " + c.Use
|
useline = c.parent.CommandPath() + " " + use
|
||||||
} else {
|
} else {
|
||||||
useline = c.Use
|
useline = use
|
||||||
}
|
}
|
||||||
if c.DisableFlagsInUseLine {
|
if c.DisableFlagsInUseLine {
|
||||||
return useline
|
return useline
|
||||||
|
@ -1402,6 +1460,7 @@ func (c *Command) UseLine() string {
|
||||||
|
|
||||||
// DebugFlags used to determine which flags have been assigned to which commands
|
// DebugFlags used to determine which flags have been assigned to which commands
|
||||||
// and which persist.
|
// and which persist.
|
||||||
|
// nolint:goconst
|
||||||
func (c *Command) DebugFlags() {
|
func (c *Command) DebugFlags() {
|
||||||
c.Println("DebugFlags called on", c.Name())
|
c.Println("DebugFlags called on", c.Name())
|
||||||
var debugflags func(*Command)
|
var debugflags func(*Command)
|
||||||
|
@ -1591,7 +1650,7 @@ func (c *Command) GlobalNormalizationFunc() func(f *flag.FlagSet, name string) f
|
||||||
// to this command (local and persistent declared here and by all parents).
|
// to this command (local and persistent declared here and by all parents).
|
||||||
func (c *Command) Flags() *flag.FlagSet {
|
func (c *Command) Flags() *flag.FlagSet {
|
||||||
if c.flags == nil {
|
if c.flags == nil {
|
||||||
c.flags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.flags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
if c.flagErrorBuf == nil {
|
if c.flagErrorBuf == nil {
|
||||||
c.flagErrorBuf = new(bytes.Buffer)
|
c.flagErrorBuf = new(bytes.Buffer)
|
||||||
}
|
}
|
||||||
|
@ -1602,10 +1661,11 @@ func (c *Command) Flags() *flag.FlagSet {
|
||||||
}
|
}
|
||||||
|
|
||||||
// LocalNonPersistentFlags are flags specific to this command which will NOT persist to subcommands.
|
// LocalNonPersistentFlags are flags specific to this command which will NOT persist to subcommands.
|
||||||
|
// This function does not modify the flags of the current command, it's purpose is to return the current state.
|
||||||
func (c *Command) LocalNonPersistentFlags() *flag.FlagSet {
|
func (c *Command) LocalNonPersistentFlags() *flag.FlagSet {
|
||||||
persistentFlags := c.PersistentFlags()
|
persistentFlags := c.PersistentFlags()
|
||||||
|
|
||||||
out := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
out := flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
c.LocalFlags().VisitAll(func(f *flag.Flag) {
|
c.LocalFlags().VisitAll(func(f *flag.Flag) {
|
||||||
if persistentFlags.Lookup(f.Name) == nil {
|
if persistentFlags.Lookup(f.Name) == nil {
|
||||||
out.AddFlag(f)
|
out.AddFlag(f)
|
||||||
|
@ -1615,11 +1675,12 @@ func (c *Command) LocalNonPersistentFlags() *flag.FlagSet {
|
||||||
}
|
}
|
||||||
|
|
||||||
// LocalFlags returns the local FlagSet specifically set in the current command.
|
// LocalFlags returns the local FlagSet specifically set in the current command.
|
||||||
|
// This function does not modify the flags of the current command, it's purpose is to return the current state.
|
||||||
func (c *Command) LocalFlags() *flag.FlagSet {
|
func (c *Command) LocalFlags() *flag.FlagSet {
|
||||||
c.mergePersistentFlags()
|
c.mergePersistentFlags()
|
||||||
|
|
||||||
if c.lflags == nil {
|
if c.lflags == nil {
|
||||||
c.lflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.lflags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
if c.flagErrorBuf == nil {
|
if c.flagErrorBuf == nil {
|
||||||
c.flagErrorBuf = new(bytes.Buffer)
|
c.flagErrorBuf = new(bytes.Buffer)
|
||||||
}
|
}
|
||||||
|
@ -1642,11 +1703,12 @@ func (c *Command) LocalFlags() *flag.FlagSet {
|
||||||
}
|
}
|
||||||
|
|
||||||
// InheritedFlags returns all flags which were inherited from parent commands.
|
// InheritedFlags returns all flags which were inherited from parent commands.
|
||||||
|
// This function does not modify the flags of the current command, it's purpose is to return the current state.
|
||||||
func (c *Command) InheritedFlags() *flag.FlagSet {
|
func (c *Command) InheritedFlags() *flag.FlagSet {
|
||||||
c.mergePersistentFlags()
|
c.mergePersistentFlags()
|
||||||
|
|
||||||
if c.iflags == nil {
|
if c.iflags == nil {
|
||||||
c.iflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.iflags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
if c.flagErrorBuf == nil {
|
if c.flagErrorBuf == nil {
|
||||||
c.flagErrorBuf = new(bytes.Buffer)
|
c.flagErrorBuf = new(bytes.Buffer)
|
||||||
}
|
}
|
||||||
|
@ -1667,6 +1729,7 @@ func (c *Command) InheritedFlags() *flag.FlagSet {
|
||||||
}
|
}
|
||||||
|
|
||||||
// NonInheritedFlags returns all flags which were not inherited from parent commands.
|
// NonInheritedFlags returns all flags which were not inherited from parent commands.
|
||||||
|
// This function does not modify the flags of the current command, it's purpose is to return the current state.
|
||||||
func (c *Command) NonInheritedFlags() *flag.FlagSet {
|
func (c *Command) NonInheritedFlags() *flag.FlagSet {
|
||||||
return c.LocalFlags()
|
return c.LocalFlags()
|
||||||
}
|
}
|
||||||
|
@ -1674,7 +1737,7 @@ func (c *Command) NonInheritedFlags() *flag.FlagSet {
|
||||||
// PersistentFlags returns the persistent FlagSet specifically set in the current command.
|
// PersistentFlags returns the persistent FlagSet specifically set in the current command.
|
||||||
func (c *Command) PersistentFlags() *flag.FlagSet {
|
func (c *Command) PersistentFlags() *flag.FlagSet {
|
||||||
if c.pflags == nil {
|
if c.pflags == nil {
|
||||||
c.pflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.pflags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
if c.flagErrorBuf == nil {
|
if c.flagErrorBuf == nil {
|
||||||
c.flagErrorBuf = new(bytes.Buffer)
|
c.flagErrorBuf = new(bytes.Buffer)
|
||||||
}
|
}
|
||||||
|
@ -1687,9 +1750,9 @@ func (c *Command) PersistentFlags() *flag.FlagSet {
|
||||||
func (c *Command) ResetFlags() {
|
func (c *Command) ResetFlags() {
|
||||||
c.flagErrorBuf = new(bytes.Buffer)
|
c.flagErrorBuf = new(bytes.Buffer)
|
||||||
c.flagErrorBuf.Reset()
|
c.flagErrorBuf.Reset()
|
||||||
c.flags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.flags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
c.flags.SetOutput(c.flagErrorBuf)
|
c.flags.SetOutput(c.flagErrorBuf)
|
||||||
c.pflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.pflags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
c.pflags.SetOutput(c.flagErrorBuf)
|
c.pflags.SetOutput(c.flagErrorBuf)
|
||||||
|
|
||||||
c.lflags = nil
|
c.lflags = nil
|
||||||
|
@ -1806,7 +1869,7 @@ func (c *Command) mergePersistentFlags() {
|
||||||
// If c.parentsPflags == nil, it makes new.
|
// If c.parentsPflags == nil, it makes new.
|
||||||
func (c *Command) updateParentsPflags() {
|
func (c *Command) updateParentsPflags() {
|
||||||
if c.parentsPflags == nil {
|
if c.parentsPflags == nil {
|
||||||
c.parentsPflags = flag.NewFlagSet(c.Name(), flag.ContinueOnError)
|
c.parentsPflags = flag.NewFlagSet(c.displayName(), flag.ContinueOnError)
|
||||||
c.parentsPflags.SetOutput(c.flagErrorBuf)
|
c.parentsPflags.SetOutput(c.flagErrorBuf)
|
||||||
c.parentsPflags.SortFlags = false
|
c.parentsPflags.SortFlags = false
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
257
command_test.go
257
command_test.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -18,7 +18,7 @@ import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io/ioutil"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
|
@ -366,6 +366,67 @@ func TestAliasPrefixMatching(t *testing.T) {
|
||||||
EnablePrefixMatching = defaultPrefixMatching
|
EnablePrefixMatching = defaultPrefixMatching
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestPlugin checks usage as plugin for another command such as kubectl. The
|
||||||
|
// executable is `kubectl-plugin`, but we run it as `kubectl plugin`. The help
|
||||||
|
// text should reflect the way we run the command.
|
||||||
|
func TestPlugin(t *testing.T) {
|
||||||
|
cmd := &Command{
|
||||||
|
Use: "kubectl-plugin",
|
||||||
|
Args: NoArgs,
|
||||||
|
Annotations: map[string]string{
|
||||||
|
CommandDisplayNameAnnotation: "kubectl plugin",
|
||||||
|
},
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
|
||||||
|
cmdHelp, err := executeCommand(cmd, "-h")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
checkStringContains(t, cmdHelp, "kubectl plugin [flags]")
|
||||||
|
checkStringContains(t, cmdHelp, "help for kubectl plugin")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestPlugin checks usage as plugin with sub commands.
|
||||||
|
func TestPluginWithSubCommands(t *testing.T) {
|
||||||
|
rootCmd := &Command{
|
||||||
|
Use: "kubectl-plugin",
|
||||||
|
Args: NoArgs,
|
||||||
|
Annotations: map[string]string{
|
||||||
|
CommandDisplayNameAnnotation: "kubectl plugin",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
subCmd := &Command{Use: "sub [flags]", Args: NoArgs, Run: emptyRun}
|
||||||
|
rootCmd.AddCommand(subCmd)
|
||||||
|
|
||||||
|
rootHelp, err := executeCommand(rootCmd, "-h")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
checkStringContains(t, rootHelp, "kubectl plugin [command]")
|
||||||
|
checkStringContains(t, rootHelp, "help for kubectl plugin")
|
||||||
|
checkStringContains(t, rootHelp, "kubectl plugin [command] --help")
|
||||||
|
|
||||||
|
childHelp, err := executeCommand(rootCmd, "sub", "-h")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
checkStringContains(t, childHelp, "kubectl plugin sub [flags]")
|
||||||
|
checkStringContains(t, childHelp, "help for sub")
|
||||||
|
|
||||||
|
helpHelp, err := executeCommand(rootCmd, "help", "-h")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
checkStringContains(t, helpHelp, "kubectl plugin help [path to command]")
|
||||||
|
checkStringContains(t, helpHelp, "kubectl plugin help [command]")
|
||||||
|
}
|
||||||
|
|
||||||
// TestChildSameName checks the correct behaviour of cobra in cases,
|
// TestChildSameName checks the correct behaviour of cobra in cases,
|
||||||
// when an application with name "foo" and with subcommand "foo"
|
// when an application with name "foo" and with subcommand "foo"
|
||||||
// is executed with args "foo foo".
|
// is executed with args "foo foo".
|
||||||
|
@ -438,7 +499,7 @@ func TestFlagLong(t *testing.T) {
|
||||||
|
|
||||||
output, err := executeCommand(c, "--intf=7", "--sf=abc", "one", "--", "two")
|
output, err := executeCommand(c, "--intf=7", "--sf=abc", "one", "--", "two")
|
||||||
if output != "" {
|
if output != "" {
|
||||||
t.Errorf("Unexpected output: %v", err)
|
t.Errorf("Unexpected output: %v", output)
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("Unexpected error: %v", err)
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
@ -475,7 +536,7 @@ func TestFlagShort(t *testing.T) {
|
||||||
|
|
||||||
output, err := executeCommand(c, "-i", "7", "-sabc", "one", "two")
|
output, err := executeCommand(c, "-i", "7", "-sabc", "one", "two")
|
||||||
if output != "" {
|
if output != "" {
|
||||||
t.Errorf("Unexpected output: %v", err)
|
t.Errorf("Unexpected output: %v", output)
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("Unexpected error: %v", err)
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
@ -504,7 +565,7 @@ func TestChildFlag(t *testing.T) {
|
||||||
|
|
||||||
output, err := executeCommand(rootCmd, "child", "-i7")
|
output, err := executeCommand(rootCmd, "child", "-i7")
|
||||||
if output != "" {
|
if output != "" {
|
||||||
t.Errorf("Unexpected output: %v", err)
|
t.Errorf("Unexpected output: %v", output)
|
||||||
}
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Errorf("Unexpected error: %v", err)
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
@ -1099,6 +1160,39 @@ func TestShorthandVersionTemplate(t *testing.T) {
|
||||||
checkStringContains(t, output, "customized version: 1.0.0")
|
checkStringContains(t, output, "customized version: 1.0.0")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRootErrPrefixExecutedOnSubcommand(t *testing.T) {
|
||||||
|
rootCmd := &Command{Use: "root", Run: emptyRun}
|
||||||
|
rootCmd.SetErrPrefix("root error prefix:")
|
||||||
|
rootCmd.AddCommand(&Command{Use: "sub", Run: emptyRun})
|
||||||
|
|
||||||
|
output, err := executeCommand(rootCmd, "sub", "--unknown-flag")
|
||||||
|
if err == nil {
|
||||||
|
t.Errorf("Expected error")
|
||||||
|
}
|
||||||
|
|
||||||
|
checkStringContains(t, output, "root error prefix: unknown flag: --unknown-flag")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRootAndSubErrPrefix(t *testing.T) {
|
||||||
|
rootCmd := &Command{Use: "root", Run: emptyRun}
|
||||||
|
subCmd := &Command{Use: "sub", Run: emptyRun}
|
||||||
|
rootCmd.AddCommand(subCmd)
|
||||||
|
rootCmd.SetErrPrefix("root error prefix:")
|
||||||
|
subCmd.SetErrPrefix("sub error prefix:")
|
||||||
|
|
||||||
|
if output, err := executeCommand(rootCmd, "--unknown-root-flag"); err == nil {
|
||||||
|
t.Errorf("Expected error")
|
||||||
|
} else {
|
||||||
|
checkStringContains(t, output, "root error prefix: unknown flag: --unknown-root-flag")
|
||||||
|
}
|
||||||
|
|
||||||
|
if output, err := executeCommand(rootCmd, "sub", "--unknown-sub-flag"); err == nil {
|
||||||
|
t.Errorf("Expected error")
|
||||||
|
} else {
|
||||||
|
checkStringContains(t, output, "sub error prefix: unknown flag: --unknown-sub-flag")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestVersionFlagExecutedOnSubcommand(t *testing.T) {
|
func TestVersionFlagExecutedOnSubcommand(t *testing.T) {
|
||||||
rootCmd := &Command{Use: "root", Version: "1.0.0"}
|
rootCmd := &Command{Use: "root", Version: "1.0.0"}
|
||||||
rootCmd.AddCommand(&Command{Use: "sub", Run: emptyRun})
|
rootCmd.AddCommand(&Command{Use: "sub", Run: emptyRun})
|
||||||
|
@ -1497,57 +1591,73 @@ func TestHooks(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPersistentHooks(t *testing.T) {
|
func TestPersistentHooks(t *testing.T) {
|
||||||
var (
|
EnableTraverseRunHooks = true
|
||||||
parentPersPreArgs string
|
testPersistentHooks(t, []string{
|
||||||
parentPreArgs string
|
"parent PersistentPreRun",
|
||||||
parentRunArgs string
|
"child PersistentPreRun",
|
||||||
parentPostArgs string
|
"child PreRun",
|
||||||
parentPersPostArgs string
|
"child Run",
|
||||||
)
|
"child PostRun",
|
||||||
|
"child PersistentPostRun",
|
||||||
|
"parent PersistentPostRun",
|
||||||
|
})
|
||||||
|
|
||||||
var (
|
EnableTraverseRunHooks = false
|
||||||
childPersPreArgs string
|
testPersistentHooks(t, []string{
|
||||||
childPreArgs string
|
"child PersistentPreRun",
|
||||||
childRunArgs string
|
"child PreRun",
|
||||||
childPostArgs string
|
"child Run",
|
||||||
childPersPostArgs string
|
"child PostRun",
|
||||||
)
|
"child PersistentPostRun",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func testPersistentHooks(t *testing.T, expectedHookRunOrder []string) {
|
||||||
|
var hookRunOrder []string
|
||||||
|
|
||||||
|
validateHook := func(args []string, hookName string) {
|
||||||
|
hookRunOrder = append(hookRunOrder, hookName)
|
||||||
|
got := strings.Join(args, " ")
|
||||||
|
if onetwo != got {
|
||||||
|
t.Errorf("Expected %s %q, got %q", hookName, onetwo, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
parentCmd := &Command{
|
parentCmd := &Command{
|
||||||
Use: "parent",
|
Use: "parent",
|
||||||
PersistentPreRun: func(_ *Command, args []string) {
|
PersistentPreRun: func(_ *Command, args []string) {
|
||||||
parentPersPreArgs = strings.Join(args, " ")
|
validateHook(args, "parent PersistentPreRun")
|
||||||
},
|
},
|
||||||
PreRun: func(_ *Command, args []string) {
|
PreRun: func(_ *Command, args []string) {
|
||||||
parentPreArgs = strings.Join(args, " ")
|
validateHook(args, "parent PreRun")
|
||||||
},
|
},
|
||||||
Run: func(_ *Command, args []string) {
|
Run: func(_ *Command, args []string) {
|
||||||
parentRunArgs = strings.Join(args, " ")
|
validateHook(args, "parent Run")
|
||||||
},
|
},
|
||||||
PostRun: func(_ *Command, args []string) {
|
PostRun: func(_ *Command, args []string) {
|
||||||
parentPostArgs = strings.Join(args, " ")
|
validateHook(args, "parent PostRun")
|
||||||
},
|
},
|
||||||
PersistentPostRun: func(_ *Command, args []string) {
|
PersistentPostRun: func(_ *Command, args []string) {
|
||||||
parentPersPostArgs = strings.Join(args, " ")
|
validateHook(args, "parent PersistentPostRun")
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
childCmd := &Command{
|
childCmd := &Command{
|
||||||
Use: "child",
|
Use: "child",
|
||||||
PersistentPreRun: func(_ *Command, args []string) {
|
PersistentPreRun: func(_ *Command, args []string) {
|
||||||
childPersPreArgs = strings.Join(args, " ")
|
validateHook(args, "child PersistentPreRun")
|
||||||
},
|
},
|
||||||
PreRun: func(_ *Command, args []string) {
|
PreRun: func(_ *Command, args []string) {
|
||||||
childPreArgs = strings.Join(args, " ")
|
validateHook(args, "child PreRun")
|
||||||
},
|
},
|
||||||
Run: func(_ *Command, args []string) {
|
Run: func(_ *Command, args []string) {
|
||||||
childRunArgs = strings.Join(args, " ")
|
validateHook(args, "child Run")
|
||||||
},
|
},
|
||||||
PostRun: func(_ *Command, args []string) {
|
PostRun: func(_ *Command, args []string) {
|
||||||
childPostArgs = strings.Join(args, " ")
|
validateHook(args, "child PostRun")
|
||||||
},
|
},
|
||||||
PersistentPostRun: func(_ *Command, args []string) {
|
PersistentPostRun: func(_ *Command, args []string) {
|
||||||
childPersPostArgs = strings.Join(args, " ")
|
validateHook(args, "child PersistentPostRun")
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
parentCmd.AddCommand(childCmd)
|
parentCmd.AddCommand(childCmd)
|
||||||
|
@ -1560,41 +1670,13 @@ func TestPersistentHooks(t *testing.T) {
|
||||||
t.Errorf("Unexpected error: %v", err)
|
t.Errorf("Unexpected error: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, v := range []struct {
|
for idx, exp := range expectedHookRunOrder {
|
||||||
name string
|
if len(hookRunOrder) > idx {
|
||||||
got string
|
if act := hookRunOrder[idx]; act != exp {
|
||||||
}{
|
t.Errorf("Expected %q at %d, got %q", exp, idx, act)
|
||||||
// TODO: currently PersistentPreRun* defined in parent does not
|
}
|
||||||
// run if the matching child subcommand has PersistentPreRun.
|
} else {
|
||||||
// If the behavior changes (https://github.com/spf13/cobra/issues/252)
|
t.Errorf("Expected %q at %d, got nothing", exp, idx)
|
||||||
// this test must be fixed.
|
|
||||||
{"parentPersPreArgs", parentPersPreArgs},
|
|
||||||
{"parentPreArgs", parentPreArgs},
|
|
||||||
{"parentRunArgs", parentRunArgs},
|
|
||||||
{"parentPostArgs", parentPostArgs},
|
|
||||||
// TODO: currently PersistentPostRun* defined in parent does not
|
|
||||||
// run if the matching child subcommand has PersistentPostRun.
|
|
||||||
// If the behavior changes (https://github.com/spf13/cobra/issues/252)
|
|
||||||
// this test must be fixed.
|
|
||||||
{"parentPersPostArgs", parentPersPostArgs},
|
|
||||||
} {
|
|
||||||
if v.got != "" {
|
|
||||||
t.Errorf("Expected blank %s, got %q", v.name, v.got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, v := range []struct {
|
|
||||||
name string
|
|
||||||
got string
|
|
||||||
}{
|
|
||||||
{"childPersPreArgs", childPersPreArgs},
|
|
||||||
{"childPreArgs", childPreArgs},
|
|
||||||
{"childRunArgs", childRunArgs},
|
|
||||||
{"childPostArgs", childPostArgs},
|
|
||||||
{"childPersPostArgs", childPersPostArgs},
|
|
||||||
} {
|
|
||||||
if v.got != onetwo {
|
|
||||||
t.Errorf("Expected %s %q, got %q", v.name, onetwo, v.got)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -2010,12 +2092,12 @@ func TestCommandPrintRedirection(t *testing.T) {
|
||||||
t.Error(err)
|
t.Error(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
gotErrBytes, err := ioutil.ReadAll(errBuff)
|
gotErrBytes, err := io.ReadAll(errBuff)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Error(err)
|
t.Error(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
gotOutBytes, err := ioutil.ReadAll(outBuff)
|
gotOutBytes, err := io.ReadAll(outBuff)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Error(err)
|
t.Error(err)
|
||||||
}
|
}
|
||||||
|
@ -2692,3 +2774,46 @@ func TestFind(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnknownFlagShouldReturnSameErrorRegardlessOfArgPosition(t *testing.T) {
|
||||||
|
testCases := [][]string{
|
||||||
|
// {"--unknown", "--namespace", "foo", "child", "--bar"}, // FIXME: This test case fails, returning the error `unknown command "foo" for "root"` instead of the expected error `unknown flag: --unknown`
|
||||||
|
{"--namespace", "foo", "--unknown", "child", "--bar"},
|
||||||
|
{"--namespace", "foo", "child", "--unknown", "--bar"},
|
||||||
|
{"--namespace", "foo", "child", "--bar", "--unknown"},
|
||||||
|
|
||||||
|
{"--unknown", "--namespace=foo", "child", "--bar"},
|
||||||
|
{"--namespace=foo", "--unknown", "child", "--bar"},
|
||||||
|
{"--namespace=foo", "child", "--unknown", "--bar"},
|
||||||
|
{"--namespace=foo", "child", "--bar", "--unknown"},
|
||||||
|
|
||||||
|
{"--unknown", "--namespace=foo", "child", "--bar=true"},
|
||||||
|
{"--namespace=foo", "--unknown", "child", "--bar=true"},
|
||||||
|
{"--namespace=foo", "child", "--unknown", "--bar=true"},
|
||||||
|
{"--namespace=foo", "child", "--bar=true", "--unknown"},
|
||||||
|
}
|
||||||
|
|
||||||
|
root := &Command{
|
||||||
|
Use: "root",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
root.PersistentFlags().String("namespace", "", "a string flag")
|
||||||
|
|
||||||
|
c := &Command{
|
||||||
|
Use: "child",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
c.Flags().Bool("bar", false, "a boolean flag")
|
||||||
|
|
||||||
|
root.AddCommand(c)
|
||||||
|
|
||||||
|
for _, tc := range testCases {
|
||||||
|
t.Run(strings.Join(tc, " "), func(t *testing.T) {
|
||||||
|
output, err := executeCommand(root, tc...)
|
||||||
|
if err == nil {
|
||||||
|
t.Error("expected unknown flag error")
|
||||||
|
}
|
||||||
|
checkStringContains(t, output, "unknown flag: --unknown")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
102
completions.go
102
completions.go
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -17,6 +17,8 @@ package cobra
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
|
@ -77,6 +79,10 @@ const (
|
||||||
// obtain the same behavior but only for flags.
|
// obtain the same behavior but only for flags.
|
||||||
ShellCompDirectiveFilterDirs
|
ShellCompDirectiveFilterDirs
|
||||||
|
|
||||||
|
// ShellCompDirectiveKeepOrder indicates that the shell should preserve the order
|
||||||
|
// in which the completions are provided
|
||||||
|
ShellCompDirectiveKeepOrder
|
||||||
|
|
||||||
// ===========================================================================
|
// ===========================================================================
|
||||||
|
|
||||||
// All directives using iota should be above this one.
|
// All directives using iota should be above this one.
|
||||||
|
@ -141,6 +147,20 @@ func (c *Command) RegisterFlagCompletionFunc(flagName string, f func(cmd *Comman
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GetFlagCompletionFunc returns the completion function for the given flag of the command, if available.
|
||||||
|
func (c *Command) GetFlagCompletionFunc(flagName string) (func(*Command, []string, string) ([]string, ShellCompDirective), bool) {
|
||||||
|
flag := c.Flag(flagName)
|
||||||
|
if flag == nil {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
flagCompletionMutex.RLock()
|
||||||
|
defer flagCompletionMutex.RUnlock()
|
||||||
|
|
||||||
|
completionFunc, exists := flagCompletionFunctions[flag]
|
||||||
|
return completionFunc, exists
|
||||||
|
}
|
||||||
|
|
||||||
// Returns a string listing the different directive enabled in the specified parameter
|
// Returns a string listing the different directive enabled in the specified parameter
|
||||||
func (d ShellCompDirective) string() string {
|
func (d ShellCompDirective) string() string {
|
||||||
var directives []string
|
var directives []string
|
||||||
|
@ -159,6 +179,9 @@ func (d ShellCompDirective) string() string {
|
||||||
if d&ShellCompDirectiveFilterDirs != 0 {
|
if d&ShellCompDirectiveFilterDirs != 0 {
|
||||||
directives = append(directives, "ShellCompDirectiveFilterDirs")
|
directives = append(directives, "ShellCompDirectiveFilterDirs")
|
||||||
}
|
}
|
||||||
|
if d&ShellCompDirectiveKeepOrder != 0 {
|
||||||
|
directives = append(directives, "ShellCompDirectiveKeepOrder")
|
||||||
|
}
|
||||||
if len(directives) == 0 {
|
if len(directives) == 0 {
|
||||||
directives = append(directives, "ShellCompDirectiveDefault")
|
directives = append(directives, "ShellCompDirectiveDefault")
|
||||||
}
|
}
|
||||||
|
@ -169,7 +192,7 @@ func (d ShellCompDirective) string() string {
|
||||||
return strings.Join(directives, ", ")
|
return strings.Join(directives, ", ")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Adds a special hidden command that can be used to request custom completions.
|
// initCompleteCmd adds a special hidden command that can be used to request custom completions.
|
||||||
func (c *Command) initCompleteCmd(args []string) {
|
func (c *Command) initCompleteCmd(args []string) {
|
||||||
completeCmd := &Command{
|
completeCmd := &Command{
|
||||||
Use: fmt.Sprintf("%s [command-line]", ShellCompRequestCmd),
|
Use: fmt.Sprintf("%s [command-line]", ShellCompRequestCmd),
|
||||||
|
@ -190,24 +213,29 @@ func (c *Command) initCompleteCmd(args []string) {
|
||||||
// 2- Even without completions, we need to print the directive
|
// 2- Even without completions, we need to print the directive
|
||||||
}
|
}
|
||||||
|
|
||||||
noDescriptions := (cmd.CalledAs() == ShellCompNoDescRequestCmd)
|
noDescriptions := cmd.CalledAs() == ShellCompNoDescRequestCmd
|
||||||
|
if !noDescriptions {
|
||||||
|
if doDescriptions, err := strconv.ParseBool(getEnvConfig(cmd, configEnvVarSuffixDescriptions)); err == nil {
|
||||||
|
noDescriptions = !doDescriptions
|
||||||
|
}
|
||||||
|
}
|
||||||
|
noActiveHelp := GetActiveHelpConfig(finalCmd) == activeHelpGlobalDisable
|
||||||
|
out := finalCmd.OutOrStdout()
|
||||||
for _, comp := range completions {
|
for _, comp := range completions {
|
||||||
if GetActiveHelpConfig(finalCmd) == activeHelpGlobalDisable {
|
if noActiveHelp && strings.HasPrefix(comp, activeHelpMarker) {
|
||||||
// Remove all activeHelp entries in this case
|
// Remove all activeHelp entries if it's disabled.
|
||||||
if strings.HasPrefix(comp, activeHelpMarker) {
|
continue
|
||||||
continue
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if noDescriptions {
|
if noDescriptions {
|
||||||
// Remove any description that may be included following a tab character.
|
// Remove any description that may be included following a tab character.
|
||||||
comp = strings.Split(comp, "\t")[0]
|
comp = strings.SplitN(comp, "\t", 2)[0]
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make sure we only write the first line to the output.
|
// Make sure we only write the first line to the output.
|
||||||
// This is needed if a description contains a linebreak.
|
// This is needed if a description contains a linebreak.
|
||||||
// Otherwise the shell scripts will interpret the other lines as new flags
|
// Otherwise the shell scripts will interpret the other lines as new flags
|
||||||
// and could therefore provide a wrong completion.
|
// and could therefore provide a wrong completion.
|
||||||
comp = strings.Split(comp, "\n")[0]
|
comp = strings.SplitN(comp, "\n", 2)[0]
|
||||||
|
|
||||||
// Finally trim the completion. This is especially important to get rid
|
// Finally trim the completion. This is especially important to get rid
|
||||||
// of a trailing tab when there are no description following it.
|
// of a trailing tab when there are no description following it.
|
||||||
|
@ -216,14 +244,14 @@ func (c *Command) initCompleteCmd(args []string) {
|
||||||
// although there is no description).
|
// although there is no description).
|
||||||
comp = strings.TrimSpace(comp)
|
comp = strings.TrimSpace(comp)
|
||||||
|
|
||||||
// Print each possible completion to stdout for the completion script to consume.
|
// Print each possible completion to the output for the completion script to consume.
|
||||||
fmt.Fprintln(finalCmd.OutOrStdout(), comp)
|
fmt.Fprintln(out, comp)
|
||||||
}
|
}
|
||||||
|
|
||||||
// As the last printout, print the completion directive for the completion script to parse.
|
// As the last printout, print the completion directive for the completion script to parse.
|
||||||
// The directive integer must be that last character following a single colon (:).
|
// The directive integer must be that last character following a single colon (:).
|
||||||
// The completion script expects :<directive>
|
// The completion script expects :<directive>
|
||||||
fmt.Fprintf(finalCmd.OutOrStdout(), ":%d\n", directive)
|
fmt.Fprintf(out, ":%d\n", directive)
|
||||||
|
|
||||||
// Print some helpful info to stderr for the user to understand.
|
// Print some helpful info to stderr for the user to understand.
|
||||||
// Output from stderr must be ignored by the completion script.
|
// Output from stderr must be ignored by the completion script.
|
||||||
|
@ -276,9 +304,13 @@ func (c *Command) getCompletions(args []string) (*Command, []string, ShellCompDi
|
||||||
|
|
||||||
// These flags are normally added when `execute()` is called on `finalCmd`,
|
// These flags are normally added when `execute()` is called on `finalCmd`,
|
||||||
// however, when doing completion, we don't call `finalCmd.execute()`.
|
// however, when doing completion, we don't call `finalCmd.execute()`.
|
||||||
// Let's add the --help and --version flag ourselves.
|
// Let's add the --help and --version flag ourselves but only if the finalCmd
|
||||||
finalCmd.InitDefaultHelpFlag()
|
// has not disabled flag parsing; if flag parsing is disabled, it is up to the
|
||||||
finalCmd.InitDefaultVersionFlag()
|
// finalCmd itself to handle the completion of *all* flags.
|
||||||
|
if !finalCmd.DisableFlagParsing {
|
||||||
|
finalCmd.InitDefaultHelpFlag()
|
||||||
|
finalCmd.InitDefaultVersionFlag()
|
||||||
|
}
|
||||||
|
|
||||||
// Check if we are doing flag value completion before parsing the flags.
|
// Check if we are doing flag value completion before parsing the flags.
|
||||||
// This is important because if we are completing a flag value, we need to also
|
// This is important because if we are completing a flag value, we need to also
|
||||||
|
@ -382,6 +414,11 @@ func (c *Command) getCompletions(args []string) (*Command, []string, ShellCompDi
|
||||||
finalCmd.InheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
finalCmd.InheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
||||||
doCompleteFlags(flag)
|
doCompleteFlags(flag)
|
||||||
})
|
})
|
||||||
|
// Try to complete non-inherited flags even if DisableFlagParsing==true.
|
||||||
|
// This allows programs to tell Cobra about flags for completion even
|
||||||
|
// if the actual parsing of flags is not done by Cobra.
|
||||||
|
// For instance, Helm uses this to provide flag name completion for
|
||||||
|
// some of its plugins.
|
||||||
finalCmd.NonInheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
finalCmd.NonInheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
||||||
doCompleteFlags(flag)
|
doCompleteFlags(flag)
|
||||||
})
|
})
|
||||||
|
@ -727,7 +764,7 @@ to enable it. You can execute the following once:
|
||||||
|
|
||||||
To load completions in your current shell session:
|
To load completions in your current shell session:
|
||||||
|
|
||||||
source <(%[1]s completion zsh); compdef _%[1]s %[1]s
|
source <(%[1]s completion zsh)
|
||||||
|
|
||||||
To load completions for every new session, execute once:
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
@ -899,3 +936,34 @@ func CompError(msg string) {
|
||||||
func CompErrorln(msg string) {
|
func CompErrorln(msg string) {
|
||||||
CompError(fmt.Sprintf("%s\n", msg))
|
CompError(fmt.Sprintf("%s\n", msg))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// These values should not be changed: users will be using them explicitly.
|
||||||
|
const (
|
||||||
|
configEnvVarGlobalPrefix = "COBRA"
|
||||||
|
configEnvVarSuffixDescriptions = "COMPLETION_DESCRIPTIONS"
|
||||||
|
)
|
||||||
|
|
||||||
|
var configEnvVarPrefixSubstRegexp = regexp.MustCompile(`[^A-Z0-9_]`)
|
||||||
|
|
||||||
|
// configEnvVar returns the name of the program-specific configuration environment
|
||||||
|
// variable. It has the format <PROGRAM>_<SUFFIX> where <PROGRAM> is the name of the
|
||||||
|
// root command in upper case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
|
func configEnvVar(name, suffix string) string {
|
||||||
|
// This format should not be changed: users will be using it explicitly.
|
||||||
|
v := strings.ToUpper(fmt.Sprintf("%s_%s", name, suffix))
|
||||||
|
v = configEnvVarPrefixSubstRegexp.ReplaceAllString(v, "_")
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
// getEnvConfig returns the value of the configuration environment variable
|
||||||
|
// <PROGRAM>_<SUFFIX> where <PROGRAM> is the name of the root command in upper
|
||||||
|
// case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
|
// If the value is empty or not set, the value of the environment variable
|
||||||
|
// COBRA_<SUFFIX> is returned instead.
|
||||||
|
func getEnvConfig(cmd *Command, suffix string) string {
|
||||||
|
v := os.Getenv(configEnvVar(cmd.Root().Name(), suffix))
|
||||||
|
if v == "" {
|
||||||
|
v = os.Getenv(configEnvVar(configEnvVarGlobalPrefix, suffix))
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -17,7 +17,10 @@ package cobra
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -2040,6 +2043,114 @@ func TestFlagCompletionWorksRootCommandAddedAfterFlags(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFlagCompletionForPersistentFlagsCalledFromSubCmd(t *testing.T) {
|
||||||
|
rootCmd := &Command{Use: "root", Run: emptyRun}
|
||||||
|
rootCmd.PersistentFlags().String("string", "", "test string flag")
|
||||||
|
_ = rootCmd.RegisterFlagCompletionFunc("string", func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"myval"}, ShellCompDirectiveDefault
|
||||||
|
})
|
||||||
|
|
||||||
|
childCmd := &Command{
|
||||||
|
Use: "child",
|
||||||
|
Run: emptyRun,
|
||||||
|
ValidArgsFunction: func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"--validarg", "test"}, ShellCompDirectiveDefault
|
||||||
|
},
|
||||||
|
}
|
||||||
|
childCmd.Flags().Bool("bool", false, "test bool flag")
|
||||||
|
rootCmd.AddCommand(childCmd)
|
||||||
|
|
||||||
|
// Test that persistent flag completion works for the subcmd
|
||||||
|
output, err := executeCommand(rootCmd, ShellCompRequestCmd, "child", "--string", "")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := strings.Join([]string{
|
||||||
|
"myval",
|
||||||
|
":0",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveDefault", ""}, "\n")
|
||||||
|
|
||||||
|
if output != expected {
|
||||||
|
t.Errorf("expected: %q, got: %q", expected, output)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// This test tries to register flag completion concurrently to make sure the
|
||||||
|
// code handles concurrency properly.
|
||||||
|
// This was reported as a problem when tests are run concurrently:
|
||||||
|
// https://github.com/spf13/cobra/issues/1320
|
||||||
|
//
|
||||||
|
// NOTE: this test can sometimes pass even if the code were to not handle
|
||||||
|
// concurrency properly. This is not great but the important part is that
|
||||||
|
// it should never fail. Therefore, if the tests fails sometimes, we will
|
||||||
|
// still be able to know there is a problem.
|
||||||
|
func TestFlagCompletionConcurrentRegistration(t *testing.T) {
|
||||||
|
rootCmd := &Command{Use: "root", Run: emptyRun}
|
||||||
|
const maxFlags = 50
|
||||||
|
for i := 1; i < maxFlags; i += 2 {
|
||||||
|
flagName := fmt.Sprintf("flag%d", i)
|
||||||
|
rootCmd.Flags().String(flagName, "", fmt.Sprintf("test %s flag on root", flagName))
|
||||||
|
}
|
||||||
|
|
||||||
|
childCmd := &Command{
|
||||||
|
Use: "child",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
for i := 2; i <= maxFlags; i += 2 {
|
||||||
|
flagName := fmt.Sprintf("flag%d", i)
|
||||||
|
childCmd.Flags().String(flagName, "", fmt.Sprintf("test %s flag on child", flagName))
|
||||||
|
}
|
||||||
|
|
||||||
|
rootCmd.AddCommand(childCmd)
|
||||||
|
|
||||||
|
// Register completion in different threads to test concurrency.
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for i := 1; i <= maxFlags; i++ {
|
||||||
|
index := i
|
||||||
|
flagName := fmt.Sprintf("flag%d", i)
|
||||||
|
wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
cmd := rootCmd
|
||||||
|
if index%2 == 0 {
|
||||||
|
cmd = childCmd
|
||||||
|
}
|
||||||
|
_ = cmd.RegisterFlagCompletionFunc(flagName, func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{fmt.Sprintf("flag%d", index)}, ShellCompDirectiveDefault
|
||||||
|
})
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
// Test that flag completion works for each flag
|
||||||
|
for i := 1; i <= 6; i++ {
|
||||||
|
var output string
|
||||||
|
var err error
|
||||||
|
flagName := fmt.Sprintf("flag%d", i)
|
||||||
|
|
||||||
|
if i%2 == 1 {
|
||||||
|
output, err = executeCommand(rootCmd, ShellCompRequestCmd, "--"+flagName, "")
|
||||||
|
} else {
|
||||||
|
output, err = executeCommand(rootCmd, ShellCompRequestCmd, "child", "--"+flagName, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := strings.Join([]string{
|
||||||
|
flagName,
|
||||||
|
":0",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveDefault", ""}, "\n")
|
||||||
|
|
||||||
|
if output != expected {
|
||||||
|
t.Errorf("expected: %q, got: %q", expected, output)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestFlagCompletionInGoWithDesc(t *testing.T) {
|
func TestFlagCompletionInGoWithDesc(t *testing.T) {
|
||||||
rootCmd := &Command{
|
rootCmd := &Command{
|
||||||
Use: "root",
|
Use: "root",
|
||||||
|
@ -2623,8 +2734,6 @@ func TestCompleteWithDisableFlagParsing(t *testing.T) {
|
||||||
expected := strings.Join([]string{
|
expected := strings.Join([]string{
|
||||||
"--persistent",
|
"--persistent",
|
||||||
"-p",
|
"-p",
|
||||||
"--help",
|
|
||||||
"-h",
|
|
||||||
"--nonPersistent",
|
"--nonPersistent",
|
||||||
"-n",
|
"-n",
|
||||||
"--flag",
|
"--flag",
|
||||||
|
@ -2831,6 +2940,104 @@ func TestCompletionForGroupedFlags(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCompletionForOneRequiredGroupFlags(t *testing.T) {
|
||||||
|
getCmd := func() *Command {
|
||||||
|
rootCmd := &Command{
|
||||||
|
Use: "root",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
childCmd := &Command{
|
||||||
|
Use: "child",
|
||||||
|
ValidArgsFunction: func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"subArg"}, ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
rootCmd.AddCommand(childCmd)
|
||||||
|
|
||||||
|
rootCmd.PersistentFlags().Int("ingroup1", -1, "ingroup1")
|
||||||
|
rootCmd.PersistentFlags().String("ingroup2", "", "ingroup2")
|
||||||
|
|
||||||
|
childCmd.Flags().Bool("ingroup3", false, "ingroup3")
|
||||||
|
childCmd.Flags().Bool("nogroup", false, "nogroup")
|
||||||
|
|
||||||
|
// Add flags to a group
|
||||||
|
childCmd.MarkFlagsOneRequired("ingroup1", "ingroup2", "ingroup3")
|
||||||
|
|
||||||
|
return rootCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// Each test case uses a unique command from the function above.
|
||||||
|
testcases := []struct {
|
||||||
|
desc string
|
||||||
|
args []string
|
||||||
|
expectedOutput string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
desc: "flags in group suggested without - prefix",
|
||||||
|
args: []string{"child", ""},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"--ingroup1",
|
||||||
|
"--ingroup2",
|
||||||
|
"--ingroup3",
|
||||||
|
"subArg",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "flags in group suggested with - prefix",
|
||||||
|
args: []string{"child", "-"},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"--ingroup1",
|
||||||
|
"--ingroup2",
|
||||||
|
"--ingroup3",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "when any flag in group present, other flags in group not suggested without - prefix",
|
||||||
|
args: []string{"child", "--ingroup2", "value", ""},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"subArg",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "when all flags in group present, flags not suggested without - prefix",
|
||||||
|
args: []string{"child", "--ingroup1", "8", "--ingroup2", "value2", "--ingroup3", ""},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"subArg",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "group ignored if some flags not applicable",
|
||||||
|
args: []string{"--ingroup2", "value", ""},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"child",
|
||||||
|
"completion",
|
||||||
|
"help",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range testcases {
|
||||||
|
t.Run(tc.desc, func(t *testing.T) {
|
||||||
|
c := getCmd()
|
||||||
|
args := []string{ShellCompNoDescRequestCmd}
|
||||||
|
args = append(args, tc.args...)
|
||||||
|
output, err := executeCommand(c, args...)
|
||||||
|
switch {
|
||||||
|
case err == nil && output != tc.expectedOutput:
|
||||||
|
t.Errorf("expected: %q, got: %q", tc.expectedOutput, output)
|
||||||
|
case err != nil:
|
||||||
|
t.Errorf("Unexpected error %q", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestCompletionForMutuallyExclusiveFlags(t *testing.T) {
|
func TestCompletionForMutuallyExclusiveFlags(t *testing.T) {
|
||||||
getCmd := func() *Command {
|
getCmd := func() *Command {
|
||||||
rootCmd := &Command{
|
rootCmd := &Command{
|
||||||
|
@ -2956,8 +3163,26 @@ func TestCompletionCobraFlags(t *testing.T) {
|
||||||
return []string{"extra3"}, ShellCompDirectiveNoFileComp
|
return []string{"extra3"}, ShellCompDirectiveNoFileComp
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
childCmd4 := &Command{
|
||||||
|
Use: "child4",
|
||||||
|
Version: "1.1.1",
|
||||||
|
Run: emptyRun,
|
||||||
|
ValidArgsFunction: func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"extra4"}, ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
DisableFlagParsing: true,
|
||||||
|
}
|
||||||
|
childCmd5 := &Command{
|
||||||
|
Use: "child5",
|
||||||
|
Version: "1.1.1",
|
||||||
|
Run: emptyRun,
|
||||||
|
ValidArgsFunction: func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"extra5"}, ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
DisableFlagParsing: true,
|
||||||
|
}
|
||||||
|
|
||||||
rootCmd.AddCommand(childCmd, childCmd2, childCmd3)
|
rootCmd.AddCommand(childCmd, childCmd2, childCmd3, childCmd4, childCmd5)
|
||||||
|
|
||||||
_ = childCmd.Flags().Bool("bool", false, "A bool flag")
|
_ = childCmd.Flags().Bool("bool", false, "A bool flag")
|
||||||
_ = childCmd.MarkFlagRequired("bool")
|
_ = childCmd.MarkFlagRequired("bool")
|
||||||
|
@ -2969,6 +3194,10 @@ func TestCompletionCobraFlags(t *testing.T) {
|
||||||
// Have a command that only adds its own -v flag
|
// Have a command that only adds its own -v flag
|
||||||
_ = childCmd3.Flags().BoolP("verbose", "v", false, "Not a version flag")
|
_ = childCmd3.Flags().BoolP("verbose", "v", false, "Not a version flag")
|
||||||
|
|
||||||
|
// Have a command that DisablesFlagParsing but that also adds its own help and version flags
|
||||||
|
_ = childCmd5.Flags().BoolP("help", "h", false, "My own help")
|
||||||
|
_ = childCmd5.Flags().BoolP("version", "v", false, "My own version")
|
||||||
|
|
||||||
return rootCmd
|
return rootCmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -3099,6 +3328,26 @@ func TestCompletionCobraFlags(t *testing.T) {
|
||||||
":4",
|
":4",
|
||||||
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "no completion for --help/-h and --version/-v flags when DisableFlagParsing=true",
|
||||||
|
args: []string{"child4", "-"},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"extra4",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "completions for program-defined --help/-h and --version/-v flags even when DisableFlagParsing=true",
|
||||||
|
args: []string{"child5", "-"},
|
||||||
|
expectedOutput: strings.Join([]string{
|
||||||
|
"--help",
|
||||||
|
"-h",
|
||||||
|
"--version",
|
||||||
|
"-v",
|
||||||
|
"extra5",
|
||||||
|
":4",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n"),
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, tc := range testcases {
|
for _, tc := range testcases {
|
||||||
|
@ -3116,3 +3365,348 @@ func TestCompletionCobraFlags(t *testing.T) {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestArgsNotDetectedAsFlagsCompletionInGo(t *testing.T) {
|
||||||
|
// Regression test that ensures the bug described in
|
||||||
|
// https://github.com/spf13/cobra/issues/1816 does not occur anymore.
|
||||||
|
|
||||||
|
root := Command{
|
||||||
|
Use: "root",
|
||||||
|
ValidArgsFunction: func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"service", "1-123", "11-123"}, ShellCompDirectiveNoFileComp
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
completion := `service
|
||||||
|
1-123
|
||||||
|
11-123
|
||||||
|
:4
|
||||||
|
Completion ended with directive: ShellCompDirectiveNoFileComp
|
||||||
|
`
|
||||||
|
|
||||||
|
testcases := []struct {
|
||||||
|
desc string
|
||||||
|
args []string
|
||||||
|
expectedOutput string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
desc: "empty",
|
||||||
|
args: []string{""},
|
||||||
|
expectedOutput: completion,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "service only",
|
||||||
|
args: []string{"service", ""},
|
||||||
|
expectedOutput: completion,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "service last",
|
||||||
|
args: []string{"1-123", "service", ""},
|
||||||
|
expectedOutput: completion,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "two digit prefixed dash last",
|
||||||
|
args: []string{"service", "11-123", ""},
|
||||||
|
expectedOutput: completion,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "one digit prefixed dash last",
|
||||||
|
args: []string{"service", "1-123", ""},
|
||||||
|
expectedOutput: completion,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range testcases {
|
||||||
|
t.Run(tc.desc, func(t *testing.T) {
|
||||||
|
args := []string{ShellCompNoDescRequestCmd}
|
||||||
|
args = append(args, tc.args...)
|
||||||
|
output, err := executeCommand(&root, args...)
|
||||||
|
switch {
|
||||||
|
case err == nil && output != tc.expectedOutput:
|
||||||
|
t.Errorf("expected: %q, got: %q", tc.expectedOutput, output)
|
||||||
|
case err != nil:
|
||||||
|
t.Errorf("Unexpected error %q", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetFlagCompletion(t *testing.T) {
|
||||||
|
rootCmd := &Command{Use: "root", Run: emptyRun}
|
||||||
|
|
||||||
|
rootCmd.Flags().String("rootflag", "", "root flag")
|
||||||
|
_ = rootCmd.RegisterFlagCompletionFunc("rootflag", func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"rootvalue"}, ShellCompDirectiveKeepOrder
|
||||||
|
})
|
||||||
|
|
||||||
|
rootCmd.PersistentFlags().String("persistentflag", "", "persistent flag")
|
||||||
|
_ = rootCmd.RegisterFlagCompletionFunc("persistentflag", func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"persistentvalue"}, ShellCompDirectiveDefault
|
||||||
|
})
|
||||||
|
|
||||||
|
childCmd := &Command{Use: "child", Run: emptyRun}
|
||||||
|
|
||||||
|
childCmd.Flags().String("childflag", "", "child flag")
|
||||||
|
_ = childCmd.RegisterFlagCompletionFunc("childflag", func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
return []string{"childvalue"}, ShellCompDirectiveNoFileComp | ShellCompDirectiveNoSpace
|
||||||
|
})
|
||||||
|
|
||||||
|
rootCmd.AddCommand(childCmd)
|
||||||
|
|
||||||
|
testcases := []struct {
|
||||||
|
desc string
|
||||||
|
cmd *Command
|
||||||
|
flagName string
|
||||||
|
exists bool
|
||||||
|
comps []string
|
||||||
|
directive ShellCompDirective
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
desc: "get flag completion function for command",
|
||||||
|
cmd: rootCmd,
|
||||||
|
flagName: "rootflag",
|
||||||
|
exists: true,
|
||||||
|
comps: []string{"rootvalue"},
|
||||||
|
directive: ShellCompDirectiveKeepOrder,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "get persistent flag completion function for command",
|
||||||
|
cmd: rootCmd,
|
||||||
|
flagName: "persistentflag",
|
||||||
|
exists: true,
|
||||||
|
comps: []string{"persistentvalue"},
|
||||||
|
directive: ShellCompDirectiveDefault,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "get flag completion function for child command",
|
||||||
|
cmd: childCmd,
|
||||||
|
flagName: "childflag",
|
||||||
|
exists: true,
|
||||||
|
comps: []string{"childvalue"},
|
||||||
|
directive: ShellCompDirectiveNoFileComp | ShellCompDirectiveNoSpace,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "get persistent flag completion function for child command",
|
||||||
|
cmd: childCmd,
|
||||||
|
flagName: "persistentflag",
|
||||||
|
exists: true,
|
||||||
|
comps: []string{"persistentvalue"},
|
||||||
|
directive: ShellCompDirectiveDefault,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "cannot get flag completion function for local parent flag",
|
||||||
|
cmd: childCmd,
|
||||||
|
flagName: "rootflag",
|
||||||
|
exists: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range testcases {
|
||||||
|
t.Run(tc.desc, func(t *testing.T) {
|
||||||
|
compFunc, exists := tc.cmd.GetFlagCompletionFunc(tc.flagName)
|
||||||
|
if tc.exists != exists {
|
||||||
|
t.Errorf("Unexpected result looking for flag completion function")
|
||||||
|
}
|
||||||
|
|
||||||
|
if exists {
|
||||||
|
comps, directive := compFunc(tc.cmd, []string{}, "")
|
||||||
|
if strings.Join(tc.comps, " ") != strings.Join(comps, " ") {
|
||||||
|
t.Errorf("Unexpected completions %q", comps)
|
||||||
|
}
|
||||||
|
if tc.directive != directive {
|
||||||
|
t.Errorf("Unexpected directive %q", directive)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGetEnvConfig(t *testing.T) {
|
||||||
|
testCases := []struct {
|
||||||
|
desc string
|
||||||
|
use string
|
||||||
|
suffix string
|
||||||
|
cmdVar string
|
||||||
|
globalVar string
|
||||||
|
cmdVal string
|
||||||
|
globalVal string
|
||||||
|
expected string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
desc: "Command envvar overrides global",
|
||||||
|
use: "root",
|
||||||
|
suffix: "test",
|
||||||
|
cmdVar: "ROOT_TEST",
|
||||||
|
globalVar: "COBRA_TEST",
|
||||||
|
cmdVal: "cmd",
|
||||||
|
globalVal: "global",
|
||||||
|
expected: "cmd",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "Missing/empty command envvar falls back to global",
|
||||||
|
use: "root",
|
||||||
|
suffix: "test",
|
||||||
|
cmdVar: "ROOT_TEST",
|
||||||
|
globalVar: "COBRA_TEST",
|
||||||
|
cmdVal: "",
|
||||||
|
globalVal: "global",
|
||||||
|
expected: "global",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "Missing/empty command and global envvars fall back to empty",
|
||||||
|
use: "root",
|
||||||
|
suffix: "test",
|
||||||
|
cmdVar: "ROOT_TEST",
|
||||||
|
globalVar: "COBRA_TEST",
|
||||||
|
cmdVal: "",
|
||||||
|
globalVal: "",
|
||||||
|
expected: "",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "Periods in command use transform to underscores in env var name",
|
||||||
|
use: "foo.bar",
|
||||||
|
suffix: "test",
|
||||||
|
cmdVar: "FOO_BAR_TEST",
|
||||||
|
globalVar: "COBRA_TEST",
|
||||||
|
cmdVal: "cmd",
|
||||||
|
globalVal: "global",
|
||||||
|
expected: "cmd",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "Dashes in command use transform to underscores in env var name",
|
||||||
|
use: "quux-BAZ",
|
||||||
|
suffix: "test",
|
||||||
|
cmdVar: "QUUX_BAZ_TEST",
|
||||||
|
globalVar: "COBRA_TEST",
|
||||||
|
cmdVal: "cmd",
|
||||||
|
globalVal: "global",
|
||||||
|
expected: "cmd",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range testCases {
|
||||||
|
t.Run(tc.desc, func(t *testing.T) {
|
||||||
|
// Could make env handling cleaner with t.Setenv with Go >= 1.17
|
||||||
|
err := os.Setenv(tc.cmdVar, tc.cmdVal)
|
||||||
|
defer func() {
|
||||||
|
assertNoErr(t, os.Unsetenv(tc.cmdVar))
|
||||||
|
}()
|
||||||
|
assertNoErr(t, err)
|
||||||
|
err = os.Setenv(tc.globalVar, tc.globalVal)
|
||||||
|
defer func() {
|
||||||
|
assertNoErr(t, os.Unsetenv(tc.globalVar))
|
||||||
|
}()
|
||||||
|
assertNoErr(t, err)
|
||||||
|
cmd := &Command{Use: tc.use}
|
||||||
|
got := getEnvConfig(cmd, tc.suffix)
|
||||||
|
if got != tc.expected {
|
||||||
|
t.Errorf("expected: %q, got: %q", tc.expected, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDisableDescriptions(t *testing.T) {
|
||||||
|
rootCmd := &Command{
|
||||||
|
Use: "root",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
|
||||||
|
childCmd := &Command{
|
||||||
|
Use: "thechild",
|
||||||
|
Short: "The child command",
|
||||||
|
Run: emptyRun,
|
||||||
|
}
|
||||||
|
rootCmd.AddCommand(childCmd)
|
||||||
|
|
||||||
|
specificDescriptionsEnvVar := configEnvVar(rootCmd.Name(), configEnvVarSuffixDescriptions)
|
||||||
|
globalDescriptionsEnvVar := configEnvVar(configEnvVarGlobalPrefix, configEnvVarSuffixDescriptions)
|
||||||
|
|
||||||
|
const (
|
||||||
|
descLineWithDescription = "first\tdescription"
|
||||||
|
descLineWithoutDescription = "first"
|
||||||
|
)
|
||||||
|
childCmd.ValidArgsFunction = func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
|
||||||
|
comps := []string{descLineWithDescription}
|
||||||
|
return comps, ShellCompDirectiveDefault
|
||||||
|
}
|
||||||
|
|
||||||
|
testCases := []struct {
|
||||||
|
desc string
|
||||||
|
globalEnvValue string
|
||||||
|
specificEnvValue string
|
||||||
|
expectedLine string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
"No env variables set",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
descLineWithDescription,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Global value false",
|
||||||
|
"false",
|
||||||
|
"",
|
||||||
|
descLineWithoutDescription,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Specific value false",
|
||||||
|
"",
|
||||||
|
"false",
|
||||||
|
descLineWithoutDescription,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Both values false",
|
||||||
|
"false",
|
||||||
|
"false",
|
||||||
|
descLineWithoutDescription,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"Both values true",
|
||||||
|
"true",
|
||||||
|
"true",
|
||||||
|
descLineWithDescription,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range testCases {
|
||||||
|
t.Run(tc.desc, func(t *testing.T) {
|
||||||
|
if err := os.Setenv(specificDescriptionsEnvVar, tc.specificEnvValue); err != nil {
|
||||||
|
t.Errorf("Unexpected error setting %s: %v", specificDescriptionsEnvVar, err)
|
||||||
|
}
|
||||||
|
if err := os.Setenv(globalDescriptionsEnvVar, tc.globalEnvValue); err != nil {
|
||||||
|
t.Errorf("Unexpected error setting %s: %v", globalDescriptionsEnvVar, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var run = func() {
|
||||||
|
output, err := executeCommand(rootCmd, ShellCompRequestCmd, "thechild", "")
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := strings.Join([]string{
|
||||||
|
tc.expectedLine,
|
||||||
|
":0",
|
||||||
|
"Completion ended with directive: ShellCompDirectiveDefault", ""}, "\n")
|
||||||
|
if output != expected {
|
||||||
|
t.Errorf("expected: %q, got: %q", expected, output)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
run()
|
||||||
|
|
||||||
|
// For empty cases, test also unset state
|
||||||
|
if tc.specificEnvValue == "" {
|
||||||
|
if err := os.Unsetenv(specificDescriptionsEnvVar); err != nil {
|
||||||
|
t.Errorf("Unexpected error unsetting %s: %v", specificDescriptionsEnvVar, err)
|
||||||
|
}
|
||||||
|
run()
|
||||||
|
}
|
||||||
|
if tc.globalEnvValue == "" {
|
||||||
|
if err := os.Unsetenv(globalDescriptionsEnvVar); err != nil {
|
||||||
|
t.Errorf("Unexpected error unsetting %s: %v", globalDescriptionsEnvVar, err)
|
||||||
|
}
|
||||||
|
run()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -133,7 +133,7 @@ func fillHeader(header *GenManHeader, name string, disableAutoGen bool) error {
|
||||||
}
|
}
|
||||||
header.Date = &now
|
header.Date = &now
|
||||||
}
|
}
|
||||||
header.date = (*header.Date).Format("Jan 2006")
|
header.date = header.Date.Format("Jan 2006")
|
||||||
if header.Source == "" && !disableAutoGen {
|
if header.Source == "" && !disableAutoGen {
|
||||||
header.Source = "Auto generated by spf13/cobra"
|
header.Source = "Auto generated by spf13/cobra"
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -150,7 +150,7 @@ func TestGenManSeeAlso(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestManPrintFlagsHidesShortDeperecated(t *testing.T) {
|
func TestManPrintFlagsHidesShortDeprecated(t *testing.T) {
|
||||||
c := &cobra.Command{}
|
c := &cobra.Command{}
|
||||||
c.Flags().StringP("foo", "f", "default", "Foo flag")
|
c.Flags().StringP("foo", "f", "default", "Foo flag")
|
||||||
assertNoErr(t, c.Flags().MarkShorthandDeprecated("foo", "don't use it no more"))
|
assertNoErr(t, c.Flags().MarkShorthandDeprecated("foo", "don't use it no more"))
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -27,6 +27,8 @@ import (
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const markdownExtension = ".md"
|
||||||
|
|
||||||
func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
|
func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
|
||||||
flags := cmd.NonInheritedFlags()
|
flags := cmd.NonInheritedFlags()
|
||||||
flags.SetOutput(buf)
|
flags.SetOutput(buf)
|
||||||
|
@ -83,7 +85,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
|
||||||
if cmd.HasParent() {
|
if cmd.HasParent() {
|
||||||
parent := cmd.Parent()
|
parent := cmd.Parent()
|
||||||
pname := parent.CommandPath()
|
pname := parent.CommandPath()
|
||||||
link := pname + ".md"
|
link := pname + markdownExtension
|
||||||
link = strings.ReplaceAll(link, " ", "_")
|
link = strings.ReplaceAll(link, " ", "_")
|
||||||
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short))
|
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short))
|
||||||
cmd.VisitParents(func(c *cobra.Command) {
|
cmd.VisitParents(func(c *cobra.Command) {
|
||||||
|
@ -101,7 +103,7 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
cname := name + " " + child.Name()
|
cname := name + " " + child.Name()
|
||||||
link := cname + ".md"
|
link := cname + markdownExtension
|
||||||
link = strings.ReplaceAll(link, " ", "_")
|
link = strings.ReplaceAll(link, " ", "_")
|
||||||
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short))
|
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short))
|
||||||
}
|
}
|
||||||
|
@ -126,7 +128,7 @@ func GenMarkdownTree(cmd *cobra.Command, dir string) error {
|
||||||
return GenMarkdownTreeCustom(cmd, dir, emptyStr, identity)
|
return GenMarkdownTreeCustom(cmd, dir, emptyStr, identity)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GenMarkdownTreeCustom is the the same as GenMarkdownTree, but
|
// GenMarkdownTreeCustom is the same as GenMarkdownTree, but
|
||||||
// with custom filePrepender and linkHandler.
|
// with custom filePrepender and linkHandler.
|
||||||
func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error {
|
func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error {
|
||||||
for _, c := range cmd.Commands() {
|
for _, c := range cmd.Commands() {
|
||||||
|
@ -138,7 +140,7 @@ func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHa
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
basename := strings.ReplaceAll(cmd.CommandPath(), " ", "_") + ".md"
|
basename := strings.ReplaceAll(cmd.CommandPath(), " ", "_") + markdownExtension
|
||||||
filename := filepath.Join(dir, basename)
|
filename := filepath.Join(dir, basename)
|
||||||
f, err := os.Create(filename)
|
f, err := os.Create(filename)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -48,7 +48,7 @@ func printOptionsReST(buf *bytes.Buffer, cmd *cobra.Command, name string) error
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// linkHandler for default ReST hyperlink markup
|
// defaultLinkHandler for default ReST hyperlink markup
|
||||||
func defaultLinkHandler(name, ref string) string {
|
func defaultLinkHandler(name, ref string) string {
|
||||||
return fmt.Sprintf("`%s <%s.rst>`_", name, ref)
|
return fmt.Sprintf("`%s <%s.rst>`_", name, ref)
|
||||||
}
|
}
|
||||||
|
@ -140,7 +140,7 @@ func GenReSTTree(cmd *cobra.Command, dir string) error {
|
||||||
return GenReSTTreeCustom(cmd, dir, emptyStr, defaultLinkHandler)
|
return GenReSTTreeCustom(cmd, dir, emptyStr, defaultLinkHandler)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GenReSTTreeCustom is the the same as GenReSTTree, but
|
// GenReSTTreeCustom is the same as GenReSTTree, but
|
||||||
// with custom filePrepender and linkHandler.
|
// with custom filePrepender and linkHandler.
|
||||||
func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, linkHandler func(string, string) string) error {
|
func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, linkHandler func(string, string) string) error {
|
||||||
for _, c := range cmd.Commands() {
|
for _, c := range cmd.Commands() {
|
||||||
|
@ -169,7 +169,7 @@ func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// adapted from: https://github.com/kr/text/blob/main/indent.go
|
// indentString adapted from: https://github.com/kr/text/blob/main/indent.go
|
||||||
func indentString(s, p string) string {
|
func indentString(s, p string) string {
|
||||||
var res []byte
|
var res []byte
|
||||||
b := []byte(s)
|
b := []byte(s)
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -40,7 +40,7 @@ func hasSeeAlso(cmd *cobra.Command) bool {
|
||||||
// that do not contain \n.
|
// that do not contain \n.
|
||||||
func forceMultiLine(s string) string {
|
func forceMultiLine(s string) string {
|
||||||
if len(s) > 60 && !strings.Contains(s, "\n") {
|
if len(s) > 60 && !strings.Contains(s, "\n") {
|
||||||
s = s + "\n"
|
s += "\n"
|
||||||
}
|
}
|
||||||
return s
|
return s
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -53,7 +53,7 @@ function __%[1]s_perform_completion
|
||||||
__%[1]s_debug "last arg: $lastArg"
|
__%[1]s_debug "last arg: $lastArg"
|
||||||
|
|
||||||
# Disable ActiveHelp which is not supported for fish shell
|
# Disable ActiveHelp which is not supported for fish shell
|
||||||
set -l requestComp "%[9]s=0 $args[1] %[3]s $args[2..-1] $lastArg"
|
set -l requestComp "%[10]s=0 $args[1] %[3]s $args[2..-1] $lastArg"
|
||||||
|
|
||||||
__%[1]s_debug "Calling $requestComp"
|
__%[1]s_debug "Calling $requestComp"
|
||||||
set -l results (eval $requestComp 2> /dev/null)
|
set -l results (eval $requestComp 2> /dev/null)
|
||||||
|
@ -89,6 +89,60 @@ function __%[1]s_perform_completion
|
||||||
printf "%%s\n" "$directiveLine"
|
printf "%%s\n" "$directiveLine"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# this function limits calls to __%[1]s_perform_completion, by caching the result behind $__%[1]s_perform_completion_once_result
|
||||||
|
function __%[1]s_perform_completion_once
|
||||||
|
__%[1]s_debug "Starting __%[1]s_perform_completion_once"
|
||||||
|
|
||||||
|
if test -n "$__%[1]s_perform_completion_once_result"
|
||||||
|
__%[1]s_debug "Seems like a valid result already exists, skipping __%[1]s_perform_completion"
|
||||||
|
return 0
|
||||||
|
end
|
||||||
|
|
||||||
|
set --global __%[1]s_perform_completion_once_result (__%[1]s_perform_completion)
|
||||||
|
if test -z "$__%[1]s_perform_completion_once_result"
|
||||||
|
__%[1]s_debug "No completions, probably due to a failure"
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
__%[1]s_debug "Performed completions and set __%[1]s_perform_completion_once_result"
|
||||||
|
return 0
|
||||||
|
end
|
||||||
|
|
||||||
|
# this function is used to clear the $__%[1]s_perform_completion_once_result variable after completions are run
|
||||||
|
function __%[1]s_clear_perform_completion_once_result
|
||||||
|
__%[1]s_debug ""
|
||||||
|
__%[1]s_debug "========= clearing previously set __%[1]s_perform_completion_once_result variable =========="
|
||||||
|
set --erase __%[1]s_perform_completion_once_result
|
||||||
|
__%[1]s_debug "Successfully erased the variable __%[1]s_perform_completion_once_result"
|
||||||
|
end
|
||||||
|
|
||||||
|
function __%[1]s_requires_order_preservation
|
||||||
|
__%[1]s_debug ""
|
||||||
|
__%[1]s_debug "========= checking if order preservation is required =========="
|
||||||
|
|
||||||
|
__%[1]s_perform_completion_once
|
||||||
|
if test -z "$__%[1]s_perform_completion_once_result"
|
||||||
|
__%[1]s_debug "Error determining if order preservation is required"
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l directive (string sub --start 2 $__%[1]s_perform_completion_once_result[-1])
|
||||||
|
__%[1]s_debug "Directive is: $directive"
|
||||||
|
|
||||||
|
set -l shellCompDirectiveKeepOrder %[9]d
|
||||||
|
set -l keeporder (math (math --scale 0 $directive / $shellCompDirectiveKeepOrder) %% 2)
|
||||||
|
__%[1]s_debug "Keeporder is: $keeporder"
|
||||||
|
|
||||||
|
if test $keeporder -ne 0
|
||||||
|
__%[1]s_debug "This does require order preservation"
|
||||||
|
return 0
|
||||||
|
end
|
||||||
|
|
||||||
|
__%[1]s_debug "This doesn't require order preservation"
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
# This function does two things:
|
# This function does two things:
|
||||||
# - Obtain the completions and store them in the global __%[1]s_comp_results
|
# - Obtain the completions and store them in the global __%[1]s_comp_results
|
||||||
# - Return false if file completion should be performed
|
# - Return false if file completion should be performed
|
||||||
|
@ -99,17 +153,17 @@ function __%[1]s_prepare_completions
|
||||||
# Start fresh
|
# Start fresh
|
||||||
set --erase __%[1]s_comp_results
|
set --erase __%[1]s_comp_results
|
||||||
|
|
||||||
set -l results (__%[1]s_perform_completion)
|
__%[1]s_perform_completion_once
|
||||||
__%[1]s_debug "Completion results: $results"
|
__%[1]s_debug "Completion results: $__%[1]s_perform_completion_once_result"
|
||||||
|
|
||||||
if test -z "$results"
|
if test -z "$__%[1]s_perform_completion_once_result"
|
||||||
__%[1]s_debug "No completion, probably due to a failure"
|
__%[1]s_debug "No completion, probably due to a failure"
|
||||||
# Might as well do file completion, in case it helps
|
# Might as well do file completion, in case it helps
|
||||||
return 1
|
return 1
|
||||||
end
|
end
|
||||||
|
|
||||||
set -l directive (string sub --start 2 $results[-1])
|
set -l directive (string sub --start 2 $__%[1]s_perform_completion_once_result[-1])
|
||||||
set --global __%[1]s_comp_results $results[1..-2]
|
set --global __%[1]s_comp_results $__%[1]s_perform_completion_once_result[1..-2]
|
||||||
|
|
||||||
__%[1]s_debug "Completions are: $__%[1]s_comp_results"
|
__%[1]s_debug "Completions are: $__%[1]s_comp_results"
|
||||||
__%[1]s_debug "Directive is: $directive"
|
__%[1]s_debug "Directive is: $directive"
|
||||||
|
@ -205,13 +259,17 @@ end
|
||||||
# Remove any pre-existing completions for the program since we will be handling all of them.
|
# Remove any pre-existing completions for the program since we will be handling all of them.
|
||||||
complete -c %[2]s -e
|
complete -c %[2]s -e
|
||||||
|
|
||||||
|
# this will get called after the two calls below and clear the $__%[1]s_perform_completion_once_result global
|
||||||
|
complete -c %[2]s -n '__%[1]s_clear_perform_completion_once_result'
|
||||||
# The call to __%[1]s_prepare_completions will setup __%[1]s_comp_results
|
# The call to __%[1]s_prepare_completions will setup __%[1]s_comp_results
|
||||||
# which provides the program's completion choices.
|
# which provides the program's completion choices.
|
||||||
complete -c %[2]s -n '__%[1]s_prepare_completions' -f -a '$__%[1]s_comp_results'
|
# If this doesn't require order preservation, we don't use the -k flag
|
||||||
|
complete -c %[2]s -n 'not __%[1]s_requires_order_preservation && __%[1]s_prepare_completions' -f -a '$__%[1]s_comp_results'
|
||||||
|
# otherwise we use the -k flag
|
||||||
|
complete -k -c %[2]s -n '__%[1]s_requires_order_preservation && __%[1]s_prepare_completions' -f -a '$__%[1]s_comp_results'
|
||||||
`, nameForVar, name, compCmd,
|
`, nameForVar, name, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, activeHelpEnvVar(name)))
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder, activeHelpEnvVar(name)))
|
||||||
}
|
}
|
||||||
|
|
||||||
// GenFishCompletion generates fish completion file and writes to the passed writer.
|
// GenFishCompletion generates fish completion file and writes to the passed writer.
|
||||||
|
|
|
@ -1,4 +0,0 @@
|
||||||
## Generating Fish Completions For Your cobra.Command
|
|
||||||
|
|
||||||
Please refer to [Shell Completions](shell_completions.md) for details.
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -16,9 +16,10 @@ package cobra
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -98,12 +99,12 @@ func TestFishCompletionNoActiveHelp(t *testing.T) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGenFishCompletionFile(t *testing.T) {
|
func TestGenFishCompletionFile(t *testing.T) {
|
||||||
err := os.Mkdir("./tmp", 0755)
|
tmpFile, err := os.CreateTemp("", "cobra-test")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err.Error())
|
t.Fatal(err.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
defer os.RemoveAll("./tmp")
|
defer os.Remove(tmpFile.Name())
|
||||||
|
|
||||||
rootCmd := &Command{Use: "root", Args: NoArgs, Run: emptyRun}
|
rootCmd := &Command{Use: "root", Args: NoArgs, Run: emptyRun}
|
||||||
child := &Command{
|
child := &Command{
|
||||||
|
@ -113,18 +114,18 @@ func TestGenFishCompletionFile(t *testing.T) {
|
||||||
}
|
}
|
||||||
rootCmd.AddCommand(child)
|
rootCmd.AddCommand(child)
|
||||||
|
|
||||||
assertNoErr(t, rootCmd.GenFishCompletionFile("./tmp/test", false))
|
assertNoErr(t, rootCmd.GenFishCompletionFile(tmpFile.Name(), false))
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFailGenFishCompletionFile(t *testing.T) {
|
func TestFailGenFishCompletionFile(t *testing.T) {
|
||||||
err := os.Mkdir("./tmp", 0755)
|
tmpDir, err := os.MkdirTemp("", "cobra-test")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err.Error())
|
t.Fatal(err.Error())
|
||||||
}
|
}
|
||||||
|
|
||||||
defer os.RemoveAll("./tmp")
|
defer os.RemoveAll(tmpDir)
|
||||||
|
|
||||||
f, _ := os.OpenFile("./tmp/test", os.O_CREATE, 0400)
|
f, _ := os.OpenFile(filepath.Join(tmpDir, "test"), os.O_CREATE, 0400)
|
||||||
defer f.Close()
|
defer f.Close()
|
||||||
|
|
||||||
rootCmd := &Command{Use: "root", Args: NoArgs, Run: emptyRun}
|
rootCmd := &Command{Use: "root", Args: NoArgs, Run: emptyRun}
|
||||||
|
@ -135,18 +136,8 @@ func TestFailGenFishCompletionFile(t *testing.T) {
|
||||||
}
|
}
|
||||||
rootCmd.AddCommand(child)
|
rootCmd.AddCommand(child)
|
||||||
|
|
||||||
got := rootCmd.GenFishCompletionFile("./tmp/test", false)
|
got := rootCmd.GenFishCompletionFile(f.Name(), false)
|
||||||
if got == nil {
|
if !errors.Is(got, os.ErrPermission) {
|
||||||
t.Error("should raise permission denied error")
|
t.Errorf("got: %s, want: %s", got.Error(), os.ErrPermission.Error())
|
||||||
}
|
|
||||||
|
|
||||||
if os.Getenv("MSYSTEM") == "MINGW64" {
|
|
||||||
if got.Error() != "open ./tmp/test: Access is denied." {
|
|
||||||
t.Errorf("got: %s, want: %s", got.Error(), "open ./tmp/test: Access is denied.")
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if got.Error() != "open ./tmp/test: permission denied" {
|
|
||||||
t.Errorf("got: %s, want: %s", got.Error(), "open ./tmp/test: permission denied")
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -24,6 +24,7 @@ import (
|
||||||
|
|
||||||
const (
|
const (
|
||||||
requiredAsGroup = "cobra_annotation_required_if_others_set"
|
requiredAsGroup = "cobra_annotation_required_if_others_set"
|
||||||
|
oneRequired = "cobra_annotation_one_required"
|
||||||
mutuallyExclusive = "cobra_annotation_mutually_exclusive"
|
mutuallyExclusive = "cobra_annotation_mutually_exclusive"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -43,6 +44,22 @@ func (c *Command) MarkFlagsRequiredTogether(flagNames ...string) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// MarkFlagsOneRequired marks the given flags with annotations so that Cobra errors
|
||||||
|
// if the command is invoked without at least one flag from the given set of flags.
|
||||||
|
func (c *Command) MarkFlagsOneRequired(flagNames ...string) {
|
||||||
|
c.mergePersistentFlags()
|
||||||
|
for _, v := range flagNames {
|
||||||
|
f := c.Flags().Lookup(v)
|
||||||
|
if f == nil {
|
||||||
|
panic(fmt.Sprintf("Failed to find flag %q and mark it as being in a one-required flag group", v))
|
||||||
|
}
|
||||||
|
if err := c.Flags().SetAnnotation(v, oneRequired, append(f.Annotations[oneRequired], strings.Join(flagNames, " "))); err != nil {
|
||||||
|
// Only errs if the flag isn't found.
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// MarkFlagsMutuallyExclusive marks the given flags with annotations so that Cobra errors
|
// MarkFlagsMutuallyExclusive marks the given flags with annotations so that Cobra errors
|
||||||
// if the command is invoked with more than one flag from the given set of flags.
|
// if the command is invoked with more than one flag from the given set of flags.
|
||||||
func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string) {
|
func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string) {
|
||||||
|
@ -59,7 +76,7 @@ func (c *Command) MarkFlagsMutuallyExclusive(flagNames ...string) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ValidateFlagGroups validates the mutuallyExclusive/requiredAsGroup logic and returns the
|
// ValidateFlagGroups validates the mutuallyExclusive/oneRequired/requiredAsGroup logic and returns the
|
||||||
// first error encountered.
|
// first error encountered.
|
||||||
func (c *Command) ValidateFlagGroups() error {
|
func (c *Command) ValidateFlagGroups() error {
|
||||||
if c.DisableFlagParsing {
|
if c.DisableFlagParsing {
|
||||||
|
@ -71,15 +88,20 @@ func (c *Command) ValidateFlagGroups() error {
|
||||||
// groupStatus format is the list of flags as a unique ID,
|
// groupStatus format is the list of flags as a unique ID,
|
||||||
// then a map of each flag name and whether it is set or not.
|
// then a map of each flag name and whether it is set or not.
|
||||||
groupStatus := map[string]map[string]bool{}
|
groupStatus := map[string]map[string]bool{}
|
||||||
|
oneRequiredGroupStatus := map[string]map[string]bool{}
|
||||||
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
||||||
flags.VisitAll(func(pflag *flag.Flag) {
|
flags.VisitAll(func(pflag *flag.Flag) {
|
||||||
processFlagForGroupAnnotation(flags, pflag, requiredAsGroup, groupStatus)
|
processFlagForGroupAnnotation(flags, pflag, requiredAsGroup, groupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, oneRequired, oneRequiredGroupStatus)
|
||||||
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusive, mutuallyExclusiveGroupStatus)
|
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusive, mutuallyExclusiveGroupStatus)
|
||||||
})
|
})
|
||||||
|
|
||||||
if err := validateRequiredFlagGroups(groupStatus); err != nil {
|
if err := validateRequiredFlagGroups(groupStatus); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
if err := validateOneRequiredFlagGroups(oneRequiredGroupStatus); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if err := validateExclusiveFlagGroups(mutuallyExclusiveGroupStatus); err != nil {
|
if err := validateExclusiveFlagGroups(mutuallyExclusiveGroupStatus); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
@ -108,7 +130,7 @@ func processFlagForGroupAnnotation(flags *flag.FlagSet, pflag *flag.Flag, annota
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
groupStatus[group] = map[string]bool{}
|
groupStatus[group] = make(map[string]bool, len(flagnames))
|
||||||
for _, name := range flagnames {
|
for _, name := range flagnames {
|
||||||
groupStatus[group][name] = false
|
groupStatus[group][name] = false
|
||||||
}
|
}
|
||||||
|
@ -142,6 +164,27 @@ func validateRequiredFlagGroups(data map[string]map[string]bool) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func validateOneRequiredFlagGroups(data map[string]map[string]bool) error {
|
||||||
|
keys := sortedKeys(data)
|
||||||
|
for _, flagList := range keys {
|
||||||
|
flagnameAndStatus := data[flagList]
|
||||||
|
var set []string
|
||||||
|
for flagname, isSet := range flagnameAndStatus {
|
||||||
|
if isSet {
|
||||||
|
set = append(set, flagname)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(set) >= 1 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sort values, so they can be tested/scripted against consistently.
|
||||||
|
sort.Strings(set)
|
||||||
|
return fmt.Errorf("at least one of the flags in the group [%v] is required", flagList)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func validateExclusiveFlagGroups(data map[string]map[string]bool) error {
|
func validateExclusiveFlagGroups(data map[string]map[string]bool) error {
|
||||||
keys := sortedKeys(data)
|
keys := sortedKeys(data)
|
||||||
for _, flagList := range keys {
|
for _, flagList := range keys {
|
||||||
|
@ -176,6 +219,7 @@ func sortedKeys(m map[string]map[string]bool) []string {
|
||||||
|
|
||||||
// enforceFlagGroupsForCompletion will do the following:
|
// enforceFlagGroupsForCompletion will do the following:
|
||||||
// - when a flag in a group is present, other flags in the group will be marked required
|
// - when a flag in a group is present, other flags in the group will be marked required
|
||||||
|
// - when none of the flags in a one-required group are present, all flags in the group will be marked required
|
||||||
// - when a flag in a mutually exclusive group is present, other flags in the group will be marked as hidden
|
// - when a flag in a mutually exclusive group is present, other flags in the group will be marked as hidden
|
||||||
// This allows the standard completion logic to behave appropriately for flag groups
|
// This allows the standard completion logic to behave appropriately for flag groups
|
||||||
func (c *Command) enforceFlagGroupsForCompletion() {
|
func (c *Command) enforceFlagGroupsForCompletion() {
|
||||||
|
@ -185,9 +229,11 @@ func (c *Command) enforceFlagGroupsForCompletion() {
|
||||||
|
|
||||||
flags := c.Flags()
|
flags := c.Flags()
|
||||||
groupStatus := map[string]map[string]bool{}
|
groupStatus := map[string]map[string]bool{}
|
||||||
|
oneRequiredGroupStatus := map[string]map[string]bool{}
|
||||||
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
||||||
c.Flags().VisitAll(func(pflag *flag.Flag) {
|
c.Flags().VisitAll(func(pflag *flag.Flag) {
|
||||||
processFlagForGroupAnnotation(flags, pflag, requiredAsGroup, groupStatus)
|
processFlagForGroupAnnotation(flags, pflag, requiredAsGroup, groupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, oneRequired, oneRequiredGroupStatus)
|
||||||
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusive, mutuallyExclusiveGroupStatus)
|
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusive, mutuallyExclusiveGroupStatus)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -204,6 +250,26 @@ func (c *Command) enforceFlagGroupsForCompletion() {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// If none of the flags of a one-required group are present, we make all the flags
|
||||||
|
// of that group required so that the shell completion suggests them automatically
|
||||||
|
for flagList, flagnameAndStatus := range oneRequiredGroupStatus {
|
||||||
|
isSet := false
|
||||||
|
|
||||||
|
for _, isSet = range flagnameAndStatus {
|
||||||
|
if isSet {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// None of the flags of the group are set, mark all flags in the group
|
||||||
|
// as required
|
||||||
|
if !isSet {
|
||||||
|
for _, fName := range strings.Split(flagList, " ") {
|
||||||
|
_ = c.MarkFlagRequired(fName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// If a flag that is mutually exclusive to others is present, we hide the other
|
// If a flag that is mutually exclusive to others is present, we hide the other
|
||||||
// flags of that group so the shell completion does not suggest them
|
// flags of that group so the shell completion does not suggest them
|
||||||
for flagList, flagnameAndStatus := range mutuallyExclusiveGroupStatus {
|
for flagList, flagnameAndStatus := range mutuallyExclusiveGroupStatus {
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -43,13 +43,15 @@ func TestValidateFlagGroups(t *testing.T) {
|
||||||
|
|
||||||
// Each test case uses a unique command from the function above.
|
// Each test case uses a unique command from the function above.
|
||||||
testcases := []struct {
|
testcases := []struct {
|
||||||
desc string
|
desc string
|
||||||
flagGroupsRequired []string
|
flagGroupsRequired []string
|
||||||
flagGroupsExclusive []string
|
flagGroupsOneRequired []string
|
||||||
subCmdFlagGroupsRequired []string
|
flagGroupsExclusive []string
|
||||||
subCmdFlagGroupsExclusive []string
|
subCmdFlagGroupsRequired []string
|
||||||
args []string
|
subCmdFlagGroupsOneRequired []string
|
||||||
expectErr string
|
subCmdFlagGroupsExclusive []string
|
||||||
|
args []string
|
||||||
|
expectErr string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
desc: "No flags no problem",
|
desc: "No flags no problem",
|
||||||
|
@ -62,6 +64,11 @@ func TestValidateFlagGroups(t *testing.T) {
|
||||||
flagGroupsRequired: []string{"a b c"},
|
flagGroupsRequired: []string{"a b c"},
|
||||||
args: []string{"--a=foo"},
|
args: []string{"--a=foo"},
|
||||||
expectErr: "if any flags in the group [a b c] are set they must all be set; missing [b c]",
|
expectErr: "if any flags in the group [a b c] are set they must all be set; missing [b c]",
|
||||||
|
}, {
|
||||||
|
desc: "One-required flag group not satisfied",
|
||||||
|
flagGroupsOneRequired: []string{"a b"},
|
||||||
|
args: []string{"--c=foo"},
|
||||||
|
expectErr: "at least one of the flags in the group [a b] is required",
|
||||||
}, {
|
}, {
|
||||||
desc: "Exclusive flag group not satisfied",
|
desc: "Exclusive flag group not satisfied",
|
||||||
flagGroupsExclusive: []string{"a b c"},
|
flagGroupsExclusive: []string{"a b c"},
|
||||||
|
@ -72,6 +79,11 @@ func TestValidateFlagGroups(t *testing.T) {
|
||||||
flagGroupsRequired: []string{"a b c", "a d"},
|
flagGroupsRequired: []string{"a b c", "a d"},
|
||||||
args: []string{"--c=foo", "--d=foo"},
|
args: []string{"--c=foo", "--d=foo"},
|
||||||
expectErr: `if any flags in the group [a b c] are set they must all be set; missing [a b]`,
|
expectErr: `if any flags in the group [a b c] are set they must all be set; missing [a b]`,
|
||||||
|
}, {
|
||||||
|
desc: "Multiple one-required flag group not satisfied returns first error",
|
||||||
|
flagGroupsOneRequired: []string{"a b", "d e"},
|
||||||
|
args: []string{"--c=foo", "--f=foo"},
|
||||||
|
expectErr: `at least one of the flags in the group [a b] is required`,
|
||||||
}, {
|
}, {
|
||||||
desc: "Multiple exclusive flag group not satisfied returns first error",
|
desc: "Multiple exclusive flag group not satisfied returns first error",
|
||||||
flagGroupsExclusive: []string{"a b c", "a d"},
|
flagGroupsExclusive: []string{"a b c", "a d"},
|
||||||
|
@ -82,32 +94,57 @@ func TestValidateFlagGroups(t *testing.T) {
|
||||||
flagGroupsRequired: []string{"a d", "a b", "a c"},
|
flagGroupsRequired: []string{"a d", "a b", "a c"},
|
||||||
args: []string{"--a=foo"},
|
args: []string{"--a=foo"},
|
||||||
expectErr: `if any flags in the group [a b] are set they must all be set; missing [b]`,
|
expectErr: `if any flags in the group [a b] are set they must all be set; missing [b]`,
|
||||||
|
}, {
|
||||||
|
desc: "Validation of one-required groups occurs on groups in sorted order",
|
||||||
|
flagGroupsOneRequired: []string{"d e", "a b", "f g"},
|
||||||
|
args: []string{"--c=foo"},
|
||||||
|
expectErr: `at least one of the flags in the group [a b] is required`,
|
||||||
}, {
|
}, {
|
||||||
desc: "Validation of exclusive groups occurs on groups in sorted order",
|
desc: "Validation of exclusive groups occurs on groups in sorted order",
|
||||||
flagGroupsExclusive: []string{"a d", "a b", "a c"},
|
flagGroupsExclusive: []string{"a d", "a b", "a c"},
|
||||||
args: []string{"--a=foo", "--b=foo", "--c=foo"},
|
args: []string{"--a=foo", "--b=foo", "--c=foo"},
|
||||||
expectErr: `if any flags in the group [a b] are set none of the others can be; [a b] were all set`,
|
expectErr: `if any flags in the group [a b] are set none of the others can be; [a b] were all set`,
|
||||||
}, {
|
}, {
|
||||||
desc: "Persistent flags utilize both features and can fail required groups",
|
desc: "Persistent flags utilize required and exclusive groups and can fail required groups",
|
||||||
flagGroupsRequired: []string{"a e", "e f"},
|
flagGroupsRequired: []string{"a e", "e f"},
|
||||||
flagGroupsExclusive: []string{"f g"},
|
flagGroupsExclusive: []string{"f g"},
|
||||||
args: []string{"--a=foo", "--f=foo", "--g=foo"},
|
args: []string{"--a=foo", "--f=foo", "--g=foo"},
|
||||||
expectErr: `if any flags in the group [a e] are set they must all be set; missing [e]`,
|
expectErr: `if any flags in the group [a e] are set they must all be set; missing [e]`,
|
||||||
}, {
|
}, {
|
||||||
desc: "Persistent flags utilize both features and can fail mutually exclusive groups",
|
desc: "Persistent flags utilize one-required and exclusive groups and can fail one-required groups",
|
||||||
|
flagGroupsOneRequired: []string{"a b", "e f"},
|
||||||
|
flagGroupsExclusive: []string{"e f"},
|
||||||
|
args: []string{"--e=foo"},
|
||||||
|
expectErr: `at least one of the flags in the group [a b] is required`,
|
||||||
|
}, {
|
||||||
|
desc: "Persistent flags utilize required and exclusive groups and can fail mutually exclusive groups",
|
||||||
flagGroupsRequired: []string{"a e", "e f"},
|
flagGroupsRequired: []string{"a e", "e f"},
|
||||||
flagGroupsExclusive: []string{"f g"},
|
flagGroupsExclusive: []string{"f g"},
|
||||||
args: []string{"--a=foo", "--e=foo", "--f=foo", "--g=foo"},
|
args: []string{"--a=foo", "--e=foo", "--f=foo", "--g=foo"},
|
||||||
expectErr: `if any flags in the group [f g] are set none of the others can be; [f g] were all set`,
|
expectErr: `if any flags in the group [f g] are set none of the others can be; [f g] were all set`,
|
||||||
}, {
|
}, {
|
||||||
desc: "Persistent flags utilize both features and can pass",
|
desc: "Persistent flags utilize required and exclusive groups and can pass",
|
||||||
flagGroupsRequired: []string{"a e", "e f"},
|
flagGroupsRequired: []string{"a e", "e f"},
|
||||||
flagGroupsExclusive: []string{"f g"},
|
flagGroupsExclusive: []string{"f g"},
|
||||||
args: []string{"--a=foo", "--e=foo", "--f=foo"},
|
args: []string{"--a=foo", "--e=foo", "--f=foo"},
|
||||||
|
}, {
|
||||||
|
desc: "Persistent flags utilize one-required and exclusive groups and can pass",
|
||||||
|
flagGroupsOneRequired: []string{"a e", "e f"},
|
||||||
|
flagGroupsExclusive: []string{"f g"},
|
||||||
|
args: []string{"--a=foo", "--e=foo", "--f=foo"},
|
||||||
}, {
|
}, {
|
||||||
desc: "Subcmds can use required groups using inherited flags",
|
desc: "Subcmds can use required groups using inherited flags",
|
||||||
subCmdFlagGroupsRequired: []string{"e subonly"},
|
subCmdFlagGroupsRequired: []string{"e subonly"},
|
||||||
args: []string{"subcmd", "--e=foo", "--subonly=foo"},
|
args: []string{"subcmd", "--e=foo", "--subonly=foo"},
|
||||||
|
}, {
|
||||||
|
desc: "Subcmds can use one-required groups using inherited flags",
|
||||||
|
subCmdFlagGroupsOneRequired: []string{"e subonly"},
|
||||||
|
args: []string{"subcmd", "--e=foo", "--subonly=foo"},
|
||||||
|
}, {
|
||||||
|
desc: "Subcmds can use one-required groups using inherited flags and fail one-required groups",
|
||||||
|
subCmdFlagGroupsOneRequired: []string{"e subonly"},
|
||||||
|
args: []string{"subcmd"},
|
||||||
|
expectErr: "at least one of the flags in the group [e subonly] is required",
|
||||||
}, {
|
}, {
|
||||||
desc: "Subcmds can use exclusive groups using inherited flags",
|
desc: "Subcmds can use exclusive groups using inherited flags",
|
||||||
subCmdFlagGroupsExclusive: []string{"e subonly"},
|
subCmdFlagGroupsExclusive: []string{"e subonly"},
|
||||||
|
@ -130,12 +167,18 @@ func TestValidateFlagGroups(t *testing.T) {
|
||||||
for _, flagGroup := range tc.flagGroupsRequired {
|
for _, flagGroup := range tc.flagGroupsRequired {
|
||||||
c.MarkFlagsRequiredTogether(strings.Split(flagGroup, " ")...)
|
c.MarkFlagsRequiredTogether(strings.Split(flagGroup, " ")...)
|
||||||
}
|
}
|
||||||
|
for _, flagGroup := range tc.flagGroupsOneRequired {
|
||||||
|
c.MarkFlagsOneRequired(strings.Split(flagGroup, " ")...)
|
||||||
|
}
|
||||||
for _, flagGroup := range tc.flagGroupsExclusive {
|
for _, flagGroup := range tc.flagGroupsExclusive {
|
||||||
c.MarkFlagsMutuallyExclusive(strings.Split(flagGroup, " ")...)
|
c.MarkFlagsMutuallyExclusive(strings.Split(flagGroup, " ")...)
|
||||||
}
|
}
|
||||||
for _, flagGroup := range tc.subCmdFlagGroupsRequired {
|
for _, flagGroup := range tc.subCmdFlagGroupsRequired {
|
||||||
sub.MarkFlagsRequiredTogether(strings.Split(flagGroup, " ")...)
|
sub.MarkFlagsRequiredTogether(strings.Split(flagGroup, " ")...)
|
||||||
}
|
}
|
||||||
|
for _, flagGroup := range tc.subCmdFlagGroupsOneRequired {
|
||||||
|
sub.MarkFlagsOneRequired(strings.Split(flagGroup, " ")...)
|
||||||
|
}
|
||||||
for _, flagGroup := range tc.subCmdFlagGroupsExclusive {
|
for _, flagGroup := range tc.subCmdFlagGroupsExclusive {
|
||||||
sub.MarkFlagsMutuallyExclusive(strings.Split(flagGroup, " ")...)
|
sub.MarkFlagsMutuallyExclusive(strings.Split(flagGroup, " ")...)
|
||||||
}
|
}
|
||||||
|
|
4
go.mod
4
go.mod
|
@ -3,8 +3,8 @@ module github.com/spf13/cobra
|
||||||
go 1.15
|
go 1.15
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/cpuguy83/go-md2man/v2 v2.0.2
|
github.com/cpuguy83/go-md2man/v2 v2.0.4
|
||||||
github.com/inconshreveable/mousetrap v1.0.1
|
github.com/inconshreveable/mousetrap v1.1.0
|
||||||
github.com/spf13/pflag v1.0.5
|
github.com/spf13/pflag v1.0.5
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
)
|
)
|
||||||
|
|
8
go.sum
8
go.sum
|
@ -1,7 +1,7 @@
|
||||||
github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
|
github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4=
|
||||||
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
|
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
|
||||||
github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc=
|
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
|
||||||
github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
|
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
|
||||||
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
|
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
|
||||||
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||||
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
|
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -28,8 +28,8 @@ import (
|
||||||
func genPowerShellComp(buf io.StringWriter, name string, includeDesc bool) {
|
func genPowerShellComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
// Variables should not contain a '-' or ':' character
|
// Variables should not contain a '-' or ':' character
|
||||||
nameForVar := name
|
nameForVar := name
|
||||||
nameForVar = strings.Replace(nameForVar, "-", "_", -1)
|
nameForVar = strings.ReplaceAll(nameForVar, "-", "_")
|
||||||
nameForVar = strings.Replace(nameForVar, ":", "_", -1)
|
nameForVar = strings.ReplaceAll(nameForVar, ":", "_")
|
||||||
|
|
||||||
compCmd := ShellCompRequestCmd
|
compCmd := ShellCompRequestCmd
|
||||||
if !includeDesc {
|
if !includeDesc {
|
||||||
|
@ -47,7 +47,7 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
`+" $_ -replace '\\s|#|@|\\$|;|,|''|\\{|\\}|\\(|\\)|\"|`|\\||<|>|&','`$&'"+`
|
`+" $_ -replace '\\s|#|@|\\$|;|,|''|\\{|\\}|\\(|\\)|\"|`|\\||<|>|&','`$&'"+`
|
||||||
}
|
}
|
||||||
|
|
||||||
[scriptblock]$__%[2]sCompleterBlock = {
|
[scriptblock]${__%[2]sCompleterBlock} = {
|
||||||
param(
|
param(
|
||||||
$WordToComplete,
|
$WordToComplete,
|
||||||
$CommandAst,
|
$CommandAst,
|
||||||
|
@ -77,6 +77,7 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
$ShellCompDirectiveNoFileComp=%[6]d
|
$ShellCompDirectiveNoFileComp=%[6]d
|
||||||
$ShellCompDirectiveFilterFileExt=%[7]d
|
$ShellCompDirectiveFilterFileExt=%[7]d
|
||||||
$ShellCompDirectiveFilterDirs=%[8]d
|
$ShellCompDirectiveFilterDirs=%[8]d
|
||||||
|
$ShellCompDirectiveKeepOrder=%[9]d
|
||||||
|
|
||||||
# Prepare the command to request completions for the program.
|
# Prepare the command to request completions for the program.
|
||||||
# Split the command at the first space to separate the program and arguments.
|
# Split the command at the first space to separate the program and arguments.
|
||||||
|
@ -106,13 +107,22 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
# If the last parameter is complete (there is a space following it)
|
# If the last parameter is complete (there is a space following it)
|
||||||
# We add an extra empty parameter so we can indicate this to the go method.
|
# We add an extra empty parameter so we can indicate this to the go method.
|
||||||
__%[1]s_debug "Adding extra empty parameter"
|
__%[1]s_debug "Adding extra empty parameter"
|
||||||
`+" # We need to use `\"`\" to pass an empty argument a \"\" or '' does not work!!!"+`
|
# PowerShell 7.2+ changed the way how the arguments are passed to executables,
|
||||||
`+" $RequestComp=\"$RequestComp\" + ' `\"`\"'"+`
|
# so for pre-7.2 or when Legacy argument passing is enabled we need to use
|
||||||
|
`+" # `\"`\" to pass an empty argument, a \"\" or '' does not work!!!"+`
|
||||||
|
if ($PSVersionTable.PsVersion -lt [version]'7.2.0' -or
|
||||||
|
($PSVersionTable.PsVersion -lt [version]'7.3.0' -and -not [ExperimentalFeature]::IsEnabled("PSNativeCommandArgumentPassing")) -or
|
||||||
|
(($PSVersionTable.PsVersion -ge [version]'7.3.0' -or [ExperimentalFeature]::IsEnabled("PSNativeCommandArgumentPassing")) -and
|
||||||
|
$PSNativeCommandArgumentPassing -eq 'Legacy')) {
|
||||||
|
`+" $RequestComp=\"$RequestComp\" + ' `\"`\"'"+`
|
||||||
|
} else {
|
||||||
|
$RequestComp="$RequestComp" + ' ""'
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
__%[1]s_debug "Calling $RequestComp"
|
__%[1]s_debug "Calling $RequestComp"
|
||||||
# First disable ActiveHelp which is not supported for Powershell
|
# First disable ActiveHelp which is not supported for Powershell
|
||||||
$env:%[9]s=0
|
${env:%[10]s}=0
|
||||||
|
|
||||||
#call the command store the output in $out and redirect stderr and stdout to null
|
#call the command store the output in $out and redirect stderr and stdout to null
|
||||||
# $Out is an array contains each line per element
|
# $Out is an array contains each line per element
|
||||||
|
@ -137,7 +147,7 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
}
|
}
|
||||||
|
|
||||||
$Longest = 0
|
$Longest = 0
|
||||||
$Values = $Out | ForEach-Object {
|
[Array]$Values = $Out | ForEach-Object {
|
||||||
#Split the output in name and description
|
#Split the output in name and description
|
||||||
`+" $Name, $Description = $_.Split(\"`t\",2)"+`
|
`+" $Name, $Description = $_.Split(\"`t\",2)"+`
|
||||||
__%[1]s_debug "Name: $Name Description: $Description"
|
__%[1]s_debug "Name: $Name Description: $Description"
|
||||||
|
@ -182,6 +192,11 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# we sort the values in ascending order by name if keep order isn't passed
|
||||||
|
if (($Directive -band $ShellCompDirectiveKeepOrder) -eq 0 ) {
|
||||||
|
$Values = $Values | Sort-Object -Property Name
|
||||||
|
}
|
||||||
|
|
||||||
if (($Directive -band $ShellCompDirectiveNoFileComp) -ne 0 ) {
|
if (($Directive -band $ShellCompDirectiveNoFileComp) -ne 0 ) {
|
||||||
__%[1]s_debug "ShellCompDirectiveNoFileComp is called"
|
__%[1]s_debug "ShellCompDirectiveNoFileComp is called"
|
||||||
|
|
||||||
|
@ -264,10 +279,10 @@ filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
Register-ArgumentCompleter -CommandName '%[1]s' -ScriptBlock $__%[2]sCompleterBlock
|
Register-ArgumentCompleter -CommandName '%[1]s' -ScriptBlock ${__%[2]sCompleterBlock}
|
||||||
`, name, nameForVar, compCmd,
|
`, name, nameForVar, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, activeHelpEnvVar(name)))
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder, activeHelpEnvVar(name)))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Command) genPowerShellCompletion(w io.Writer, includeDesc bool) error {
|
func (c *Command) genPowerShellCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Generating PowerShell Completions For Your Own cobra.Command
|
|
||||||
|
|
||||||
Please refer to [Shell Completions](shell_completions.md#powershell-completions) for details.
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -29,5 +29,5 @@ func TestPwshCompletionNoActiveHelp(t *testing.T) {
|
||||||
|
|
||||||
// check that active help is being disabled
|
// check that active help is being disabled
|
||||||
activeHelpVar := activeHelpEnvVar(c.Name())
|
activeHelpVar := activeHelpEnvVar(c.Name())
|
||||||
check(t, output, fmt.Sprintf("%s=0", activeHelpVar))
|
check(t, output, fmt.Sprintf("${env:%s}=0", activeHelpVar))
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
|
@ -92,7 +92,7 @@ Allowing to configure Active Help is entirely optional; you can use Active Help
|
||||||
|
|
||||||
The way to configure Active Help is to use the program's Active Help environment
|
The way to configure Active Help is to use the program's Active Help environment
|
||||||
variable. That variable is named `<PROGRAM>_ACTIVE_HELP` where `<PROGRAM>` is the name of your
|
variable. That variable is named `<PROGRAM>_ACTIVE_HELP` where `<PROGRAM>` is the name of your
|
||||||
program in uppercase with any `-` replaced by an `_`. The variable should be set by the user to whatever
|
program in uppercase with any non-ASCII-alphanumeric characters replaced by an `_`. The variable should be set by the user to whatever
|
||||||
Active Help configuration values are supported by the program.
|
Active Help configuration values are supported by the program.
|
||||||
|
|
||||||
For example, say `helm` has chosen to support three levels for Active Help: `on`, `off`, `local`. Then a user
|
For example, say `helm` has chosen to support three levels for Active Help: `on`, `off`, `local`. Then a user
|
||||||
|
@ -140,7 +140,7 @@ details for your users.
|
||||||
|
|
||||||
Debugging your Active Help code is done in the same way as debugging your dynamic completion code, which is with Cobra's hidden `__complete` command. Please refer to [debugging shell completion](shell_completions.md#debugging) for details.
|
Debugging your Active Help code is done in the same way as debugging your dynamic completion code, which is with Cobra's hidden `__complete` command. Please refer to [debugging shell completion](shell_completions.md#debugging) for details.
|
||||||
|
|
||||||
When debugging with the `__complete` command, if you want to specify different Active Help configurations, you should use the active help environment variable. That variable is named `<PROGRAM>_ACTIVE_HELP` where any `-` is replaced by an `_`. For example, we can test deactivating some Active Help as shown below:
|
When debugging with the `__complete` command, if you want to specify different Active Help configurations, you should use the active help environment variable. That variable is named `<PROGRAM>_ACTIVE_HELP` where any non-ASCII-alphanumeric characters are replaced by an `_`. For example, we can test deactivating some Active Help as shown below:
|
||||||
```
|
```
|
||||||
$ HELM_ACTIVE_HELP=1 bin/helm __complete install wordpress bitnami/h<ENTER>
|
$ HELM_ACTIVE_HELP=1 bin/helm __complete install wordpress bitnami/h<ENTER>
|
||||||
bitnami/haproxy
|
bitnami/haproxy
|
|
@ -185,16 +185,7 @@ cmd := &cobra.Command{
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The aliases are not shown to the user on tab completion, but they are accepted as valid nouns by
|
The aliases are shown to the user on tab completion only if no completions were found within sub-commands or `ValidArgs`.
|
||||||
the completion algorithm if entered manually, e.g. in:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ kubectl get rc [tab][tab]
|
|
||||||
backend frontend database
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that without declaring `rc` as an alias, the completion algorithm would not know to show the list of
|
|
||||||
replication controllers following `rc`.
|
|
||||||
|
|
||||||
### Dynamic completion of nouns
|
### Dynamic completion of nouns
|
||||||
|
|
||||||
|
@ -260,6 +251,10 @@ ShellCompDirectiveFilterFileExt
|
||||||
// return []string{"themes"}, ShellCompDirectiveFilterDirs
|
// return []string{"themes"}, ShellCompDirectiveFilterDirs
|
||||||
//
|
//
|
||||||
ShellCompDirectiveFilterDirs
|
ShellCompDirectiveFilterDirs
|
||||||
|
|
||||||
|
// ShellCompDirectiveKeepOrder indicates that the shell should preserve the order
|
||||||
|
// in which the completions are provided
|
||||||
|
ShellCompDirectiveKeepOrder
|
||||||
```
|
```
|
||||||
|
|
||||||
***Note***: When using the `ValidArgsFunction`, Cobra will call your registered function after having parsed all flags and arguments provided in the command-line. You therefore don't need to do this parsing yourself. For example, when a user calls `helm status --namespace my-rook-ns [tab][tab]`, Cobra will call your registered `ValidArgsFunction` after having parsed the `--namespace` flag, as it would have done when calling the `RunE` function.
|
***Note***: When using the `ValidArgsFunction`, Cobra will call your registered function after having parsed all flags and arguments provided in the command-line. You therefore don't need to do this parsing yourself. For example, when a user calls `helm status --namespace my-rook-ns [tab][tab]`, Cobra will call your registered `ValidArgsFunction` after having parsed the `--namespace` flag, as it would have done when calling the `RunE` function.
|
||||||
|
@ -408,6 +403,22 @@ or
|
||||||
```go
|
```go
|
||||||
ValidArgs: []string{"bash\tCompletions for bash", "zsh\tCompletions for zsh"}
|
ValidArgs: []string{"bash\tCompletions for bash", "zsh\tCompletions for zsh"}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you don't want to show descriptions in the completions, you can add `--no-descriptions` to the default `completion` command to disable them, like:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ source <(helm completion bash)
|
||||||
|
$ helm completion [tab][tab]
|
||||||
|
bash (generate autocompletion script for bash) powershell (generate autocompletion script for powershell)
|
||||||
|
fish (generate autocompletion script for fish) zsh (generate autocompletion script for zsh)
|
||||||
|
|
||||||
|
$ source <(helm completion bash --no-descriptions)
|
||||||
|
$ helm completion [tab][tab]
|
||||||
|
bash fish powershell zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
Setting the `<PROGRAM>_COMPLETION_DESCRIPTIONS` environment variable (falling back to `COBRA_COMPLETION_DESCRIPTIONS` if empty or not set) to a [falsey value](https://pkg.go.dev/strconv#ParseBool) achieves the same. `<PROGRAM>` is the name of your program with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
|
|
||||||
## Bash completions
|
## Bash completions
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
|
@ -431,7 +442,7 @@ completion firstcommand secondcommand
|
||||||
### Bash legacy dynamic completions
|
### Bash legacy dynamic completions
|
||||||
|
|
||||||
For backward compatibility, Cobra still supports its bash legacy dynamic completion solution.
|
For backward compatibility, Cobra still supports its bash legacy dynamic completion solution.
|
||||||
Please refer to [Bash Completions](bash_completions.md) for details.
|
Please refer to [Bash Completions](bash.md) for details.
|
||||||
|
|
||||||
### Bash completion V2
|
### Bash completion V2
|
||||||
|
|
||||||
|
@ -440,7 +451,7 @@ Cobra provides two versions for bash completion. The original bash completion (
|
||||||
|
|
||||||
A new V2 bash completion version is also available. This version can be used by calling `GenBashCompletionV2()` or
|
A new V2 bash completion version is also available. This version can be used by calling `GenBashCompletionV2()` or
|
||||||
`GenBashCompletionFileV2()`. The V2 version does **not** support the legacy dynamic completion
|
`GenBashCompletionFileV2()`. The V2 version does **not** support the legacy dynamic completion
|
||||||
(see [Bash Completions](bash_completions.md)) but instead works only with the Go dynamic completion
|
(see [Bash Completions](bash.md)) but instead works only with the Go dynamic completion
|
||||||
solution described in this document.
|
solution described in this document.
|
||||||
Unless your program already uses the legacy dynamic completion solution, it is recommended that you use the bash
|
Unless your program already uses the legacy dynamic completion solution, it is recommended that you use the bash
|
||||||
completion V2 solution which provides the following extra features:
|
completion V2 solution which provides the following extra features:
|
||||||
|
@ -497,7 +508,7 @@ search show status
|
||||||
### Zsh completions standardization
|
### Zsh completions standardization
|
||||||
|
|
||||||
Cobra 1.1 standardized its zsh completion support to align it with its other shell completions. Although the API was kept backward-compatible, some small changes in behavior were introduced.
|
Cobra 1.1 standardized its zsh completion support to align it with its other shell completions. Although the API was kept backward-compatible, some small changes in behavior were introduced.
|
||||||
Please refer to [Zsh Completions](zsh_completions.md) for details.
|
Please refer to [Zsh Completions](zsh.md) for details.
|
||||||
|
|
||||||
## fish completions
|
## fish completions
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Generating Bash Completions For Your cobra.Command
|
# Generating Bash Completions For Your cobra.Command
|
||||||
|
|
||||||
Please refer to [Shell Completions](shell_completions.md) for details.
|
Please refer to [Shell Completions](_index.md) for details.
|
||||||
|
|
||||||
## Bash legacy dynamic completions
|
## Bash legacy dynamic completions
|
||||||
|
|
4
site/content/completions/fish.md
Normal file
4
site/content/completions/fish.md
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
## Generating Fish Completions For Your cobra.Command
|
||||||
|
|
||||||
|
Please refer to [Shell Completions](_index.md) for details.
|
||||||
|
|
3
site/content/completions/powershell.md
Normal file
3
site/content/completions/powershell.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Generating PowerShell Completions For Your Own cobra.Command
|
||||||
|
|
||||||
|
Please refer to [Shell Completions](_index.md#powershell-completions) for details.
|
|
@ -1,6 +1,6 @@
|
||||||
## Generating Zsh Completion For Your cobra.Command
|
## Generating Zsh Completion For Your cobra.Command
|
||||||
|
|
||||||
Please refer to [Shell Completions](shell_completions.md) for details.
|
Please refer to [Shell Completions](_index.md) for details.
|
||||||
|
|
||||||
## Zsh completions standardization
|
## Zsh completions standardization
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
# Documentation generation
|
# Documentation generation
|
||||||
|
|
||||||
- [Man page docs](./man_docs.md)
|
- [Man page docs](man.md)
|
||||||
- [Markdown docs](./md_docs.md)
|
- [Markdown docs](md.md)
|
||||||
- [Rest docs](./rest_docs.md)
|
- [Rest docs](rest.md)
|
||||||
- [Yaml docs](./yaml_docs.md)
|
- [Yaml docs](yaml.md)
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
### `DisableAutoGenTag`
|
### `DisableAutoGenTag`
|
|
@ -1,6 +1,7 @@
|
||||||
## Projects using Cobra
|
## Projects using Cobra
|
||||||
|
|
||||||
- [Allero](https://github.com/allero-io/allero)
|
- [Allero](https://github.com/allero-io/allero)
|
||||||
|
- [Arewefastyet](https://benchmark.vitess.io)
|
||||||
- [Arduino CLI](https://github.com/arduino/arduino-cli)
|
- [Arduino CLI](https://github.com/arduino/arduino-cli)
|
||||||
- [Bleve](https://blevesearch.com/)
|
- [Bleve](https://blevesearch.com/)
|
||||||
- [Cilium](https://cilium.io/)
|
- [Cilium](https://cilium.io/)
|
||||||
|
@ -11,6 +12,7 @@
|
||||||
- [Datree](https://github.com/datreeio/datree)
|
- [Datree](https://github.com/datreeio/datree)
|
||||||
- [Delve](https://github.com/derekparker/delve)
|
- [Delve](https://github.com/derekparker/delve)
|
||||||
- [Docker (distribution)](https://github.com/docker/distribution)
|
- [Docker (distribution)](https://github.com/docker/distribution)
|
||||||
|
- [Encore](https://encore.dev)
|
||||||
- [Etcd](https://etcd.io/)
|
- [Etcd](https://etcd.io/)
|
||||||
- [Gardener](https://github.com/gardener/gardenctl)
|
- [Gardener](https://github.com/gardener/gardenctl)
|
||||||
- [Giant Swarm's gsctl](https://github.com/giantswarm/gsctl)
|
- [Giant Swarm's gsctl](https://github.com/giantswarm/gsctl)
|
||||||
|
@ -22,13 +24,15 @@
|
||||||
- [GoReleaser](https://goreleaser.com)
|
- [GoReleaser](https://goreleaser.com)
|
||||||
- [Helm](https://helm.sh)
|
- [Helm](https://helm.sh)
|
||||||
- [Hugo](https://gohugo.io)
|
- [Hugo](https://gohugo.io)
|
||||||
|
- [Incus](https://linuxcontainers.org/incus/)
|
||||||
- [Infracost](https://github.com/infracost/infracost)
|
- [Infracost](https://github.com/infracost/infracost)
|
||||||
- [Istio](https://istio.io)
|
- [Istio](https://istio.io)
|
||||||
- [Kool](https://github.com/kool-dev/kool)
|
- [Kool](https://github.com/kool-dev/kool)
|
||||||
- [Kubernetes](https://kubernetes.io/)
|
- [Kubernetes](https://kubernetes.io/)
|
||||||
- [Kubescape](https://github.com/armosec/kubescape)
|
- [Kubescape](https://github.com/kubescape/kubescape)
|
||||||
- [KubeVirt](https://github.com/kubevirt/kubevirt)
|
- [KubeVirt](https://github.com/kubevirt/kubevirt)
|
||||||
- [Linkerd](https://linkerd.io/)
|
- [Linkerd](https://linkerd.io/)
|
||||||
|
- [LXC](https://github.com/canonical/lxd)
|
||||||
- [Mattermost-server](https://github.com/mattermost/mattermost-server)
|
- [Mattermost-server](https://github.com/mattermost/mattermost-server)
|
||||||
- [Mercure](https://mercure.rocks/)
|
- [Mercure](https://mercure.rocks/)
|
||||||
- [Meroxa CLI](https://github.com/meroxa/cli)
|
- [Meroxa CLI](https://github.com/meroxa/cli)
|
||||||
|
@ -54,9 +58,12 @@
|
||||||
- [Scaleway CLI](https://github.com/scaleway/scaleway-cli)
|
- [Scaleway CLI](https://github.com/scaleway/scaleway-cli)
|
||||||
- [Sia](https://github.com/SiaFoundation/siad)
|
- [Sia](https://github.com/SiaFoundation/siad)
|
||||||
- [Skaffold](https://skaffold.dev/)
|
- [Skaffold](https://skaffold.dev/)
|
||||||
|
- [Taikun](https://taikun.cloud/)
|
||||||
- [Tendermint](https://github.com/tendermint/tendermint)
|
- [Tendermint](https://github.com/tendermint/tendermint)
|
||||||
- [Twitch CLI](https://github.com/twitchdev/twitch-cli)
|
- [Twitch CLI](https://github.com/twitchdev/twitch-cli)
|
||||||
- [UpCloud CLI (`upctl`)](https://github.com/UpCloudLtd/upcloud-cli)
|
- [UpCloud CLI (`upctl`)](https://github.com/UpCloudLtd/upcloud-cli)
|
||||||
|
- [Vitess](https://vitess.io)
|
||||||
- VMware's [Tanzu Community Edition](https://github.com/vmware-tanzu/community-edition) & [Tanzu Framework](https://github.com/vmware-tanzu/tanzu-framework)
|
- VMware's [Tanzu Community Edition](https://github.com/vmware-tanzu/community-edition) & [Tanzu Framework](https://github.com/vmware-tanzu/tanzu-framework)
|
||||||
- [Werf](https://werf.io/)
|
- [Werf](https://werf.io/)
|
||||||
|
- [Zarf](https://github.com/defenseunicorns/zarf)
|
||||||
- [ZITADEL](https://github.com/zitadel/zitadel)
|
- [ZITADEL](https://github.com/zitadel/zitadel)
|
|
@ -3,7 +3,7 @@
|
||||||
While you are welcome to provide your own organization, typically a Cobra-based
|
While you are welcome to provide your own organization, typically a Cobra-based
|
||||||
application will follow the following organizational structure:
|
application will follow the following organizational structure:
|
||||||
|
|
||||||
```
|
```test
|
||||||
▾ appName/
|
▾ appName/
|
||||||
▾ cmd/
|
▾ cmd/
|
||||||
add.go
|
add.go
|
||||||
|
@ -29,8 +29,8 @@ func main() {
|
||||||
|
|
||||||
## Using the Cobra Generator
|
## Using the Cobra Generator
|
||||||
|
|
||||||
Cobra-CLI is its own program that will create your application and add any
|
Cobra-CLI is its own program that will create your application and add any commands you want.
|
||||||
commands you want. It's the easiest way to incorporate Cobra into your application.
|
It's the easiest way to incorporate Cobra into your application.
|
||||||
|
|
||||||
For complete details on using the Cobra generator, please refer to [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/main/README.md)
|
For complete details on using the Cobra generator, please refer to [The Cobra-CLI Generator README](https://github.com/spf13/cobra-cli/blob/main/README.md)
|
||||||
|
|
||||||
|
@ -188,6 +188,37 @@ var versionCmd = &cobra.Command{
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Organizing subcommands
|
||||||
|
|
||||||
|
A command may have subcommands which in turn may have other subcommands. This is achieved by using
|
||||||
|
`AddCommand`. In some cases, especially in larger applications, each subcommand may be defined in
|
||||||
|
its own go package.
|
||||||
|
|
||||||
|
The suggested approach is for the parent command to use `AddCommand` to add its most immediate
|
||||||
|
subcommands. For example, consider the following directory structure:
|
||||||
|
|
||||||
|
```text
|
||||||
|
├── cmd
|
||||||
|
│ ├── root.go
|
||||||
|
│ └── sub1
|
||||||
|
│ ├── sub1.go
|
||||||
|
│ └── sub2
|
||||||
|
│ ├── leafA.go
|
||||||
|
│ ├── leafB.go
|
||||||
|
│ └── sub2.go
|
||||||
|
└── main.go
|
||||||
|
```
|
||||||
|
|
||||||
|
In this case:
|
||||||
|
|
||||||
|
* The `init` function of `root.go` adds the command defined in `sub1.go` to the root command.
|
||||||
|
* The `init` function of `sub1.go` adds the command defined in `sub2.go` to the sub1 command.
|
||||||
|
* The `init` function of `sub2.go` adds the commands defined in `leafA.go` and `leafB.go` to the
|
||||||
|
sub2 command.
|
||||||
|
|
||||||
|
This approach ensures the subcommands are always included at compile time while avoiding cyclic
|
||||||
|
references.
|
||||||
|
|
||||||
### Returning and handling errors
|
### Returning and handling errors
|
||||||
|
|
||||||
If you wish to return an error to the caller of a command, `RunE` can be used.
|
If you wish to return an error to the caller of a command, `RunE` can be used.
|
||||||
|
@ -270,6 +301,7 @@ command := cobra.Command{
|
||||||
### Bind Flags with Config
|
### Bind Flags with Config
|
||||||
|
|
||||||
You can also bind your flags with [viper](https://github.com/spf13/viper):
|
You can also bind your flags with [viper](https://github.com/spf13/viper):
|
||||||
|
|
||||||
```go
|
```go
|
||||||
var author string
|
var author string
|
||||||
|
|
||||||
|
@ -289,12 +321,14 @@ More in [viper documentation](https://github.com/spf13/viper#working-with-flags)
|
||||||
|
|
||||||
Flags are optional by default. If instead you wish your command to report an error
|
Flags are optional by default. If instead you wish your command to report an error
|
||||||
when a flag has not been set, mark it as required:
|
when a flag has not been set, mark it as required:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
rootCmd.Flags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
|
rootCmd.Flags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
|
||||||
rootCmd.MarkFlagRequired("region")
|
rootCmd.MarkFlagRequired("region")
|
||||||
```
|
```
|
||||||
|
|
||||||
Or, for persistent flags:
|
Or, for persistent flags:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
rootCmd.PersistentFlags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
|
rootCmd.PersistentFlags().StringVarP(&Region, "region", "r", "", "AWS region (required)")
|
||||||
rootCmd.MarkPersistentFlagRequired("region")
|
rootCmd.MarkPersistentFlagRequired("region")
|
||||||
|
@ -304,6 +338,7 @@ rootCmd.MarkPersistentFlagRequired("region")
|
||||||
|
|
||||||
If you have different flags that must be provided together (e.g. if they provide the `--username` flag they MUST provide the `--password` flag as well) then
|
If you have different flags that must be provided together (e.g. if they provide the `--username` flag they MUST provide the `--password` flag as well) then
|
||||||
Cobra can enforce that requirement:
|
Cobra can enforce that requirement:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)")
|
rootCmd.Flags().StringVarP(&u, "username", "u", "", "Username (required if password is set)")
|
||||||
rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)")
|
rootCmd.Flags().StringVarP(&pw, "password", "p", "", "Password (required if username is set)")
|
||||||
|
@ -312,13 +347,24 @@ rootCmd.MarkFlagsRequiredTogether("username", "password")
|
||||||
|
|
||||||
You can also prevent different flags from being provided together if they represent mutually
|
You can also prevent different flags from being provided together if they represent mutually
|
||||||
exclusive options such as specifying an output format as either `--json` or `--yaml` but never both:
|
exclusive options such as specifying an output format as either `--json` or `--yaml` but never both:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
rootCmd.Flags().BoolVar(&u, "json", false, "Output in JSON")
|
rootCmd.Flags().BoolVar(&ofJson, "json", false, "Output in JSON")
|
||||||
rootCmd.Flags().BoolVar(&pw, "yaml", false, "Output in YAML")
|
rootCmd.Flags().BoolVar(&ofYaml, "yaml", false, "Output in YAML")
|
||||||
rootCmd.MarkFlagsMutuallyExclusive("json", "yaml")
|
rootCmd.MarkFlagsMutuallyExclusive("json", "yaml")
|
||||||
```
|
```
|
||||||
|
|
||||||
In both of these cases:
|
If you want to require at least one flag from a group to be present, you can use `MarkFlagsOneRequired`.
|
||||||
|
This can be combined with `MarkFlagsMutuallyExclusive` to enforce exactly one flag from a given group:
|
||||||
|
|
||||||
|
```go
|
||||||
|
rootCmd.Flags().BoolVar(&ofJson, "json", false, "Output in JSON")
|
||||||
|
rootCmd.Flags().BoolVar(&ofYaml, "yaml", false, "Output in YAML")
|
||||||
|
rootCmd.MarkFlagsOneRequired("json", "yaml")
|
||||||
|
rootCmd.MarkFlagsMutuallyExclusive("json", "yaml")
|
||||||
|
```
|
||||||
|
|
||||||
|
In these cases:
|
||||||
- both local and persistent flags can be used
|
- both local and persistent flags can be used
|
||||||
- **NOTE:** the group is only enforced on commands where every flag is defined
|
- **NOTE:** the group is only enforced on commands where every flag is defined
|
||||||
- a flag may appear in multiple groups
|
- a flag may appear in multiple groups
|
||||||
|
@ -388,7 +434,7 @@ by not providing a 'Run' for the 'rootCmd'.
|
||||||
|
|
||||||
We have only defined one flag for a single command.
|
We have only defined one flag for a single command.
|
||||||
|
|
||||||
More documentation about flags is available at https://github.com/spf13/pflag
|
More documentation about flags is available at https://github.com/spf13/pflag.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
package main
|
||||||
|
@ -556,9 +602,15 @@ Running an application with the '--version' flag will print the version to stdou
|
||||||
the version template. The template can be customized using the
|
the version template. The template can be customized using the
|
||||||
`cmd.SetVersionTemplate(s string)` function.
|
`cmd.SetVersionTemplate(s string)` function.
|
||||||
|
|
||||||
|
## Error Message Prefix
|
||||||
|
|
||||||
|
Cobra prints an error message when receiving a non-nil error value.
|
||||||
|
The default error message is `Error: <error contents>`.
|
||||||
|
The Prefix, `Error:` can be customized using the `cmd.SetErrPrefix(s string)` function.
|
||||||
|
|
||||||
## PreRun and PostRun Hooks
|
## PreRun and PostRun Hooks
|
||||||
|
|
||||||
It is possible to run functions before or after the main `Run` function of your command. The `PersistentPreRun` and `PreRun` functions will be executed before `Run`. `PersistentPostRun` and `PostRun` will be executed after `Run`. The `Persistent*Run` functions will be inherited by children if they do not declare their own. These functions are run in the following order:
|
It is possible to run functions before or after the main `Run` function of your command. The `PersistentPreRun` and `PreRun` functions will be executed before `Run`. `PersistentPostRun` and `PostRun` will be executed after `Run`. The `Persistent*Run` functions will be inherited by children if they do not declare their own. The `*PreRun` and `*PostRun` functions will only be executed if the `Run` function of the current command has been declared. These functions are run in the following order:
|
||||||
|
|
||||||
- `PersistentPreRun`
|
- `PersistentPreRun`
|
||||||
- `PreRun`
|
- `PreRun`
|
||||||
|
@ -641,6 +693,10 @@ Inside subCmd PostRun with args: [arg1 arg2]
|
||||||
Inside subCmd PersistentPostRun with args: [arg1 arg2]
|
Inside subCmd PersistentPostRun with args: [arg1 arg2]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
By default, only the first persistent hook found in the command chain is executed.
|
||||||
|
That is why in the above output, the `rootCmd PersistentPostRun` was not called for a child command.
|
||||||
|
Set `EnableTraverseRunHooks` global variable to `true` if you want to execute all parents' persistent hooks.
|
||||||
|
|
||||||
## Suggestions when "unknown command" happens
|
## Suggestions when "unknown command" happens
|
||||||
|
|
||||||
Cobra will print automatic suggestions when "unknown command" errors happen. This allows Cobra to behave similarly to the `git` command when a typo happens. For example:
|
Cobra will print automatic suggestions when "unknown command" errors happen. This allows Cobra to behave similarly to the `git` command when a typo happens. For example:
|
||||||
|
@ -672,7 +728,7 @@ command.SuggestionsMinimumDistance = 1
|
||||||
You can also explicitly set names for which a given command will be suggested using the `SuggestFor` attribute. This allows suggestions for strings that are not close in terms of string distance, but make sense in your set of commands but for which
|
You can also explicitly set names for which a given command will be suggested using the `SuggestFor` attribute. This allows suggestions for strings that are not close in terms of string distance, but make sense in your set of commands but for which
|
||||||
you don't want aliases. Example:
|
you don't want aliases. Example:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
$ kubectl remove
|
$ kubectl remove
|
||||||
Error: unknown command "remove" for "kubectl"
|
Error: unknown command "remove" for "kubectl"
|
||||||
|
|
||||||
|
@ -684,12 +740,71 @@ Run 'kubectl help' for usage.
|
||||||
|
|
||||||
## Generating documentation for your command
|
## Generating documentation for your command
|
||||||
|
|
||||||
Cobra can generate documentation based on subcommands, flags, etc. Read more about it in the [docs generation documentation](doc/README.md).
|
Cobra can generate documentation based on subcommands, flags, etc.
|
||||||
|
Read more about it in the [docs generation documentation](docgen/_index.md).
|
||||||
|
|
||||||
## Generating shell completions
|
## Generating shell completions
|
||||||
|
|
||||||
Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell. If you add more information to your commands, these completions can be amazingly powerful and flexible. Read more about it in [Shell Completions](shell_completions.md).
|
Cobra can generate a shell-completion file for the following shells: bash, zsh, fish, PowerShell.
|
||||||
|
If you add more information to your commands, these completions can be amazingly powerful and flexible.
|
||||||
|
Read more about it in [Shell Completions](completions/_index.md).
|
||||||
|
|
||||||
## Providing Active Help
|
## Providing Active Help
|
||||||
|
|
||||||
Cobra makes use of the shell-completion system to define a framework allowing you to provide Active Help to your users. Active Help are messages (hints, warnings, etc) printed as the program is being used. Read more about it in [Active Help](active_help.md).
|
Cobra makes use of the shell-completion system to define a framework allowing you to provide Active Help to your users.
|
||||||
|
Active Help are messages (hints, warnings, etc) printed as the program is being used.
|
||||||
|
Read more about it in [Active Help](active_help.md).
|
||||||
|
|
||||||
|
## Creating a plugin
|
||||||
|
|
||||||
|
When creating a plugin for tools like *kubectl*, the executable is named
|
||||||
|
`kubectl-myplugin`, but it is used as `kubectl myplugin`. To fix help
|
||||||
|
messages and completions, annotate the root command with the
|
||||||
|
`cobra.CommandDisplayNameAnnotation` annotation.
|
||||||
|
|
||||||
|
### Example kubectl plugin
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
rootCmd := &cobra.Command{
|
||||||
|
Use: "kubectl-myplugin",
|
||||||
|
Annotations: map[string]string{
|
||||||
|
cobra.CommandDisplayNameAnnotation: "kubectl myplugin",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
subCmd := &cobra.Command{
|
||||||
|
Use: "subcmd",
|
||||||
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
fmt.Println("kubectl myplugin subcmd")
|
||||||
|
},
|
||||||
|
}
|
||||||
|
rootCmd.AddCommand(subCmd)
|
||||||
|
rootCmd.Execute()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Example run as a kubectl plugin:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ kubectl myplugin
|
||||||
|
Usage:
|
||||||
|
kubectl myplugin [command]
|
||||||
|
|
||||||
|
Available Commands:
|
||||||
|
completion Generate the autocompletion script for the specified shell
|
||||||
|
help Help about any command
|
||||||
|
subcmd
|
||||||
|
|
||||||
|
Flags:
|
||||||
|
-h, --help help for kubectl myplugin
|
||||||
|
|
||||||
|
Use "kubectl myplugin [command] --help" for more information about a command.
|
||||||
|
```
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
@ -90,6 +90,7 @@ func genZshComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
compCmd = ShellCompNoDescRequestCmd
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
}
|
}
|
||||||
WriteStringAndCheck(buf, fmt.Sprintf(`#compdef %[1]s
|
WriteStringAndCheck(buf, fmt.Sprintf(`#compdef %[1]s
|
||||||
|
compdef _%[1]s %[1]s
|
||||||
|
|
||||||
# zsh completion for %-36[1]s -*- shell-script -*-
|
# zsh completion for %-36[1]s -*- shell-script -*-
|
||||||
|
|
||||||
|
@ -108,8 +109,9 @@ _%[1]s()
|
||||||
local shellCompDirectiveNoFileComp=%[5]d
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
local shellCompDirectiveFilterFileExt=%[6]d
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
local shellCompDirectiveFilterDirs=%[7]d
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveKeepOrder=%[8]d
|
||||||
|
|
||||||
local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace
|
local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace keepOrder
|
||||||
local -a completions
|
local -a completions
|
||||||
|
|
||||||
__%[1]s_debug "\n========= starting completion logic =========="
|
__%[1]s_debug "\n========= starting completion logic =========="
|
||||||
|
@ -177,7 +179,7 @@ _%[1]s()
|
||||||
return
|
return
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local activeHelpMarker="%[8]s"
|
local activeHelpMarker="%[9]s"
|
||||||
local endIndex=${#activeHelpMarker}
|
local endIndex=${#activeHelpMarker}
|
||||||
local startIndex=$((${#activeHelpMarker}+1))
|
local startIndex=$((${#activeHelpMarker}+1))
|
||||||
local hasActiveHelp=0
|
local hasActiveHelp=0
|
||||||
|
@ -227,6 +229,11 @@ _%[1]s()
|
||||||
noSpace="-S ''"
|
noSpace="-S ''"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveKeepOrder)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "Activating keep order."
|
||||||
|
keepOrder="-V"
|
||||||
|
fi
|
||||||
|
|
||||||
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
||||||
# File extension filtering
|
# File extension filtering
|
||||||
local filteringCmd
|
local filteringCmd
|
||||||
|
@ -262,7 +269,7 @@ _%[1]s()
|
||||||
return $result
|
return $result
|
||||||
else
|
else
|
||||||
__%[1]s_debug "Calling _describe"
|
__%[1]s_debug "Calling _describe"
|
||||||
if eval _describe "completions" completions $flagPrefix $noSpace; then
|
if eval _describe $keepOrder "completions" completions $flagPrefix $noSpace; then
|
||||||
__%[1]s_debug "_describe found some completions"
|
__%[1]s_debug "_describe found some completions"
|
||||||
|
|
||||||
# Return the success of having called _describe
|
# Return the success of having called _describe
|
||||||
|
@ -296,6 +303,6 @@ if [ "$funcstack[1]" = "_%[1]s" ]; then
|
||||||
fi
|
fi
|
||||||
`, name, compCmd,
|
`, name, compCmd,
|
||||||
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs,
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder,
|
||||||
activeHelpMarker))
|
activeHelpMarker))
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
// Copyright 2013-2022 The Cobra Authors
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
//
|
//
|
||||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
// you may not use this file except in compliance with the License.
|
// you may not use this file except in compliance with the License.
|
||||||
|
|
Loading…
Reference in a new issue