mirror of
https://github.com/cheat/cheat.git
synced 2026-03-07 11:13:33 +01:00
Merge branch 'feat/cobra'
This commit is contained in:
@@ -55,9 +55,10 @@ make vendor-update
|
|||||||
The `cheat` command-line tool is organized into several key packages:
|
The `cheat` command-line tool is organized into several key packages:
|
||||||
|
|
||||||
### Command Layer (`cmd/cheat/`)
|
### Command Layer (`cmd/cheat/`)
|
||||||
- `main.go`: Entry point, argument parsing, command routing
|
- `main.go`: Entry point, cobra command definition, flag registration, command routing
|
||||||
- `cmd_*.go`: Individual command implementations (view, edit, list, search, etc.)
|
- `cmd_*.go`: Individual command implementations (view, edit, list, search, etc.)
|
||||||
- Commands are selected based on docopt parsed arguments
|
- `completions.go`: Dynamic shell completion functions for cheatsheet names, tags, and paths
|
||||||
|
- Commands are routed via a `switch` block in the cobra `RunE` handler
|
||||||
|
|
||||||
### Core Internal Packages
|
### Core Internal Packages
|
||||||
|
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ make coverage-text # Terminal output
|
|||||||
|
|
||||||
The `cheat` application follows a clean architecture with well-separated concerns:
|
The `cheat` application follows a clean architecture with well-separated concerns:
|
||||||
|
|
||||||
- **`cmd/cheat/`**: Command layer with argument parsing and command routing
|
- **`cmd/cheat/`**: Command layer (cobra-based CLI, flag registration, command routing, shell completions)
|
||||||
- **`internal/config`**: Configuration management (YAML loading, validation, paths)
|
- **`internal/config`**: Configuration management (YAML loading, validation, paths)
|
||||||
- **`internal/cheatpath`**: Cheatsheet path management (collections, filtering)
|
- **`internal/cheatpath`**: Cheatsheet path management (collections, filtering)
|
||||||
- **`internal/sheet`**: Individual cheatsheet handling (parsing, search, highlighting)
|
- **`internal/sheet`**: Individual cheatsheet handling (parsing, search, highlighting)
|
||||||
|
|||||||
@@ -8,13 +8,13 @@ On Unix-like systems, you may simply paste the following snippet into your termi
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
cd /tmp \
|
cd /tmp \
|
||||||
&& wget https://github.com/cheat/cheat/releases/download/4.7.0/cheat-linux-amd64.gz \
|
&& wget https://github.com/cheat/cheat/releases/download/5.0.0/cheat-linux-amd64.gz \
|
||||||
&& gunzip cheat-linux-amd64.gz \
|
&& gunzip cheat-linux-amd64.gz \
|
||||||
&& chmod +x cheat-linux-amd64 \
|
&& chmod +x cheat-linux-amd64 \
|
||||||
&& sudo mv cheat-linux-amd64 /usr/local/bin/cheat
|
&& sudo mv cheat-linux-amd64 /usr/local/bin/cheat
|
||||||
```
|
```
|
||||||
|
|
||||||
You may need to need to change the version number (`4.7.0`) and the archive
|
You may need to need to change the version number (`5.0.0`) and the archive
|
||||||
(`cheat-linux-amd64.gz`) depending on your platform.
|
(`cheat-linux-amd64.gz`) depending on your platform.
|
||||||
|
|
||||||
See the [releases page][releases] for a list of supported platforms.
|
See the [releases page][releases] for a list of supported platforms.
|
||||||
|
|||||||
37
README.md
37
README.md
@@ -175,21 +175,38 @@ added to the cheatpaths. This means you can place a `.cheat` directory at your
|
|||||||
project root and it will be available from any subdirectory within that project.
|
project root and it will be available from any subdirectory within that project.
|
||||||
|
|
||||||
## Autocompletion
|
## Autocompletion
|
||||||
Shell autocompletion is currently available for `bash`, `fish`, and `zsh`. Copy
|
`cheat` can generate shell completion scripts for `bash`, `zsh`, `fish`, and
|
||||||
the relevant [completion script][completions] into the appropriate directory on
|
`powershell` via the `--completion` flag:
|
||||||
your filesystem to enable autocompletion. (This directory will vary depending
|
|
||||||
on operating system and shell specifics.)
|
|
||||||
|
|
||||||
Additionally, `cheat` supports enhanced autocompletion via integration with
|
```sh
|
||||||
[fzf][]. To enable `fzf` integration:
|
cheat --completion bash
|
||||||
|
cheat --completion zsh
|
||||||
|
cheat --completion fish
|
||||||
|
cheat --completion powershell
|
||||||
|
```
|
||||||
|
|
||||||
1. Ensure that `fzf` is available on your `$PATH`
|
Pipe the output to the appropriate location for your shell. For example:
|
||||||
2. Set an envvar: `export CHEAT_USE_FZF=true`
|
|
||||||
|
```sh
|
||||||
|
# bash (user-local)
|
||||||
|
mkdir -p ~/.local/share/bash-completion/completions
|
||||||
|
cheat --completion bash > ~/.local/share/bash-completion/completions/cheat
|
||||||
|
|
||||||
|
# bash (system-wide)
|
||||||
|
cheat --completion bash > /etc/bash_completion.d/cheat
|
||||||
|
|
||||||
|
# zsh (ensure the directory is on your fpath)
|
||||||
|
cheat --completion zsh > "${fpath[1]}/_cheat"
|
||||||
|
|
||||||
|
# fish
|
||||||
|
cheat --completion fish > ~/.config/fish/completions/cheat.fish
|
||||||
|
```
|
||||||
|
|
||||||
|
Completions are dynamically generated and include cheatsheet names, tags, and
|
||||||
|
cheatpath names.
|
||||||
|
|
||||||
[INSTALLING.md]: INSTALLING.md
|
[INSTALLING.md]: INSTALLING.md
|
||||||
[Releases]: https://github.com/cheat/cheat/releases
|
[Releases]: https://github.com/cheat/cheat/releases
|
||||||
[cheatsheets]: https://github.com/cheat/cheatsheets
|
[cheatsheets]: https://github.com/cheat/cheatsheets
|
||||||
[completions]: https://github.com/cheat/cheat/tree/master/scripts
|
|
||||||
[Chroma]: https://github.com/alecthomas/chroma
|
[Chroma]: https://github.com/alecthomas/chroma
|
||||||
[supported languages]: https://github.com/alecthomas/chroma#supported-languages
|
[supported languages]: https://github.com/alecthomas/chroma#supported-languages
|
||||||
[fzf]: https://github.com/junegunn/fzf
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Accepted
|
|||||||
|
|
||||||
## Context
|
## Context
|
||||||
|
|
||||||
In `cmd/cheat/main.go` lines 47-52, the code parses environment variables assuming they all contain an equals sign:
|
In the `envVars()` function in `cmd/cheat/main.go`, the code parses environment variables assuming they all contain an equals sign:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
for _, e := range os.Environ() {
|
for _, e := range os.Environ() {
|
||||||
|
|||||||
@@ -100,5 +100,5 @@ The parallelization attempt was valuable as a learning exercise and definitively
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- Benchmark implementation: cmd/cheat/search_bench_test.go
|
- Benchmark implementation: test/integration/search_bench_test.go
|
||||||
- Reverted parallel implementation: see git history (commit 82eb918)
|
- Reverted parallel implementation: see git history (commit 82eb918)
|
||||||
@@ -3,9 +3,11 @@ package main
|
|||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
)
|
)
|
||||||
|
|
||||||
func cmdConf(_ map[string]interface{}, conf config.Config) {
|
func cmdConf(_ *cobra.Command, _ []string, conf config.Config) {
|
||||||
fmt.Println(conf.Path)
|
fmt.Println(conf.Path)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,12 +5,14 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"text/tabwriter"
|
"text/tabwriter"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/display"
|
"github.com/cheat/cheat/internal/display"
|
||||||
)
|
)
|
||||||
|
|
||||||
// cmdDirectories lists the configured cheatpaths.
|
// cmdDirectories lists the configured cheatpaths.
|
||||||
func cmdDirectories(_ map[string]interface{}, conf config.Config) {
|
func cmdDirectories(_ *cobra.Command, _ []string, conf config.Config) {
|
||||||
|
|
||||||
// initialize a tabwriter to produce cleanly columnized output
|
// initialize a tabwriter to produce cleanly columnized output
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/cheatpath"
|
"github.com/cheat/cheat/internal/cheatpath"
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/sheet"
|
"github.com/cheat/cheat/internal/sheet"
|
||||||
@@ -14,9 +16,9 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// cmdEdit opens a cheatsheet for editing (or creates it if it doesn't exist).
|
// cmdEdit opens a cheatsheet for editing (or creates it if it doesn't exist).
|
||||||
func cmdEdit(opts map[string]interface{}, conf config.Config) {
|
func cmdEdit(cmd *cobra.Command, _ []string, conf config.Config) {
|
||||||
|
|
||||||
cheatsheet := opts["--edit"].(string)
|
cheatsheet, _ := cmd.Flags().GetString("edit")
|
||||||
|
|
||||||
// validate the cheatsheet name
|
// validate the cheatsheet name
|
||||||
if err := sheet.Validate(cheatsheet); err != nil {
|
if err := sheet.Validate(cheatsheet); err != nil {
|
||||||
@@ -30,10 +32,11 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
|
|||||||
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if opts["--tag"] != nil {
|
if cmd.Flags().Changed("tag") {
|
||||||
|
tagVal, _ := cmd.Flags().GetString("tag")
|
||||||
cheatsheets = sheets.Filter(
|
cheatsheets = sheets.Filter(
|
||||||
cheatsheets,
|
cheatsheets,
|
||||||
strings.Split(opts["--tag"].(string), ","),
|
strings.Split(tagVal, ","),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,14 +93,14 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
|
|||||||
// call to `exec.Command` will fail.
|
// call to `exec.Command` will fail.
|
||||||
parts := strings.Fields(conf.Editor)
|
parts := strings.Fields(conf.Editor)
|
||||||
editor := parts[0]
|
editor := parts[0]
|
||||||
args := append(parts[1:], editpath)
|
editorArgs := append(parts[1:], editpath)
|
||||||
|
|
||||||
// edit the cheatsheet
|
// edit the cheatsheet
|
||||||
cmd := exec.Command(editor, args...)
|
editorCmd := exec.Command(editor, editorArgs...)
|
||||||
cmd.Stdout = os.Stdout
|
editorCmd.Stdout = os.Stdout
|
||||||
cmd.Stdin = os.Stdin
|
editorCmd.Stdin = os.Stdin
|
||||||
cmd.Stderr = os.Stderr
|
editorCmd.Stderr = os.Stderr
|
||||||
if err := cmd.Run(); err != nil {
|
if err := editorCmd.Run(); err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "failed to edit cheatsheet: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to edit cheatsheet: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"text/tabwriter"
|
"text/tabwriter"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/display"
|
"github.com/cheat/cheat/internal/display"
|
||||||
"github.com/cheat/cheat/internal/sheet"
|
"github.com/cheat/cheat/internal/sheet"
|
||||||
@@ -16,7 +18,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// cmdList lists all available cheatsheets.
|
// cmdList lists all available cheatsheets.
|
||||||
func cmdList(opts map[string]interface{}, conf config.Config) {
|
func cmdList(cmd *cobra.Command, args []string, conf config.Config) {
|
||||||
|
|
||||||
// load the cheatsheets
|
// load the cheatsheets
|
||||||
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
@@ -24,10 +26,11 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
|
|||||||
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if opts["--tag"] != nil {
|
if cmd.Flags().Changed("tag") {
|
||||||
|
tagVal, _ := cmd.Flags().GetString("tag")
|
||||||
cheatsheets = sheets.Filter(
|
cheatsheets = sheets.Filter(
|
||||||
cheatsheets,
|
cheatsheets,
|
||||||
strings.Split(opts["--tag"].(string), ","),
|
strings.Split(tagVal, ","),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -47,16 +50,13 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
// filter if <cheatsheet> was specified
|
// filter if <cheatsheet> was specified
|
||||||
// NB: our docopt specification is misleading here. When used in conjunction
|
if len(args) > 0 {
|
||||||
// with `-l`, `<cheatsheet>` is really a pattern against which to filter
|
|
||||||
// sheet titles.
|
|
||||||
if opts["<cheatsheet>"] != nil {
|
|
||||||
|
|
||||||
// initialize a slice of filtered sheets
|
// initialize a slice of filtered sheets
|
||||||
filtered := []sheet.Sheet{}
|
filtered := []sheet.Sheet{}
|
||||||
|
|
||||||
// initialize our filter pattern
|
// initialize our filter pattern
|
||||||
pattern := "(?i)" + opts["<cheatsheet>"].(string)
|
pattern := "(?i)" + args[0]
|
||||||
|
|
||||||
// compile the regex
|
// compile the regex
|
||||||
reg, err := regexp.Compile(pattern)
|
reg, err := regexp.Compile(pattern)
|
||||||
@@ -86,7 +86,8 @@ func cmdList(opts map[string]interface{}, conf config.Config) {
|
|||||||
w := tabwriter.NewWriter(&out, 0, 0, 1, ' ', 0)
|
w := tabwriter.NewWriter(&out, 0, 0, 1, ' ', 0)
|
||||||
|
|
||||||
// generate sorted, columnized output
|
// generate sorted, columnized output
|
||||||
if opts["--brief"].(bool) {
|
briefFlag, _ := cmd.Flags().GetBool("brief")
|
||||||
|
if briefFlag {
|
||||||
fmt.Fprintln(w, "title:\ttags:")
|
fmt.Fprintln(w, "title:\ttags:")
|
||||||
for _, sheet := range flattened {
|
for _, sheet := range flattened {
|
||||||
fmt.Fprintf(w, "%s\t%s\n", sheet.Title, strings.Join(sheet.Tags, ","))
|
fmt.Fprintf(w, "%s\t%s\n", sheet.Title, strings.Join(sheet.Tags, ","))
|
||||||
|
|||||||
@@ -5,15 +5,17 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/sheet"
|
"github.com/cheat/cheat/internal/sheet"
|
||||||
"github.com/cheat/cheat/internal/sheets"
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
)
|
)
|
||||||
|
|
||||||
// cmdRemove removes (deletes) a cheatsheet.
|
// cmdRemove removes (deletes) a cheatsheet.
|
||||||
func cmdRemove(opts map[string]interface{}, conf config.Config) {
|
func cmdRemove(cmd *cobra.Command, _ []string, conf config.Config) {
|
||||||
|
|
||||||
cheatsheet := opts["--rm"].(string)
|
cheatsheet, _ := cmd.Flags().GetString("rm")
|
||||||
|
|
||||||
// validate the cheatsheet name
|
// validate the cheatsheet name
|
||||||
if err := sheet.Validate(cheatsheet); err != nil {
|
if err := sheet.Validate(cheatsheet); err != nil {
|
||||||
@@ -27,10 +29,11 @@ func cmdRemove(opts map[string]interface{}, conf config.Config) {
|
|||||||
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if opts["--tag"] != nil {
|
if cmd.Flags().Changed("tag") {
|
||||||
|
tagVal, _ := cmd.Flags().GetString("tag")
|
||||||
cheatsheets = sheets.Filter(
|
cheatsheets = sheets.Filter(
|
||||||
cheatsheets,
|
cheatsheets,
|
||||||
strings.Split(opts["--tag"].(string), ","),
|
strings.Split(tagVal, ","),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,15 +6,19 @@ import (
|
|||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/display"
|
"github.com/cheat/cheat/internal/display"
|
||||||
"github.com/cheat/cheat/internal/sheets"
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
)
|
)
|
||||||
|
|
||||||
// cmdSearch searches for strings in cheatsheets.
|
// cmdSearch searches for strings in cheatsheets.
|
||||||
func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
func cmdSearch(cmd *cobra.Command, args []string, conf config.Config) {
|
||||||
|
|
||||||
phrase := opts["--search"].(string)
|
phrase, _ := cmd.Flags().GetString("search")
|
||||||
|
colorize, _ := cmd.Flags().GetBool("colorize")
|
||||||
|
useRegex, _ := cmd.Flags().GetBool("regex")
|
||||||
|
|
||||||
// load the cheatsheets
|
// load the cheatsheets
|
||||||
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
@@ -22,10 +26,11 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
|||||||
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if opts["--tag"] != nil {
|
if cmd.Flags().Changed("tag") {
|
||||||
|
tagVal, _ := cmd.Flags().GetString("tag")
|
||||||
cheatsheets = sheets.Filter(
|
cheatsheets = sheets.Filter(
|
||||||
cheatsheets,
|
cheatsheets,
|
||||||
strings.Split(opts["--tag"].(string), ","),
|
strings.Split(tagVal, ","),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -33,7 +38,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
|||||||
pattern := "(?i)" + phrase
|
pattern := "(?i)" + phrase
|
||||||
|
|
||||||
// unless --regex is provided, in which case we pass the regex unaltered
|
// unless --regex is provided, in which case we pass the regex unaltered
|
||||||
if opts["--regex"] == true {
|
if useRegex {
|
||||||
pattern = phrase
|
pattern = phrase
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -53,7 +58,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
|||||||
|
|
||||||
// if <cheatsheet> was provided, constrain the search only to
|
// if <cheatsheet> was provided, constrain the search only to
|
||||||
// matching cheatsheets
|
// matching cheatsheets
|
||||||
if opts["<cheatsheet>"] != nil && sheet.Title != opts["<cheatsheet>"] {
|
if len(args) > 0 && sheet.Title != args[0] {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -68,7 +73,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// if colorization was requested, apply it here
|
// if colorization was requested, apply it here
|
||||||
if conf.Color(opts) {
|
if conf.Color(colorize) {
|
||||||
sheet.Colorize(conf)
|
sheet.Colorize(conf)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -78,7 +83,7 @@ func cmdSearch(opts map[string]interface{}, conf config.Config) {
|
|||||||
// append the cheatsheet title
|
// append the cheatsheet title
|
||||||
sheet.Title,
|
sheet.Title,
|
||||||
// append the cheatsheet path
|
// append the cheatsheet path
|
||||||
display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf.Color(opts)),
|
display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf.Color(colorize)),
|
||||||
// indent each line of content
|
// indent each line of content
|
||||||
display.Indent(sheet.Text),
|
display.Indent(sheet.Text),
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -4,13 +4,15 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/display"
|
"github.com/cheat/cheat/internal/display"
|
||||||
"github.com/cheat/cheat/internal/sheets"
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
)
|
)
|
||||||
|
|
||||||
// cmdTags lists all tags in use.
|
// cmdTags lists all tags in use.
|
||||||
func cmdTags(_ map[string]interface{}, conf config.Config) {
|
func cmdTags(_ *cobra.Command, _ []string, conf config.Config) {
|
||||||
|
|
||||||
// load the cheatsheets
|
// load the cheatsheets
|
||||||
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
|
|||||||
@@ -5,15 +5,19 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/display"
|
"github.com/cheat/cheat/internal/display"
|
||||||
"github.com/cheat/cheat/internal/sheets"
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
)
|
)
|
||||||
|
|
||||||
// cmdView displays a cheatsheet for viewing.
|
// cmdView displays a cheatsheet for viewing.
|
||||||
func cmdView(opts map[string]interface{}, conf config.Config) {
|
func cmdView(cmd *cobra.Command, args []string, conf config.Config) {
|
||||||
|
|
||||||
cheatsheet := opts["<cheatsheet>"].(string)
|
cheatsheet := args[0]
|
||||||
|
|
||||||
|
colorize, _ := cmd.Flags().GetBool("colorize")
|
||||||
|
|
||||||
// load the cheatsheets
|
// load the cheatsheets
|
||||||
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
@@ -21,15 +25,17 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
|
|||||||
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to list cheatsheets: %v\n", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if opts["--tag"] != nil {
|
if cmd.Flags().Changed("tag") {
|
||||||
|
tagVal, _ := cmd.Flags().GetString("tag")
|
||||||
cheatsheets = sheets.Filter(
|
cheatsheets = sheets.Filter(
|
||||||
cheatsheets,
|
cheatsheets,
|
||||||
strings.Split(opts["--tag"].(string), ","),
|
strings.Split(tagVal, ","),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// if --all was passed, display cheatsheets from all cheatpaths
|
// if --all was passed, display cheatsheets from all cheatpaths
|
||||||
if opts["--all"].(bool) {
|
allFlag, _ := cmd.Flags().GetBool("all")
|
||||||
|
if allFlag {
|
||||||
// iterate over the cheatpaths
|
// iterate over the cheatpaths
|
||||||
out := ""
|
out := ""
|
||||||
for _, cheatpath := range cheatsheets {
|
for _, cheatpath := range cheatsheets {
|
||||||
@@ -40,11 +46,11 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
|
|||||||
// identify the matching cheatsheet
|
// identify the matching cheatsheet
|
||||||
out += fmt.Sprintf("%s %s\n",
|
out += fmt.Sprintf("%s %s\n",
|
||||||
sheet.Title,
|
sheet.Title,
|
||||||
display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf.Color(opts)),
|
display.Faint(fmt.Sprintf("(%s)", sheet.CheatPath), conf.Color(colorize)),
|
||||||
)
|
)
|
||||||
|
|
||||||
// apply colorization if requested
|
// apply colorization if requested
|
||||||
if conf.Color(opts) {
|
if conf.Color(colorize) {
|
||||||
sheet.Colorize(conf)
|
sheet.Colorize(conf)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -71,7 +77,7 @@ func cmdView(opts map[string]interface{}, conf config.Config) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// apply colorization if requested
|
// apply colorization if requested
|
||||||
if conf.Color(opts) {
|
if conf.Color(colorize) {
|
||||||
sheet.Colorize(conf)
|
sheet.Colorize(conf)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,25 +5,138 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"runtime"
|
"runtime"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/docopt/docopt-go"
|
|
||||||
"github.com/mitchellh/go-homedir"
|
"github.com/mitchellh/go-homedir"
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
"github.com/cheat/cheat/internal/cheatpath"
|
"github.com/cheat/cheat/internal/cheatpath"
|
||||||
|
"github.com/cheat/cheat/internal/completions"
|
||||||
"github.com/cheat/cheat/internal/config"
|
"github.com/cheat/cheat/internal/config"
|
||||||
"github.com/cheat/cheat/internal/installer"
|
"github.com/cheat/cheat/internal/installer"
|
||||||
)
|
)
|
||||||
|
|
||||||
const version = "4.7.1"
|
const version = "5.0.0"
|
||||||
|
|
||||||
|
var rootCmd = &cobra.Command{
|
||||||
|
Use: "cheat [cheatsheet]",
|
||||||
|
Short: "Create and view interactive cheatsheets on the command-line",
|
||||||
|
Long: `cheat allows you to create and view interactive cheatsheets on the
|
||||||
|
command-line. It was designed to help remind *nix system administrators of
|
||||||
|
options for commands that they use frequently, but not frequently enough to
|
||||||
|
remember.`,
|
||||||
|
Example: ` To initialize a config file:
|
||||||
|
mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml
|
||||||
|
|
||||||
|
To view the tar cheatsheet:
|
||||||
|
cheat tar
|
||||||
|
|
||||||
|
To edit (or create) the foo cheatsheet:
|
||||||
|
cheat -e foo
|
||||||
|
|
||||||
|
To edit (or create) the foo/bar cheatsheet on the "work" cheatpath:
|
||||||
|
cheat -p work -e foo/bar
|
||||||
|
|
||||||
|
To view all cheatsheet directories:
|
||||||
|
cheat -d
|
||||||
|
|
||||||
|
To list all available cheatsheets:
|
||||||
|
cheat -l
|
||||||
|
|
||||||
|
To briefly list all cheatsheets whose titles match "apt":
|
||||||
|
cheat -b apt
|
||||||
|
|
||||||
|
To list all tags in use:
|
||||||
|
cheat -T
|
||||||
|
|
||||||
|
To list available cheatsheets that are tagged as "personal":
|
||||||
|
cheat -l -t personal
|
||||||
|
|
||||||
|
To search for "ssh" among all cheatsheets, and colorize matches:
|
||||||
|
cheat -c -s ssh
|
||||||
|
|
||||||
|
To search (by regex) for cheatsheets that contain an IP address:
|
||||||
|
cheat -c -r -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
|
||||||
|
|
||||||
|
To remove (delete) the foo/bar cheatsheet:
|
||||||
|
cheat --rm foo/bar
|
||||||
|
|
||||||
|
To view the configuration file path:
|
||||||
|
cheat --conf
|
||||||
|
|
||||||
|
To generate shell completions (bash, zsh, fish, powershell):
|
||||||
|
cheat --completion bash`,
|
||||||
|
RunE: run,
|
||||||
|
Args: cobra.MaximumNArgs(1),
|
||||||
|
SilenceErrors: true,
|
||||||
|
SilenceUsage: true,
|
||||||
|
ValidArgsFunction: completions.Cheatsheets,
|
||||||
|
CompletionOptions: cobra.CompletionOptions{
|
||||||
|
DisableDefaultCmd: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
f := rootCmd.Flags()
|
||||||
|
|
||||||
|
// bool flags
|
||||||
|
f.BoolP("all", "a", false, "Search among all cheatpaths")
|
||||||
|
f.BoolP("brief", "b", false, "List cheatsheets without file paths")
|
||||||
|
f.BoolP("colorize", "c", false, "Colorize output")
|
||||||
|
f.BoolP("directories", "d", false, "List cheatsheet directories")
|
||||||
|
f.Bool("init", false, "Write a default config file to stdout")
|
||||||
|
f.BoolP("list", "l", false, "List cheatsheets")
|
||||||
|
f.BoolP("regex", "r", false, "Treat search <phrase> as a regex")
|
||||||
|
f.BoolP("tags", "T", false, "List all tags in use")
|
||||||
|
f.BoolP("version", "v", false, "Print the version number")
|
||||||
|
f.Bool("conf", false, "Display the config file path")
|
||||||
|
|
||||||
|
// string flags
|
||||||
|
f.StringP("edit", "e", "", "Edit `cheatsheet`")
|
||||||
|
f.StringP("path", "p", "", "Return only sheets found on cheatpath `name`")
|
||||||
|
f.StringP("search", "s", "", "Search cheatsheets for `phrase`")
|
||||||
|
f.StringP("tag", "t", "", "Return only sheets matching `tag`")
|
||||||
|
f.String("rm", "", "Remove (delete) `cheatsheet`")
|
||||||
|
f.String("completion", "", "Generate shell completion script (`shell`: bash, zsh, fish, powershell)")
|
||||||
|
|
||||||
|
// register flag completion functions
|
||||||
|
rootCmd.RegisterFlagCompletionFunc("tag", completions.Tags)
|
||||||
|
rootCmd.RegisterFlagCompletionFunc("path", completions.Paths)
|
||||||
|
rootCmd.RegisterFlagCompletionFunc("edit", completions.Cheatsheets)
|
||||||
|
rootCmd.RegisterFlagCompletionFunc("rm", completions.Cheatsheets)
|
||||||
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
if err := rootCmd.Execute(); err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// initialize options
|
func run(cmd *cobra.Command, args []string) error {
|
||||||
opts, err := docopt.ParseArgs(usage(), nil, version)
|
f := cmd.Flags()
|
||||||
if err != nil {
|
|
||||||
// panic here, because this should never happen
|
// handle --init early (no config needed)
|
||||||
panic(fmt.Errorf("docopt failed to parse: %v", err))
|
if initFlag, _ := f.GetBool("init"); initFlag {
|
||||||
|
home, err := homedir.Dir()
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(os.Stderr, "failed to get user home directory: %v\n", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
envvars := config.EnvVars()
|
||||||
|
cmdInit(home, envvars)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handle --version early
|
||||||
|
if versionFlag, _ := f.GetBool("version"); versionFlag {
|
||||||
|
fmt.Println(version)
|
||||||
|
os.Exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handle --completion early (no config needed)
|
||||||
|
if f.Changed("completion") {
|
||||||
|
shell, _ := f.GetString("completion")
|
||||||
|
return completions.Generate(cmd, shell, os.Stdout)
|
||||||
}
|
}
|
||||||
|
|
||||||
// get the user's home directory
|
// get the user's home directory
|
||||||
@@ -34,24 +147,9 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// read the envvars into a map of strings
|
// read the envvars into a map of strings
|
||||||
envvars := map[string]string{}
|
envvars := config.EnvVars()
|
||||||
for _, e := range os.Environ() {
|
|
||||||
// os.Environ() guarantees "key=value" format (see ADR-002)
|
|
||||||
pair := strings.SplitN(e, "=", 2)
|
|
||||||
if runtime.GOOS == "windows" {
|
|
||||||
pair[0] = strings.ToUpper(pair[0])
|
|
||||||
}
|
|
||||||
envvars[pair[0]] = pair[1]
|
|
||||||
}
|
|
||||||
|
|
||||||
// if --init was passed, we don't want to attempt to load a config file.
|
// identify the os-specific paths at which configs may be located
|
||||||
// Instead, just execute cmd_init and exit
|
|
||||||
if opts["--init"] == true {
|
|
||||||
cmdInit(home, envvars)
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
|
||||||
|
|
||||||
// identify the os-specifc paths at which configs may be located
|
|
||||||
confpaths, err := config.Paths(runtime.GOOS, home, envvars)
|
confpaths, err := config.Paths(runtime.GOOS, home, envvars)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "failed to load config: %v\n", err)
|
fmt.Fprintf(os.Stderr, "failed to load config: %v\n", err)
|
||||||
@@ -105,10 +203,11 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// filter the cheatpaths if --path was passed
|
// filter the cheatpaths if --path was passed
|
||||||
if opts["--path"] != nil {
|
if f.Changed("path") {
|
||||||
|
pathVal, _ := f.GetString("path")
|
||||||
conf.Cheatpaths, err = cheatpath.Filter(
|
conf.Cheatpaths, err = cheatpath.Filter(
|
||||||
conf.Cheatpaths,
|
conf.Cheatpaths,
|
||||||
opts["--path"].(string),
|
pathVal,
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(os.Stderr, "invalid option --path: %v\n", err)
|
fmt.Fprintf(os.Stderr, "invalid option --path: %v\n", err)
|
||||||
@@ -117,41 +216,44 @@ func main() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// determine which command to execute
|
// determine which command to execute
|
||||||
var cmd func(map[string]interface{}, config.Config)
|
confFlag, _ := f.GetBool("conf")
|
||||||
|
dirFlag, _ := f.GetBool("directories")
|
||||||
|
listFlag, _ := f.GetBool("list")
|
||||||
|
briefFlag, _ := f.GetBool("brief")
|
||||||
|
tagsFlag, _ := f.GetBool("tags")
|
||||||
|
tagVal, _ := f.GetString("tag")
|
||||||
|
|
||||||
switch {
|
switch {
|
||||||
case opts["--conf"].(bool):
|
case confFlag:
|
||||||
cmd = cmdConf
|
cmdConf(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--directories"].(bool):
|
case dirFlag:
|
||||||
cmd = cmdDirectories
|
cmdDirectories(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--edit"] != nil:
|
case f.Changed("edit"):
|
||||||
cmd = cmdEdit
|
cmdEdit(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--list"].(bool), opts["--brief"].(bool):
|
case listFlag, briefFlag:
|
||||||
cmd = cmdList
|
cmdList(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--tags"].(bool):
|
case tagsFlag:
|
||||||
cmd = cmdTags
|
cmdTags(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--search"] != nil:
|
case f.Changed("search"):
|
||||||
cmd = cmdSearch
|
cmdSearch(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--rm"] != nil:
|
case f.Changed("rm"):
|
||||||
cmd = cmdRemove
|
cmdRemove(cmd, args, conf)
|
||||||
|
|
||||||
case opts["<cheatsheet>"] != nil:
|
case len(args) > 0:
|
||||||
cmd = cmdView
|
cmdView(cmd, args, conf)
|
||||||
|
|
||||||
case opts["--tag"] != nil && opts["--tag"].(string) != "":
|
case tagVal != "":
|
||||||
cmd = cmdList
|
cmdList(cmd, args, conf)
|
||||||
|
|
||||||
default:
|
default:
|
||||||
fmt.Println(usage())
|
return cmd.Help()
|
||||||
os.Exit(0)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// execute the command
|
return nil
|
||||||
cmd(opts, conf)
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,65 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
// usage returns the usage text for the cheat command
|
|
||||||
func usage() string {
|
|
||||||
return `Usage:
|
|
||||||
cheat [options] [<cheatsheet>]
|
|
||||||
|
|
||||||
Options:
|
|
||||||
--init Write a default config file to stdout
|
|
||||||
-a --all Search among all cheatpaths
|
|
||||||
-b --brief List cheatsheets without file paths
|
|
||||||
-c --colorize Colorize output
|
|
||||||
-d --directories List cheatsheet directories
|
|
||||||
-e --edit=<cheatsheet> Edit <cheatsheet>
|
|
||||||
-l --list List cheatsheets
|
|
||||||
-p --path=<name> Return only sheets found on cheatpath <name>
|
|
||||||
-r --regex Treat search <phrase> as a regex
|
|
||||||
-s --search=<phrase> Search cheatsheets for <phrase>
|
|
||||||
-t --tag=<tag> Return only sheets matching <tag>
|
|
||||||
-T --tags List all tags in use
|
|
||||||
-v --version Print the version number
|
|
||||||
--rm=<cheatsheet> Remove (delete) <cheatsheet>
|
|
||||||
--conf Display the config file path
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
To initialize a config file:
|
|
||||||
mkdir -p ~/.config/cheat && cheat --init > ~/.config/cheat/conf.yml
|
|
||||||
|
|
||||||
To view the tar cheatsheet:
|
|
||||||
cheat tar
|
|
||||||
|
|
||||||
To edit (or create) the foo cheatsheet:
|
|
||||||
cheat -e foo
|
|
||||||
|
|
||||||
To edit (or create) the foo/bar cheatsheet on the "work" cheatpath:
|
|
||||||
cheat -p work -e foo/bar
|
|
||||||
|
|
||||||
To view all cheatsheet directories:
|
|
||||||
cheat -d
|
|
||||||
|
|
||||||
To list all available cheatsheets:
|
|
||||||
cheat -l
|
|
||||||
|
|
||||||
To briefly list all cheatsheets whose titles match "apt":
|
|
||||||
cheat -b apt
|
|
||||||
|
|
||||||
To list all tags in use:
|
|
||||||
cheat -T
|
|
||||||
|
|
||||||
To list available cheatsheets that are tagged as "personal":
|
|
||||||
cheat -l -t personal
|
|
||||||
|
|
||||||
To search for "ssh" among all cheatsheets, and colorize matches:
|
|
||||||
cheat -c -s ssh
|
|
||||||
|
|
||||||
To search (by regex) for cheatsheets that contain an IP address:
|
|
||||||
cheat -c -r -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
|
|
||||||
|
|
||||||
To remove (delete) the foo/bar cheatsheet:
|
|
||||||
cheat --rm foo/bar
|
|
||||||
|
|
||||||
To view the configuration file path:
|
|
||||||
cheat --conf`
|
|
||||||
}
|
|
||||||
66
doc/cheat.1
66
doc/cheat.1
@@ -58,6 +58,11 @@ Print the version number.
|
|||||||
.TP
|
.TP
|
||||||
\[en]rm=\f[I]CHEATSHEET\f[R]
|
\[en]rm=\f[I]CHEATSHEET\f[R]
|
||||||
Remove (deletes) \f[I]CHEATSHEET\f[R].
|
Remove (deletes) \f[I]CHEATSHEET\f[R].
|
||||||
|
.TP
|
||||||
|
\[en]completion=\f[I]SHELL\f[R]
|
||||||
|
Generate a shell completion script.
|
||||||
|
\f[I]SHELL\f[R] must be one of: \f[B]bash\f[R], \f[B]zsh\f[R],
|
||||||
|
\f[B]fish\f[R], \f[B]powershell\f[R].
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
.TP
|
.TP
|
||||||
To view the foo cheatsheet:
|
To view the foo cheatsheet:
|
||||||
@@ -135,37 +140,52 @@ Cheatpaths may be configured in \f[I]conf.yaml\f[R], and viewed via
|
|||||||
For detailed instructions on how to configure cheatpaths, please refer
|
For detailed instructions on how to configure cheatpaths, please refer
|
||||||
to the comments in conf.yml.
|
to the comments in conf.yml.
|
||||||
.SS Autocompletion
|
.SS Autocompletion
|
||||||
Autocompletion scripts for \f[B]bash\f[R], \f[B]zsh\f[R], and
|
\f[B]cheat\f[R] can generate shell completion scripts for
|
||||||
\f[B]fish\f[R] are available for download:
|
\f[B]bash\f[R], \f[B]zsh\f[R], \f[B]fish\f[R], and \f[B]powershell\f[R]
|
||||||
.IP \[bu] 2
|
via the \f[B]\[en]completion\f[R] flag:
|
||||||
\c
|
.IP
|
||||||
.UR https://github.com/cheat/cheat/blob/master/scripts/cheat.bash
|
.EX
|
||||||
.UE \c
|
cheat \-\-completion bash
|
||||||
.IP \[bu] 2
|
cheat \-\-completion zsh
|
||||||
\c
|
cheat \-\-completion fish
|
||||||
.UR https://github.com/cheat/cheat/blob/master/scripts/cheat.fish
|
cheat \-\-completion powershell
|
||||||
.UE \c
|
.EE
|
||||||
.IP \[bu] 2
|
|
||||||
\c
|
|
||||||
.UR https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh
|
|
||||||
.UE \c
|
|
||||||
.PP
|
.PP
|
||||||
The \f[B]bash\f[R] and \f[B]zsh\f[R] scripts provide optional
|
Completions are dynamically generated and include cheatsheet names,
|
||||||
integration with \f[B]fzf\f[R], if the latter is available on your
|
tags, and cheatpath names.
|
||||||
\f[B]PATH\f[R].
|
|
||||||
.PP
|
.PP
|
||||||
The installation process will vary per system and shell configuration,
|
To install completions, pipe the output to the appropriate location for
|
||||||
and thus will not be discussed here.
|
your shell.
|
||||||
|
For example, on \f[B]bash\f[R]:
|
||||||
|
.IP
|
||||||
|
.EX
|
||||||
|
cheat \-\-completion bash > /etc/bash_completion.d/cheat
|
||||||
|
.EE
|
||||||
|
.PP
|
||||||
|
Or for the current user only:
|
||||||
|
.IP
|
||||||
|
.EX
|
||||||
|
cheat \-\-completion bash > \[ti]/.local/share/bash\-completion/completions/cheat
|
||||||
|
.EE
|
||||||
|
.PP
|
||||||
|
For \f[B]zsh\f[R], you may need to add the completions directory to your
|
||||||
|
\f[B]fpath\f[R]:
|
||||||
|
.IP
|
||||||
|
.EX
|
||||||
|
cheat \-\-completion zsh > \[dq]${fpath[1]}/_cheat\[dq]
|
||||||
|
.EE
|
||||||
|
.PP
|
||||||
|
For \f[B]fish\f[R]:
|
||||||
|
.IP
|
||||||
|
.EX
|
||||||
|
cheat \-\-completion fish > \[ti]/.config/fish/completions/cheat.fish
|
||||||
|
.EE
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
.TP
|
.TP
|
||||||
\f[B]CHEAT_CONFIG_PATH\f[R]
|
\f[B]CHEAT_CONFIG_PATH\f[R]
|
||||||
The path at which the config file is available.
|
The path at which the config file is available.
|
||||||
If \f[B]CHEAT_CONFIG_PATH\f[R] is set, all other config paths will be
|
If \f[B]CHEAT_CONFIG_PATH\f[R] is set, all other config paths will be
|
||||||
ignored.
|
ignored.
|
||||||
.TP
|
|
||||||
\f[B]CHEAT_USE_FZF\f[R]
|
|
||||||
If set, autocompletion scripts will attempt to integrate with
|
|
||||||
\f[B]fzf\f[R].
|
|
||||||
.SH RETURN VALUES
|
.SH RETURN VALUES
|
||||||
.IP "0." 3
|
.IP "0." 3
|
||||||
Successful termination
|
Successful termination
|
||||||
|
|||||||
@@ -65,6 +65,10 @@ OPTIONS
|
|||||||
--rm=_CHEATSHEET_
|
--rm=_CHEATSHEET_
|
||||||
: Remove (deletes) _CHEATSHEET_.
|
: Remove (deletes) _CHEATSHEET_.
|
||||||
|
|
||||||
|
--completion=_SHELL_
|
||||||
|
: Generate a shell completion script. _SHELL_ must be one of: **bash**,
|
||||||
|
**zsh**, **fish**, **powershell**.
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES
|
EXAMPLES
|
||||||
========
|
========
|
||||||
@@ -149,18 +153,33 @@ comments in conf.yml.
|
|||||||
|
|
||||||
Autocompletion
|
Autocompletion
|
||||||
--------------
|
--------------
|
||||||
Autocompletion scripts for **bash**, **zsh**, and **fish** are available for
|
**cheat** can generate shell completion scripts for **bash**, **zsh**,
|
||||||
download:
|
**fish**, and **powershell** via the **--completion** flag:
|
||||||
|
|
||||||
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.bash>
|
cheat --completion bash
|
||||||
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.fish>
|
cheat --completion zsh
|
||||||
- <https://github.com/cheat/cheat/blob/master/scripts/cheat.zsh>
|
cheat --completion fish
|
||||||
|
cheat --completion powershell
|
||||||
|
|
||||||
The **bash** and **zsh** scripts provide optional integration with **fzf**, if
|
Completions are dynamically generated and include cheatsheet names, tags, and
|
||||||
the latter is available on your **PATH**.
|
cheatpath names.
|
||||||
|
|
||||||
The installation process will vary per system and shell configuration, and thus
|
To install completions, pipe the output to the appropriate location for your
|
||||||
will not be discussed here.
|
shell. For example, on **bash**:
|
||||||
|
|
||||||
|
cheat --completion bash > /etc/bash_completion.d/cheat
|
||||||
|
|
||||||
|
Or for the current user only:
|
||||||
|
|
||||||
|
cheat --completion bash > ~/.local/share/bash-completion/completions/cheat
|
||||||
|
|
||||||
|
For **zsh**, you may need to add the completions directory to your **fpath**:
|
||||||
|
|
||||||
|
cheat --completion zsh > "${fpath[1]}/_cheat"
|
||||||
|
|
||||||
|
For **fish**:
|
||||||
|
|
||||||
|
cheat --completion fish > ~/.config/fish/completions/cheat.fish
|
||||||
|
|
||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
@@ -171,10 +190,6 @@ ENVIRONMENT
|
|||||||
: The path at which the config file is available. If **CHEAT_CONFIG_PATH** is
|
: The path at which the config file is available. If **CHEAT_CONFIG_PATH** is
|
||||||
set, all other config paths will be ignored.
|
set, all other config paths will be ignored.
|
||||||
|
|
||||||
**CHEAT_USE_FZF**
|
|
||||||
|
|
||||||
: If set, autocompletion scripts will attempt to integrate with **fzf**.
|
|
||||||
|
|
||||||
RETURN VALUES
|
RETURN VALUES
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
|||||||
4
go.mod
4
go.mod
@@ -5,10 +5,10 @@ go 1.26
|
|||||||
require (
|
require (
|
||||||
github.com/alecthomas/chroma/v2 v2.23.1
|
github.com/alecthomas/chroma/v2 v2.23.1
|
||||||
github.com/davecgh/go-spew v1.1.1
|
github.com/davecgh/go-spew v1.1.1
|
||||||
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815
|
|
||||||
github.com/go-git/go-git/v5 v5.16.5
|
github.com/go-git/go-git/v5 v5.16.5
|
||||||
github.com/mattn/go-isatty v0.0.20
|
github.com/mattn/go-isatty v0.0.20
|
||||||
github.com/mitchellh/go-homedir v1.1.0
|
github.com/mitchellh/go-homedir v1.1.0
|
||||||
|
github.com/spf13/cobra v1.10.2
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -23,12 +23,14 @@ require (
|
|||||||
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
|
github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
|
||||||
github.com/go-git/go-billy/v5 v5.7.0 // indirect
|
github.com/go-git/go-billy/v5 v5.7.0 // indirect
|
||||||
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
|
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
|
||||||
|
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||||
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
|
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
|
||||||
github.com/kevinburke/ssh_config v1.5.0 // indirect
|
github.com/kevinburke/ssh_config v1.5.0 // indirect
|
||||||
github.com/klauspost/cpuid/v2 v2.3.0 // indirect
|
github.com/klauspost/cpuid/v2 v2.3.0 // indirect
|
||||||
github.com/pjbgf/sha1cd v0.5.0 // indirect
|
github.com/pjbgf/sha1cd v0.5.0 // indirect
|
||||||
github.com/sergi/go-diff v1.4.0 // indirect
|
github.com/sergi/go-diff v1.4.0 // indirect
|
||||||
github.com/skeema/knownhosts v1.3.2 // indirect
|
github.com/skeema/knownhosts v1.3.2 // indirect
|
||||||
|
github.com/spf13/pflag v1.0.9 // indirect
|
||||||
github.com/xanzy/ssh-agent v0.3.3 // indirect
|
github.com/xanzy/ssh-agent v0.3.3 // indirect
|
||||||
golang.org/x/crypto v0.48.0 // indirect
|
golang.org/x/crypto v0.48.0 // indirect
|
||||||
golang.org/x/net v0.50.0 // indirect
|
golang.org/x/net v0.50.0 // indirect
|
||||||
|
|||||||
11
go.sum
11
go.sum
@@ -17,6 +17,7 @@ github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPd
|
|||||||
github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
|
github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
|
||||||
github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8=
|
github.com/cloudflare/circl v1.6.3 h1:9GPOhQGF9MCYUeXyMYlqTR6a5gTrgR/fBLXvUgtVcg8=
|
||||||
github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4=
|
github.com/cloudflare/circl v1.6.3/go.mod h1:2eXP6Qfat4O/Yhh8BznvKnJ+uzEoTQ6jVKJRn81BiS4=
|
||||||
|
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
|
||||||
github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE=
|
github.com/cyphar/filepath-securejoin v0.6.1 h1:5CeZ1jPXEiYt3+Z6zqprSAgSWiggmpVyciv8syjIpVE=
|
||||||
github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc=
|
github.com/cyphar/filepath-securejoin v0.6.1/go.mod h1:A8hd4EnAeyujCJRrICiOWqjS1AX0a9kM5XL+NwKoYSc=
|
||||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
@@ -24,8 +25,6 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
|
|||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/dlclark/regexp2 v1.11.5 h1:Q/sSnsKerHeCkc/jSTNq1oCm7KiVgUMZRDUoRu0JQZQ=
|
github.com/dlclark/regexp2 v1.11.5 h1:Q/sSnsKerHeCkc/jSTNq1oCm7KiVgUMZRDUoRu0JQZQ=
|
||||||
github.com/dlclark/regexp2 v1.11.5/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
github.com/dlclark/regexp2 v1.11.5/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
||||||
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 h1:bWDMxwH3px2JBh6AyO7hdCn/PkvCZXii8TGj7sbtEbQ=
|
|
||||||
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
|
|
||||||
github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o=
|
github.com/elazarl/goproxy v1.7.2 h1:Y2o6urb7Eule09PjlhQRGNsqRfPmYI3KKQLFpCAV3+o=
|
||||||
github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE=
|
github.com/elazarl/goproxy v1.7.2/go.mod h1:82vkLNir0ALaW14Rc399OTTjyNREgmdL2cVoIbS6XaE=
|
||||||
github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
|
github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc=
|
||||||
@@ -46,6 +45,8 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
|||||||
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
||||||
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
|
github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM=
|
||||||
github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
|
github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg=
|
||||||
|
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
|
||||||
|
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
|
||||||
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
|
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
|
||||||
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
|
github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
|
||||||
github.com/kevinburke/ssh_config v1.5.0 h1:3cPZmE54xb5j3G5xQCjSvokqNwU2uW+3ry1+PRLSPpA=
|
github.com/kevinburke/ssh_config v1.5.0 h1:3cPZmE54xb5j3G5xQCjSvokqNwU2uW+3ry1+PRLSPpA=
|
||||||
@@ -73,11 +74,16 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
|
|||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
|
||||||
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
|
||||||
|
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||||
github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw=
|
github.com/sergi/go-diff v1.4.0 h1:n/SP9D5ad1fORl+llWyN+D6qoUETXNZARKjyY2/KVCw=
|
||||||
github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4=
|
github.com/sergi/go-diff v1.4.0/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4=
|
||||||
github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
|
github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
|
||||||
github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg=
|
github.com/skeema/knownhosts v1.3.2 h1:EDL9mgf4NzwMXCTfaxSD/o/a5fxDw/xL9nkU28JjdBg=
|
||||||
github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow=
|
github.com/skeema/knownhosts v1.3.2/go.mod h1:bEg3iQAuw+jyiw+484wwFJoKSLwcfd7fqRy+N0QTiow=
|
||||||
|
github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
|
||||||
|
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
|
||||||
|
github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
|
||||||
|
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
||||||
@@ -85,6 +91,7 @@ github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu
|
|||||||
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||||
github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
|
github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
|
||||||
github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
|
github.com/xanzy/ssh-agent v0.3.3/go.mod h1:6dzNDKs0J9rVPHPhaGCukekBHKqfl+L3KghI1Bc68Uw=
|
||||||
|
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
||||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||||
golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=
|
golang.org/x/crypto v0.48.0 h1:/VRzVqiRSggnhY7gNRxPauEQ5Drw9haKdM0jqfcCFts=
|
||||||
golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=
|
golang.org/x/crypto v0.48.0/go.mod h1:r0kV5h3qnFPlQnBSrULhlsRfryS2pmewsg+XfMgkVos=
|
||||||
|
|||||||
43
internal/completions/cheatsheets.go
Normal file
43
internal/completions/cheatsheets.go
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
// Package completions provides dynamic shell completion functions and
|
||||||
|
// completion script generation for the cheat CLI.
|
||||||
|
package completions
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Cheatsheets provides completion for cheatsheet names.
|
||||||
|
func Cheatsheets(
|
||||||
|
_ *cobra.Command,
|
||||||
|
args []string,
|
||||||
|
_ string,
|
||||||
|
) ([]string, cobra.ShellCompDirective) {
|
||||||
|
|
||||||
|
if len(args) > 0 {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
conf, err := loadConfig()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
consolidated := sheets.Consolidate(cheatsheets)
|
||||||
|
|
||||||
|
names := make([]string, 0, len(consolidated))
|
||||||
|
for name := range consolidated {
|
||||||
|
names = append(names, name)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
|
||||||
|
return names, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
38
internal/completions/config.go
Normal file
38
internal/completions/config.go
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
package completions
|
||||||
|
|
||||||
|
import (
|
||||||
|
"runtime"
|
||||||
|
|
||||||
|
"github.com/mitchellh/go-homedir"
|
||||||
|
|
||||||
|
"github.com/cheat/cheat/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// loadConfig loads the cheat configuration for use in completion functions.
|
||||||
|
// It returns an error rather than exiting, since completions should degrade
|
||||||
|
// gracefully.
|
||||||
|
func loadConfig() (config.Config, error) {
|
||||||
|
home, err := homedir.Dir()
|
||||||
|
if err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
envvars := config.EnvVars()
|
||||||
|
|
||||||
|
confpaths, err := config.Paths(runtime.GOOS, home, envvars)
|
||||||
|
if err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
confpath, err := config.Path(confpaths)
|
||||||
|
if err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
conf, err := config.New(confpath, true)
|
||||||
|
if err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return conf, nil
|
||||||
|
}
|
||||||
24
internal/completions/generate.go
Normal file
24
internal/completions/generate.go
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
package completions
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Generate writes a shell completion script to the given writer.
|
||||||
|
func Generate(cmd *cobra.Command, shell string, w io.Writer) error {
|
||||||
|
switch shell {
|
||||||
|
case "bash":
|
||||||
|
return cmd.Root().GenBashCompletionV2(w, true)
|
||||||
|
case "zsh":
|
||||||
|
return cmd.Root().GenZshCompletion(w)
|
||||||
|
case "fish":
|
||||||
|
return cmd.Root().GenFishCompletion(w, true)
|
||||||
|
case "powershell":
|
||||||
|
return cmd.Root().GenPowerShellCompletionWithDesc(w)
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("unsupported shell: %s (valid: bash, zsh, fish, powershell)", shell)
|
||||||
|
}
|
||||||
|
}
|
||||||
25
internal/completions/paths.go
Normal file
25
internal/completions/paths.go
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
package completions
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Paths provides completion for the --path flag.
|
||||||
|
func Paths(
|
||||||
|
_ *cobra.Command,
|
||||||
|
_ []string,
|
||||||
|
_ string,
|
||||||
|
) ([]string, cobra.ShellCompDirective) {
|
||||||
|
|
||||||
|
conf, err := loadConfig()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
names := make([]string, 0, len(conf.Cheatpaths))
|
||||||
|
for _, cp := range conf.Cheatpaths {
|
||||||
|
names = append(names, cp.Name)
|
||||||
|
}
|
||||||
|
|
||||||
|
return names, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
27
internal/completions/tags.go
Normal file
27
internal/completions/tags.go
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
package completions
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"github.com/cheat/cheat/internal/sheets"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Tags provides completion for the --tag flag.
|
||||||
|
func Tags(
|
||||||
|
_ *cobra.Command,
|
||||||
|
_ []string,
|
||||||
|
_ string,
|
||||||
|
) ([]string, cobra.ShellCompDirective) {
|
||||||
|
|
||||||
|
conf, err := loadConfig()
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
cheatsheets, err := sheets.Load(conf.Cheatpaths)
|
||||||
|
if err != nil {
|
||||||
|
return nil, cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
|
|
||||||
|
return sheets.Tags(cheatsheets), cobra.ShellCompDirectiveNoFileComp
|
||||||
|
}
|
||||||
@@ -7,7 +7,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
// Color indicates whether colorization should be applied to the output
|
// Color indicates whether colorization should be applied to the output
|
||||||
func (c *Config) Color(opts map[string]interface{}) bool {
|
func (c *Config) Color(forceColorize bool) bool {
|
||||||
|
|
||||||
// default to the colorization specified in the configs...
|
// default to the colorization specified in the configs...
|
||||||
colorize := c.Colorize
|
colorize := c.Colorize
|
||||||
@@ -18,7 +18,7 @@ func (c *Config) Color(opts map[string]interface{}) bool {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ... *unless* the --colorize flag was passed
|
// ... *unless* the --colorize flag was passed
|
||||||
if opts["--colorize"] == true {
|
if forceColorize {
|
||||||
colorize = true
|
colorize = true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -10,13 +10,11 @@ func TestColor(t *testing.T) {
|
|||||||
// mock a config
|
// mock a config
|
||||||
conf := Config{}
|
conf := Config{}
|
||||||
|
|
||||||
opts := map[string]interface{}{"--colorize": false}
|
if conf.Color(false) {
|
||||||
if conf.Color(opts) {
|
t.Errorf("failed to respect forceColorize (false)")
|
||||||
t.Errorf("failed to respect --colorize (false)")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
opts = map[string]interface{}{"--colorize": true}
|
if !conf.Color(true) {
|
||||||
if !conf.Color(opts) {
|
t.Errorf("failed to respect forceColorize (true)")
|
||||||
t.Errorf("failed to respect --colorize (true)")
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
20
internal/config/env.go
Normal file
20
internal/config/env.go
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// EnvVars reads environment variables into a map of strings.
|
||||||
|
func EnvVars() map[string]string {
|
||||||
|
envvars := map[string]string{}
|
||||||
|
for _, e := range os.Environ() {
|
||||||
|
pair := strings.SplitN(e, "=", 2)
|
||||||
|
if runtime.GOOS == "windows" {
|
||||||
|
pair[0] = strings.ToUpper(pair[0])
|
||||||
|
}
|
||||||
|
envvars[pair[0]] = pair[1]
|
||||||
|
}
|
||||||
|
return envvars
|
||||||
|
}
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
# cheat(1) completion -*- shell-script -*-
|
|
||||||
|
|
||||||
# generate cheatsheet completions, optionally using `fzf`
|
|
||||||
_cheat_complete_cheatsheets()
|
|
||||||
{
|
|
||||||
if [[ "$CHEAT_USE_FZF" = true ]]; then
|
|
||||||
FZF_COMPLETION_TRIGGER='' _fzf_complete "--no-multi" "$@" < <(
|
|
||||||
cheat -l | tail -n +2 | cut -d' ' -f1
|
|
||||||
)
|
|
||||||
else
|
|
||||||
COMPREPLY=( $(compgen -W "$(cheat -l | tail -n +2 | cut -d' ' -f1)" -- "$cur") )
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# generate tag completions, optionally using `fzf`
|
|
||||||
_cheat_complete_tags()
|
|
||||||
{
|
|
||||||
if [ "$CHEAT_USE_FZF" = true ]; then
|
|
||||||
FZF_COMPLETION_TRIGGER='' _fzf_complete "--no-multi" "$@" < <(cheat -T)
|
|
||||||
else
|
|
||||||
COMPREPLY=( $(compgen -W "$(cheat -T)" -- "$cur") )
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# implement the `cheat` autocompletions
|
|
||||||
_cheat()
|
|
||||||
{
|
|
||||||
local cur prev words cword split
|
|
||||||
_init_completion -s || return
|
|
||||||
|
|
||||||
# complete options that are currently being typed: `--col` => `--colorize`
|
|
||||||
if [[ $cur == -* ]]; then
|
|
||||||
COMPREPLY=( $(compgen -W '$(_parse_help "$1" | sed "s/=//g")' -- "$cur") )
|
|
||||||
[[ $COMPREPLY == *= ]] && compopt -o nospace
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
# implement completions
|
|
||||||
case $prev in
|
|
||||||
--colorize|-c|\
|
|
||||||
--directories|-d|\
|
|
||||||
--init|\
|
|
||||||
--regex|-r|\
|
|
||||||
--search|-s|\
|
|
||||||
--tags|-T|\
|
|
||||||
--version|-v)
|
|
||||||
# noop the above, which should implement no completions
|
|
||||||
;;
|
|
||||||
--edit|-e)
|
|
||||||
_cheat_complete_cheatsheets
|
|
||||||
;;
|
|
||||||
--list|-l)
|
|
||||||
_cheat_complete_cheatsheets
|
|
||||||
;;
|
|
||||||
--path|-p)
|
|
||||||
COMPREPLY=( $(compgen -W "$(cheat -d | cut -d':' -f1)" -- "$cur") )
|
|
||||||
;;
|
|
||||||
--rm)
|
|
||||||
_cheat_complete_cheatsheets
|
|
||||||
;;
|
|
||||||
--tag|-t)
|
|
||||||
_cheat_complete_tags
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
_cheat_complete_cheatsheets
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
|
|
||||||
$split && return
|
|
||||||
|
|
||||||
} &&
|
|
||||||
complete -F _cheat cheat
|
|
||||||
|
|
||||||
# ex: filetype=sh
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
complete -c cheat -f -a "(cheat -l | tail -n +2 | cut -d ' ' -f 1)"
|
|
||||||
complete -c cheat -l init -d "Write a default config file to stdout"
|
|
||||||
complete -c cheat -s c -l colorize -d "Colorize output"
|
|
||||||
complete -c cheat -s d -l directories -d "List cheatsheet directories"
|
|
||||||
complete -c cheat -s e -l edit -x -a "(cheat -l | tail -n +2 | cut -d ' ' -f 1)" -d "Edit cheatsheet"
|
|
||||||
complete -c cheat -s l -l list -d "List cheatsheets"
|
|
||||||
complete -c cheat -s p -l path -x -a "(cheat -d | cut -d ':' -f 1)" -d "Return only sheets found on given path"
|
|
||||||
complete -c cheat -s r -l regex -d "Treat search phrase as a regex"
|
|
||||||
complete -c cheat -s s -l search -x -d "Search cheatsheets for given phrase"
|
|
||||||
complete -c cheat -s t -l tag -x -a "(cheat -T)" -d "Return only sheets matching the given tag"
|
|
||||||
complete -c cheat -s T -l tags -d "List all tags in use"
|
|
||||||
complete -c cheat -s v -l version -d "Print the version number"
|
|
||||||
complete -c cheat -l rm -x -a "(cheat -l | tail -n +2 | cut -d ' ' -f 1)" -d "Remove (delete) cheatsheet"
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
#compdef cheat
|
|
||||||
|
|
||||||
local cheats taglist pathlist
|
|
||||||
|
|
||||||
_cheat_complete_personal_cheatsheets()
|
|
||||||
{
|
|
||||||
cheats=("${(f)$(cheat -l -t personal | tail -n +2 | cut -d' ' -f1)}")
|
|
||||||
_describe -t cheats 'cheats' cheats
|
|
||||||
}
|
|
||||||
|
|
||||||
_cheat_complete_full_cheatsheets()
|
|
||||||
{
|
|
||||||
cheats=("${(f)$(cheat -l | tail -n +2 | cut -d' ' -f1)}")
|
|
||||||
_describe -t cheats 'cheats' cheats
|
|
||||||
}
|
|
||||||
|
|
||||||
_cheat_complete_tags()
|
|
||||||
{
|
|
||||||
taglist=("${(f)$(cheat -T)}")
|
|
||||||
_describe -t taglist 'taglist' taglist
|
|
||||||
}
|
|
||||||
|
|
||||||
_cheat_complete_paths()
|
|
||||||
{
|
|
||||||
pathlist=("${(f)$(cheat -d | cut -d':' -f1)}")
|
|
||||||
_describe -t pathlist 'pathlist' pathlist
|
|
||||||
}
|
|
||||||
|
|
||||||
_cheat() {
|
|
||||||
|
|
||||||
_arguments -C \
|
|
||||||
'(--init)--init[Write a default config file to stdout]: :->none' \
|
|
||||||
'(-c --colorize)'{-c,--colorize}'[Colorize output]: :->none' \
|
|
||||||
'(-d --directories)'{-d,--directories}'[List cheatsheet directories]: :->none' \
|
|
||||||
'(-e --edit)'{-e,--edit}'[Edit <sheet>]: :->personal' \
|
|
||||||
'(-l --list)'{-l,--list}'[List cheatsheets]: :->full' \
|
|
||||||
'(-p --path)'{-p,--path}'[Return only sheets found on path <name>]: :->pathlist' \
|
|
||||||
'(-r --regex)'{-r,--regex}'[Treat search <phrase> as a regex]: :->none' \
|
|
||||||
'(-s --search)'{-s,--search}'[Search cheatsheets for <phrase>]: :->none' \
|
|
||||||
'(-t --tag)'{-t,--tag}'[Return only sheets matching <tag>]: :->taglist' \
|
|
||||||
'(-T --tags)'{-T,--tags}'[List all tags in use]: :->none' \
|
|
||||||
'(-v --version)'{-v,--version}'[Print the version number]: :->none' \
|
|
||||||
'(--rm)--rm[Remove (delete) <sheet>]: :->personal'
|
|
||||||
|
|
||||||
case $state in
|
|
||||||
(none)
|
|
||||||
;;
|
|
||||||
(full)
|
|
||||||
_cheat_complete_full_cheatsheets
|
|
||||||
;;
|
|
||||||
(personal)
|
|
||||||
_cheat_complete_personal_cheatsheets
|
|
||||||
;;
|
|
||||||
(taglist)
|
|
||||||
_cheat_complete_tags
|
|
||||||
;;
|
|
||||||
(pathlist)
|
|
||||||
_cheat_complete_paths
|
|
||||||
;;
|
|
||||||
(*)
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
|
|
||||||
compdef _cheat cheat
|
|
||||||
32
vendor/github.com/docopt/docopt-go/.travis.yml
generated
vendored
32
vendor/github.com/docopt/docopt-go/.travis.yml
generated
vendored
@@ -1,32 +0,0 @@
|
|||||||
# Travis CI (http://travis-ci.org/) is a continuous integration
|
|
||||||
# service for open source projects. This file configures it
|
|
||||||
# to run unit tests for docopt-go.
|
|
||||||
|
|
||||||
language: go
|
|
||||||
|
|
||||||
go:
|
|
||||||
- 1.4
|
|
||||||
- 1.5
|
|
||||||
- 1.6
|
|
||||||
- 1.7
|
|
||||||
- 1.8
|
|
||||||
- 1.9
|
|
||||||
- tip
|
|
||||||
|
|
||||||
matrix:
|
|
||||||
fast_finish: true
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- go get golang.org/x/tools/cmd/cover
|
|
||||||
- go get github.com/mattn/goveralls
|
|
||||||
|
|
||||||
install:
|
|
||||||
- go get -d -v ./... && go build -v ./...
|
|
||||||
|
|
||||||
script:
|
|
||||||
- go vet -x ./...
|
|
||||||
- go test -v ./...
|
|
||||||
- go test -covermode=count -coverprofile=profile.cov .
|
|
||||||
|
|
||||||
after_script:
|
|
||||||
- $HOME/gopath/bin/goveralls -coverprofile=profile.cov -service=travis-ci
|
|
||||||
21
vendor/github.com/docopt/docopt-go/LICENSE
generated
vendored
21
vendor/github.com/docopt/docopt-go/LICENSE
generated
vendored
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2013 Keith Batten
|
|
||||||
Copyright (c) 2016 David Irvine
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
||||||
this software and associated documentation files (the "Software"), to deal in
|
|
||||||
the Software without restriction, including without limitation the rights to
|
|
||||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
||||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
||||||
subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
||||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
||||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
||||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
||||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
116
vendor/github.com/docopt/docopt-go/README.md
generated
vendored
116
vendor/github.com/docopt/docopt-go/README.md
generated
vendored
@@ -1,116 +0,0 @@
|
|||||||
docopt-go
|
|
||||||
=========
|
|
||||||
|
|
||||||
[](https://travis-ci.org/docopt/docopt.go)
|
|
||||||
[](https://coveralls.io/github/docopt/docopt.go)
|
|
||||||
[](https://godoc.org/github.com/docopt/docopt.go)
|
|
||||||
|
|
||||||
An implementation of [docopt](http://docopt.org/) in the [Go](http://golang.org/) programming language.
|
|
||||||
|
|
||||||
**docopt** helps you create *beautiful* command-line interfaces easily:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"github.com/docopt/docopt-go"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
usage := `Naval Fate.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
naval_fate ship new <name>...
|
|
||||||
naval_fate ship <name> move <x> <y> [--speed=<kn>]
|
|
||||||
naval_fate ship shoot <x> <y>
|
|
||||||
naval_fate mine (set|remove) <x> <y> [--moored|--drifting]
|
|
||||||
naval_fate -h | --help
|
|
||||||
naval_fate --version
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-h --help Show this screen.
|
|
||||||
--version Show version.
|
|
||||||
--speed=<kn> Speed in knots [default: 10].
|
|
||||||
--moored Moored (anchored) mine.
|
|
||||||
--drifting Drifting mine.`
|
|
||||||
|
|
||||||
arguments, _ := docopt.ParseDoc(usage)
|
|
||||||
fmt.Println(arguments)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**docopt** parses command-line arguments based on a help message. Don't write parser code: a good help message already has all the necessary information in it.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
⚠ Use the alias "docopt-go". To use docopt in your Go code:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import "github.com/docopt/docopt-go"
|
|
||||||
```
|
|
||||||
|
|
||||||
To install docopt in your `$GOPATH`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ go get github.com/docopt/docopt-go
|
|
||||||
```
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
Given a conventional command-line help message, docopt processes the arguments. See https://github.com/docopt/docopt#help-message-format for a description of the help message format.
|
|
||||||
|
|
||||||
This package exposes three different APIs, depending on the level of control required. The first, simplest way to parse your docopt usage is to just call:
|
|
||||||
|
|
||||||
```go
|
|
||||||
docopt.ParseDoc(usage)
|
|
||||||
```
|
|
||||||
|
|
||||||
This will use `os.Args[1:]` as the argv slice, and use the default parser options. If you want to provide your own version string and args, then use:
|
|
||||||
|
|
||||||
```go
|
|
||||||
docopt.ParseArgs(usage, argv, "1.2.3")
|
|
||||||
```
|
|
||||||
|
|
||||||
If the last parameter (version) is a non-empty string, it will be printed when `--version` is given in the argv slice. Finally, we can instantiate our own `docopt.Parser` which gives us control over how things like help messages are printed and whether to exit after displaying usage messages, etc.
|
|
||||||
|
|
||||||
```go
|
|
||||||
parser := &docopt.Parser{
|
|
||||||
HelpHandler: docopt.PrintHelpOnly,
|
|
||||||
OptionsFirst: true,
|
|
||||||
}
|
|
||||||
opts, err := parser.ParseArgs(usage, argv, "")
|
|
||||||
```
|
|
||||||
|
|
||||||
In particular, setting your own custom `HelpHandler` function makes unit testing your own docs with example command line invocations much more enjoyable.
|
|
||||||
|
|
||||||
All three of these return a map of option names to the values parsed from argv, and an error or nil. You can get the values using the helpers, or just treat it as a regular map:
|
|
||||||
|
|
||||||
```go
|
|
||||||
flag, _ := opts.Bool("--flag")
|
|
||||||
secs, _ := opts.Int("<seconds>")
|
|
||||||
```
|
|
||||||
|
|
||||||
Additionally, you can `Bind` these to a struct, assigning option values to the
|
|
||||||
exported fields of that struct, all at once.
|
|
||||||
|
|
||||||
```go
|
|
||||||
var config struct {
|
|
||||||
Command string `docopt:"<cmd>"`
|
|
||||||
Tries int `docopt:"-n"`
|
|
||||||
Force bool // Gets the value of --force
|
|
||||||
}
|
|
||||||
opts.Bind(&config)
|
|
||||||
```
|
|
||||||
|
|
||||||
More documentation is available at [godoc.org](https://godoc.org/github.com/docopt/docopt-go).
|
|
||||||
|
|
||||||
## Unit Testing
|
|
||||||
|
|
||||||
Unit testing your own usage docs is recommended, so you can be sure that for a given command line invocation, the expected options are set. An example of how to do this is [in the examples folder](examples/unit_test/unit_test.go).
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
All tests from the Python version are implemented and passing at [Travis CI](https://travis-ci.org/docopt/docopt-go). New language-agnostic tests have been added to [test_golang.docopt](test_golang.docopt).
|
|
||||||
|
|
||||||
To run tests for docopt-go, use `go test`.
|
|
||||||
49
vendor/github.com/docopt/docopt-go/doc.go
generated
vendored
49
vendor/github.com/docopt/docopt-go/doc.go
generated
vendored
@@ -1,49 +0,0 @@
|
|||||||
/*
|
|
||||||
Package docopt parses command-line arguments based on a help message.
|
|
||||||
|
|
||||||
Given a conventional command-line help message, docopt processes the arguments.
|
|
||||||
See https://github.com/docopt/docopt#help-message-format for a description of
|
|
||||||
the help message format.
|
|
||||||
|
|
||||||
This package exposes three different APIs, depending on the level of control
|
|
||||||
required. The first, simplest way to parse your docopt usage is to just call:
|
|
||||||
|
|
||||||
docopt.ParseDoc(usage)
|
|
||||||
|
|
||||||
This will use os.Args[1:] as the argv slice, and use the default parser
|
|
||||||
options. If you want to provide your own version string and args, then use:
|
|
||||||
|
|
||||||
docopt.ParseArgs(usage, argv, "1.2.3")
|
|
||||||
|
|
||||||
If the last parameter (version) is a non-empty string, it will be printed when
|
|
||||||
--version is given in the argv slice. Finally, we can instantiate our own
|
|
||||||
docopt.Parser which gives us control over how things like help messages are
|
|
||||||
printed and whether to exit after displaying usage messages, etc.
|
|
||||||
|
|
||||||
parser := &docopt.Parser{
|
|
||||||
HelpHandler: docopt.PrintHelpOnly,
|
|
||||||
OptionsFirst: true,
|
|
||||||
}
|
|
||||||
opts, err := parser.ParseArgs(usage, argv, "")
|
|
||||||
|
|
||||||
In particular, setting your own custom HelpHandler function makes unit testing
|
|
||||||
your own docs with example command line invocations much more enjoyable.
|
|
||||||
|
|
||||||
All three of these return a map of option names to the values parsed from argv,
|
|
||||||
and an error or nil. You can get the values using the helpers, or just treat it
|
|
||||||
as a regular map:
|
|
||||||
|
|
||||||
flag, _ := opts.Bool("--flag")
|
|
||||||
secs, _ := opts.Int("<seconds>")
|
|
||||||
|
|
||||||
Additionally, you can `Bind` these to a struct, assigning option values to the
|
|
||||||
exported fields of that struct, all at once.
|
|
||||||
|
|
||||||
var config struct {
|
|
||||||
Command string `docopt:"<cmd>"`
|
|
||||||
Tries int `docopt:"-n"`
|
|
||||||
Force bool // Gets the value of --force
|
|
||||||
}
|
|
||||||
opts.Bind(&config)
|
|
||||||
*/
|
|
||||||
package docopt
|
|
||||||
575
vendor/github.com/docopt/docopt-go/docopt.go
generated
vendored
575
vendor/github.com/docopt/docopt-go/docopt.go
generated
vendored
@@ -1,575 +0,0 @@
|
|||||||
// Licensed under terms of MIT license (see LICENSE-MIT)
|
|
||||||
// Copyright (c) 2013 Keith Batten, kbatten@gmail.com
|
|
||||||
// Copyright (c) 2016 David Irvine
|
|
||||||
|
|
||||||
package docopt
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
type Parser struct {
|
|
||||||
// HelpHandler is called when we encounter bad user input, or when the user
|
|
||||||
// asks for help.
|
|
||||||
// By default, this calls os.Exit(0) if it handled a built-in option such
|
|
||||||
// as -h, --help or --version. If the user errored with a wrong command or
|
|
||||||
// options, we exit with a return code of 1.
|
|
||||||
HelpHandler func(err error, usage string)
|
|
||||||
// OptionsFirst requires that option flags always come before positional
|
|
||||||
// arguments; otherwise they can overlap.
|
|
||||||
OptionsFirst bool
|
|
||||||
// SkipHelpFlags tells the parser not to look for -h and --help flags and
|
|
||||||
// call the HelpHandler.
|
|
||||||
SkipHelpFlags bool
|
|
||||||
}
|
|
||||||
|
|
||||||
var PrintHelpAndExit = func(err error, usage string) {
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintln(os.Stderr, usage)
|
|
||||||
os.Exit(1)
|
|
||||||
} else {
|
|
||||||
fmt.Println(usage)
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var PrintHelpOnly = func(err error, usage string) {
|
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintln(os.Stderr, usage)
|
|
||||||
} else {
|
|
||||||
fmt.Println(usage)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var NoHelpHandler = func(err error, usage string) {}
|
|
||||||
|
|
||||||
var DefaultParser = &Parser{
|
|
||||||
HelpHandler: PrintHelpAndExit,
|
|
||||||
OptionsFirst: false,
|
|
||||||
SkipHelpFlags: false,
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseDoc parses os.Args[1:] based on the interface described in doc, using the default parser options.
|
|
||||||
func ParseDoc(doc string) (Opts, error) {
|
|
||||||
return ParseArgs(doc, nil, "")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseArgs parses custom arguments based on the interface described in doc. If you provide a non-empty version
|
|
||||||
// string, then this will be displayed when the --version flag is found. This method uses the default parser options.
|
|
||||||
func ParseArgs(doc string, argv []string, version string) (Opts, error) {
|
|
||||||
return DefaultParser.ParseArgs(doc, argv, version)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseArgs parses custom arguments based on the interface described in doc. If you provide a non-empty version
|
|
||||||
// string, then this will be displayed when the --version flag is found.
|
|
||||||
func (p *Parser) ParseArgs(doc string, argv []string, version string) (Opts, error) {
|
|
||||||
return p.parse(doc, argv, version)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Deprecated: Parse is provided for backward compatibility with the original docopt.go package.
|
|
||||||
// Please rather make use of ParseDoc, ParseArgs, or use your own custom Parser.
|
|
||||||
func Parse(doc string, argv []string, help bool, version string, optionsFirst bool, exit ...bool) (map[string]interface{}, error) {
|
|
||||||
exitOk := true
|
|
||||||
if len(exit) > 0 {
|
|
||||||
exitOk = exit[0]
|
|
||||||
}
|
|
||||||
p := &Parser{
|
|
||||||
OptionsFirst: optionsFirst,
|
|
||||||
SkipHelpFlags: !help,
|
|
||||||
}
|
|
||||||
if exitOk {
|
|
||||||
p.HelpHandler = PrintHelpAndExit
|
|
||||||
} else {
|
|
||||||
p.HelpHandler = PrintHelpOnly
|
|
||||||
}
|
|
||||||
return p.parse(doc, argv, version)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *Parser) parse(doc string, argv []string, version string) (map[string]interface{}, error) {
|
|
||||||
if argv == nil {
|
|
||||||
argv = os.Args[1:]
|
|
||||||
}
|
|
||||||
if p.HelpHandler == nil {
|
|
||||||
p.HelpHandler = DefaultParser.HelpHandler
|
|
||||||
}
|
|
||||||
args, output, err := parse(doc, argv, !p.SkipHelpFlags, version, p.OptionsFirst)
|
|
||||||
if _, ok := err.(*UserError); ok {
|
|
||||||
// the user gave us bad input
|
|
||||||
p.HelpHandler(err, output)
|
|
||||||
} else if len(output) > 0 && err == nil {
|
|
||||||
// the user asked for help or --version
|
|
||||||
p.HelpHandler(err, output)
|
|
||||||
}
|
|
||||||
return args, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
// parse and return a map of args, output and all errors
|
|
||||||
func parse(doc string, argv []string, help bool, version string, optionsFirst bool) (args map[string]interface{}, output string, err error) {
|
|
||||||
if argv == nil && len(os.Args) > 1 {
|
|
||||||
argv = os.Args[1:]
|
|
||||||
}
|
|
||||||
|
|
||||||
usageSections := parseSection("usage:", doc)
|
|
||||||
|
|
||||||
if len(usageSections) == 0 {
|
|
||||||
err = newLanguageError("\"usage:\" (case-insensitive) not found.")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if len(usageSections) > 1 {
|
|
||||||
err = newLanguageError("More than one \"usage:\" (case-insensitive).")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
usage := usageSections[0]
|
|
||||||
|
|
||||||
options := parseDefaults(doc)
|
|
||||||
formal, err := formalUsage(usage)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
pat, err := parsePattern(formal, &options)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
patternArgv, err := parseArgv(newTokenList(argv, errorUser), &options, optionsFirst)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
patFlat, err := pat.flat(patternOption)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
patternOptions := patFlat.unique()
|
|
||||||
|
|
||||||
patFlat, err = pat.flat(patternOptionSSHORTCUT)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for _, optionsShortcut := range patFlat {
|
|
||||||
docOptions := parseDefaults(doc)
|
|
||||||
optionsShortcut.children = docOptions.unique().diff(patternOptions)
|
|
||||||
}
|
|
||||||
|
|
||||||
if output = extras(help, version, patternArgv, doc); len(output) > 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
err = pat.fix()
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
matched, left, collected := pat.match(&patternArgv, nil)
|
|
||||||
if matched && len(*left) == 0 {
|
|
||||||
patFlat, err = pat.flat(patternDefault)
|
|
||||||
if err != nil {
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
args = append(patFlat, *collected...).dictionary()
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
err = newUserError("")
|
|
||||||
output = handleError(err, usage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func handleError(err error, usage string) string {
|
|
||||||
if _, ok := err.(*UserError); ok {
|
|
||||||
return strings.TrimSpace(fmt.Sprintf("%s\n%s", err, usage))
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseSection(name, source string) []string {
|
|
||||||
p := regexp.MustCompile(`(?im)^([^\n]*` + name + `[^\n]*\n?(?:[ \t].*?(?:\n|$))*)`)
|
|
||||||
s := p.FindAllString(source, -1)
|
|
||||||
if s == nil {
|
|
||||||
s = []string{}
|
|
||||||
}
|
|
||||||
for i, v := range s {
|
|
||||||
s[i] = strings.TrimSpace(v)
|
|
||||||
}
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseDefaults(doc string) patternList {
|
|
||||||
defaults := patternList{}
|
|
||||||
p := regexp.MustCompile(`\n[ \t]*(-\S+?)`)
|
|
||||||
for _, s := range parseSection("options:", doc) {
|
|
||||||
// FIXME corner case "bla: options: --foo"
|
|
||||||
_, _, s = stringPartition(s, ":") // get rid of "options:"
|
|
||||||
split := p.Split("\n"+s, -1)[1:]
|
|
||||||
match := p.FindAllStringSubmatch("\n"+s, -1)
|
|
||||||
for i := range split {
|
|
||||||
optionDescription := match[i][1] + split[i]
|
|
||||||
if strings.HasPrefix(optionDescription, "-") {
|
|
||||||
defaults = append(defaults, parseOption(optionDescription))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return defaults
|
|
||||||
}
|
|
||||||
|
|
||||||
func parsePattern(source string, options *patternList) (*pattern, error) {
|
|
||||||
tokens := tokenListFromPattern(source)
|
|
||||||
result, err := parseExpr(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if tokens.current() != nil {
|
|
||||||
return nil, tokens.errorFunc("unexpected ending: %s" + strings.Join(tokens.tokens, " "))
|
|
||||||
}
|
|
||||||
return newRequired(result...), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseArgv(tokens *tokenList, options *patternList, optionsFirst bool) (patternList, error) {
|
|
||||||
/*
|
|
||||||
Parse command-line argument vector.
|
|
||||||
|
|
||||||
If options_first:
|
|
||||||
argv ::= [ long | shorts ]* [ argument ]* [ '--' [ argument ]* ] ;
|
|
||||||
else:
|
|
||||||
argv ::= [ long | shorts | argument ]* [ '--' [ argument ]* ] ;
|
|
||||||
*/
|
|
||||||
parsed := patternList{}
|
|
||||||
for tokens.current() != nil {
|
|
||||||
if tokens.current().eq("--") {
|
|
||||||
for _, v := range tokens.tokens {
|
|
||||||
parsed = append(parsed, newArgument("", v))
|
|
||||||
}
|
|
||||||
return parsed, nil
|
|
||||||
} else if tokens.current().hasPrefix("--") {
|
|
||||||
pl, err := parseLong(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
parsed = append(parsed, pl...)
|
|
||||||
} else if tokens.current().hasPrefix("-") && !tokens.current().eq("-") {
|
|
||||||
ps, err := parseShorts(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
parsed = append(parsed, ps...)
|
|
||||||
} else if optionsFirst {
|
|
||||||
for _, v := range tokens.tokens {
|
|
||||||
parsed = append(parsed, newArgument("", v))
|
|
||||||
}
|
|
||||||
return parsed, nil
|
|
||||||
} else {
|
|
||||||
parsed = append(parsed, newArgument("", tokens.move().String()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return parsed, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseOption(optionDescription string) *pattern {
|
|
||||||
optionDescription = strings.TrimSpace(optionDescription)
|
|
||||||
options, _, description := stringPartition(optionDescription, " ")
|
|
||||||
options = strings.Replace(options, ",", " ", -1)
|
|
||||||
options = strings.Replace(options, "=", " ", -1)
|
|
||||||
|
|
||||||
short := ""
|
|
||||||
long := ""
|
|
||||||
argcount := 0
|
|
||||||
var value interface{}
|
|
||||||
value = false
|
|
||||||
|
|
||||||
reDefault := regexp.MustCompile(`(?i)\[default: (.*)\]`)
|
|
||||||
for _, s := range strings.Fields(options) {
|
|
||||||
if strings.HasPrefix(s, "--") {
|
|
||||||
long = s
|
|
||||||
} else if strings.HasPrefix(s, "-") {
|
|
||||||
short = s
|
|
||||||
} else {
|
|
||||||
argcount = 1
|
|
||||||
}
|
|
||||||
if argcount > 0 {
|
|
||||||
matched := reDefault.FindAllStringSubmatch(description, -1)
|
|
||||||
if len(matched) > 0 {
|
|
||||||
value = matched[0][1]
|
|
||||||
} else {
|
|
||||||
value = nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return newOption(short, long, argcount, value)
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseExpr(tokens *tokenList, options *patternList) (patternList, error) {
|
|
||||||
// expr ::= seq ( '|' seq )* ;
|
|
||||||
seq, err := parseSeq(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if !tokens.current().eq("|") {
|
|
||||||
return seq, nil
|
|
||||||
}
|
|
||||||
var result patternList
|
|
||||||
if len(seq) > 1 {
|
|
||||||
result = patternList{newRequired(seq...)}
|
|
||||||
} else {
|
|
||||||
result = seq
|
|
||||||
}
|
|
||||||
for tokens.current().eq("|") {
|
|
||||||
tokens.move()
|
|
||||||
seq, err = parseSeq(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if len(seq) > 1 {
|
|
||||||
result = append(result, newRequired(seq...))
|
|
||||||
} else {
|
|
||||||
result = append(result, seq...)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(result) > 1 {
|
|
||||||
return patternList{newEither(result...)}, nil
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseSeq(tokens *tokenList, options *patternList) (patternList, error) {
|
|
||||||
// seq ::= ( atom [ '...' ] )* ;
|
|
||||||
result := patternList{}
|
|
||||||
for !tokens.current().match(true, "]", ")", "|") {
|
|
||||||
atom, err := parseAtom(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if tokens.current().eq("...") {
|
|
||||||
atom = patternList{newOneOrMore(atom...)}
|
|
||||||
tokens.move()
|
|
||||||
}
|
|
||||||
result = append(result, atom...)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseAtom(tokens *tokenList, options *patternList) (patternList, error) {
|
|
||||||
// atom ::= '(' expr ')' | '[' expr ']' | 'options' | long | shorts | argument | command ;
|
|
||||||
tok := tokens.current()
|
|
||||||
result := patternList{}
|
|
||||||
if tokens.current().match(false, "(", "[") {
|
|
||||||
tokens.move()
|
|
||||||
var matching string
|
|
||||||
pl, err := parseExpr(tokens, options)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if tok.eq("(") {
|
|
||||||
matching = ")"
|
|
||||||
result = patternList{newRequired(pl...)}
|
|
||||||
} else if tok.eq("[") {
|
|
||||||
matching = "]"
|
|
||||||
result = patternList{newOptional(pl...)}
|
|
||||||
}
|
|
||||||
moved := tokens.move()
|
|
||||||
if !moved.eq(matching) {
|
|
||||||
return nil, tokens.errorFunc("unmatched '%s', expected: '%s' got: '%s'", tok, matching, moved)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
} else if tok.eq("options") {
|
|
||||||
tokens.move()
|
|
||||||
return patternList{newOptionsShortcut()}, nil
|
|
||||||
} else if tok.hasPrefix("--") && !tok.eq("--") {
|
|
||||||
return parseLong(tokens, options)
|
|
||||||
} else if tok.hasPrefix("-") && !tok.eq("-") && !tok.eq("--") {
|
|
||||||
return parseShorts(tokens, options)
|
|
||||||
} else if tok.hasPrefix("<") && tok.hasSuffix(">") || tok.isUpper() {
|
|
||||||
return patternList{newArgument(tokens.move().String(), nil)}, nil
|
|
||||||
}
|
|
||||||
return patternList{newCommand(tokens.move().String(), false)}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseLong(tokens *tokenList, options *patternList) (patternList, error) {
|
|
||||||
// long ::= '--' chars [ ( ' ' | '=' ) chars ] ;
|
|
||||||
long, eq, v := stringPartition(tokens.move().String(), "=")
|
|
||||||
var value interface{}
|
|
||||||
var opt *pattern
|
|
||||||
if eq == "" && v == "" {
|
|
||||||
value = nil
|
|
||||||
} else {
|
|
||||||
value = v
|
|
||||||
}
|
|
||||||
|
|
||||||
if !strings.HasPrefix(long, "--") {
|
|
||||||
return nil, newError("long option '%s' doesn't start with --", long)
|
|
||||||
}
|
|
||||||
similar := patternList{}
|
|
||||||
for _, o := range *options {
|
|
||||||
if o.long == long {
|
|
||||||
similar = append(similar, o)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if tokens.err == errorUser && len(similar) == 0 { // if no exact match
|
|
||||||
similar = patternList{}
|
|
||||||
for _, o := range *options {
|
|
||||||
if strings.HasPrefix(o.long, long) {
|
|
||||||
similar = append(similar, o)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(similar) > 1 { // might be simply specified ambiguously 2+ times?
|
|
||||||
similarLong := make([]string, len(similar))
|
|
||||||
for i, s := range similar {
|
|
||||||
similarLong[i] = s.long
|
|
||||||
}
|
|
||||||
return nil, tokens.errorFunc("%s is not a unique prefix: %s?", long, strings.Join(similarLong, ", "))
|
|
||||||
} else if len(similar) < 1 {
|
|
||||||
argcount := 0
|
|
||||||
if eq == "=" {
|
|
||||||
argcount = 1
|
|
||||||
}
|
|
||||||
opt = newOption("", long, argcount, false)
|
|
||||||
*options = append(*options, opt)
|
|
||||||
if tokens.err == errorUser {
|
|
||||||
var val interface{}
|
|
||||||
if argcount > 0 {
|
|
||||||
val = value
|
|
||||||
} else {
|
|
||||||
val = true
|
|
||||||
}
|
|
||||||
opt = newOption("", long, argcount, val)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
opt = newOption(similar[0].short, similar[0].long, similar[0].argcount, similar[0].value)
|
|
||||||
if opt.argcount == 0 {
|
|
||||||
if value != nil {
|
|
||||||
return nil, tokens.errorFunc("%s must not have an argument", opt.long)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if value == nil {
|
|
||||||
if tokens.current().match(true, "--") {
|
|
||||||
return nil, tokens.errorFunc("%s requires argument", opt.long)
|
|
||||||
}
|
|
||||||
moved := tokens.move()
|
|
||||||
if moved != nil {
|
|
||||||
value = moved.String() // only set as string if not nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if tokens.err == errorUser {
|
|
||||||
if value != nil {
|
|
||||||
opt.value = value
|
|
||||||
} else {
|
|
||||||
opt.value = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return patternList{opt}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseShorts(tokens *tokenList, options *patternList) (patternList, error) {
|
|
||||||
// shorts ::= '-' ( chars )* [ [ ' ' ] chars ] ;
|
|
||||||
tok := tokens.move()
|
|
||||||
if !tok.hasPrefix("-") || tok.hasPrefix("--") {
|
|
||||||
return nil, newError("short option '%s' doesn't start with -", tok)
|
|
||||||
}
|
|
||||||
left := strings.TrimLeft(tok.String(), "-")
|
|
||||||
parsed := patternList{}
|
|
||||||
for left != "" {
|
|
||||||
var opt *pattern
|
|
||||||
short := "-" + left[0:1]
|
|
||||||
left = left[1:]
|
|
||||||
similar := patternList{}
|
|
||||||
for _, o := range *options {
|
|
||||||
if o.short == short {
|
|
||||||
similar = append(similar, o)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(similar) > 1 {
|
|
||||||
return nil, tokens.errorFunc("%s is specified ambiguously %d times", short, len(similar))
|
|
||||||
} else if len(similar) < 1 {
|
|
||||||
opt = newOption(short, "", 0, false)
|
|
||||||
*options = append(*options, opt)
|
|
||||||
if tokens.err == errorUser {
|
|
||||||
opt = newOption(short, "", 0, true)
|
|
||||||
}
|
|
||||||
} else { // why copying is necessary here?
|
|
||||||
opt = newOption(short, similar[0].long, similar[0].argcount, similar[0].value)
|
|
||||||
var value interface{}
|
|
||||||
if opt.argcount > 0 {
|
|
||||||
if left == "" {
|
|
||||||
if tokens.current().match(true, "--") {
|
|
||||||
return nil, tokens.errorFunc("%s requires argument", short)
|
|
||||||
}
|
|
||||||
value = tokens.move().String()
|
|
||||||
} else {
|
|
||||||
value = left
|
|
||||||
left = ""
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if tokens.err == errorUser {
|
|
||||||
if value != nil {
|
|
||||||
opt.value = value
|
|
||||||
} else {
|
|
||||||
opt.value = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
parsed = append(parsed, opt)
|
|
||||||
}
|
|
||||||
return parsed, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func formalUsage(section string) (string, error) {
|
|
||||||
_, _, section = stringPartition(section, ":") // drop "usage:"
|
|
||||||
pu := strings.Fields(section)
|
|
||||||
|
|
||||||
if len(pu) == 0 {
|
|
||||||
return "", newLanguageError("no fields found in usage (perhaps a spacing error).")
|
|
||||||
}
|
|
||||||
|
|
||||||
result := "( "
|
|
||||||
for _, s := range pu[1:] {
|
|
||||||
if s == pu[0] {
|
|
||||||
result += ") | ( "
|
|
||||||
} else {
|
|
||||||
result += s + " "
|
|
||||||
}
|
|
||||||
}
|
|
||||||
result += ")"
|
|
||||||
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func extras(help bool, version string, options patternList, doc string) string {
|
|
||||||
if help {
|
|
||||||
for _, o := range options {
|
|
||||||
if (o.name == "-h" || o.name == "--help") && o.value == true {
|
|
||||||
return strings.Trim(doc, "\n")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if version != "" {
|
|
||||||
for _, o := range options {
|
|
||||||
if (o.name == "--version") && o.value == true {
|
|
||||||
return version
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func stringPartition(s, sep string) (string, string, string) {
|
|
||||||
sepPos := strings.Index(s, sep)
|
|
||||||
if sepPos == -1 { // no seperator found
|
|
||||||
return s, "", ""
|
|
||||||
}
|
|
||||||
split := strings.SplitN(s, sep, 2)
|
|
||||||
return split[0], sep, split[1]
|
|
||||||
}
|
|
||||||
49
vendor/github.com/docopt/docopt-go/error.go
generated
vendored
49
vendor/github.com/docopt/docopt-go/error.go
generated
vendored
@@ -1,49 +0,0 @@
|
|||||||
package docopt
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
)
|
|
||||||
|
|
||||||
type errorType int
|
|
||||||
|
|
||||||
const (
|
|
||||||
errorUser errorType = iota
|
|
||||||
errorLanguage
|
|
||||||
)
|
|
||||||
|
|
||||||
func (e errorType) String() string {
|
|
||||||
switch e {
|
|
||||||
case errorUser:
|
|
||||||
return "errorUser"
|
|
||||||
case errorLanguage:
|
|
||||||
return "errorLanguage"
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// UserError records an error with program arguments.
|
|
||||||
type UserError struct {
|
|
||||||
msg string
|
|
||||||
Usage string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e UserError) Error() string {
|
|
||||||
return e.msg
|
|
||||||
}
|
|
||||||
func newUserError(msg string, f ...interface{}) error {
|
|
||||||
return &UserError{fmt.Sprintf(msg, f...), ""}
|
|
||||||
}
|
|
||||||
|
|
||||||
// LanguageError records an error with the doc string.
|
|
||||||
type LanguageError struct {
|
|
||||||
msg string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e LanguageError) Error() string {
|
|
||||||
return e.msg
|
|
||||||
}
|
|
||||||
func newLanguageError(msg string, f ...interface{}) error {
|
|
||||||
return &LanguageError{fmt.Sprintf(msg, f...)}
|
|
||||||
}
|
|
||||||
|
|
||||||
var newError = fmt.Errorf
|
|
||||||
264
vendor/github.com/docopt/docopt-go/opts.go
generated
vendored
264
vendor/github.com/docopt/docopt-go/opts.go
generated
vendored
@@ -1,264 +0,0 @@
|
|||||||
package docopt
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"reflect"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"unicode"
|
|
||||||
)
|
|
||||||
|
|
||||||
func errKey(key string) error {
|
|
||||||
return fmt.Errorf("no such key: %q", key)
|
|
||||||
}
|
|
||||||
func errType(key string) error {
|
|
||||||
return fmt.Errorf("key: %q failed type conversion", key)
|
|
||||||
}
|
|
||||||
func errStrconv(key string, convErr error) error {
|
|
||||||
return fmt.Errorf("key: %q failed type conversion: %s", key, convErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Opts is a map of command line options to their values, with some convenience
|
|
||||||
// methods for value type conversion (bool, float64, int, string). For example,
|
|
||||||
// to get an option value as an int:
|
|
||||||
//
|
|
||||||
// opts, _ := docopt.ParseDoc("Usage: sleep <seconds>")
|
|
||||||
// secs, _ := opts.Int("<seconds>")
|
|
||||||
//
|
|
||||||
// Additionally, Opts.Bind allows you easily populate a struct's fields with the
|
|
||||||
// values of each option value. See below for examples.
|
|
||||||
//
|
|
||||||
// Lastly, you can still treat Opts as a regular map, and do any type checking
|
|
||||||
// and conversion that you want to yourself. For example:
|
|
||||||
//
|
|
||||||
// if s, ok := opts["<binary>"].(string); ok {
|
|
||||||
// if val, err := strconv.ParseUint(s, 2, 64); err != nil { ... }
|
|
||||||
// }
|
|
||||||
//
|
|
||||||
// Note that any non-boolean option / flag will have a string value in the
|
|
||||||
// underlying map.
|
|
||||||
type Opts map[string]interface{}
|
|
||||||
|
|
||||||
func (o Opts) String(key string) (s string, err error) {
|
|
||||||
v, ok := o[key]
|
|
||||||
if !ok {
|
|
||||||
err = errKey(key)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
s, ok = v.(string)
|
|
||||||
if !ok {
|
|
||||||
err = errType(key)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o Opts) Bool(key string) (b bool, err error) {
|
|
||||||
v, ok := o[key]
|
|
||||||
if !ok {
|
|
||||||
err = errKey(key)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
b, ok = v.(bool)
|
|
||||||
if !ok {
|
|
||||||
err = errType(key)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o Opts) Int(key string) (i int, err error) {
|
|
||||||
s, err := o.String(key)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
i, err = strconv.Atoi(s)
|
|
||||||
if err != nil {
|
|
||||||
err = errStrconv(key, err)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (o Opts) Float64(key string) (f float64, err error) {
|
|
||||||
s, err := o.String(key)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
f, err = strconv.ParseFloat(s, 64)
|
|
||||||
if err != nil {
|
|
||||||
err = errStrconv(key, err)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Bind populates the fields of a given struct with matching option values.
|
|
||||||
// Each key in Opts will be mapped to an exported field of the struct pointed
|
|
||||||
// to by `v`, as follows:
|
|
||||||
//
|
|
||||||
// abc int // Unexported field, ignored
|
|
||||||
// Abc string // Mapped from `--abc`, `<abc>`, or `abc`
|
|
||||||
// // (case insensitive)
|
|
||||||
// A string // Mapped from `-a`, `<a>` or `a`
|
|
||||||
// // (case insensitive)
|
|
||||||
// Abc int `docopt:"XYZ"` // Mapped from `XYZ`
|
|
||||||
// Abc bool `docopt:"-"` // Mapped from `-`
|
|
||||||
// Abc bool `docopt:"-x,--xyz"` // Mapped from `-x` or `--xyz`
|
|
||||||
// // (first non-zero value found)
|
|
||||||
//
|
|
||||||
// Tagged (annotated) fields will always be mapped first. If no field is tagged
|
|
||||||
// with an option's key, Bind will try to map the option to an appropriately
|
|
||||||
// named field (as above).
|
|
||||||
//
|
|
||||||
// Bind also handles conversion to bool, float, int or string types.
|
|
||||||
func (o Opts) Bind(v interface{}) error {
|
|
||||||
structVal := reflect.ValueOf(v)
|
|
||||||
if structVal.Kind() != reflect.Ptr {
|
|
||||||
return newError("'v' argument is not pointer to struct type")
|
|
||||||
}
|
|
||||||
for structVal.Kind() == reflect.Ptr {
|
|
||||||
structVal = structVal.Elem()
|
|
||||||
}
|
|
||||||
if structVal.Kind() != reflect.Struct {
|
|
||||||
return newError("'v' argument is not pointer to struct type")
|
|
||||||
}
|
|
||||||
structType := structVal.Type()
|
|
||||||
|
|
||||||
tagged := make(map[string]int) // Tagged field tags
|
|
||||||
untagged := make(map[string]int) // Untagged field names
|
|
||||||
|
|
||||||
for i := 0; i < structType.NumField(); i++ {
|
|
||||||
field := structType.Field(i)
|
|
||||||
if isUnexportedField(field) || field.Anonymous {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
tag := field.Tag.Get("docopt")
|
|
||||||
if tag == "" {
|
|
||||||
untagged[field.Name] = i
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
for _, t := range strings.Split(tag, ",") {
|
|
||||||
tagged[t] = i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get the index of the struct field to use, based on the option key.
|
|
||||||
// Second argument is true/false on whether something was matched.
|
|
||||||
getFieldIndex := func(key string) (int, bool) {
|
|
||||||
if i, ok := tagged[key]; ok {
|
|
||||||
return i, true
|
|
||||||
}
|
|
||||||
if i, ok := untagged[guessUntaggedField(key)]; ok {
|
|
||||||
return i, true
|
|
||||||
}
|
|
||||||
return -1, false
|
|
||||||
}
|
|
||||||
|
|
||||||
indexMap := make(map[string]int) // Option keys to field index
|
|
||||||
|
|
||||||
// Pre-check that option keys are mapped to fields and fields are zero valued, before populating them.
|
|
||||||
for k := range o {
|
|
||||||
i, ok := getFieldIndex(k)
|
|
||||||
if !ok {
|
|
||||||
if k == "--help" || k == "--version" { // Don't require these to be mapped.
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return newError("mapping of %q is not found in given struct, or is an unexported field", k)
|
|
||||||
}
|
|
||||||
fieldVal := structVal.Field(i)
|
|
||||||
zeroVal := reflect.Zero(fieldVal.Type())
|
|
||||||
if !reflect.DeepEqual(fieldVal.Interface(), zeroVal.Interface()) {
|
|
||||||
return newError("%q field is non-zero, will be overwritten by value of %q", structType.Field(i).Name, k)
|
|
||||||
}
|
|
||||||
indexMap[k] = i
|
|
||||||
}
|
|
||||||
|
|
||||||
// Populate fields with option values.
|
|
||||||
for k, v := range o {
|
|
||||||
i, ok := indexMap[k]
|
|
||||||
if !ok {
|
|
||||||
continue // Not mapped.
|
|
||||||
}
|
|
||||||
field := structVal.Field(i)
|
|
||||||
if !reflect.DeepEqual(field.Interface(), reflect.Zero(field.Type()).Interface()) {
|
|
||||||
// The struct's field is already non-zero (by our doing), so don't change it.
|
|
||||||
// This happens with comma separated tags, e.g. `docopt:"-h,--help"` which is a
|
|
||||||
// convenient way of checking if one of multiple boolean flags are set.
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
optVal := reflect.ValueOf(v)
|
|
||||||
// Option value is the zero Value, so we can't get its .Type(). No need to assign anyway, so move along.
|
|
||||||
if !optVal.IsValid() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !field.CanSet() {
|
|
||||||
return newError("%q field cannot be set", structType.Field(i).Name)
|
|
||||||
}
|
|
||||||
// Try to assign now if able. bool and string values should be assignable already.
|
|
||||||
if optVal.Type().AssignableTo(field.Type()) {
|
|
||||||
field.Set(optVal)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// Try to convert the value and assign if able.
|
|
||||||
switch field.Kind() {
|
|
||||||
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
|
||||||
if x, err := o.Int(k); err == nil {
|
|
||||||
field.SetInt(int64(x))
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
case reflect.Float32, reflect.Float64:
|
|
||||||
if x, err := o.Float64(k); err == nil {
|
|
||||||
field.SetFloat(x)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// TODO: Something clever (recursive?) with non-string slices.
|
|
||||||
// case reflect.Slice:
|
|
||||||
// if optVal.Kind() == reflect.Slice {
|
|
||||||
// for i := 0; i < optVal.Len(); i++ {
|
|
||||||
// sliceVal := optVal.Index(i)
|
|
||||||
// fmt.Printf("%v", sliceVal)
|
|
||||||
// }
|
|
||||||
// fmt.Printf("\n")
|
|
||||||
// }
|
|
||||||
return newError("value of %q is not assignable to %q field", k, structType.Field(i).Name)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// isUnexportedField returns whether the field is unexported.
|
|
||||||
// isUnexportedField is to avoid the bug in versions older than Go1.3.
|
|
||||||
// See following links:
|
|
||||||
// https://code.google.com/p/go/issues/detail?id=7247
|
|
||||||
// http://golang.org/ref/spec#Exported_identifiers
|
|
||||||
func isUnexportedField(field reflect.StructField) bool {
|
|
||||||
return !(field.PkgPath == "" && unicode.IsUpper(rune(field.Name[0])))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert a string like "--my-special-flag" to "MySpecialFlag".
|
|
||||||
func titleCaseDashes(key string) string {
|
|
||||||
nextToUpper := true
|
|
||||||
mapFn := func(r rune) rune {
|
|
||||||
if r == '-' {
|
|
||||||
nextToUpper = true
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
if nextToUpper {
|
|
||||||
nextToUpper = false
|
|
||||||
return unicode.ToUpper(r)
|
|
||||||
}
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
return strings.Map(mapFn, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Best guess which field.Name in a struct to assign for an option key.
|
|
||||||
func guessUntaggedField(key string) string {
|
|
||||||
switch {
|
|
||||||
case strings.HasPrefix(key, "--") && len(key[2:]) > 1:
|
|
||||||
return titleCaseDashes(key[2:])
|
|
||||||
case strings.HasPrefix(key, "-") && len(key[1:]) == 1:
|
|
||||||
return titleCaseDashes(key[1:])
|
|
||||||
case strings.HasPrefix(key, "<") && strings.HasSuffix(key, ">"):
|
|
||||||
key = key[1 : len(key)-1]
|
|
||||||
}
|
|
||||||
return strings.Title(strings.ToLower(key))
|
|
||||||
}
|
|
||||||
550
vendor/github.com/docopt/docopt-go/pattern.go
generated
vendored
550
vendor/github.com/docopt/docopt-go/pattern.go
generated
vendored
@@ -1,550 +0,0 @@
|
|||||||
package docopt
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
type patternType uint
|
|
||||||
|
|
||||||
const (
|
|
||||||
// leaf
|
|
||||||
patternArgument patternType = 1 << iota
|
|
||||||
patternCommand
|
|
||||||
patternOption
|
|
||||||
|
|
||||||
// branch
|
|
||||||
patternRequired
|
|
||||||
patternOptionAL
|
|
||||||
patternOptionSSHORTCUT // Marker/placeholder for [options] shortcut.
|
|
||||||
patternOneOrMore
|
|
||||||
patternEither
|
|
||||||
|
|
||||||
patternLeaf = patternArgument +
|
|
||||||
patternCommand +
|
|
||||||
patternOption
|
|
||||||
patternBranch = patternRequired +
|
|
||||||
patternOptionAL +
|
|
||||||
patternOptionSSHORTCUT +
|
|
||||||
patternOneOrMore +
|
|
||||||
patternEither
|
|
||||||
patternAll = patternLeaf + patternBranch
|
|
||||||
patternDefault = 0
|
|
||||||
)
|
|
||||||
|
|
||||||
func (pt patternType) String() string {
|
|
||||||
switch pt {
|
|
||||||
case patternArgument:
|
|
||||||
return "argument"
|
|
||||||
case patternCommand:
|
|
||||||
return "command"
|
|
||||||
case patternOption:
|
|
||||||
return "option"
|
|
||||||
case patternRequired:
|
|
||||||
return "required"
|
|
||||||
case patternOptionAL:
|
|
||||||
return "optional"
|
|
||||||
case patternOptionSSHORTCUT:
|
|
||||||
return "optionsshortcut"
|
|
||||||
case patternOneOrMore:
|
|
||||||
return "oneormore"
|
|
||||||
case patternEither:
|
|
||||||
return "either"
|
|
||||||
case patternLeaf:
|
|
||||||
return "leaf"
|
|
||||||
case patternBranch:
|
|
||||||
return "branch"
|
|
||||||
case patternAll:
|
|
||||||
return "all"
|
|
||||||
case patternDefault:
|
|
||||||
return "default"
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
type pattern struct {
|
|
||||||
t patternType
|
|
||||||
|
|
||||||
children patternList
|
|
||||||
|
|
||||||
name string
|
|
||||||
value interface{}
|
|
||||||
|
|
||||||
short string
|
|
||||||
long string
|
|
||||||
argcount int
|
|
||||||
}
|
|
||||||
|
|
||||||
type patternList []*pattern
|
|
||||||
|
|
||||||
func newBranchPattern(t patternType, pl ...*pattern) *pattern {
|
|
||||||
var p pattern
|
|
||||||
p.t = t
|
|
||||||
p.children = make(patternList, len(pl))
|
|
||||||
copy(p.children, pl)
|
|
||||||
return &p
|
|
||||||
}
|
|
||||||
|
|
||||||
func newRequired(pl ...*pattern) *pattern {
|
|
||||||
return newBranchPattern(patternRequired, pl...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newEither(pl ...*pattern) *pattern {
|
|
||||||
return newBranchPattern(patternEither, pl...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newOneOrMore(pl ...*pattern) *pattern {
|
|
||||||
return newBranchPattern(patternOneOrMore, pl...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newOptional(pl ...*pattern) *pattern {
|
|
||||||
return newBranchPattern(patternOptionAL, pl...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newOptionsShortcut() *pattern {
|
|
||||||
var p pattern
|
|
||||||
p.t = patternOptionSSHORTCUT
|
|
||||||
return &p
|
|
||||||
}
|
|
||||||
|
|
||||||
func newLeafPattern(t patternType, name string, value interface{}) *pattern {
|
|
||||||
// default: value=nil
|
|
||||||
var p pattern
|
|
||||||
p.t = t
|
|
||||||
p.name = name
|
|
||||||
p.value = value
|
|
||||||
return &p
|
|
||||||
}
|
|
||||||
|
|
||||||
func newArgument(name string, value interface{}) *pattern {
|
|
||||||
// default: value=nil
|
|
||||||
return newLeafPattern(patternArgument, name, value)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newCommand(name string, value interface{}) *pattern {
|
|
||||||
// default: value=false
|
|
||||||
var p pattern
|
|
||||||
p.t = patternCommand
|
|
||||||
p.name = name
|
|
||||||
p.value = value
|
|
||||||
return &p
|
|
||||||
}
|
|
||||||
|
|
||||||
func newOption(short, long string, argcount int, value interface{}) *pattern {
|
|
||||||
// default: "", "", 0, false
|
|
||||||
var p pattern
|
|
||||||
p.t = patternOption
|
|
||||||
p.short = short
|
|
||||||
p.long = long
|
|
||||||
if long != "" {
|
|
||||||
p.name = long
|
|
||||||
} else {
|
|
||||||
p.name = short
|
|
||||||
}
|
|
||||||
p.argcount = argcount
|
|
||||||
if value == false && argcount > 0 {
|
|
||||||
p.value = nil
|
|
||||||
} else {
|
|
||||||
p.value = value
|
|
||||||
}
|
|
||||||
return &p
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) flat(types patternType) (patternList, error) {
|
|
||||||
if p.t&patternLeaf != 0 {
|
|
||||||
if types == patternDefault {
|
|
||||||
types = patternAll
|
|
||||||
}
|
|
||||||
if p.t&types != 0 {
|
|
||||||
return patternList{p}, nil
|
|
||||||
}
|
|
||||||
return patternList{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if p.t&patternBranch != 0 {
|
|
||||||
if p.t&types != 0 {
|
|
||||||
return patternList{p}, nil
|
|
||||||
}
|
|
||||||
result := patternList{}
|
|
||||||
for _, child := range p.children {
|
|
||||||
childFlat, err := child.flat(types)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result = append(result, childFlat...)
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
return nil, newError("unknown pattern type: %d, %d", p.t, types)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) fix() error {
|
|
||||||
err := p.fixIdentities(nil)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
p.fixRepeatingArguments()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) fixIdentities(uniq patternList) error {
|
|
||||||
// Make pattern-tree tips point to same object if they are equal.
|
|
||||||
if p.t&patternBranch == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if uniq == nil {
|
|
||||||
pFlat, err := p.flat(patternDefault)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
uniq = pFlat.unique()
|
|
||||||
}
|
|
||||||
for i, child := range p.children {
|
|
||||||
if child.t&patternBranch == 0 {
|
|
||||||
ind, err := uniq.index(child)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
p.children[i] = uniq[ind]
|
|
||||||
} else {
|
|
||||||
err := child.fixIdentities(uniq)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) fixRepeatingArguments() {
|
|
||||||
// Fix elements that should accumulate/increment values.
|
|
||||||
var either []patternList
|
|
||||||
|
|
||||||
for _, child := range p.transform().children {
|
|
||||||
either = append(either, child.children)
|
|
||||||
}
|
|
||||||
for _, cas := range either {
|
|
||||||
casMultiple := patternList{}
|
|
||||||
for _, e := range cas {
|
|
||||||
if cas.count(e) > 1 {
|
|
||||||
casMultiple = append(casMultiple, e)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for _, e := range casMultiple {
|
|
||||||
if e.t == patternArgument || e.t == patternOption && e.argcount > 0 {
|
|
||||||
switch e.value.(type) {
|
|
||||||
case string:
|
|
||||||
e.value = strings.Fields(e.value.(string))
|
|
||||||
case []string:
|
|
||||||
default:
|
|
||||||
e.value = []string{}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if e.t == patternCommand || e.t == patternOption && e.argcount == 0 {
|
|
||||||
e.value = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) match(left *patternList, collected *patternList) (bool, *patternList, *patternList) {
|
|
||||||
if collected == nil {
|
|
||||||
collected = &patternList{}
|
|
||||||
}
|
|
||||||
if p.t&patternRequired != 0 {
|
|
||||||
l := left
|
|
||||||
c := collected
|
|
||||||
for _, p := range p.children {
|
|
||||||
var matched bool
|
|
||||||
matched, l, c = p.match(l, c)
|
|
||||||
if !matched {
|
|
||||||
return false, left, collected
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return true, l, c
|
|
||||||
} else if p.t&patternOptionAL != 0 || p.t&patternOptionSSHORTCUT != 0 {
|
|
||||||
for _, p := range p.children {
|
|
||||||
_, left, collected = p.match(left, collected)
|
|
||||||
}
|
|
||||||
return true, left, collected
|
|
||||||
} else if p.t&patternOneOrMore != 0 {
|
|
||||||
if len(p.children) != 1 {
|
|
||||||
panic("OneOrMore.match(): assert len(p.children) == 1")
|
|
||||||
}
|
|
||||||
l := left
|
|
||||||
c := collected
|
|
||||||
var lAlt *patternList
|
|
||||||
matched := true
|
|
||||||
times := 0
|
|
||||||
for matched {
|
|
||||||
// could it be that something didn't match but changed l or c?
|
|
||||||
matched, l, c = p.children[0].match(l, c)
|
|
||||||
if matched {
|
|
||||||
times++
|
|
||||||
}
|
|
||||||
if lAlt == l {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
lAlt = l
|
|
||||||
}
|
|
||||||
if times >= 1 {
|
|
||||||
return true, l, c
|
|
||||||
}
|
|
||||||
return false, left, collected
|
|
||||||
} else if p.t&patternEither != 0 {
|
|
||||||
type outcomeStruct struct {
|
|
||||||
matched bool
|
|
||||||
left *patternList
|
|
||||||
collected *patternList
|
|
||||||
length int
|
|
||||||
}
|
|
||||||
outcomes := []outcomeStruct{}
|
|
||||||
for _, p := range p.children {
|
|
||||||
matched, l, c := p.match(left, collected)
|
|
||||||
outcome := outcomeStruct{matched, l, c, len(*l)}
|
|
||||||
if matched {
|
|
||||||
outcomes = append(outcomes, outcome)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(outcomes) > 0 {
|
|
||||||
minLen := outcomes[0].length
|
|
||||||
minIndex := 0
|
|
||||||
for i, v := range outcomes {
|
|
||||||
if v.length < minLen {
|
|
||||||
minIndex = i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return outcomes[minIndex].matched, outcomes[minIndex].left, outcomes[minIndex].collected
|
|
||||||
}
|
|
||||||
return false, left, collected
|
|
||||||
} else if p.t&patternLeaf != 0 {
|
|
||||||
pos, match := p.singleMatch(left)
|
|
||||||
var increment interface{}
|
|
||||||
if match == nil {
|
|
||||||
return false, left, collected
|
|
||||||
}
|
|
||||||
leftAlt := make(patternList, len((*left)[:pos]), len((*left)[:pos])+len((*left)[pos+1:]))
|
|
||||||
copy(leftAlt, (*left)[:pos])
|
|
||||||
leftAlt = append(leftAlt, (*left)[pos+1:]...)
|
|
||||||
sameName := patternList{}
|
|
||||||
for _, a := range *collected {
|
|
||||||
if a.name == p.name {
|
|
||||||
sameName = append(sameName, a)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
switch p.value.(type) {
|
|
||||||
case int, []string:
|
|
||||||
switch p.value.(type) {
|
|
||||||
case int:
|
|
||||||
increment = 1
|
|
||||||
case []string:
|
|
||||||
switch match.value.(type) {
|
|
||||||
case string:
|
|
||||||
increment = []string{match.value.(string)}
|
|
||||||
default:
|
|
||||||
increment = match.value
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(sameName) == 0 {
|
|
||||||
match.value = increment
|
|
||||||
collectedMatch := make(patternList, len(*collected), len(*collected)+1)
|
|
||||||
copy(collectedMatch, *collected)
|
|
||||||
collectedMatch = append(collectedMatch, match)
|
|
||||||
return true, &leftAlt, &collectedMatch
|
|
||||||
}
|
|
||||||
switch sameName[0].value.(type) {
|
|
||||||
case int:
|
|
||||||
sameName[0].value = sameName[0].value.(int) + increment.(int)
|
|
||||||
case []string:
|
|
||||||
sameName[0].value = append(sameName[0].value.([]string), increment.([]string)...)
|
|
||||||
}
|
|
||||||
return true, &leftAlt, collected
|
|
||||||
}
|
|
||||||
collectedMatch := make(patternList, len(*collected), len(*collected)+1)
|
|
||||||
copy(collectedMatch, *collected)
|
|
||||||
collectedMatch = append(collectedMatch, match)
|
|
||||||
return true, &leftAlt, &collectedMatch
|
|
||||||
}
|
|
||||||
panic("unmatched type")
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) singleMatch(left *patternList) (int, *pattern) {
|
|
||||||
if p.t&patternArgument != 0 {
|
|
||||||
for n, pat := range *left {
|
|
||||||
if pat.t&patternArgument != 0 {
|
|
||||||
return n, newArgument(p.name, pat.value)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1, nil
|
|
||||||
} else if p.t&patternCommand != 0 {
|
|
||||||
for n, pat := range *left {
|
|
||||||
if pat.t&patternArgument != 0 {
|
|
||||||
if pat.value == p.name {
|
|
||||||
return n, newCommand(p.name, true)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1, nil
|
|
||||||
} else if p.t&patternOption != 0 {
|
|
||||||
for n, pat := range *left {
|
|
||||||
if p.name == pat.name {
|
|
||||||
return n, pat
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1, nil
|
|
||||||
}
|
|
||||||
panic("unmatched type")
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) String() string {
|
|
||||||
if p.t&patternOption != 0 {
|
|
||||||
return fmt.Sprintf("%s(%s, %s, %d, %+v)", p.t, p.short, p.long, p.argcount, p.value)
|
|
||||||
} else if p.t&patternLeaf != 0 {
|
|
||||||
return fmt.Sprintf("%s(%s, %+v)", p.t, p.name, p.value)
|
|
||||||
} else if p.t&patternBranch != 0 {
|
|
||||||
result := ""
|
|
||||||
for i, child := range p.children {
|
|
||||||
if i > 0 {
|
|
||||||
result += ", "
|
|
||||||
}
|
|
||||||
result += child.String()
|
|
||||||
}
|
|
||||||
return fmt.Sprintf("%s(%s)", p.t, result)
|
|
||||||
}
|
|
||||||
panic("unmatched type")
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) transform() *pattern {
|
|
||||||
/*
|
|
||||||
Expand pattern into an (almost) equivalent one, but with single Either.
|
|
||||||
|
|
||||||
Example: ((-a | -b) (-c | -d)) => (-a -c | -a -d | -b -c | -b -d)
|
|
||||||
Quirks: [-a] => (-a), (-a...) => (-a -a)
|
|
||||||
*/
|
|
||||||
result := []patternList{}
|
|
||||||
groups := []patternList{patternList{p}}
|
|
||||||
parents := patternRequired +
|
|
||||||
patternOptionAL +
|
|
||||||
patternOptionSSHORTCUT +
|
|
||||||
patternEither +
|
|
||||||
patternOneOrMore
|
|
||||||
for len(groups) > 0 {
|
|
||||||
children := groups[0]
|
|
||||||
groups = groups[1:]
|
|
||||||
var child *pattern
|
|
||||||
for _, c := range children {
|
|
||||||
if c.t&parents != 0 {
|
|
||||||
child = c
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if child != nil {
|
|
||||||
children.remove(child)
|
|
||||||
if child.t&patternEither != 0 {
|
|
||||||
for _, c := range child.children {
|
|
||||||
r := patternList{}
|
|
||||||
r = append(r, c)
|
|
||||||
r = append(r, children...)
|
|
||||||
groups = append(groups, r)
|
|
||||||
}
|
|
||||||
} else if child.t&patternOneOrMore != 0 {
|
|
||||||
r := patternList{}
|
|
||||||
r = append(r, child.children.double()...)
|
|
||||||
r = append(r, children...)
|
|
||||||
groups = append(groups, r)
|
|
||||||
} else {
|
|
||||||
r := patternList{}
|
|
||||||
r = append(r, child.children...)
|
|
||||||
r = append(r, children...)
|
|
||||||
groups = append(groups, r)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
result = append(result, children)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
either := patternList{}
|
|
||||||
for _, e := range result {
|
|
||||||
either = append(either, newRequired(e...))
|
|
||||||
}
|
|
||||||
return newEither(either...)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *pattern) eq(other *pattern) bool {
|
|
||||||
return reflect.DeepEqual(p, other)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) unique() patternList {
|
|
||||||
table := make(map[string]bool)
|
|
||||||
result := patternList{}
|
|
||||||
for _, v := range pl {
|
|
||||||
if !table[v.String()] {
|
|
||||||
table[v.String()] = true
|
|
||||||
result = append(result, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) index(p *pattern) (int, error) {
|
|
||||||
for i, c := range pl {
|
|
||||||
if c.eq(p) {
|
|
||||||
return i, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return -1, newError("%s not in list", p)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) count(p *pattern) int {
|
|
||||||
count := 0
|
|
||||||
for _, c := range pl {
|
|
||||||
if c.eq(p) {
|
|
||||||
count++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return count
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) diff(l patternList) patternList {
|
|
||||||
lAlt := make(patternList, len(l))
|
|
||||||
copy(lAlt, l)
|
|
||||||
result := make(patternList, 0, len(pl))
|
|
||||||
for _, v := range pl {
|
|
||||||
if v != nil {
|
|
||||||
match := false
|
|
||||||
for i, w := range lAlt {
|
|
||||||
if w.eq(v) {
|
|
||||||
match = true
|
|
||||||
lAlt[i] = nil
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if match == false {
|
|
||||||
result = append(result, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) double() patternList {
|
|
||||||
l := len(pl)
|
|
||||||
result := make(patternList, l*2)
|
|
||||||
copy(result, pl)
|
|
||||||
copy(result[l:2*l], pl)
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl *patternList) remove(p *pattern) {
|
|
||||||
(*pl) = pl.diff(patternList{p})
|
|
||||||
}
|
|
||||||
|
|
||||||
func (pl patternList) dictionary() map[string]interface{} {
|
|
||||||
dict := make(map[string]interface{})
|
|
||||||
for _, a := range pl {
|
|
||||||
dict[a.name] = a.value
|
|
||||||
}
|
|
||||||
return dict
|
|
||||||
}
|
|
||||||
9
vendor/github.com/docopt/docopt-go/test_golang.docopt
generated
vendored
9
vendor/github.com/docopt/docopt-go/test_golang.docopt
generated
vendored
@@ -1,9 +0,0 @@
|
|||||||
r"""usage: prog [NAME_-2]..."""
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME_-2": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"NAME_-2": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"NAME_-2": []}
|
|
||||||
957
vendor/github.com/docopt/docopt-go/testcases.docopt
generated
vendored
957
vendor/github.com/docopt/docopt-go/testcases.docopt
generated
vendored
@@ -1,957 +0,0 @@
|
|||||||
r"""Usage: prog
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{}
|
|
||||||
|
|
||||||
$ prog --xxx
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: -a All.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"-a": false}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
{"-a": true}
|
|
||||||
|
|
||||||
$ prog -x
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: --all All.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"--all": false}
|
|
||||||
|
|
||||||
$ prog --all
|
|
||||||
{"--all": true}
|
|
||||||
|
|
||||||
$ prog --xxx
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: -v, --verbose Verbose.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog --verbose
|
|
||||||
{"--verbose": true}
|
|
||||||
|
|
||||||
$ prog --ver
|
|
||||||
{"--verbose": true}
|
|
||||||
|
|
||||||
$ prog -v
|
|
||||||
{"--verbose": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: -p PATH
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -p home/
|
|
||||||
{"-p": "home/"}
|
|
||||||
|
|
||||||
$ prog -phome/
|
|
||||||
{"-p": "home/"}
|
|
||||||
|
|
||||||
$ prog -p
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: --path <path>
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog --path home/
|
|
||||||
{"--path": "home/"}
|
|
||||||
|
|
||||||
$ prog --path=home/
|
|
||||||
{"--path": "home/"}
|
|
||||||
|
|
||||||
$ prog --pa home/
|
|
||||||
{"--path": "home/"}
|
|
||||||
|
|
||||||
$ prog --pa=home/
|
|
||||||
{"--path": "home/"}
|
|
||||||
|
|
||||||
$ prog --path
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: -p PATH, --path=<path> Path to files.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -proot
|
|
||||||
{"--path": "root"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: -p --path PATH Path to files.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -p root
|
|
||||||
{"--path": "root"}
|
|
||||||
|
|
||||||
$ prog --path root
|
|
||||||
{"--path": "root"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-p PATH Path to files [default: ./]
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"-p": "./"}
|
|
||||||
|
|
||||||
$ prog -phome
|
|
||||||
{"-p": "home"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""UsAgE: prog [options]
|
|
||||||
|
|
||||||
OpTiOnS: --path=<files> Path to files
|
|
||||||
[dEfAuLt: /root]
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"--path": "/root"}
|
|
||||||
|
|
||||||
$ prog --path=home
|
|
||||||
{"--path": "home"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [options]
|
|
||||||
|
|
||||||
options:
|
|
||||||
-a Add
|
|
||||||
-r Remote
|
|
||||||
-m <msg> Message
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -r -m Hello
|
|
||||||
{"-a": true,
|
|
||||||
"-r": true,
|
|
||||||
"-m": "Hello"}
|
|
||||||
|
|
||||||
$ prog -armyourass
|
|
||||||
{"-a": true,
|
|
||||||
"-r": true,
|
|
||||||
"-m": "yourass"}
|
|
||||||
|
|
||||||
$ prog -a -r
|
|
||||||
{"-a": true,
|
|
||||||
"-r": true,
|
|
||||||
"-m": null}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
Options: --version
|
|
||||||
--verbose
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog --version
|
|
||||||
{"--version": true,
|
|
||||||
"--verbose": false}
|
|
||||||
|
|
||||||
$ prog --verbose
|
|
||||||
{"--version": false,
|
|
||||||
"--verbose": true}
|
|
||||||
|
|
||||||
$ prog --ver
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog --verb
|
|
||||||
{"--version": false,
|
|
||||||
"--verbose": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [-a -r -m <msg>]
|
|
||||||
|
|
||||||
options:
|
|
||||||
-a Add
|
|
||||||
-r Remote
|
|
||||||
-m <msg> Message
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -armyourass
|
|
||||||
{"-a": true,
|
|
||||||
"-r": true,
|
|
||||||
"-m": "yourass"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [-armmsg]
|
|
||||||
|
|
||||||
options: -a Add
|
|
||||||
-r Remote
|
|
||||||
-m <msg> Message
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -r -m Hello
|
|
||||||
{"-a": true,
|
|
||||||
"-r": true,
|
|
||||||
"-m": "Hello"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog -a -b
|
|
||||||
|
|
||||||
options:
|
|
||||||
-a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -b -a
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog (-a -b)
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -b -a
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [-a] -b
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -b -a
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog -b
|
|
||||||
{"-a": false, "-b": true}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [(-a -b)]
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -b -a
|
|
||||||
{"-a": true, "-b": true}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog -b
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"-a": false, "-b": false}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog (-a|-b)
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
{"-a": true, "-b": false}
|
|
||||||
|
|
||||||
$ prog -b
|
|
||||||
{"-a": false, "-b": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [ -a | -b ]
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a -b
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"-a": false, "-b": false}
|
|
||||||
|
|
||||||
$ prog -a
|
|
||||||
{"-a": true, "-b": false}
|
|
||||||
|
|
||||||
$ prog -b
|
|
||||||
{"-a": false, "-b": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog <arg>"""
|
|
||||||
$ prog 10
|
|
||||||
{"<arg>": "10"}
|
|
||||||
|
|
||||||
$ prog 10 20
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [<arg>]"""
|
|
||||||
$ prog 10
|
|
||||||
{"<arg>": "10"}
|
|
||||||
|
|
||||||
$ prog 10 20
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"<arg>": null}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog <kind> <name> <type>"""
|
|
||||||
$ prog 10 20 40
|
|
||||||
{"<kind>": "10", "<name>": "20", "<type>": "40"}
|
|
||||||
|
|
||||||
$ prog 10 20
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog <kind> [<name> <type>]"""
|
|
||||||
$ prog 10 20 40
|
|
||||||
{"<kind>": "10", "<name>": "20", "<type>": "40"}
|
|
||||||
|
|
||||||
$ prog 10 20
|
|
||||||
{"<kind>": "10", "<name>": "20", "<type>": null}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [<kind> | <name> <type>]"""
|
|
||||||
$ prog 10 20 40
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog 20 40
|
|
||||||
{"<kind>": null, "<name>": "20", "<type>": "40"}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"<kind>": null, "<name>": null, "<type>": null}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog (<kind> --all | <name>)
|
|
||||||
|
|
||||||
options:
|
|
||||||
--all
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog 10 --all
|
|
||||||
{"<kind>": "10", "--all": true, "<name>": null}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"<kind>": null, "--all": false, "<name>": "10"}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [<name> <name>]"""
|
|
||||||
$ prog 10 20
|
|
||||||
{"<name>": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"<name>": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"<name>": []}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [(<name> <name>)]"""
|
|
||||||
$ prog 10 20
|
|
||||||
{"<name>": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"<name>": []}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog NAME..."""
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [NAME]..."""
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"NAME": []}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [NAME...]"""
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"NAME": []}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [NAME [NAME ...]]"""
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME": ["10", "20"]}
|
|
||||||
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": ["10"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"NAME": []}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog (NAME | --foo NAME)
|
|
||||||
|
|
||||||
options: --foo
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": "10", "--foo": false}
|
|
||||||
|
|
||||||
$ prog --foo 10
|
|
||||||
{"NAME": "10", "--foo": true}
|
|
||||||
|
|
||||||
$ prog --foo=10
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog (NAME | --foo) [--bar | NAME]
|
|
||||||
|
|
||||||
options: --foo
|
|
||||||
options: --bar
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog 10
|
|
||||||
{"NAME": ["10"], "--foo": false, "--bar": false}
|
|
||||||
|
|
||||||
$ prog 10 20
|
|
||||||
{"NAME": ["10", "20"], "--foo": false, "--bar": false}
|
|
||||||
|
|
||||||
$ prog --foo --bar
|
|
||||||
{"NAME": [], "--foo": true, "--bar": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Naval Fate.
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
prog ship new <name>...
|
|
||||||
prog ship [<name>] move <x> <y> [--speed=<kn>]
|
|
||||||
prog ship shoot <x> <y>
|
|
||||||
prog mine (set|remove) <x> <y> [--moored|--drifting]
|
|
||||||
prog -h | --help
|
|
||||||
prog --version
|
|
||||||
|
|
||||||
Options:
|
|
||||||
-h --help Show this screen.
|
|
||||||
--version Show version.
|
|
||||||
--speed=<kn> Speed in knots [default: 10].
|
|
||||||
--moored Mored (anchored) mine.
|
|
||||||
--drifting Drifting mine.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog ship Guardian move 150 300 --speed=20
|
|
||||||
{"--drifting": false,
|
|
||||||
"--help": false,
|
|
||||||
"--moored": false,
|
|
||||||
"--speed": "20",
|
|
||||||
"--version": false,
|
|
||||||
"<name>": ["Guardian"],
|
|
||||||
"<x>": "150",
|
|
||||||
"<y>": "300",
|
|
||||||
"mine": false,
|
|
||||||
"move": true,
|
|
||||||
"new": false,
|
|
||||||
"remove": false,
|
|
||||||
"set": false,
|
|
||||||
"ship": true,
|
|
||||||
"shoot": false}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog --hello"""
|
|
||||||
$ prog --hello
|
|
||||||
{"--hello": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [--hello=<world>]"""
|
|
||||||
$ prog
|
|
||||||
{"--hello": null}
|
|
||||||
|
|
||||||
$ prog --hello wrld
|
|
||||||
{"--hello": "wrld"}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [-o]"""
|
|
||||||
$ prog
|
|
||||||
{"-o": false}
|
|
||||||
|
|
||||||
$ prog -o
|
|
||||||
{"-o": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [-opr]"""
|
|
||||||
$ prog -op
|
|
||||||
{"-o": true, "-p": true, "-r": false}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog --aabb | --aa"""
|
|
||||||
$ prog --aa
|
|
||||||
{"--aabb": false, "--aa": true}
|
|
||||||
|
|
||||||
$ prog --a
|
|
||||||
"user-error" # not a unique prefix
|
|
||||||
|
|
||||||
#
|
|
||||||
# Counting number of flags
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""Usage: prog -v"""
|
|
||||||
$ prog -v
|
|
||||||
{"-v": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [-v -v]"""
|
|
||||||
$ prog
|
|
||||||
{"-v": 0}
|
|
||||||
|
|
||||||
$ prog -v
|
|
||||||
{"-v": 1}
|
|
||||||
|
|
||||||
$ prog -vv
|
|
||||||
{"-v": 2}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog -v ..."""
|
|
||||||
$ prog
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
$ prog -v
|
|
||||||
{"-v": 1}
|
|
||||||
|
|
||||||
$ prog -vv
|
|
||||||
{"-v": 2}
|
|
||||||
|
|
||||||
$ prog -vvvvvv
|
|
||||||
{"-v": 6}
|
|
||||||
|
|
||||||
|
|
||||||
r"""Usage: prog [-v | -vv | -vvv]
|
|
||||||
|
|
||||||
This one is probably most readable user-friednly variant.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"-v": 0}
|
|
||||||
|
|
||||||
$ prog -v
|
|
||||||
{"-v": 1}
|
|
||||||
|
|
||||||
$ prog -vv
|
|
||||||
{"-v": 2}
|
|
||||||
|
|
||||||
$ prog -vvvv
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [--ver --ver]"""
|
|
||||||
$ prog --ver --ver
|
|
||||||
{"--ver": 2}
|
|
||||||
|
|
||||||
|
|
||||||
#
|
|
||||||
# Counting commands
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [go]"""
|
|
||||||
$ prog go
|
|
||||||
{"go": true}
|
|
||||||
|
|
||||||
|
|
||||||
r"""usage: prog [go go]"""
|
|
||||||
$ prog
|
|
||||||
{"go": 0}
|
|
||||||
|
|
||||||
$ prog go
|
|
||||||
{"go": 1}
|
|
||||||
|
|
||||||
$ prog go go
|
|
||||||
{"go": 2}
|
|
||||||
|
|
||||||
$ prog go go go
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
r"""usage: prog go..."""
|
|
||||||
$ prog go go go go go
|
|
||||||
{"go": 5}
|
|
||||||
|
|
||||||
#
|
|
||||||
# [options] does not include options from usage-pattern
|
|
||||||
#
|
|
||||||
r"""usage: prog [options] [-a]
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
-b
|
|
||||||
"""
|
|
||||||
$ prog -a
|
|
||||||
{"-a": true, "-b": false}
|
|
||||||
|
|
||||||
$ prog -aa
|
|
||||||
"user-error"
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test [options] shourtcut
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""Usage: prog [options] A
|
|
||||||
Options:
|
|
||||||
-q Be quiet
|
|
||||||
-v Be verbose.
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog arg
|
|
||||||
{"A": "arg", "-v": false, "-q": false}
|
|
||||||
|
|
||||||
$ prog -v arg
|
|
||||||
{"A": "arg", "-v": true, "-q": false}
|
|
||||||
|
|
||||||
$ prog -q arg
|
|
||||||
{"A": "arg", "-v": false, "-q": true}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test single dash
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [-]"""
|
|
||||||
|
|
||||||
$ prog -
|
|
||||||
{"-": true}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"-": false}
|
|
||||||
|
|
||||||
#
|
|
||||||
# If argument is repeated, its value should always be a list
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [NAME [NAME ...]]"""
|
|
||||||
|
|
||||||
$ prog a b
|
|
||||||
{"NAME": ["a", "b"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"NAME": []}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Option's argument defaults to null/None
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [options]
|
|
||||||
options:
|
|
||||||
-a Add
|
|
||||||
-m <msg> Message
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a
|
|
||||||
{"-m": null, "-a": true}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test options without description
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog --hello"""
|
|
||||||
$ prog --hello
|
|
||||||
{"--hello": true}
|
|
||||||
|
|
||||||
r"""usage: prog [--hello=<world>]"""
|
|
||||||
$ prog
|
|
||||||
{"--hello": null}
|
|
||||||
|
|
||||||
$ prog --hello wrld
|
|
||||||
{"--hello": "wrld"}
|
|
||||||
|
|
||||||
r"""usage: prog [-o]"""
|
|
||||||
$ prog
|
|
||||||
{"-o": false}
|
|
||||||
|
|
||||||
$ prog -o
|
|
||||||
{"-o": true}
|
|
||||||
|
|
||||||
r"""usage: prog [-opr]"""
|
|
||||||
$ prog -op
|
|
||||||
{"-o": true, "-p": true, "-r": false}
|
|
||||||
|
|
||||||
r"""usage: git [-v | --verbose]"""
|
|
||||||
$ prog -v
|
|
||||||
{"-v": true, "--verbose": false}
|
|
||||||
|
|
||||||
r"""usage: git remote [-v | --verbose]"""
|
|
||||||
$ prog remote -v
|
|
||||||
{"remote": true, "-v": true, "--verbose": false}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test empty usage pattern
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog"""
|
|
||||||
$ prog
|
|
||||||
{}
|
|
||||||
|
|
||||||
r"""usage: prog
|
|
||||||
prog <a> <b>
|
|
||||||
"""
|
|
||||||
$ prog 1 2
|
|
||||||
{"<a>": "1", "<b>": "2"}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"<a>": null, "<b>": null}
|
|
||||||
|
|
||||||
r"""usage: prog <a> <b>
|
|
||||||
prog
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"<a>": null, "<b>": null}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Option's argument should not capture default value from usage pattern
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [--file=<f>]"""
|
|
||||||
$ prog
|
|
||||||
{"--file": null}
|
|
||||||
|
|
||||||
r"""usage: prog [--file=<f>]
|
|
||||||
|
|
||||||
options: --file <a>
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"--file": null}
|
|
||||||
|
|
||||||
r"""Usage: prog [-a <host:port>]
|
|
||||||
|
|
||||||
Options: -a, --address <host:port> TCP address [default: localhost:6283].
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog
|
|
||||||
{"--address": "localhost:6283"}
|
|
||||||
|
|
||||||
#
|
|
||||||
# If option with argument could be repeated,
|
|
||||||
# its arguments should be accumulated into a list
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog --long=<arg> ..."""
|
|
||||||
|
|
||||||
$ prog --long one
|
|
||||||
{"--long": ["one"]}
|
|
||||||
|
|
||||||
$ prog --long one --long two
|
|
||||||
{"--long": ["one", "two"]}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test multiple elements repeated at once
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog (go <direction> --speed=<km/h>)..."""
|
|
||||||
$ prog go left --speed=5 go right --speed=9
|
|
||||||
{"go": 2, "<direction>": ["left", "right"], "--speed": ["5", "9"]}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Required options should work with option shortcut
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [options] -a
|
|
||||||
|
|
||||||
options: -a
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -a
|
|
||||||
{"-a": true}
|
|
||||||
|
|
||||||
#
|
|
||||||
# If option could be repeated its defaults should be split into a list
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [-o <o>]...
|
|
||||||
|
|
||||||
options: -o <o> [default: x]
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -o this -o that
|
|
||||||
{"-o": ["this", "that"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"-o": ["x"]}
|
|
||||||
|
|
||||||
r"""usage: prog [-o <o>]...
|
|
||||||
|
|
||||||
options: -o <o> [default: x y]
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -o this
|
|
||||||
{"-o": ["this"]}
|
|
||||||
|
|
||||||
$ prog
|
|
||||||
{"-o": ["x", "y"]}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Test stacked option's argument
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog -pPATH
|
|
||||||
|
|
||||||
options: -p PATH
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog -pHOME
|
|
||||||
{"-p": "HOME"}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Issue 56: Repeated mutually exclusive args give nested lists sometimes
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""Usage: foo (--xx=x|--yy=y)..."""
|
|
||||||
$ prog --xx=1 --yy=2
|
|
||||||
{"--xx": ["1"], "--yy": ["2"]}
|
|
||||||
|
|
||||||
#
|
|
||||||
# POSIXly correct tokenization
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog [<input file>]"""
|
|
||||||
$ prog f.txt
|
|
||||||
{"<input file>": "f.txt"}
|
|
||||||
|
|
||||||
r"""usage: prog [--input=<file name>]..."""
|
|
||||||
$ prog --input a.txt --input=b.txt
|
|
||||||
{"--input": ["a.txt", "b.txt"]}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Issue 85: `[options]` shourtcut with multiple subcommands
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage: prog good [options]
|
|
||||||
prog fail [options]
|
|
||||||
|
|
||||||
options: --loglevel=N
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog fail --loglevel 5
|
|
||||||
{"--loglevel": "5", "fail": true, "good": false}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Usage-section syntax
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""usage:prog --foo"""
|
|
||||||
$ prog --foo
|
|
||||||
{"--foo": true}
|
|
||||||
|
|
||||||
r"""PROGRAM USAGE: prog --foo"""
|
|
||||||
$ prog --foo
|
|
||||||
{"--foo": true}
|
|
||||||
|
|
||||||
r"""Usage: prog --foo
|
|
||||||
prog --bar
|
|
||||||
NOT PART OF SECTION"""
|
|
||||||
$ prog --foo
|
|
||||||
{"--foo": true, "--bar": false}
|
|
||||||
|
|
||||||
r"""Usage:
|
|
||||||
prog --foo
|
|
||||||
prog --bar
|
|
||||||
|
|
||||||
NOT PART OF SECTION"""
|
|
||||||
$ prog --foo
|
|
||||||
{"--foo": true, "--bar": false}
|
|
||||||
|
|
||||||
r"""Usage:
|
|
||||||
prog --foo
|
|
||||||
prog --bar
|
|
||||||
NOT PART OF SECTION"""
|
|
||||||
$ prog --foo
|
|
||||||
{"--foo": true, "--bar": false}
|
|
||||||
|
|
||||||
#
|
|
||||||
# Options-section syntax
|
|
||||||
#
|
|
||||||
|
|
||||||
r"""Usage: prog [options]
|
|
||||||
|
|
||||||
global options: --foo
|
|
||||||
local options: --baz
|
|
||||||
--bar
|
|
||||||
other options:
|
|
||||||
--egg
|
|
||||||
--spam
|
|
||||||
-not-an-option-
|
|
||||||
|
|
||||||
"""
|
|
||||||
$ prog --baz --egg
|
|
||||||
{"--foo": false, "--baz": true, "--bar": false, "--egg": true, "--spam": false}
|
|
||||||
126
vendor/github.com/docopt/docopt-go/token.go
generated
vendored
126
vendor/github.com/docopt/docopt-go/token.go
generated
vendored
@@ -1,126 +0,0 @@
|
|||||||
package docopt
|
|
||||||
|
|
||||||
import (
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
"unicode"
|
|
||||||
)
|
|
||||||
|
|
||||||
type tokenList struct {
|
|
||||||
tokens []string
|
|
||||||
errorFunc func(string, ...interface{}) error
|
|
||||||
err errorType
|
|
||||||
}
|
|
||||||
type token string
|
|
||||||
|
|
||||||
func newTokenList(source []string, err errorType) *tokenList {
|
|
||||||
errorFunc := newError
|
|
||||||
if err == errorUser {
|
|
||||||
errorFunc = newUserError
|
|
||||||
} else if err == errorLanguage {
|
|
||||||
errorFunc = newLanguageError
|
|
||||||
}
|
|
||||||
return &tokenList{source, errorFunc, err}
|
|
||||||
}
|
|
||||||
|
|
||||||
func tokenListFromString(source string) *tokenList {
|
|
||||||
return newTokenList(strings.Fields(source), errorUser)
|
|
||||||
}
|
|
||||||
|
|
||||||
func tokenListFromPattern(source string) *tokenList {
|
|
||||||
p := regexp.MustCompile(`([\[\]\(\)\|]|\.\.\.)`)
|
|
||||||
source = p.ReplaceAllString(source, ` $1 `)
|
|
||||||
p = regexp.MustCompile(`\s+|(\S*<.*?>)`)
|
|
||||||
split := p.Split(source, -1)
|
|
||||||
match := p.FindAllStringSubmatch(source, -1)
|
|
||||||
var result []string
|
|
||||||
l := len(split)
|
|
||||||
for i := 0; i < l; i++ {
|
|
||||||
if len(split[i]) > 0 {
|
|
||||||
result = append(result, split[i])
|
|
||||||
}
|
|
||||||
if i < l-1 && len(match[i][1]) > 0 {
|
|
||||||
result = append(result, match[i][1])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return newTokenList(result, errorLanguage)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (t *token) eq(s string) bool {
|
|
||||||
if t == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return string(*t) == s
|
|
||||||
}
|
|
||||||
func (t *token) match(matchNil bool, tokenStrings ...string) bool {
|
|
||||||
if t == nil && matchNil {
|
|
||||||
return true
|
|
||||||
} else if t == nil && !matchNil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tok := range tokenStrings {
|
|
||||||
if tok == string(*t) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
func (t *token) hasPrefix(prefix string) bool {
|
|
||||||
if t == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return strings.HasPrefix(string(*t), prefix)
|
|
||||||
}
|
|
||||||
func (t *token) hasSuffix(suffix string) bool {
|
|
||||||
if t == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return strings.HasSuffix(string(*t), suffix)
|
|
||||||
}
|
|
||||||
func (t *token) isUpper() bool {
|
|
||||||
if t == nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return isStringUppercase(string(*t))
|
|
||||||
}
|
|
||||||
func (t *token) String() string {
|
|
||||||
if t == nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return string(*t)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tl *tokenList) current() *token {
|
|
||||||
if len(tl.tokens) > 0 {
|
|
||||||
return (*token)(&(tl.tokens[0]))
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tl *tokenList) length() int {
|
|
||||||
return len(tl.tokens)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tl *tokenList) move() *token {
|
|
||||||
if len(tl.tokens) > 0 {
|
|
||||||
t := tl.tokens[0]
|
|
||||||
tl.tokens = tl.tokens[1:]
|
|
||||||
return (*token)(&t)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// returns true if all cased characters in the string are uppercase
|
|
||||||
// and there are there is at least one cased charcter
|
|
||||||
func isStringUppercase(s string) bool {
|
|
||||||
if strings.ToUpper(s) != s {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
for _, c := range []rune(s) {
|
|
||||||
if unicode.IsUpper(c) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
201
vendor/github.com/inconshreveable/mousetrap/LICENSE
generated
vendored
Normal file
201
vendor/github.com/inconshreveable/mousetrap/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright 2022 Alan Shreve (@inconshreveable)
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
23
vendor/github.com/inconshreveable/mousetrap/README.md
generated
vendored
Normal file
23
vendor/github.com/inconshreveable/mousetrap/README.md
generated
vendored
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# mousetrap
|
||||||
|
|
||||||
|
mousetrap is a tiny library that answers a single question.
|
||||||
|
|
||||||
|
On a Windows machine, was the process invoked by someone double clicking on
|
||||||
|
the executable file while browsing in explorer?
|
||||||
|
|
||||||
|
### Motivation
|
||||||
|
|
||||||
|
Windows developers unfamiliar with command line tools will often "double-click"
|
||||||
|
the executable for a tool. Because most CLI tools print the help and then exit
|
||||||
|
when invoked without arguments, this is often very frustrating for those users.
|
||||||
|
|
||||||
|
mousetrap provides a way to detect these invocations so that you can provide
|
||||||
|
more helpful behavior and instructions on how to run the CLI tool. To see what
|
||||||
|
this looks like, both from an organizational and a technical perspective, see
|
||||||
|
https://inconshreveable.com/09-09-2014/sweat-the-small-stuff/
|
||||||
|
|
||||||
|
### The interface
|
||||||
|
|
||||||
|
The library exposes a single interface:
|
||||||
|
|
||||||
|
func StartedByExplorer() (bool)
|
||||||
16
vendor/github.com/inconshreveable/mousetrap/trap_others.go
generated
vendored
Normal file
16
vendor/github.com/inconshreveable/mousetrap/trap_others.go
generated
vendored
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
//go:build !windows
|
||||||
|
// +build !windows
|
||||||
|
|
||||||
|
package mousetrap
|
||||||
|
|
||||||
|
// StartedByExplorer returns true if the program was invoked by the user
|
||||||
|
// double-clicking on the executable from explorer.exe
|
||||||
|
//
|
||||||
|
// It is conservative and returns false if any of the internal calls fail.
|
||||||
|
// It does not guarantee that the program was run from a terminal. It only can tell you
|
||||||
|
// whether it was launched from explorer.exe
|
||||||
|
//
|
||||||
|
// On non-Windows platforms, it always returns false.
|
||||||
|
func StartedByExplorer() bool {
|
||||||
|
return false
|
||||||
|
}
|
||||||
42
vendor/github.com/inconshreveable/mousetrap/trap_windows.go
generated
vendored
Normal file
42
vendor/github.com/inconshreveable/mousetrap/trap_windows.go
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
package mousetrap
|
||||||
|
|
||||||
|
import (
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
func getProcessEntry(pid int) (*syscall.ProcessEntry32, error) {
|
||||||
|
snapshot, err := syscall.CreateToolhelp32Snapshot(syscall.TH32CS_SNAPPROCESS, 0)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer syscall.CloseHandle(snapshot)
|
||||||
|
var procEntry syscall.ProcessEntry32
|
||||||
|
procEntry.Size = uint32(unsafe.Sizeof(procEntry))
|
||||||
|
if err = syscall.Process32First(snapshot, &procEntry); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
if procEntry.ProcessID == uint32(pid) {
|
||||||
|
return &procEntry, nil
|
||||||
|
}
|
||||||
|
err = syscall.Process32Next(snapshot, &procEntry)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// StartedByExplorer returns true if the program was invoked by the user double-clicking
|
||||||
|
// on the executable from explorer.exe
|
||||||
|
//
|
||||||
|
// It is conservative and returns false if any of the internal calls fail.
|
||||||
|
// It does not guarantee that the program was run from a terminal. It only can tell you
|
||||||
|
// whether it was launched from explorer.exe
|
||||||
|
func StartedByExplorer() bool {
|
||||||
|
pe, err := getProcessEntry(syscall.Getppid())
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return "explorer.exe" == syscall.UTF16ToString(pe.ExeFile[:])
|
||||||
|
}
|
||||||
20
vendor/github.com/docopt/docopt-go/.gitignore → vendor/github.com/spf13/cobra/.gitignore
generated
vendored
20
vendor/github.com/docopt/docopt-go/.gitignore → vendor/github.com/spf13/cobra/.gitignore
generated
vendored
@@ -19,7 +19,21 @@ _cgo_export.*
|
|||||||
|
|
||||||
_testmain.go
|
_testmain.go
|
||||||
|
|
||||||
*.exe
|
# Vim files https://github.com/github/gitignore/blob/master/Global/Vim.gitignore
|
||||||
|
# swap
|
||||||
|
[._]*.s[a-w][a-z]
|
||||||
|
[._]s[a-w][a-z]
|
||||||
|
# session
|
||||||
|
Session.vim
|
||||||
|
# temporary
|
||||||
|
.netrwhist
|
||||||
|
*~
|
||||||
|
# auto-generated tag files
|
||||||
|
tags
|
||||||
|
|
||||||
# coverage droppings
|
*.exe
|
||||||
profile.cov
|
cobra.test
|
||||||
|
bin
|
||||||
|
|
||||||
|
.idea/
|
||||||
|
*.iml
|
||||||
66
vendor/github.com/spf13/cobra/.golangci.yml
generated
vendored
Normal file
66
vendor/github.com/spf13/cobra/.golangci.yml
generated
vendored
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# Copyright 2013-2023 The Cobra Authors
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
version: "2"
|
||||||
|
|
||||||
|
run:
|
||||||
|
timeout: 5m
|
||||||
|
|
||||||
|
formatters:
|
||||||
|
enable:
|
||||||
|
- gofmt
|
||||||
|
- goimports
|
||||||
|
|
||||||
|
linters:
|
||||||
|
default: none
|
||||||
|
enable:
|
||||||
|
#- bodyclose
|
||||||
|
#- depguard
|
||||||
|
#- dogsled
|
||||||
|
#- dupl
|
||||||
|
- errcheck
|
||||||
|
#- exhaustive
|
||||||
|
#- funlen
|
||||||
|
#- gochecknoinits
|
||||||
|
- goconst
|
||||||
|
- gocritic
|
||||||
|
#- gocyclo
|
||||||
|
#- goprintffuncname
|
||||||
|
- gosec
|
||||||
|
- govet
|
||||||
|
- ineffassign
|
||||||
|
#- lll
|
||||||
|
- misspell
|
||||||
|
#- mnd
|
||||||
|
#- nakedret
|
||||||
|
#- noctx
|
||||||
|
- nolintlint
|
||||||
|
#- rowserrcheck
|
||||||
|
- staticcheck
|
||||||
|
- unconvert
|
||||||
|
#- unparam
|
||||||
|
- unused
|
||||||
|
#- whitespace
|
||||||
|
exclusions:
|
||||||
|
presets:
|
||||||
|
- common-false-positives
|
||||||
|
- legacy
|
||||||
|
- std-error-handling
|
||||||
|
settings:
|
||||||
|
govet:
|
||||||
|
# Disable buildtag check to allow dual build tag syntax (both //go:build and // +build).
|
||||||
|
# This is necessary for Go 1.15 compatibility since //go:build was introduced in Go 1.17.
|
||||||
|
# This can be removed once Cobra requires Go 1.17 or higher.
|
||||||
|
disable:
|
||||||
|
- buildtag
|
||||||
3
vendor/github.com/spf13/cobra/.mailmap
generated
vendored
Normal file
3
vendor/github.com/spf13/cobra/.mailmap
generated
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
Steve Francia <steve.francia@gmail.com>
|
||||||
|
Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
|
||||||
|
Fabiano Franz <ffranz@redhat.com> <contact@fabianofranz.com>
|
||||||
37
vendor/github.com/spf13/cobra/CONDUCT.md
generated
vendored
Normal file
37
vendor/github.com/spf13/cobra/CONDUCT.md
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
## Cobra User Contract
|
||||||
|
|
||||||
|
### Versioning
|
||||||
|
Cobra will follow a steady release cadence. Non breaking changes will be released as minor versions quarterly. Patch bug releases are at the discretion of the maintainers. Users can expect security patch fixes to be released within relatively short order of a CVE becoming known. For more information on security patch fixes see the CVE section below. Releases will follow [Semantic Versioning](https://semver.org/). Users tracking the Master branch should expect unpredictable breaking changes as the project continues to move forward. For stability, it is highly recommended to use a release.
|
||||||
|
|
||||||
|
### Backward Compatibility
|
||||||
|
We will maintain two major releases in a moving window. The N-1 release will only receive bug fixes and security updates and will be dropped once N+1 is released.
|
||||||
|
|
||||||
|
### Deprecation
|
||||||
|
Deprecation of Go versions or dependent packages will only occur in major releases. To reduce the change of this taking users by surprise, any large deprecation will be preceded by an announcement in the [#cobra slack channel](https://gophers.slack.com/archives/CD3LP1199) and an Issue on Github.
|
||||||
|
|
||||||
|
### CVE
|
||||||
|
Maintainers will make every effort to release security patches in the case of a medium to high severity CVE directly impacting the library. The speed in which these patches reach a release is up to the discretion of the maintainers. A low severity CVE may be a lower priority than a high severity one.
|
||||||
|
|
||||||
|
### Communication
|
||||||
|
Cobra maintainers will use GitHub issues and the [#cobra slack channel](https://gophers.slack.com/archives/CD3LP1199) as the primary means of communication with the community. This is to foster open communication with all users and contributors.
|
||||||
|
|
||||||
|
### Breaking Changes
|
||||||
|
Breaking changes are generally allowed in the master branch, as this is the branch used to develop the next release of Cobra.
|
||||||
|
|
||||||
|
There may be times, however, when master is closed for breaking changes. This is likely to happen as we near the release of a new version.
|
||||||
|
|
||||||
|
Breaking changes are not allowed in release branches, as these represent minor versions that have already been released. These version have consumers who expect the APIs, behaviors, etc, to remain stable during the lifetime of the patch stream for the minor release.
|
||||||
|
|
||||||
|
Examples of breaking changes include:
|
||||||
|
- Removing or renaming exported constant, variable, type, or function.
|
||||||
|
- Updating the version of critical libraries such as `spf13/pflag`, `spf13/viper` etc...
|
||||||
|
- Some version updates may be acceptable for picking up bug fixes, but maintainers must exercise caution when reviewing.
|
||||||
|
|
||||||
|
There may, at times, need to be exceptions where breaking changes are allowed in release branches. These are at the discretion of the project's maintainers, and must be carefully considered before merging.
|
||||||
|
|
||||||
|
### CI Testing
|
||||||
|
Maintainers will ensure the Cobra test suite utilizes the current supported versions of Golang.
|
||||||
|
|
||||||
|
### Disclaimer
|
||||||
|
Changes to this document and the contents therein are at the discretion of the maintainers.
|
||||||
|
None of the contents of this document are legally binding in any way to the maintainers or the users.
|
||||||
50
vendor/github.com/spf13/cobra/CONTRIBUTING.md
generated
vendored
Normal file
50
vendor/github.com/spf13/cobra/CONTRIBUTING.md
generated
vendored
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
# Contributing to Cobra
|
||||||
|
|
||||||
|
Thank you so much for contributing to Cobra. We appreciate your time and help.
|
||||||
|
Here are some guidelines to help you get started.
|
||||||
|
|
||||||
|
## Code of Conduct
|
||||||
|
|
||||||
|
Be kind and respectful to the members of the community. Take time to educate
|
||||||
|
others who are seeking help. Harassment of any kind will not be tolerated.
|
||||||
|
|
||||||
|
## Questions
|
||||||
|
|
||||||
|
If you have questions regarding Cobra, feel free to ask it in the community
|
||||||
|
[#cobra Slack channel][cobra-slack]
|
||||||
|
|
||||||
|
## Filing a bug or feature
|
||||||
|
|
||||||
|
1. Before filing an issue, please check the existing issues to see if a
|
||||||
|
similar one was already opened. If there is one already opened, feel free
|
||||||
|
to comment on it.
|
||||||
|
1. If you believe you've found a bug, please provide detailed steps of
|
||||||
|
reproduction, the version of Cobra and anything else you believe will be
|
||||||
|
useful to help troubleshoot it (e.g. OS environment, environment variables,
|
||||||
|
etc...). Also state the current behavior vs. the expected behavior.
|
||||||
|
1. If you'd like to see a feature or an enhancement please open an issue with
|
||||||
|
a clear title and description of what the feature is and why it would be
|
||||||
|
beneficial to the project and its users.
|
||||||
|
|
||||||
|
## Submitting changes
|
||||||
|
|
||||||
|
1. CLA: Upon submitting a Pull Request (PR), contributors will be prompted to
|
||||||
|
sign a CLA. Please sign the CLA :slightly_smiling_face:
|
||||||
|
1. Tests: If you are submitting code, please ensure you have adequate tests
|
||||||
|
for the feature. Tests can be run via `go test ./...` or `make test`.
|
||||||
|
1. Since this is golang project, ensure the new code is properly formatted to
|
||||||
|
ensure code consistency. Run `make all`.
|
||||||
|
|
||||||
|
### Quick steps to contribute
|
||||||
|
|
||||||
|
1. Fork the project.
|
||||||
|
1. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
|
||||||
|
1. Create your feature branch (`git checkout -b my-new-feature`)
|
||||||
|
1. Make changes and run tests (`make test`)
|
||||||
|
1. Add them to staging (`git add .`)
|
||||||
|
1. Commit your changes (`git commit -m 'Add some feature'`)
|
||||||
|
1. Push to the branch (`git push origin my-new-feature`)
|
||||||
|
1. Create new pull request
|
||||||
|
|
||||||
|
<!-- Links -->
|
||||||
|
[cobra-slack]: https://gophers.slack.com/archives/CD3LP1199
|
||||||
174
vendor/github.com/spf13/cobra/LICENSE.txt
generated
vendored
Normal file
174
vendor/github.com/spf13/cobra/LICENSE.txt
generated
vendored
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
13
vendor/github.com/spf13/cobra/MAINTAINERS
generated
vendored
Normal file
13
vendor/github.com/spf13/cobra/MAINTAINERS
generated
vendored
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
maintainers:
|
||||||
|
- spf13
|
||||||
|
- johnSchnake
|
||||||
|
- jpmcb
|
||||||
|
- marckhouzam
|
||||||
|
inactive:
|
||||||
|
- anthonyfok
|
||||||
|
- bep
|
||||||
|
- bogem
|
||||||
|
- broady
|
||||||
|
- eparis
|
||||||
|
- jharshman
|
||||||
|
- wfernandes
|
||||||
35
vendor/github.com/spf13/cobra/Makefile
generated
vendored
Normal file
35
vendor/github.com/spf13/cobra/Makefile
generated
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
BIN="./bin"
|
||||||
|
SRC=$(shell find . -name "*.go")
|
||||||
|
|
||||||
|
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")
|
||||||
|
endif
|
||||||
|
|
||||||
|
.PHONY: fmt lint test install_deps clean
|
||||||
|
|
||||||
|
default: all
|
||||||
|
|
||||||
|
all: fmt test
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
$(info ******************** checking formatting ********************)
|
||||||
|
@test -z $(shell gofmt -l $(SRC)) || (gofmt -d $(SRC); exit 1)
|
||||||
|
|
||||||
|
lint:
|
||||||
|
$(info ******************** running lint tools ********************)
|
||||||
|
golangci-lint run -v
|
||||||
|
|
||||||
|
test: install_deps
|
||||||
|
$(info ******************** running tests ********************)
|
||||||
|
go test -v ./...
|
||||||
|
|
||||||
|
richtest: install_deps
|
||||||
|
$(info ******************** running tests with kyoh86/richgo ********************)
|
||||||
|
richgo test -v ./...
|
||||||
|
|
||||||
|
install_deps:
|
||||||
|
$(info ******************** downloading dependencies ********************)
|
||||||
|
go get -v ./...
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf $(BIN)
|
||||||
133
vendor/github.com/spf13/cobra/README.md
generated
vendored
Normal file
133
vendor/github.com/spf13/cobra/README.md
generated
vendored
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
<div align="center">
|
||||||
|
<a href="https://cobra.dev">
|
||||||
|
<img width="512" height="535" alt="cobra-logo" src="https://github.com/user-attachments/assets/c8bf9aad-b5ae-41d3-8899-d83baec10af8" />
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Cobra is a library for creating powerful modern CLI applications.
|
||||||
|
|
||||||
|
<a href="https://cobra.dev">Visit Cobra.dev for extensive documentation</a>
|
||||||
|
|
||||||
|
|
||||||
|
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
|
||||||
|
name a few. [This list](site/content/projects_using_cobra.md) contains a more extensive list of projects using Cobra.
|
||||||
|
|
||||||
|
[](https://github.com/spf13/cobra/actions?query=workflow%3ATest)
|
||||||
|
[](https://pkg.go.dev/github.com/spf13/cobra)
|
||||||
|
[](https://goreportcard.com/report/github.com/spf13/cobra)
|
||||||
|
[](https://gophers.slack.com/archives/CD3LP1199)
|
||||||
|
<hr>
|
||||||
|
<div align="center" markdown="1">
|
||||||
|
<sup>Supported by:</sup>
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
<a href="https://www.warp.dev/cobra">
|
||||||
|
<img alt="Warp sponsorship" width="400" src="https://github.com/user-attachments/assets/ab8dd143-b0fd-4904-bdc5-dd7ecac94eae">
|
||||||
|
</a>
|
||||||
|
|
||||||
|
### [Warp, the AI terminal for devs](https://www.warp.dev/cobra)
|
||||||
|
[Try Cobra in Warp today](https://www.warp.dev/cobra)<br>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
# Overview
|
||||||
|
|
||||||
|
Cobra is a library providing a simple interface to create powerful modern CLI
|
||||||
|
interfaces similar to git & go tools.
|
||||||
|
|
||||||
|
Cobra provides:
|
||||||
|
* Easy subcommand-based CLIs: `app server`, `app fetch`, etc.
|
||||||
|
* Fully POSIX-compliant flags (including short & long versions)
|
||||||
|
* Nested subcommands
|
||||||
|
* Global, local and cascading flags
|
||||||
|
* Intelligent suggestions (`app srver`... did you mean `app server`?)
|
||||||
|
* Automatic help generation for commands and flags
|
||||||
|
* Grouping help for subcommands
|
||||||
|
* Automatic help flag recognition of `-h`, `--help`, etc.
|
||||||
|
* Automatically generated shell autocomplete for your application (bash, zsh, fish, powershell)
|
||||||
|
* Automatically generated man pages for your application
|
||||||
|
* Command aliases so you can change things without breaking them
|
||||||
|
* The flexibility to define your own help, usage, etc.
|
||||||
|
* Optional seamless integration with [viper](https://github.com/spf13/viper) for 12-factor apps
|
||||||
|
|
||||||
|
# Concepts
|
||||||
|
|
||||||
|
Cobra is built on a structure of commands, arguments & flags.
|
||||||
|
|
||||||
|
**Commands** represent actions, **Args** are things and **Flags** are modifiers for those actions.
|
||||||
|
|
||||||
|
The best applications read like sentences when used, and as a result, users
|
||||||
|
intuitively know how to interact with them.
|
||||||
|
|
||||||
|
The pattern to follow is
|
||||||
|
`APPNAME VERB NOUN --ADJECTIVE`
|
||||||
|
or
|
||||||
|
`APPNAME COMMAND ARG --FLAG`.
|
||||||
|
|
||||||
|
A few good real world examples may better illustrate this point.
|
||||||
|
|
||||||
|
In the following example, 'server' is a command, and 'port' is a flag:
|
||||||
|
|
||||||
|
hugo server --port=1313
|
||||||
|
|
||||||
|
In this command we are telling Git to clone the url bare.
|
||||||
|
|
||||||
|
git clone URL --bare
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Command is the central point of the application. Each interaction that
|
||||||
|
the application supports will be contained in a Command. A command can
|
||||||
|
have children commands and optionally run an action.
|
||||||
|
|
||||||
|
In the example above, 'server' is the command.
|
||||||
|
|
||||||
|
[More about cobra.Command](https://pkg.go.dev/github.com/spf13/cobra#Command)
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
|
||||||
|
A flag is a way to modify the behavior of a command. Cobra supports
|
||||||
|
fully POSIX-compliant flags as well as the Go [flag package](https://golang.org/pkg/flag/).
|
||||||
|
A Cobra command can define flags that persist through to children commands
|
||||||
|
and flags that are only available to that command.
|
||||||
|
|
||||||
|
In the example above, 'port' is the flag.
|
||||||
|
|
||||||
|
Flag functionality is provided by the [pflag
|
||||||
|
library](https://github.com/spf13/pflag), a fork of the flag standard library
|
||||||
|
which maintains the same interface while adding POSIX compliance.
|
||||||
|
|
||||||
|
# Installing
|
||||||
|
Using Cobra is easy. First, use `go get` to install the latest version
|
||||||
|
of the library.
|
||||||
|
|
||||||
|
```
|
||||||
|
go get -u github.com/spf13/cobra@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, include Cobra in your application:
|
||||||
|
|
||||||
|
```go
|
||||||
|
import "github.com/spf13/cobra"
|
||||||
|
```
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
`cobra-cli` is a command line program to generate cobra applications and command files.
|
||||||
|
It will bootstrap your application scaffolding to rapidly
|
||||||
|
develop a Cobra-based application. It is the easiest way to incorporate Cobra into your application.
|
||||||
|
|
||||||
|
It can be installed by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
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 library, please read [The Cobra User Guide](site/content/user_guide.md).
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)
|
||||||
105
vendor/github.com/spf13/cobra/SECURITY.md
generated
vendored
Normal file
105
vendor/github.com/spf13/cobra/SECURITY.md
generated
vendored
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
The `cobra` maintainers take security issues seriously and
|
||||||
|
we appreciate your efforts to _**responsibly**_ disclose your findings.
|
||||||
|
We will make every effort to swiftly respond and address concerns.
|
||||||
|
|
||||||
|
To report a security vulnerability:
|
||||||
|
|
||||||
|
1. **DO NOT** create a public GitHub issue for the vulnerability!
|
||||||
|
2. **DO NOT** create a public GitHub Pull Request with a fix for the vulnerability!
|
||||||
|
3. Send an email to `cobra-security@googlegroups.com`.
|
||||||
|
4. Include the following details in your report:
|
||||||
|
- Description of the vulnerability
|
||||||
|
- Steps to reproduce
|
||||||
|
- Potential impact of the vulnerability (to your downstream project, to the Go ecosystem, etc.)
|
||||||
|
- Any potential mitigations you've already identified
|
||||||
|
5. Allow up to 7 days for an initial response.
|
||||||
|
You should receive an acknowledgment of your report and an estimated timeline for a fix.
|
||||||
|
6. (Optional) If you have a fix and would like to contribute your patch, please work
|
||||||
|
directly with the maintainers via `cobra-security@googlegroups.com` to
|
||||||
|
coordinate pushing the patch to GitHub, cutting a new release, and disclosing the change.
|
||||||
|
|
||||||
|
## Response Process
|
||||||
|
|
||||||
|
When a security vulnerability report is received, the `cobra` maintainers will:
|
||||||
|
|
||||||
|
1. Confirm receipt of the vulnerability report within 7 days.
|
||||||
|
2. Assess the report to determine if it constitutes a security vulnerability.
|
||||||
|
3. If confirmed, assign the vulnerability a severity level and create a timeline for addressing it.
|
||||||
|
4. Develop and test a fix.
|
||||||
|
5. Patch the vulnerability and make a new GitHub release: the maintainers will coordinate disclosure with the reporter.
|
||||||
|
6. Create a new GitHub Security Advisory to inform the broader Go ecosystem
|
||||||
|
|
||||||
|
## Disclosure Policy
|
||||||
|
|
||||||
|
The `cobra` maintainers follow a coordinated disclosure process:
|
||||||
|
|
||||||
|
1. Security vulnerabilities will be addressed as quickly as possible.
|
||||||
|
2. A CVE (Common Vulnerabilities and Exposures) identifier will be requested for significant vulnerabilities
|
||||||
|
that are within `cobra` itself.
|
||||||
|
3. Once a fix is ready, the maintainers will:
|
||||||
|
- Release a new version containing the fix.
|
||||||
|
- Update the security advisory with details about the vulnerability.
|
||||||
|
- Credit the reporter (unless they wish to remain anonymous).
|
||||||
|
- Credit the fixer (unless they wish to remain anonymous, this may be the same as the reporter).
|
||||||
|
- Announce the vulnerability through appropriate channels
|
||||||
|
(GitHub Security Advisory, mailing lists, GitHub Releases, etc.)
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
Security fixes will typically only be released for the most recent major release.
|
||||||
|
|
||||||
|
## Upstream Security Issues
|
||||||
|
|
||||||
|
`cobra` generally will not accept vulnerability reports that originate in upstream
|
||||||
|
dependencies. I.e., if there is a problem in Go code that `cobra` depends on,
|
||||||
|
it is best to engage that project's maintainers and owners.
|
||||||
|
|
||||||
|
This security policy primarily pertains only to `cobra` itself but if you believe you've
|
||||||
|
identified a problem that originates in an upstream dependency and is being widely
|
||||||
|
distributed by `cobra`, please follow the disclosure procedure above: the `cobra`
|
||||||
|
maintainers will work with you to determine the severity and ecosystem impact.
|
||||||
|
|
||||||
|
## Security Updates and CVEs
|
||||||
|
|
||||||
|
Information about known security vulnerabilities and CVEs affecting `cobra` will
|
||||||
|
be published as GitHub Security Advisories at
|
||||||
|
https://github.com/spf13/cobra/security/advisories.
|
||||||
|
|
||||||
|
All users are encouraged to watch the repository and upgrade promptly when
|
||||||
|
security releases are published.
|
||||||
|
|
||||||
|
## `cobra` Security Best Practices for Users
|
||||||
|
|
||||||
|
When using `cobra` in your CLIs, the `cobra` maintainers recommend the following:
|
||||||
|
|
||||||
|
1. Always use the latest version of `cobra`.
|
||||||
|
2. [Use Go modules](https://go.dev/blog/using-go-modules) for dependency management.
|
||||||
|
3. Always use the latest possible version of Go.
|
||||||
|
|
||||||
|
## Security Best Practices for Contributors
|
||||||
|
|
||||||
|
When contributing to `cobra`:
|
||||||
|
|
||||||
|
1. Be mindful of security implications when adding new features or modifying existing ones.
|
||||||
|
2. Be aware of `cobra`'s extremely large reach: it is used in nearly every Go CLI
|
||||||
|
(like Kubernetes, Docker, Prometheus, etc. etc.)
|
||||||
|
3. Write tests that explicitly cover edge cases and potential issues.
|
||||||
|
4. If you discover a security issue while working on `cobra`, please report it
|
||||||
|
following the process above rather than opening a public pull request or issue that
|
||||||
|
addresses the vulnerability.
|
||||||
|
5. Take personal sec-ops seriously and secure your GitHub account: use [two-factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa),
|
||||||
|
[sign your commits with a GPG or SSH key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification),
|
||||||
|
etc.
|
||||||
|
|
||||||
|
## Acknowledgments
|
||||||
|
|
||||||
|
The `cobra` maintainers would like to thank all security researchers and
|
||||||
|
community members who help keep cobra, its users, and the entire Go ecosystem secure through responsible disclosures!!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*This security policy is inspired by the [Open Web Application Security Project (OWASP)](https://owasp.org/) guidelines and security best practices.*
|
||||||
60
vendor/github.com/spf13/cobra/active_help.go
generated
vendored
Normal file
60
vendor/github.com/spf13/cobra/active_help.go
generated
vendored
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
activeHelpMarker = "_activeHelp_ "
|
||||||
|
// The below values should not be changed: programs will be using them explicitly
|
||||||
|
// in their user documentation, and users will be using them explicitly.
|
||||||
|
activeHelpEnvVarSuffix = "ACTIVE_HELP"
|
||||||
|
activeHelpGlobalEnvVar = configEnvVarGlobalPrefix + "_" + activeHelpEnvVarSuffix
|
||||||
|
activeHelpGlobalDisable = "0"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AppendActiveHelp adds the specified string to the specified array to be used as ActiveHelp.
|
||||||
|
// Such strings will be processed by the completion script and will be shown as ActiveHelp
|
||||||
|
// to the user.
|
||||||
|
// The array parameter should be the array that will contain the completions.
|
||||||
|
// This function can be called multiple times before and/or after completions are added to
|
||||||
|
// the array. Each time this function is called with the same array, the new
|
||||||
|
// ActiveHelp line will be shown below the previous ones when completion is triggered.
|
||||||
|
func AppendActiveHelp(compArray []Completion, activeHelpStr string) []Completion {
|
||||||
|
return append(compArray, fmt.Sprintf("%s%s", activeHelpMarker, activeHelpStr))
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetActiveHelpConfig returns the value of the ActiveHelp environment variable
|
||||||
|
// <PROGRAM>_ACTIVE_HELP where <PROGRAM> is the name of the root command in upper
|
||||||
|
// case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
|
// It will always return "0" if the global environment variable COBRA_ACTIVE_HELP
|
||||||
|
// is set to "0".
|
||||||
|
func GetActiveHelpConfig(cmd *Command) string {
|
||||||
|
activeHelpCfg := os.Getenv(activeHelpGlobalEnvVar)
|
||||||
|
if activeHelpCfg != activeHelpGlobalDisable {
|
||||||
|
activeHelpCfg = os.Getenv(activeHelpEnvVar(cmd.Root().Name()))
|
||||||
|
}
|
||||||
|
return activeHelpCfg
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// root command in upper case, with all non-ASCII-alphanumeric characters replaced by `_`.
|
||||||
|
func activeHelpEnvVar(name string) string {
|
||||||
|
return configEnvVar(name, activeHelpEnvVarSuffix)
|
||||||
|
}
|
||||||
131
vendor/github.com/spf13/cobra/args.go
generated
vendored
Normal file
131
vendor/github.com/spf13/cobra/args.go
generated
vendored
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type PositionalArgs func(cmd *Command, args []string) error
|
||||||
|
|
||||||
|
// legacyArgs validation has the following behaviour:
|
||||||
|
// - root commands with no subcommands can take arbitrary arguments
|
||||||
|
// - root commands with subcommands will do subcommand validity checking
|
||||||
|
// - subcommands will always accept arbitrary arguments
|
||||||
|
func legacyArgs(cmd *Command, args []string) error {
|
||||||
|
// no subcommand, always take args
|
||||||
|
if !cmd.HasSubCommands() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// root command with subcommands, do subcommand checking.
|
||||||
|
if !cmd.HasParent() && len(args) > 0 {
|
||||||
|
return fmt.Errorf("unknown command %q for %q%s", args[0], cmd.CommandPath(), cmd.findSuggestions(args[0]))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// NoArgs returns an error if any args are included.
|
||||||
|
func NoArgs(cmd *Command, args []string) error {
|
||||||
|
if len(args) > 0 {
|
||||||
|
return fmt.Errorf("unknown command %q for %q", args[0], cmd.CommandPath())
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnlyValidArgs returns an error if there are any positional args that are not in
|
||||||
|
// the `ValidArgs` field of `Command`
|
||||||
|
func OnlyValidArgs(cmd *Command, args []string) error {
|
||||||
|
if len(cmd.ValidArgs) > 0 {
|
||||||
|
// Remove any description that may be included in ValidArgs.
|
||||||
|
// A description is following a tab character.
|
||||||
|
validArgs := make([]string, 0, len(cmd.ValidArgs))
|
||||||
|
for _, v := range cmd.ValidArgs {
|
||||||
|
validArgs = append(validArgs, strings.SplitN(v, "\t", 2)[0])
|
||||||
|
}
|
||||||
|
for _, v := range args {
|
||||||
|
if !stringInSlice(v, validArgs) {
|
||||||
|
return fmt.Errorf("invalid argument %q for %q%s", v, cmd.CommandPath(), cmd.findSuggestions(args[0]))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ArbitraryArgs never returns an error.
|
||||||
|
func ArbitraryArgs(cmd *Command, args []string) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MinimumNArgs returns an error if there is not at least N args.
|
||||||
|
func MinimumNArgs(n int) PositionalArgs {
|
||||||
|
return func(cmd *Command, args []string) error {
|
||||||
|
if len(args) < n {
|
||||||
|
return fmt.Errorf("requires at least %d arg(s), only received %d", n, len(args))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaximumNArgs returns an error if there are more than N args.
|
||||||
|
func MaximumNArgs(n int) PositionalArgs {
|
||||||
|
return func(cmd *Command, args []string) error {
|
||||||
|
if len(args) > n {
|
||||||
|
return fmt.Errorf("accepts at most %d arg(s), received %d", n, len(args))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExactArgs returns an error if there are not exactly n args.
|
||||||
|
func ExactArgs(n int) PositionalArgs {
|
||||||
|
return func(cmd *Command, args []string) error {
|
||||||
|
if len(args) != n {
|
||||||
|
return fmt.Errorf("accepts %d arg(s), received %d", n, len(args))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// RangeArgs returns an error if the number of args is not within the expected range.
|
||||||
|
func RangeArgs(min int, max int) PositionalArgs {
|
||||||
|
return func(cmd *Command, args []string) error {
|
||||||
|
if len(args) < min || len(args) > max {
|
||||||
|
return fmt.Errorf("accepts between %d and %d arg(s), received %d", min, max, len(args))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// MatchAll allows combining several PositionalArgs to work in concert.
|
||||||
|
func MatchAll(pargs ...PositionalArgs) PositionalArgs {
|
||||||
|
return func(cmd *Command, args []string) error {
|
||||||
|
for _, parg := range pargs {
|
||||||
|
if err := parg(cmd, args); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExactValidArgs returns an error if there are not exactly N positional args OR
|
||||||
|
// there are any positional args that are not in the `ValidArgs` field of `Command`
|
||||||
|
//
|
||||||
|
// Deprecated: use MatchAll(ExactArgs(n), OnlyValidArgs) instead
|
||||||
|
func ExactValidArgs(n int) PositionalArgs {
|
||||||
|
return MatchAll(ExactArgs(n), OnlyValidArgs)
|
||||||
|
}
|
||||||
709
vendor/github.com/spf13/cobra/bash_completions.go
generated
vendored
Normal file
709
vendor/github.com/spf13/cobra/bash_completions.go
generated
vendored
Normal file
@@ -0,0 +1,709 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Annotations for Bash completion.
|
||||||
|
const (
|
||||||
|
BashCompFilenameExt = "cobra_annotation_bash_completion_filename_extensions"
|
||||||
|
BashCompCustom = "cobra_annotation_bash_completion_custom"
|
||||||
|
BashCompOneRequiredFlag = "cobra_annotation_bash_completion_one_required_flag"
|
||||||
|
BashCompSubdirsInDir = "cobra_annotation_bash_completion_subdirs_in_dir"
|
||||||
|
)
|
||||||
|
|
||||||
|
func writePreamble(buf io.StringWriter, name string) {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf("# bash completion for %-36s -*- shell-script -*-\n", name))
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`
|
||||||
|
__%[1]s_debug()
|
||||||
|
{
|
||||||
|
if [[ -n ${BASH_COMP_DEBUG_FILE:-} ]]; then
|
||||||
|
echo "$*" >> "${BASH_COMP_DEBUG_FILE}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Homebrew on Macs have version 1.3 of bash-completion which doesn't include
|
||||||
|
# _init_completion. This is a very minimal version of that function.
|
||||||
|
__%[1]s_init_completion()
|
||||||
|
{
|
||||||
|
COMPREPLY=()
|
||||||
|
_get_comp_words_by_ref "$@" cur prev words cword
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_index_of_word()
|
||||||
|
{
|
||||||
|
local w word=$1
|
||||||
|
shift
|
||||||
|
index=0
|
||||||
|
for w in "$@"; do
|
||||||
|
[[ $w = "$word" ]] && return
|
||||||
|
index=$((index+1))
|
||||||
|
done
|
||||||
|
index=-1
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_contains_word()
|
||||||
|
{
|
||||||
|
local w word=$1; shift
|
||||||
|
for w in "$@"; do
|
||||||
|
[[ $w = "$word" ]] && return
|
||||||
|
done
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_go_custom_completion()
|
||||||
|
{
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}"
|
||||||
|
|
||||||
|
local shellCompDirectiveError=%[3]d
|
||||||
|
local shellCompDirectiveNoSpace=%[4]d
|
||||||
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
|
||||||
|
local out requestComp lastParam lastChar comp directive args
|
||||||
|
|
||||||
|
# Prepare the command to request completions for the program.
|
||||||
|
# Calling ${words[0]} instead of directly %[1]s allows handling aliases
|
||||||
|
args=("${words[@]:1}")
|
||||||
|
# Disable ActiveHelp which is not supported for bash completion v1
|
||||||
|
requestComp="%[8]s=0 ${words[0]} %[2]s ${args[*]}"
|
||||||
|
|
||||||
|
lastParam=${words[$((${#words[@]}-1))]}
|
||||||
|
lastChar=${lastParam:$((${#lastParam}-1)):1}
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: lastParam ${lastParam}, lastChar ${lastChar}"
|
||||||
|
|
||||||
|
if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then
|
||||||
|
# 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.
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: Adding extra empty parameter"
|
||||||
|
requestComp="${requestComp} \"\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: calling ${requestComp}"
|
||||||
|
# Use eval to handle any environment variables and such
|
||||||
|
out=$(eval "${requestComp}" 2>/dev/null)
|
||||||
|
|
||||||
|
# Extract the directive integer at the very end of the output following a colon (:)
|
||||||
|
directive=${out##*:}
|
||||||
|
# Remove the directive
|
||||||
|
out=${out%%:*}
|
||||||
|
if [ "${directive}" = "${out}" ]; then
|
||||||
|
# There is not directive specified
|
||||||
|
directive=0
|
||||||
|
fi
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: the completion directive is: ${directive}"
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: the completions are: ${out}"
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
|
||||||
|
# Error code. No completion.
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: received error from custom completion go code"
|
||||||
|
return
|
||||||
|
else
|
||||||
|
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: activating no space"
|
||||||
|
compopt -o nospace
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: activating no file completion"
|
||||||
|
compopt +o default
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
||||||
|
# File extension filtering
|
||||||
|
local fullFilter filter filteringCmd
|
||||||
|
# Do not use quotes around the $out variable or else newline
|
||||||
|
# characters will be kept.
|
||||||
|
for filter in ${out}; do
|
||||||
|
fullFilter+="$filter|"
|
||||||
|
done
|
||||||
|
|
||||||
|
filteringCmd="_filedir $fullFilter"
|
||||||
|
__%[1]s_debug "File filtering command: $filteringCmd"
|
||||||
|
$filteringCmd
|
||||||
|
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
|
||||||
|
# File completion for directories only
|
||||||
|
local subdir
|
||||||
|
# Use printf to strip any trailing newline
|
||||||
|
subdir=$(printf "%%s" "${out}")
|
||||||
|
if [ -n "$subdir" ]; then
|
||||||
|
__%[1]s_debug "Listing directories in $subdir"
|
||||||
|
__%[1]s_handle_subdirs_in_dir_flag "$subdir"
|
||||||
|
else
|
||||||
|
__%[1]s_debug "Listing directories in ."
|
||||||
|
_filedir -d
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
while IFS='' read -r comp; do
|
||||||
|
COMPREPLY+=("$comp")
|
||||||
|
done < <(compgen -W "${out}" -- "$cur")
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_reply()
|
||||||
|
{
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}"
|
||||||
|
local comp
|
||||||
|
case $cur in
|
||||||
|
-*)
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
compopt -o nospace
|
||||||
|
fi
|
||||||
|
local allflags
|
||||||
|
if [ ${#must_have_one_flag[@]} -ne 0 ]; then
|
||||||
|
allflags=("${must_have_one_flag[@]}")
|
||||||
|
else
|
||||||
|
allflags=("${flags[*]} ${two_word_flags[*]}")
|
||||||
|
fi
|
||||||
|
while IFS='' read -r comp; do
|
||||||
|
COMPREPLY+=("$comp")
|
||||||
|
done < <(compgen -W "${allflags[*]}" -- "$cur")
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
[[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace
|
||||||
|
fi
|
||||||
|
|
||||||
|
# complete after --flag=abc
|
||||||
|
if [[ $cur == *=* ]]; then
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
compopt +o nospace
|
||||||
|
fi
|
||||||
|
|
||||||
|
local index flag
|
||||||
|
flag="${cur%%=*}"
|
||||||
|
__%[1]s_index_of_word "${flag}" "${flags_with_completion[@]}"
|
||||||
|
COMPREPLY=()
|
||||||
|
if [[ ${index} -ge 0 ]]; then
|
||||||
|
PREFIX=""
|
||||||
|
cur="${cur#*=}"
|
||||||
|
${flags_completion[${index}]}
|
||||||
|
if [ -n "${ZSH_VERSION:-}" ]; then
|
||||||
|
# zsh completion needs --flag= prefix
|
||||||
|
eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ -z "${flag_parsing_disabled}" ]]; then
|
||||||
|
# If flag parsing is enabled, we have completed the flags and can return.
|
||||||
|
# If flag parsing is disabled, we may not know all (or any) of the flags, so we fallthrough
|
||||||
|
# to possibly call handle_go_custom_completion.
|
||||||
|
return 0;
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
# check if we are handling a flag with special work handling
|
||||||
|
local index
|
||||||
|
__%[1]s_index_of_word "${prev}" "${flags_with_completion[@]}"
|
||||||
|
if [[ ${index} -ge 0 ]]; then
|
||||||
|
${flags_completion[${index}]}
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# we are parsing a flag and don't have a special handler, no completion
|
||||||
|
if [[ ${cur} != "${words[cword]}" ]]; then
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
local completions
|
||||||
|
completions=("${commands[@]}")
|
||||||
|
if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then
|
||||||
|
completions+=("${must_have_one_noun[@]}")
|
||||||
|
elif [[ -n "${has_completion_function}" ]]; then
|
||||||
|
# if a go completion function is provided, defer to that function
|
||||||
|
__%[1]s_handle_go_custom_completion
|
||||||
|
fi
|
||||||
|
if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then
|
||||||
|
completions+=("${must_have_one_flag[@]}")
|
||||||
|
fi
|
||||||
|
while IFS='' read -r comp; do
|
||||||
|
COMPREPLY+=("$comp")
|
||||||
|
done < <(compgen -W "${completions[*]}" -- "$cur")
|
||||||
|
|
||||||
|
if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then
|
||||||
|
while IFS='' read -r comp; do
|
||||||
|
COMPREPLY+=("$comp")
|
||||||
|
done < <(compgen -W "${noun_aliases[*]}" -- "$cur")
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ${#COMPREPLY[@]} -eq 0 ]]; then
|
||||||
|
if declare -F __%[1]s_custom_func >/dev/null; then
|
||||||
|
# try command name qualified custom func
|
||||||
|
__%[1]s_custom_func
|
||||||
|
else
|
||||||
|
# otherwise fall back to unqualified for compatibility
|
||||||
|
declare -F __custom_func >/dev/null && __custom_func
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# available in bash-completion >= 2, not always present on macOS
|
||||||
|
if declare -F __ltrim_colon_completions >/dev/null; then
|
||||||
|
__ltrim_colon_completions "$cur"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If there is only 1 completion and it is a flag with an = it will be completed
|
||||||
|
# but we don't want a space after the =
|
||||||
|
if [[ "${#COMPREPLY[@]}" -eq "1" ]] && [[ $(type -t compopt) = "builtin" ]] && [[ "${COMPREPLY[0]}" == --*= ]]; then
|
||||||
|
compopt -o nospace
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# The arguments should be in the form "ext1|ext2|extn"
|
||||||
|
__%[1]s_handle_filename_extension_flag()
|
||||||
|
{
|
||||||
|
local ext="$1"
|
||||||
|
_filedir "@(${ext})"
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_subdirs_in_dir_flag()
|
||||||
|
{
|
||||||
|
local dir="$1"
|
||||||
|
pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_flag()
|
||||||
|
{
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
||||||
|
|
||||||
|
# if a command required a flag, and we found it, unset must_have_one_flag()
|
||||||
|
local flagname=${words[c]}
|
||||||
|
local flagvalue=""
|
||||||
|
# if the word contained an =
|
||||||
|
if [[ ${words[c]} == *"="* ]]; then
|
||||||
|
flagvalue=${flagname#*=} # take in as flagvalue after the =
|
||||||
|
flagname=${flagname%%=*} # strip everything after the =
|
||||||
|
flagname="${flagname}=" # but put the = back
|
||||||
|
fi
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: looking for ${flagname}"
|
||||||
|
if __%[1]s_contains_word "${flagname}" "${must_have_one_flag[@]}"; then
|
||||||
|
must_have_one_flag=()
|
||||||
|
fi
|
||||||
|
|
||||||
|
# if you set a flag which only applies to this command, don't show subcommands
|
||||||
|
if __%[1]s_contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then
|
||||||
|
commands=()
|
||||||
|
fi
|
||||||
|
|
||||||
|
# keep flag value with flagname as flaghash
|
||||||
|
# flaghash variable is an associative array which is only supported in bash > 3.
|
||||||
|
if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
|
||||||
|
if [ -n "${flagvalue}" ] ; then
|
||||||
|
flaghash[${flagname}]=${flagvalue}
|
||||||
|
elif [ -n "${words[ $((c+1)) ]}" ] ; then
|
||||||
|
flaghash[${flagname}]=${words[ $((c+1)) ]}
|
||||||
|
else
|
||||||
|
flaghash[${flagname}]="true" # pad "true" for bool flag
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# skip the argument to a two word flag
|
||||||
|
if [[ ${words[c]} != *"="* ]] && __%[1]s_contains_word "${words[c]}" "${two_word_flags[@]}"; then
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
|
||||||
|
c=$((c+1))
|
||||||
|
# if we are looking for a flags value, don't show commands
|
||||||
|
if [[ $c -eq $cword ]]; then
|
||||||
|
commands=()
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
c=$((c+1))
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_noun()
|
||||||
|
{
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
||||||
|
|
||||||
|
if __%[1]s_contains_word "${words[c]}" "${must_have_one_noun[@]}"; then
|
||||||
|
must_have_one_noun=()
|
||||||
|
elif __%[1]s_contains_word "${words[c]}" "${noun_aliases[@]}"; then
|
||||||
|
must_have_one_noun=()
|
||||||
|
fi
|
||||||
|
|
||||||
|
nouns+=("${words[c]}")
|
||||||
|
c=$((c+1))
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_command()
|
||||||
|
{
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
||||||
|
|
||||||
|
local next_command
|
||||||
|
if [[ -n ${last_command} ]]; then
|
||||||
|
next_command="_${last_command}_${words[c]//:/__}"
|
||||||
|
else
|
||||||
|
if [[ $c -eq 0 ]]; then
|
||||||
|
next_command="_%[1]s_root_command"
|
||||||
|
else
|
||||||
|
next_command="_${words[c]//:/__}"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
c=$((c+1))
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: looking for ${next_command}"
|
||||||
|
declare -F "$next_command" >/dev/null && $next_command
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_word()
|
||||||
|
{
|
||||||
|
if [[ $c -ge $cword ]]; then
|
||||||
|
__%[1]s_handle_reply
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
__%[1]s_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
|
||||||
|
if [[ "${words[c]}" == -* ]]; then
|
||||||
|
__%[1]s_handle_flag
|
||||||
|
elif __%[1]s_contains_word "${words[c]}" "${commands[@]}"; then
|
||||||
|
__%[1]s_handle_command
|
||||||
|
elif [[ $c -eq 0 ]]; then
|
||||||
|
__%[1]s_handle_command
|
||||||
|
elif __%[1]s_contains_word "${words[c]}" "${command_aliases[@]}"; then
|
||||||
|
# aliashash variable is an associative array which is only supported in bash > 3.
|
||||||
|
if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
|
||||||
|
words[c]=${aliashash[${words[c]}]}
|
||||||
|
__%[1]s_handle_command
|
||||||
|
else
|
||||||
|
__%[1]s_handle_noun
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
__%[1]s_handle_noun
|
||||||
|
fi
|
||||||
|
__%[1]s_handle_word
|
||||||
|
}
|
||||||
|
|
||||||
|
`, name, ShellCompNoDescRequestCmd,
|
||||||
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, activeHelpEnvVar(name)))
|
||||||
|
}
|
||||||
|
|
||||||
|
func writePostscript(buf io.StringWriter, name string) {
|
||||||
|
name = strings.ReplaceAll(name, ":", "__")
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf("__start_%s()\n", name))
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`{
|
||||||
|
local cur prev words cword split
|
||||||
|
declare -A flaghash 2>/dev/null || :
|
||||||
|
declare -A aliashash 2>/dev/null || :
|
||||||
|
if declare -F _init_completion >/dev/null 2>&1; then
|
||||||
|
_init_completion -s || return
|
||||||
|
else
|
||||||
|
__%[1]s_init_completion -n "=" || return
|
||||||
|
fi
|
||||||
|
|
||||||
|
local c=0
|
||||||
|
local flag_parsing_disabled=
|
||||||
|
local flags=()
|
||||||
|
local two_word_flags=()
|
||||||
|
local local_nonpersistent_flags=()
|
||||||
|
local flags_with_completion=()
|
||||||
|
local flags_completion=()
|
||||||
|
local commands=("%[1]s")
|
||||||
|
local command_aliases=()
|
||||||
|
local must_have_one_flag=()
|
||||||
|
local must_have_one_noun=()
|
||||||
|
local has_completion_function=""
|
||||||
|
local last_command=""
|
||||||
|
local nouns=()
|
||||||
|
local noun_aliases=()
|
||||||
|
|
||||||
|
__%[1]s_handle_word
|
||||||
|
}
|
||||||
|
|
||||||
|
`, name))
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
complete -o default -F __start_%s %s
|
||||||
|
else
|
||||||
|
complete -o default -o nospace -F __start_%s %s
|
||||||
|
fi
|
||||||
|
|
||||||
|
`, name, name, name, name))
|
||||||
|
WriteStringAndCheck(buf, "# ex: ts=4 sw=4 et filetype=sh\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeCommands(buf io.StringWriter, cmd *Command) {
|
||||||
|
WriteStringAndCheck(buf, " commands=()\n")
|
||||||
|
for _, c := range cmd.Commands() {
|
||||||
|
if !c.IsAvailableCommand() && c != cmd.helpCommand {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" commands+=(%q)\n", c.Name()))
|
||||||
|
writeCmdAliases(buf, c)
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeFlagHandler(buf io.StringWriter, name string, annotations map[string][]string, cmd *Command) {
|
||||||
|
for key, value := range annotations {
|
||||||
|
switch key {
|
||||||
|
case BashCompFilenameExt:
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
||||||
|
|
||||||
|
var ext string
|
||||||
|
if len(value) > 0 {
|
||||||
|
ext = fmt.Sprintf("__%s_handle_filename_extension_flag ", cmd.Root().Name()) + strings.Join(value, "|")
|
||||||
|
} else {
|
||||||
|
ext = "_filedir"
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_completion+=(%q)\n", ext))
|
||||||
|
case BashCompCustom:
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
||||||
|
|
||||||
|
if len(value) > 0 {
|
||||||
|
handlers := strings.Join(value, "; ")
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_completion+=(%q)\n", handlers))
|
||||||
|
} else {
|
||||||
|
WriteStringAndCheck(buf, " flags_completion+=(:)\n")
|
||||||
|
}
|
||||||
|
case BashCompSubdirsInDir:
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_with_completion+=(%q)\n", name))
|
||||||
|
|
||||||
|
var ext string
|
||||||
|
if len(value) == 1 {
|
||||||
|
ext = fmt.Sprintf("__%s_handle_subdirs_in_dir_flag ", cmd.Root().Name()) + value[0]
|
||||||
|
} else {
|
||||||
|
ext = "_filedir -d"
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" flags_completion+=(%q)\n", ext))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const cbn = "\")\n"
|
||||||
|
|
||||||
|
func writeShortFlag(buf io.StringWriter, flag *pflag.Flag, cmd *Command) {
|
||||||
|
name := flag.Shorthand
|
||||||
|
format := " "
|
||||||
|
if len(flag.NoOptDefVal) == 0 {
|
||||||
|
format += "two_word_"
|
||||||
|
}
|
||||||
|
format += "flags+=(\"-%s" + cbn
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(format, name))
|
||||||
|
writeFlagHandler(buf, "-"+name, flag.Annotations, cmd)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeFlag(buf io.StringWriter, flag *pflag.Flag, cmd *Command) {
|
||||||
|
name := flag.Name
|
||||||
|
format := " flags+=(\"--%s"
|
||||||
|
if len(flag.NoOptDefVal) == 0 {
|
||||||
|
format += "="
|
||||||
|
}
|
||||||
|
format += cbn
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(format, name))
|
||||||
|
if len(flag.NoOptDefVal) == 0 {
|
||||||
|
format = " two_word_flags+=(\"--%s" + cbn
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(format, name))
|
||||||
|
}
|
||||||
|
writeFlagHandler(buf, "--"+name, flag.Annotations, cmd)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeLocalNonPersistentFlag(buf io.StringWriter, flag *pflag.Flag) {
|
||||||
|
name := flag.Name
|
||||||
|
format := " local_nonpersistent_flags+=(\"--%[1]s" + cbn
|
||||||
|
if len(flag.NoOptDefVal) == 0 {
|
||||||
|
format += " local_nonpersistent_flags+=(\"--%[1]s=" + cbn
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(format, name))
|
||||||
|
if len(flag.Shorthand) > 0 {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" local_nonpersistent_flags+=(\"-%s\")\n", flag.Shorthand))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// prepareCustomAnnotationsForFlags setup annotations for go completions for registered flags
|
||||||
|
func prepareCustomAnnotationsForFlags(cmd *Command) {
|
||||||
|
flagCompletionMutex.RLock()
|
||||||
|
defer flagCompletionMutex.RUnlock()
|
||||||
|
for flag := range flagCompletionFunctions {
|
||||||
|
// Make sure the completion script calls the __*_go_custom_completion function for
|
||||||
|
// every registered flag. We need to do this here (and not when the flag was registered
|
||||||
|
// for completion) so that we can know the root command name for the prefix
|
||||||
|
// of __<prefix>_go_custom_completion
|
||||||
|
if flag.Annotations == nil {
|
||||||
|
flag.Annotations = map[string][]string{}
|
||||||
|
}
|
||||||
|
flag.Annotations[BashCompCustom] = []string{fmt.Sprintf("__%[1]s_handle_go_custom_completion", cmd.Root().Name())}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeFlags(buf io.StringWriter, cmd *Command) {
|
||||||
|
prepareCustomAnnotationsForFlags(cmd)
|
||||||
|
WriteStringAndCheck(buf, ` flags=()
|
||||||
|
two_word_flags=()
|
||||||
|
local_nonpersistent_flags=()
|
||||||
|
flags_with_completion=()
|
||||||
|
flags_completion=()
|
||||||
|
|
||||||
|
`)
|
||||||
|
|
||||||
|
if cmd.DisableFlagParsing {
|
||||||
|
WriteStringAndCheck(buf, " flag_parsing_disabled=1\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
localNonPersistentFlags := cmd.LocalNonPersistentFlags()
|
||||||
|
cmd.NonInheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
||||||
|
if nonCompletableFlag(flag) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeFlag(buf, flag, cmd)
|
||||||
|
if len(flag.Shorthand) > 0 {
|
||||||
|
writeShortFlag(buf, flag, cmd)
|
||||||
|
}
|
||||||
|
// localNonPersistentFlags are used to stop the completion of subcommands when one is set
|
||||||
|
// if TraverseChildren is true we should allow to complete subcommands
|
||||||
|
if localNonPersistentFlags.Lookup(flag.Name) != nil && !cmd.Root().TraverseChildren {
|
||||||
|
writeLocalNonPersistentFlag(buf, flag)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
cmd.InheritedFlags().VisitAll(func(flag *pflag.Flag) {
|
||||||
|
if nonCompletableFlag(flag) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeFlag(buf, flag, cmd)
|
||||||
|
if len(flag.Shorthand) > 0 {
|
||||||
|
writeShortFlag(buf, flag, cmd)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
WriteStringAndCheck(buf, "\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeRequiredFlag(buf io.StringWriter, cmd *Command) {
|
||||||
|
WriteStringAndCheck(buf, " must_have_one_flag=()\n")
|
||||||
|
flags := cmd.NonInheritedFlags()
|
||||||
|
flags.VisitAll(func(flag *pflag.Flag) {
|
||||||
|
if nonCompletableFlag(flag) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, ok := flag.Annotations[BashCompOneRequiredFlag]; ok {
|
||||||
|
format := " must_have_one_flag+=(\"--%s"
|
||||||
|
if flag.Value.Type() != "bool" {
|
||||||
|
format += "="
|
||||||
|
}
|
||||||
|
format += cbn
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(format, flag.Name))
|
||||||
|
|
||||||
|
if len(flag.Shorthand) > 0 {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_flag+=(\"-%s"+cbn, flag.Shorthand))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeRequiredNouns(buf io.StringWriter, cmd *Command) {
|
||||||
|
WriteStringAndCheck(buf, " must_have_one_noun=()\n")
|
||||||
|
sort.Strings(cmd.ValidArgs)
|
||||||
|
for _, value := range cmd.ValidArgs {
|
||||||
|
// Remove any description that may be included following a tab character.
|
||||||
|
// Descriptions are not supported by bash completion.
|
||||||
|
value = strings.SplitN(value, "\t", 2)[0]
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" must_have_one_noun+=(%q)\n", value))
|
||||||
|
}
|
||||||
|
if cmd.ValidArgsFunction != nil {
|
||||||
|
WriteStringAndCheck(buf, " has_completion_function=1\n")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeCmdAliases(buf io.StringWriter, cmd *Command) {
|
||||||
|
if len(cmd.Aliases) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
sort.Strings(cmd.Aliases)
|
||||||
|
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprint(` if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then`, "\n"))
|
||||||
|
for _, value := range cmd.Aliases {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" command_aliases+=(%q)\n", value))
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" aliashash[%q]=%q\n", value, cmd.Name()))
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, ` fi`)
|
||||||
|
WriteStringAndCheck(buf, "\n")
|
||||||
|
}
|
||||||
|
func writeArgAliases(buf io.StringWriter, cmd *Command) {
|
||||||
|
WriteStringAndCheck(buf, " noun_aliases=()\n")
|
||||||
|
sort.Strings(cmd.ArgAliases)
|
||||||
|
for _, value := range cmd.ArgAliases {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" noun_aliases+=(%q)\n", value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func gen(buf io.StringWriter, cmd *Command) {
|
||||||
|
for _, c := range cmd.Commands() {
|
||||||
|
if !c.IsAvailableCommand() && c != cmd.helpCommand {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
gen(buf, c)
|
||||||
|
}
|
||||||
|
commandName := cmd.CommandPath()
|
||||||
|
commandName = strings.ReplaceAll(commandName, " ", "_")
|
||||||
|
commandName = strings.ReplaceAll(commandName, ":", "__")
|
||||||
|
|
||||||
|
if cmd.Root() == cmd {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf("_%s_root_command()\n{\n", commandName))
|
||||||
|
} else {
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf("_%s()\n{\n", commandName))
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(" last_command=%q\n", commandName))
|
||||||
|
WriteStringAndCheck(buf, "\n")
|
||||||
|
WriteStringAndCheck(buf, " command_aliases=()\n")
|
||||||
|
WriteStringAndCheck(buf, "\n")
|
||||||
|
|
||||||
|
writeCommands(buf, cmd)
|
||||||
|
writeFlags(buf, cmd)
|
||||||
|
writeRequiredFlag(buf, cmd)
|
||||||
|
writeRequiredNouns(buf, cmd)
|
||||||
|
writeArgAliases(buf, cmd)
|
||||||
|
WriteStringAndCheck(buf, "}\n\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletion generates bash completion file and writes to the passed writer.
|
||||||
|
func (c *Command) GenBashCompletion(w io.Writer) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
writePreamble(buf, c.Name())
|
||||||
|
if len(c.BashCompletionFunction) > 0 {
|
||||||
|
buf.WriteString(c.BashCompletionFunction + "\n")
|
||||||
|
}
|
||||||
|
gen(buf, c)
|
||||||
|
writePostscript(buf, c.Name())
|
||||||
|
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func nonCompletableFlag(flag *pflag.Flag) bool {
|
||||||
|
return flag.Hidden || len(flag.Deprecated) > 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionFile generates bash completion file.
|
||||||
|
func (c *Command) GenBashCompletionFile(filename string) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.GenBashCompletion(outFile)
|
||||||
|
}
|
||||||
484
vendor/github.com/spf13/cobra/bash_completionsV2.go
generated
vendored
Normal file
484
vendor/github.com/spf13/cobra/bash_completionsV2.go
generated
vendored
Normal file
@@ -0,0 +1,484 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (c *Command) genBashCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
genBashComp(buf, c.Name(), includeDesc)
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func genBashComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
|
compCmd := ShellCompRequestCmd
|
||||||
|
if !includeDesc {
|
||||||
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
|
}
|
||||||
|
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`# bash completion V2 for %-36[1]s -*- shell-script -*-
|
||||||
|
|
||||||
|
__%[1]s_debug()
|
||||||
|
{
|
||||||
|
if [[ -n ${BASH_COMP_DEBUG_FILE-} ]]; then
|
||||||
|
echo "$*" >> "${BASH_COMP_DEBUG_FILE}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Macs have bash3 for which the bash-completion package doesn't include
|
||||||
|
# _init_completion. This is a minimal version of that function.
|
||||||
|
__%[1]s_init_completion()
|
||||||
|
{
|
||||||
|
COMPREPLY=()
|
||||||
|
_get_comp_words_by_ref "$@" cur prev words cword
|
||||||
|
}
|
||||||
|
|
||||||
|
# This function calls the %[1]s program to obtain the completion
|
||||||
|
# results and the directive. It fills the 'out' and 'directive' vars.
|
||||||
|
__%[1]s_get_completion_results() {
|
||||||
|
local requestComp lastParam lastChar args
|
||||||
|
|
||||||
|
# Prepare the command to request completions for the program.
|
||||||
|
# Calling ${words[0]} instead of directly %[1]s allows handling aliases
|
||||||
|
args=("${words[@]:1}")
|
||||||
|
requestComp="${words[0]} %[2]s ${args[*]}"
|
||||||
|
|
||||||
|
lastParam=${words[$((${#words[@]}-1))]}
|
||||||
|
lastChar=${lastParam:$((${#lastParam}-1)):1}
|
||||||
|
__%[1]s_debug "lastParam ${lastParam}, lastChar ${lastChar}"
|
||||||
|
|
||||||
|
if [[ -z ${cur} && ${lastChar} != = ]]; then
|
||||||
|
# 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.
|
||||||
|
__%[1]s_debug "Adding extra empty parameter"
|
||||||
|
requestComp="${requestComp} ''"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# When completing a flag with an = (e.g., %[1]s -n=<TAB>)
|
||||||
|
# bash focuses on the part after the =, so we need to remove
|
||||||
|
# the flag part from $cur
|
||||||
|
if [[ ${cur} == -*=* ]]; then
|
||||||
|
cur="${cur#*=}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug "Calling ${requestComp}"
|
||||||
|
# Use eval to handle any environment variables and such
|
||||||
|
out=$(eval "${requestComp}" 2>/dev/null)
|
||||||
|
|
||||||
|
# Extract the directive integer at the very end of the output following a colon (:)
|
||||||
|
directive=${out##*:}
|
||||||
|
# Remove the directive
|
||||||
|
out=${out%%:*}
|
||||||
|
if [[ ${directive} == "${out}" ]]; then
|
||||||
|
# There is not directive specified
|
||||||
|
directive=0
|
||||||
|
fi
|
||||||
|
__%[1]s_debug "The completion directive is: ${directive}"
|
||||||
|
__%[1]s_debug "The completions are: ${out}"
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_process_completion_results() {
|
||||||
|
local shellCompDirectiveError=%[3]d
|
||||||
|
local shellCompDirectiveNoSpace=%[4]d
|
||||||
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveKeepOrder=%[8]d
|
||||||
|
|
||||||
|
if (((directive & shellCompDirectiveError) != 0)); then
|
||||||
|
# Error code. No completion.
|
||||||
|
__%[1]s_debug "Received error from custom completion go code"
|
||||||
|
return
|
||||||
|
else
|
||||||
|
if (((directive & shellCompDirectiveNoSpace) != 0)); then
|
||||||
|
if [[ $(type -t compopt) == builtin ]]; then
|
||||||
|
__%[1]s_debug "Activating no space"
|
||||||
|
compopt -o nospace
|
||||||
|
else
|
||||||
|
__%[1]s_debug "No space directive not supported in this version of bash"
|
||||||
|
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 [[ $(type -t compopt) == builtin ]]; then
|
||||||
|
__%[1]s_debug "Activating no file completion"
|
||||||
|
compopt +o default
|
||||||
|
else
|
||||||
|
__%[1]s_debug "No file completion directive not supported in this version of bash"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Separate activeHelp from normal completions
|
||||||
|
local completions=()
|
||||||
|
local activeHelp=()
|
||||||
|
__%[1]s_extract_activeHelp
|
||||||
|
|
||||||
|
if (((directive & shellCompDirectiveFilterFileExt) != 0)); then
|
||||||
|
# File extension filtering
|
||||||
|
local fullFilter="" filter filteringCmd
|
||||||
|
|
||||||
|
# Do not use quotes around the $completions variable or else newline
|
||||||
|
# characters will be kept.
|
||||||
|
for filter in ${completions[*]}; do
|
||||||
|
fullFilter+="$filter|"
|
||||||
|
done
|
||||||
|
|
||||||
|
filteringCmd="_filedir $fullFilter"
|
||||||
|
__%[1]s_debug "File filtering command: $filteringCmd"
|
||||||
|
$filteringCmd
|
||||||
|
elif (((directive & shellCompDirectiveFilterDirs) != 0)); then
|
||||||
|
# File completion for directories only
|
||||||
|
|
||||||
|
local subdir
|
||||||
|
subdir=${completions[0]}
|
||||||
|
if [[ -n $subdir ]]; then
|
||||||
|
__%[1]s_debug "Listing directories in $subdir"
|
||||||
|
pushd "$subdir" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
|
||||||
|
else
|
||||||
|
__%[1]s_debug "Listing directories in ."
|
||||||
|
_filedir -d
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
__%[1]s_handle_completion_types
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_handle_special_char "$cur" :
|
||||||
|
__%[1]s_handle_special_char "$cur" =
|
||||||
|
|
||||||
|
# Print the activeHelp statements before we finish
|
||||||
|
__%[1]s_handle_activeHelp
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_activeHelp() {
|
||||||
|
# Print the activeHelp statements
|
||||||
|
if ((${#activeHelp[*]} != 0)); then
|
||||||
|
if [ -z $COMP_TYPE ]; then
|
||||||
|
# Bash v3 does not set the COMP_TYPE variable.
|
||||||
|
printf "\n";
|
||||||
|
printf "%%s\n" "${activeHelp[@]}"
|
||||||
|
printf "\n"
|
||||||
|
__%[1]s_reprint_commandLine
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Only print ActiveHelp on the second TAB press
|
||||||
|
if [ $COMP_TYPE -eq 63 ]; then
|
||||||
|
printf "\n"
|
||||||
|
printf "%%s\n" "${activeHelp[@]}"
|
||||||
|
|
||||||
|
if ((${#COMPREPLY[*]} == 0)); then
|
||||||
|
# When there are no completion choices from the program, file completion
|
||||||
|
# may kick in if the program has not disabled it; in such a case, we want
|
||||||
|
# to know if any files will match what the user typed, so that we know if
|
||||||
|
# there will be completions presented, so that we know how to handle ActiveHelp.
|
||||||
|
# To find out, we actually trigger the file completion ourselves;
|
||||||
|
# the call to _filedir will fill COMPREPLY if files match.
|
||||||
|
if (((directive & shellCompDirectiveNoFileComp) == 0)); then
|
||||||
|
__%[1]s_debug "Listing files"
|
||||||
|
_filedir
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ((${#COMPREPLY[*]} != 0)); then
|
||||||
|
# If there are completion choices to be shown, print a delimiter.
|
||||||
|
# Re-printing the command-line will automatically be done
|
||||||
|
# by the shell when it prints the completion choices.
|
||||||
|
printf -- "--"
|
||||||
|
else
|
||||||
|
# When there are no completion choices at all, we need
|
||||||
|
# to re-print the command-line since the shell will
|
||||||
|
# not be doing it itself.
|
||||||
|
__%[1]s_reprint_commandLine
|
||||||
|
fi
|
||||||
|
elif [ $COMP_TYPE -eq 37 ] || [ $COMP_TYPE -eq 42 ]; then
|
||||||
|
# For completion type: menu-complete/menu-complete-backward and insert-completions
|
||||||
|
# the completions are immediately inserted into the command-line, so we first
|
||||||
|
# print the activeHelp message and reprint the command-line since the shell won't.
|
||||||
|
printf "\n"
|
||||||
|
printf "%%s\n" "${activeHelp[@]}"
|
||||||
|
|
||||||
|
__%[1]s_reprint_commandLine
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_reprint_commandLine() {
|
||||||
|
# The prompt format is only available from bash 4.4.
|
||||||
|
# We test if it is available before using it.
|
||||||
|
if (x=${PS1@P}) 2> /dev/null; then
|
||||||
|
printf "%%s" "${PS1@P}${COMP_LINE[@]}"
|
||||||
|
else
|
||||||
|
# Can't print the prompt. Just print the
|
||||||
|
# text the user had typed, it is workable enough.
|
||||||
|
printf "%%s" "${COMP_LINE[@]}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Separate activeHelp lines from real completions.
|
||||||
|
# Fills the $activeHelp and $completions arrays.
|
||||||
|
__%[1]s_extract_activeHelp() {
|
||||||
|
local activeHelpMarker="%[9]s"
|
||||||
|
local endIndex=${#activeHelpMarker}
|
||||||
|
|
||||||
|
while IFS='' read -r comp; do
|
||||||
|
[[ -z $comp ]] && continue
|
||||||
|
|
||||||
|
if [[ ${comp:0:endIndex} == $activeHelpMarker ]]; then
|
||||||
|
comp=${comp:endIndex}
|
||||||
|
__%[1]s_debug "ActiveHelp found: $comp"
|
||||||
|
if [[ -n $comp ]]; then
|
||||||
|
activeHelp+=("$comp")
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
# Not an activeHelp line but a normal completion
|
||||||
|
completions+=("$comp")
|
||||||
|
fi
|
||||||
|
done <<<"${out}"
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_completion_types() {
|
||||||
|
__%[1]s_debug "__%[1]s_handle_completion_types: COMP_TYPE is $COMP_TYPE"
|
||||||
|
|
||||||
|
case $COMP_TYPE in
|
||||||
|
37|42)
|
||||||
|
# Type: menu-complete/menu-complete-backward and insert-completions
|
||||||
|
# If the user requested inserting one completion at a time, or all
|
||||||
|
# completions at once on the command-line we must remove the descriptions.
|
||||||
|
# https://github.com/spf13/cobra/issues/1508
|
||||||
|
|
||||||
|
# If there are no completions, we don't need to do anything
|
||||||
|
(( ${#completions[@]} == 0 )) && return 0
|
||||||
|
|
||||||
|
local tab=$'\t'
|
||||||
|
|
||||||
|
# Strip any description and escape the completion to handled special characters
|
||||||
|
IFS=$'\n' read -ra completions -d '' < <(printf "%%q\n" "${completions[@]%%%%$tab*}")
|
||||||
|
|
||||||
|
# Only consider the completions that match
|
||||||
|
IFS=$'\n' read -ra COMPREPLY -d '' < <(IFS=$'\n'; compgen -W "${completions[*]}" -- "${cur}")
|
||||||
|
|
||||||
|
# compgen looses the escaping so we need to escape all completions again since they will
|
||||||
|
# all be inserted on the command-line.
|
||||||
|
IFS=$'\n' read -ra COMPREPLY -d '' < <(printf "%%q\n" "${COMPREPLY[@]}")
|
||||||
|
;;
|
||||||
|
|
||||||
|
*)
|
||||||
|
# Type: complete (normal completion)
|
||||||
|
__%[1]s_handle_standard_completion_case
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_standard_completion_case() {
|
||||||
|
local tab=$'\t'
|
||||||
|
|
||||||
|
# If there are no completions, we don't need to do anything
|
||||||
|
(( ${#completions[@]} == 0 )) && return 0
|
||||||
|
|
||||||
|
# Short circuit to optimize if we don't have descriptions
|
||||||
|
if [[ "${completions[*]}" != *$tab* ]]; then
|
||||||
|
# First, escape the completions to handle special characters
|
||||||
|
IFS=$'\n' read -ra completions -d '' < <(printf "%%q\n" "${completions[@]}")
|
||||||
|
# Only consider the completions that match what the user typed
|
||||||
|
IFS=$'\n' read -ra COMPREPLY -d '' < <(IFS=$'\n'; compgen -W "${completions[*]}" -- "${cur}")
|
||||||
|
|
||||||
|
# compgen looses the escaping so, if there is only a single completion, we need to
|
||||||
|
# escape it again because it will be inserted on the command-line. If there are multiple
|
||||||
|
# completions, we don't want to escape them because they will be printed in a list
|
||||||
|
# and we don't want to show escape characters in that list.
|
||||||
|
if (( ${#COMPREPLY[@]} == 1 )); then
|
||||||
|
COMPREPLY[0]=$(printf "%%q" "${COMPREPLY[0]}")
|
||||||
|
fi
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
local longest=0
|
||||||
|
local compline
|
||||||
|
# Look for the longest completion so that we can format things nicely
|
||||||
|
while IFS='' read -r compline; do
|
||||||
|
[[ -z $compline ]] && continue
|
||||||
|
|
||||||
|
# Before checking if the completion matches what the user typed,
|
||||||
|
# we need to strip any description and escape the completion to handle special
|
||||||
|
# characters because those escape characters are part of what the user typed.
|
||||||
|
# Don't call "printf" in a sub-shell because it will be much slower
|
||||||
|
# since we are in a loop.
|
||||||
|
printf -v comp "%%q" "${compline%%%%$tab*}" &>/dev/null || comp=$(printf "%%q" "${compline%%%%$tab*}")
|
||||||
|
|
||||||
|
# Only consider the completions that match
|
||||||
|
[[ $comp == "$cur"* ]] || continue
|
||||||
|
|
||||||
|
# The completions matches. Add it to the list of full completions including
|
||||||
|
# its description. We don't escape the completion because it may get printed
|
||||||
|
# in a list if there are more than one and we don't want show escape characters
|
||||||
|
# in that list.
|
||||||
|
COMPREPLY+=("$compline")
|
||||||
|
|
||||||
|
# Strip any description before checking the length, and again, don't escape
|
||||||
|
# the completion because this length is only used when printing the completions
|
||||||
|
# in a list and we don't want show escape characters in that list.
|
||||||
|
comp=${compline%%%%$tab*}
|
||||||
|
if ((${#comp}>longest)); then
|
||||||
|
longest=${#comp}
|
||||||
|
fi
|
||||||
|
done < <(printf "%%s\n" "${completions[@]}")
|
||||||
|
|
||||||
|
# If there is a single completion left, remove the description text and escape any special characters
|
||||||
|
if ((${#COMPREPLY[*]} == 1)); then
|
||||||
|
__%[1]s_debug "COMPREPLY[0]: ${COMPREPLY[0]}"
|
||||||
|
COMPREPLY[0]=$(printf "%%q" "${COMPREPLY[0]%%%%$tab*}")
|
||||||
|
__%[1]s_debug "Removed description from single completion, which is now: ${COMPREPLY[0]}"
|
||||||
|
else
|
||||||
|
# Format the descriptions
|
||||||
|
__%[1]s_format_comp_descriptions $longest
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_handle_special_char()
|
||||||
|
{
|
||||||
|
local comp="$1"
|
||||||
|
local char=$2
|
||||||
|
if [[ "$comp" == *${char}* && "$COMP_WORDBREAKS" == *${char}* ]]; then
|
||||||
|
local word=${comp%%"${comp##*${char}}"}
|
||||||
|
local idx=${#COMPREPLY[*]}
|
||||||
|
while ((--idx >= 0)); do
|
||||||
|
COMPREPLY[idx]=${COMPREPLY[idx]#"$word"}
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
__%[1]s_format_comp_descriptions()
|
||||||
|
{
|
||||||
|
local tab=$'\t'
|
||||||
|
local comp desc maxdesclength
|
||||||
|
local longest=$1
|
||||||
|
|
||||||
|
local i ci
|
||||||
|
for ci in ${!COMPREPLY[*]}; do
|
||||||
|
comp=${COMPREPLY[ci]}
|
||||||
|
# Properly format the description string which follows a tab character if there is one
|
||||||
|
if [[ "$comp" == *$tab* ]]; then
|
||||||
|
__%[1]s_debug "Original comp: $comp"
|
||||||
|
desc=${comp#*$tab}
|
||||||
|
comp=${comp%%%%$tab*}
|
||||||
|
|
||||||
|
# $COLUMNS stores the current shell width.
|
||||||
|
# Remove an extra 4 because we add 2 spaces and 2 parentheses.
|
||||||
|
maxdesclength=$(( COLUMNS - longest - 4 ))
|
||||||
|
|
||||||
|
# Make sure we can fit a description of at least 8 characters
|
||||||
|
# if we are to align the descriptions.
|
||||||
|
if ((maxdesclength > 8)); then
|
||||||
|
# Add the proper number of spaces to align the descriptions
|
||||||
|
for ((i = ${#comp} ; i < longest ; i++)); do
|
||||||
|
comp+=" "
|
||||||
|
done
|
||||||
|
else
|
||||||
|
# Don't pad the descriptions so we can fit more text after the completion
|
||||||
|
maxdesclength=$(( COLUMNS - ${#comp} - 4 ))
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If there is enough space for any description text,
|
||||||
|
# truncate the descriptions that are too long for the shell width
|
||||||
|
if ((maxdesclength > 0)); then
|
||||||
|
if ((${#desc} > maxdesclength)); then
|
||||||
|
desc=${desc:0:$(( maxdesclength - 1 ))}
|
||||||
|
desc+="…"
|
||||||
|
fi
|
||||||
|
comp+=" ($desc)"
|
||||||
|
fi
|
||||||
|
COMPREPLY[ci]=$comp
|
||||||
|
__%[1]s_debug "Final comp: $comp"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
}
|
||||||
|
|
||||||
|
__start_%[1]s()
|
||||||
|
{
|
||||||
|
local cur prev words cword split
|
||||||
|
|
||||||
|
COMPREPLY=()
|
||||||
|
|
||||||
|
# Call _init_completion from the bash-completion package
|
||||||
|
# to prepare the arguments properly
|
||||||
|
if declare -F _init_completion >/dev/null 2>&1; then
|
||||||
|
_init_completion -n =: || return
|
||||||
|
else
|
||||||
|
__%[1]s_init_completion -n =: || return
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug
|
||||||
|
__%[1]s_debug "========= starting completion logic =========="
|
||||||
|
__%[1]s_debug "cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}, cword is $cword"
|
||||||
|
|
||||||
|
# The user could have moved the cursor backwards on the command-line.
|
||||||
|
# We need to trigger completion from the $cword location, so we need
|
||||||
|
# to truncate the command-line ($words) up to the $cword location.
|
||||||
|
words=("${words[@]:0:$cword+1}")
|
||||||
|
__%[1]s_debug "Truncated words[*]: ${words[*]},"
|
||||||
|
|
||||||
|
local out directive
|
||||||
|
__%[1]s_get_completion_results
|
||||||
|
__%[1]s_process_completion_results
|
||||||
|
}
|
||||||
|
|
||||||
|
if [[ $(type -t compopt) = "builtin" ]]; then
|
||||||
|
complete -o default -F __start_%[1]s %[1]s
|
||||||
|
else
|
||||||
|
complete -o default -o nospace -F __start_%[1]s %[1]s
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ex: ts=4 sw=4 et filetype=sh
|
||||||
|
`, name, compCmd,
|
||||||
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder,
|
||||||
|
activeHelpMarker))
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionFileV2 generates Bash completion version 2.
|
||||||
|
func (c *Command) GenBashCompletionFileV2(filename string, includeDesc bool) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.GenBashCompletionV2(outFile, includeDesc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenBashCompletionV2 generates Bash completion file version 2
|
||||||
|
// and writes it to the passed writer.
|
||||||
|
func (c *Command) GenBashCompletionV2(w io.Writer, includeDesc bool) error {
|
||||||
|
return c.genBashCompletion(w, includeDesc)
|
||||||
|
}
|
||||||
246
vendor/github.com/spf13/cobra/cobra.go
generated
vendored
Normal file
246
vendor/github.com/spf13/cobra/cobra.go
generated
vendored
Normal file
@@ -0,0 +1,246 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
// Commands similar to git, go tools and other modern CLI tools
|
||||||
|
// inspired by go, go-Commander, gh and subcommand
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"text/template"
|
||||||
|
"time"
|
||||||
|
"unicode"
|
||||||
|
)
|
||||||
|
|
||||||
|
var templateFuncs = template.FuncMap{
|
||||||
|
"trim": strings.TrimSpace,
|
||||||
|
"trimRightSpace": trimRightSpace,
|
||||||
|
"trimTrailingWhitespaces": trimRightSpace,
|
||||||
|
"appendIfNotPresent": appendIfNotPresent,
|
||||||
|
"rpad": rpad,
|
||||||
|
"gt": Gt,
|
||||||
|
"eq": Eq,
|
||||||
|
}
|
||||||
|
|
||||||
|
var initializers []func()
|
||||||
|
var finalizers []func()
|
||||||
|
|
||||||
|
const (
|
||||||
|
defaultPrefixMatching = false
|
||||||
|
defaultCommandSorting = true
|
||||||
|
defaultCaseInsensitive = false
|
||||||
|
defaultTraverseRunHooks = false
|
||||||
|
)
|
||||||
|
|
||||||
|
// EnablePrefixMatching allows setting automatic prefix matching. Automatic prefix matching can be a dangerous thing
|
||||||
|
// to automatically enable in CLI tools.
|
||||||
|
// Set this to true to enable it.
|
||||||
|
var EnablePrefixMatching = defaultPrefixMatching
|
||||||
|
|
||||||
|
// EnableCommandSorting controls sorting of the slice of commands, which is turned on by default.
|
||||||
|
// To disable sorting, set it to false.
|
||||||
|
var EnableCommandSorting = defaultCommandSorting
|
||||||
|
|
||||||
|
// EnableCaseInsensitive allows case-insensitive commands names. (case sensitive by default)
|
||||||
|
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
|
||||||
|
// if the CLI is started from explorer.exe.
|
||||||
|
// To disable the mousetrap, just set this variable to blank string ("").
|
||||||
|
// Works only on Microsoft Windows.
|
||||||
|
var MousetrapHelpText = `This is a command line tool.
|
||||||
|
|
||||||
|
You need to open cmd.exe and run it from there.
|
||||||
|
`
|
||||||
|
|
||||||
|
// MousetrapDisplayDuration controls how long the MousetrapHelpText message is displayed on Windows
|
||||||
|
// if the CLI is started from explorer.exe. Set to 0 to wait for the return key to be pressed.
|
||||||
|
// To disable the mousetrap, just set MousetrapHelpText to blank string ("").
|
||||||
|
// Works only on Microsoft Windows.
|
||||||
|
var MousetrapDisplayDuration = 5 * time.Second
|
||||||
|
|
||||||
|
// AddTemplateFunc adds a template function that's available to Usage and Help
|
||||||
|
// template generation.
|
||||||
|
func AddTemplateFunc(name string, tmplFunc interface{}) {
|
||||||
|
templateFuncs[name] = tmplFunc
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddTemplateFuncs adds multiple template functions that are available to Usage and
|
||||||
|
// Help template generation.
|
||||||
|
func AddTemplateFuncs(tmplFuncs template.FuncMap) {
|
||||||
|
for k, v := range tmplFuncs {
|
||||||
|
templateFuncs[k] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnInitialize sets the passed functions to be run when each command's
|
||||||
|
// Execute method is called.
|
||||||
|
func OnInitialize(y ...func()) {
|
||||||
|
initializers = append(initializers, y...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OnFinalize sets the passed functions to be run when each command's
|
||||||
|
// Execute method is terminated.
|
||||||
|
func OnFinalize(y ...func()) {
|
||||||
|
finalizers = append(finalizers, y...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME Gt is unused by cobra and should be removed in a version 2. It exists only for compatibility with users of cobra.
|
||||||
|
|
||||||
|
// Gt takes two types and checks whether the first type is greater than the second. In case of types Arrays, Chans,
|
||||||
|
// Maps and Slices, Gt will compare their lengths. Ints are compared directly while strings are first parsed as
|
||||||
|
// ints and then compared.
|
||||||
|
func Gt(a interface{}, b interface{}) bool {
|
||||||
|
var left, right int64
|
||||||
|
av := reflect.ValueOf(a)
|
||||||
|
|
||||||
|
switch av.Kind() {
|
||||||
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
||||||
|
left = int64(av.Len())
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
left = av.Int()
|
||||||
|
case reflect.String:
|
||||||
|
left, _ = strconv.ParseInt(av.String(), 10, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
bv := reflect.ValueOf(b)
|
||||||
|
|
||||||
|
switch bv.Kind() {
|
||||||
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
||||||
|
right = int64(bv.Len())
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
right = bv.Int()
|
||||||
|
case reflect.String:
|
||||||
|
right, _ = strconv.ParseInt(bv.String(), 10, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
return left > right
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME Eq is unused by cobra and should be removed in a version 2. It exists only for compatibility with users of cobra.
|
||||||
|
|
||||||
|
// Eq takes two types and checks whether they are equal. Supported types are int and string. Unsupported types will panic.
|
||||||
|
func Eq(a interface{}, b interface{}) bool {
|
||||||
|
av := reflect.ValueOf(a)
|
||||||
|
bv := reflect.ValueOf(b)
|
||||||
|
|
||||||
|
switch av.Kind() {
|
||||||
|
case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
|
||||||
|
panic("Eq called on unsupported type")
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
return av.Int() == bv.Int()
|
||||||
|
case reflect.String:
|
||||||
|
return av.String() == bv.String()
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func trimRightSpace(s string) string {
|
||||||
|
return strings.TrimRightFunc(s, unicode.IsSpace)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME appendIfNotPresent is unused by cobra and should be removed in a version 2. It exists only for compatibility with users of cobra.
|
||||||
|
|
||||||
|
// appendIfNotPresent will append stringToAppend to the end of s, but only if it's not yet present in s.
|
||||||
|
func appendIfNotPresent(s, stringToAppend string) string {
|
||||||
|
if strings.Contains(s, stringToAppend) {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
return s + " " + stringToAppend
|
||||||
|
}
|
||||||
|
|
||||||
|
// rpad adds padding to the right of a string.
|
||||||
|
func rpad(s string, padding int) string {
|
||||||
|
formattedString := fmt.Sprintf("%%-%ds", padding)
|
||||||
|
return fmt.Sprintf(formattedString, s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func tmpl(text string) *tmplFunc {
|
||||||
|
return &tmplFunc{
|
||||||
|
tmpl: text,
|
||||||
|
fn: func(w io.Writer, data interface{}) error {
|
||||||
|
t := template.New("top")
|
||||||
|
t.Funcs(templateFuncs)
|
||||||
|
template.Must(t.Parse(text))
|
||||||
|
return t.Execute(w, data)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ld compares two strings and returns the levenshtein distance between them.
|
||||||
|
func ld(s, t string, ignoreCase bool) int {
|
||||||
|
if ignoreCase {
|
||||||
|
s = strings.ToLower(s)
|
||||||
|
t = strings.ToLower(t)
|
||||||
|
}
|
||||||
|
d := make([][]int, len(s)+1)
|
||||||
|
for i := range d {
|
||||||
|
d[i] = make([]int, len(t)+1)
|
||||||
|
d[i][0] = i
|
||||||
|
}
|
||||||
|
for j := range d[0] {
|
||||||
|
d[0][j] = j
|
||||||
|
}
|
||||||
|
for j := 1; j <= len(t); j++ {
|
||||||
|
for i := 1; i <= len(s); i++ {
|
||||||
|
if s[i-1] == t[j-1] {
|
||||||
|
d[i][j] = d[i-1][j-1]
|
||||||
|
} else {
|
||||||
|
min := d[i-1][j]
|
||||||
|
if d[i][j-1] < min {
|
||||||
|
min = d[i][j-1]
|
||||||
|
}
|
||||||
|
if d[i-1][j-1] < min {
|
||||||
|
min = d[i-1][j-1]
|
||||||
|
}
|
||||||
|
d[i][j] = min + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return d[len(s)][len(t)]
|
||||||
|
}
|
||||||
|
|
||||||
|
func stringInSlice(a string, list []string) bool {
|
||||||
|
for _, b := range list {
|
||||||
|
if b == a {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckErr prints the msg with the prefix 'Error:' and exits with error code 1. If the msg is nil, it does nothing.
|
||||||
|
func CheckErr(msg interface{}) {
|
||||||
|
if msg != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, "Error:", msg)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteStringAndCheck writes a string into a buffer, and checks if the error is not nil.
|
||||||
|
func WriteStringAndCheck(b io.StringWriter, s string) {
|
||||||
|
_, err := b.WriteString(s)
|
||||||
|
CheckErr(err)
|
||||||
|
}
|
||||||
2072
vendor/github.com/spf13/cobra/command.go
generated
vendored
Normal file
2072
vendor/github.com/spf13/cobra/command.go
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
20
vendor/github.com/spf13/cobra/command_notwin.go
generated
vendored
Normal file
20
vendor/github.com/spf13/cobra/command_notwin.go
generated
vendored
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
//go:build !windows
|
||||||
|
// +build !windows
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
var preExecHookFn func(*Command)
|
||||||
41
vendor/github.com/spf13/cobra/command_win.go
generated
vendored
Normal file
41
vendor/github.com/spf13/cobra/command_win.go
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
//go:build windows
|
||||||
|
// +build windows
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/inconshreveable/mousetrap"
|
||||||
|
)
|
||||||
|
|
||||||
|
var preExecHookFn = preExecHook
|
||||||
|
|
||||||
|
func preExecHook(c *Command) {
|
||||||
|
if MousetrapHelpText != "" && mousetrap.StartedByExplorer() {
|
||||||
|
c.Print(MousetrapHelpText)
|
||||||
|
if MousetrapDisplayDuration > 0 {
|
||||||
|
time.Sleep(MousetrapDisplayDuration)
|
||||||
|
} else {
|
||||||
|
c.Println("Press return to continue...")
|
||||||
|
fmt.Scanln()
|
||||||
|
}
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
1020
vendor/github.com/spf13/cobra/completions.go
generated
vendored
Normal file
1020
vendor/github.com/spf13/cobra/completions.go
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
292
vendor/github.com/spf13/cobra/fish_completions.go
generated
vendored
Normal file
292
vendor/github.com/spf13/cobra/fish_completions.go
generated
vendored
Normal file
@@ -0,0 +1,292 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func genFishComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
|
// Variables should not contain a '-' or ':' character
|
||||||
|
nameForVar := name
|
||||||
|
nameForVar = strings.ReplaceAll(nameForVar, "-", "_")
|
||||||
|
nameForVar = strings.ReplaceAll(nameForVar, ":", "_")
|
||||||
|
|
||||||
|
compCmd := ShellCompRequestCmd
|
||||||
|
if !includeDesc {
|
||||||
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf("# fish completion for %-36s -*- shell-script -*-\n", name))
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`
|
||||||
|
function __%[1]s_debug
|
||||||
|
set -l file "$BASH_COMP_DEBUG_FILE"
|
||||||
|
if test -n "$file"
|
||||||
|
echo "$argv" >> $file
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
function __%[1]s_perform_completion
|
||||||
|
__%[1]s_debug "Starting __%[1]s_perform_completion"
|
||||||
|
|
||||||
|
# Extract all args except the last one
|
||||||
|
set -l args (commandline -opc)
|
||||||
|
# Extract the last arg and escape it in case it is a space
|
||||||
|
set -l lastArg (string escape -- (commandline -ct))
|
||||||
|
|
||||||
|
__%[1]s_debug "args: $args"
|
||||||
|
__%[1]s_debug "last arg: $lastArg"
|
||||||
|
|
||||||
|
# Disable ActiveHelp which is not supported for fish shell
|
||||||
|
set -l requestComp "%[10]s=0 $args[1] %[3]s $args[2..-1] $lastArg"
|
||||||
|
|
||||||
|
__%[1]s_debug "Calling $requestComp"
|
||||||
|
set -l results (eval $requestComp 2> /dev/null)
|
||||||
|
|
||||||
|
# Some programs may output extra empty lines after the directive.
|
||||||
|
# Let's ignore them or else it will break completion.
|
||||||
|
# Ref: https://github.com/spf13/cobra/issues/1279
|
||||||
|
for line in $results[-1..1]
|
||||||
|
if test (string trim -- $line) = ""
|
||||||
|
# Found an empty line, remove it
|
||||||
|
set results $results[1..-2]
|
||||||
|
else
|
||||||
|
# Found non-empty line, we have our proper output
|
||||||
|
break
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l comps $results[1..-2]
|
||||||
|
set -l directiveLine $results[-1]
|
||||||
|
|
||||||
|
# For Fish, when completing a flag with an = (e.g., <program> -n=<TAB>)
|
||||||
|
# completions must be prefixed with the flag
|
||||||
|
set -l flagPrefix (string match -r -- '-.*=' "$lastArg")
|
||||||
|
|
||||||
|
__%[1]s_debug "Comps: $comps"
|
||||||
|
__%[1]s_debug "DirectiveLine: $directiveLine"
|
||||||
|
__%[1]s_debug "flagPrefix: $flagPrefix"
|
||||||
|
|
||||||
|
for comp in $comps
|
||||||
|
printf "%%s%%s\n" "$flagPrefix" "$comp"
|
||||||
|
end
|
||||||
|
|
||||||
|
printf "%%s\n" "$directiveLine"
|
||||||
|
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:
|
||||||
|
# - Obtain the completions and store them in the global __%[1]s_comp_results
|
||||||
|
# - Return false if file completion should be performed
|
||||||
|
function __%[1]s_prepare_completions
|
||||||
|
__%[1]s_debug ""
|
||||||
|
__%[1]s_debug "========= starting completion logic =========="
|
||||||
|
|
||||||
|
# Start fresh
|
||||||
|
set --erase __%[1]s_comp_results
|
||||||
|
|
||||||
|
__%[1]s_perform_completion_once
|
||||||
|
__%[1]s_debug "Completion results: $__%[1]s_perform_completion_once_result"
|
||||||
|
|
||||||
|
if test -z "$__%[1]s_perform_completion_once_result"
|
||||||
|
__%[1]s_debug "No completion, probably due to a failure"
|
||||||
|
# Might as well do file completion, in case it helps
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l directive (string sub --start 2 $__%[1]s_perform_completion_once_result[-1])
|
||||||
|
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 "Directive is: $directive"
|
||||||
|
|
||||||
|
set -l shellCompDirectiveError %[4]d
|
||||||
|
set -l shellCompDirectiveNoSpace %[5]d
|
||||||
|
set -l shellCompDirectiveNoFileComp %[6]d
|
||||||
|
set -l shellCompDirectiveFilterFileExt %[7]d
|
||||||
|
set -l shellCompDirectiveFilterDirs %[8]d
|
||||||
|
|
||||||
|
if test -z "$directive"
|
||||||
|
set directive 0
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l compErr (math (math --scale 0 $directive / $shellCompDirectiveError) %% 2)
|
||||||
|
if test $compErr -eq 1
|
||||||
|
__%[1]s_debug "Received error directive: aborting."
|
||||||
|
# Might as well do file completion, in case it helps
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l filefilter (math (math --scale 0 $directive / $shellCompDirectiveFilterFileExt) %% 2)
|
||||||
|
set -l dirfilter (math (math --scale 0 $directive / $shellCompDirectiveFilterDirs) %% 2)
|
||||||
|
if test $filefilter -eq 1; or test $dirfilter -eq 1
|
||||||
|
__%[1]s_debug "File extension filtering or directory filtering not supported"
|
||||||
|
# Do full file completion instead
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set -l nospace (math (math --scale 0 $directive / $shellCompDirectiveNoSpace) %% 2)
|
||||||
|
set -l nofiles (math (math --scale 0 $directive / $shellCompDirectiveNoFileComp) %% 2)
|
||||||
|
|
||||||
|
__%[1]s_debug "nospace: $nospace, nofiles: $nofiles"
|
||||||
|
|
||||||
|
# If we want to prevent a space, or if file completion is NOT disabled,
|
||||||
|
# we need to count the number of valid completions.
|
||||||
|
# To do so, we will filter on prefix as the completions we have received
|
||||||
|
# may not already be filtered so as to allow fish to match on different
|
||||||
|
# criteria than the prefix.
|
||||||
|
if test $nospace -ne 0; or test $nofiles -eq 0
|
||||||
|
set -l prefix (commandline -t | string escape --style=regex)
|
||||||
|
__%[1]s_debug "prefix: $prefix"
|
||||||
|
|
||||||
|
set -l completions (string match -r -- "^$prefix.*" $__%[1]s_comp_results)
|
||||||
|
set --global __%[1]s_comp_results $completions
|
||||||
|
__%[1]s_debug "Filtered completions are: $__%[1]s_comp_results"
|
||||||
|
|
||||||
|
# Important not to quote the variable for count to work
|
||||||
|
set -l numComps (count $__%[1]s_comp_results)
|
||||||
|
__%[1]s_debug "numComps: $numComps"
|
||||||
|
|
||||||
|
if test $numComps -eq 1; and test $nospace -ne 0
|
||||||
|
# We must first split on \t to get rid of the descriptions to be
|
||||||
|
# able to check what the actual completion will be.
|
||||||
|
# We don't need descriptions anyway since there is only a single
|
||||||
|
# real completion which the shell will expand immediately.
|
||||||
|
set -l split (string split --max 1 \t $__%[1]s_comp_results[1])
|
||||||
|
|
||||||
|
# Fish won't add a space if the completion ends with any
|
||||||
|
# of the following characters: @=/:.,
|
||||||
|
set -l lastChar (string sub -s -1 -- $split)
|
||||||
|
if not string match -r -q "[@=/:.,]" -- "$lastChar"
|
||||||
|
# In other cases, to support the "nospace" directive we trick the shell
|
||||||
|
# by outputting an extra, longer completion.
|
||||||
|
__%[1]s_debug "Adding second completion to perform nospace directive"
|
||||||
|
set --global __%[1]s_comp_results $split[1] $split[1].
|
||||||
|
__%[1]s_debug "Completions are now: $__%[1]s_comp_results"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
if test $numComps -eq 0; and test $nofiles -eq 0
|
||||||
|
# To be consistent with bash and zsh, we only trigger file
|
||||||
|
# completion when there are no other completions
|
||||||
|
__%[1]s_debug "Requesting file completion"
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return 0
|
||||||
|
end
|
||||||
|
|
||||||
|
# Since Fish completions are only loaded once the user triggers them, we trigger them ourselves
|
||||||
|
# so we can properly delete any completions provided by another script.
|
||||||
|
# Only do this if the program can be found, or else fish may print some errors; besides,
|
||||||
|
# the existing completions will only be loaded if the program can be found.
|
||||||
|
if type -q "%[2]s"
|
||||||
|
# The space after the program name is essential to trigger completion for the program
|
||||||
|
# and not completion of the program name itself.
|
||||||
|
# Also, we use '> /dev/null 2>&1' since '&>' is not supported in older versions of fish.
|
||||||
|
complete --do-complete "%[2]s " > /dev/null 2>&1
|
||||||
|
end
|
||||||
|
|
||||||
|
# Remove any pre-existing completions for the program since we will be handling all of them.
|
||||||
|
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
|
||||||
|
# which provides the program's completion choices.
|
||||||
|
# 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,
|
||||||
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder, activeHelpEnvVar(name)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenFishCompletion generates fish completion file and writes to the passed writer.
|
||||||
|
func (c *Command) GenFishCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
genFishComp(buf, c.Name(), includeDesc)
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenFishCompletionFile generates fish completion file.
|
||||||
|
func (c *Command) GenFishCompletionFile(filename string, includeDesc bool) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.GenFishCompletion(outFile, includeDesc)
|
||||||
|
}
|
||||||
290
vendor/github.com/spf13/cobra/flag_groups.go
generated
vendored
Normal file
290
vendor/github.com/spf13/cobra/flag_groups.go
generated
vendored
Normal file
@@ -0,0 +1,290 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
flag "github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
requiredAsGroupAnnotation = "cobra_annotation_required_if_others_set"
|
||||||
|
oneRequiredAnnotation = "cobra_annotation_one_required"
|
||||||
|
mutuallyExclusiveAnnotation = "cobra_annotation_mutually_exclusive"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MarkFlagsRequiredTogether marks the given flags with annotations so that Cobra errors
|
||||||
|
// if the command is invoked with a subset (but not all) of the given flags.
|
||||||
|
func (c *Command) MarkFlagsRequiredTogether(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 required in a flag group", v))
|
||||||
|
}
|
||||||
|
if err := c.Flags().SetAnnotation(v, requiredAsGroupAnnotation, append(f.Annotations[requiredAsGroupAnnotation], strings.Join(flagNames, " "))); err != nil {
|
||||||
|
// Only errs if the flag isn't found.
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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, oneRequiredAnnotation, append(f.Annotations[oneRequiredAnnotation], 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
|
||||||
|
// if the command is invoked with more than one flag from the given set of flags.
|
||||||
|
func (c *Command) MarkFlagsMutuallyExclusive(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 mutually exclusive flag group", v))
|
||||||
|
}
|
||||||
|
// Each time this is called is a single new entry; this allows it to be a member of multiple groups if needed.
|
||||||
|
if err := c.Flags().SetAnnotation(v, mutuallyExclusiveAnnotation, append(f.Annotations[mutuallyExclusiveAnnotation], strings.Join(flagNames, " "))); err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValidateFlagGroups validates the mutuallyExclusive/oneRequired/requiredAsGroup logic and returns the
|
||||||
|
// first error encountered.
|
||||||
|
func (c *Command) ValidateFlagGroups() error {
|
||||||
|
if c.DisableFlagParsing {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
flags := c.Flags()
|
||||||
|
|
||||||
|
// 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.
|
||||||
|
groupStatus := map[string]map[string]bool{}
|
||||||
|
oneRequiredGroupStatus := map[string]map[string]bool{}
|
||||||
|
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
||||||
|
flags.VisitAll(func(pflag *flag.Flag) {
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, requiredAsGroupAnnotation, groupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, oneRequiredAnnotation, oneRequiredGroupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusiveAnnotation, mutuallyExclusiveGroupStatus)
|
||||||
|
})
|
||||||
|
|
||||||
|
if err := validateRequiredFlagGroups(groupStatus); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := validateOneRequiredFlagGroups(oneRequiredGroupStatus); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := validateExclusiveFlagGroups(mutuallyExclusiveGroupStatus); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasAllFlags(fs *flag.FlagSet, flagnames ...string) bool {
|
||||||
|
for _, fname := range flagnames {
|
||||||
|
f := fs.Lookup(fname)
|
||||||
|
if f == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func processFlagForGroupAnnotation(flags *flag.FlagSet, pflag *flag.Flag, annotation string, groupStatus map[string]map[string]bool) {
|
||||||
|
groupInfo, found := pflag.Annotations[annotation]
|
||||||
|
if found {
|
||||||
|
for _, group := range groupInfo {
|
||||||
|
if groupStatus[group] == nil {
|
||||||
|
flagnames := strings.Split(group, " ")
|
||||||
|
|
||||||
|
// Only consider this flag group at all if all the flags are defined.
|
||||||
|
if !hasAllFlags(flags, flagnames...) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
groupStatus[group] = make(map[string]bool, len(flagnames))
|
||||||
|
for _, name := range flagnames {
|
||||||
|
groupStatus[group][name] = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
groupStatus[group][pflag.Name] = pflag.Changed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateRequiredFlagGroups(data map[string]map[string]bool) error {
|
||||||
|
keys := sortedKeys(data)
|
||||||
|
for _, flagList := range keys {
|
||||||
|
flagnameAndStatus := data[flagList]
|
||||||
|
|
||||||
|
unset := []string{}
|
||||||
|
for flagname, isSet := range flagnameAndStatus {
|
||||||
|
if !isSet {
|
||||||
|
unset = append(unset, flagname)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(unset) == len(flagnameAndStatus) || len(unset) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sort values, so they can be tested/scripted against consistently.
|
||||||
|
sort.Strings(unset)
|
||||||
|
return fmt.Errorf("if any flags in the group [%v] are set they must all be set; missing %v", flagList, unset)
|
||||||
|
}
|
||||||
|
|
||||||
|
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 {
|
||||||
|
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) == 0 || len(set) == 1 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sort values, so they can be tested/scripted against consistently.
|
||||||
|
sort.Strings(set)
|
||||||
|
return fmt.Errorf("if any flags in the group [%v] are set none of the others can be; %v were all set", flagList, set)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func sortedKeys(m map[string]map[string]bool) []string {
|
||||||
|
keys := make([]string, len(m))
|
||||||
|
i := 0
|
||||||
|
for k := range m {
|
||||||
|
keys[i] = k
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
sort.Strings(keys)
|
||||||
|
return keys
|
||||||
|
}
|
||||||
|
|
||||||
|
// enforceFlagGroupsForCompletion will do the following:
|
||||||
|
// - 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
|
||||||
|
// This allows the standard completion logic to behave appropriately for flag groups
|
||||||
|
func (c *Command) enforceFlagGroupsForCompletion() {
|
||||||
|
if c.DisableFlagParsing {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
flags := c.Flags()
|
||||||
|
groupStatus := map[string]map[string]bool{}
|
||||||
|
oneRequiredGroupStatus := map[string]map[string]bool{}
|
||||||
|
mutuallyExclusiveGroupStatus := map[string]map[string]bool{}
|
||||||
|
c.Flags().VisitAll(func(pflag *flag.Flag) {
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, requiredAsGroupAnnotation, groupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, oneRequiredAnnotation, oneRequiredGroupStatus)
|
||||||
|
processFlagForGroupAnnotation(flags, pflag, mutuallyExclusiveAnnotation, mutuallyExclusiveGroupStatus)
|
||||||
|
})
|
||||||
|
|
||||||
|
// If a flag that is part of a group is present, we make all the other flags
|
||||||
|
// of that group required so that the shell completion suggests them automatically
|
||||||
|
for flagList, flagnameAndStatus := range groupStatus {
|
||||||
|
for _, isSet := range flagnameAndStatus {
|
||||||
|
if isSet {
|
||||||
|
// One of the flags of the group is set, mark the other ones as required
|
||||||
|
for _, fName := range strings.Split(flagList, " ") {
|
||||||
|
_ = c.MarkFlagRequired(fName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// flags of that group so the shell completion does not suggest them
|
||||||
|
for flagList, flagnameAndStatus := range mutuallyExclusiveGroupStatus {
|
||||||
|
for flagName, isSet := range flagnameAndStatus {
|
||||||
|
if isSet {
|
||||||
|
// One of the flags of the mutually exclusive group is set, mark the other ones as hidden
|
||||||
|
// Don't mark the flag that is already set as hidden because it may be an
|
||||||
|
// array or slice flag and therefore must continue being suggested
|
||||||
|
for _, fName := range strings.Split(flagList, " ") {
|
||||||
|
if fName != flagName {
|
||||||
|
flag := c.Flags().Lookup(fName)
|
||||||
|
flag.Hidden = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
350
vendor/github.com/spf13/cobra/powershell_completions.go
generated
vendored
Normal file
350
vendor/github.com/spf13/cobra/powershell_completions.go
generated
vendored
Normal file
@@ -0,0 +1,350 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
// The generated scripts require PowerShell v5.0+ (which comes Windows 10, but
|
||||||
|
// can be downloaded separately for windows 7 or 8.1).
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
func genPowerShellComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
|
// Variables should not contain a '-' or ':' character
|
||||||
|
nameForVar := name
|
||||||
|
nameForVar = strings.ReplaceAll(nameForVar, "-", "_")
|
||||||
|
nameForVar = strings.ReplaceAll(nameForVar, ":", "_")
|
||||||
|
|
||||||
|
compCmd := ShellCompRequestCmd
|
||||||
|
if !includeDesc {
|
||||||
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`# powershell completion for %-36[1]s -*- shell-script -*-
|
||||||
|
|
||||||
|
function __%[1]s_debug {
|
||||||
|
if ($env:BASH_COMP_DEBUG_FILE) {
|
||||||
|
"$args" | Out-File -Append -FilePath "$env:BASH_COMP_DEBUG_FILE"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
filter __%[1]s_escapeStringWithSpecialChars {
|
||||||
|
`+" $_ -replace '\\s|#|@|\\$|;|,|''|\\{|\\}|\\(|\\)|\"|`|\\||<|>|&','`$&'"+`
|
||||||
|
}
|
||||||
|
|
||||||
|
[scriptblock]${__%[2]sCompleterBlock} = {
|
||||||
|
param(
|
||||||
|
$WordToComplete,
|
||||||
|
$CommandAst,
|
||||||
|
$CursorPosition
|
||||||
|
)
|
||||||
|
|
||||||
|
# Get the current command line and convert into a string
|
||||||
|
$Command = $CommandAst.CommandElements
|
||||||
|
$Command = "$Command"
|
||||||
|
|
||||||
|
__%[1]s_debug ""
|
||||||
|
__%[1]s_debug "========= starting completion logic =========="
|
||||||
|
__%[1]s_debug "WordToComplete: $WordToComplete Command: $Command CursorPosition: $CursorPosition"
|
||||||
|
|
||||||
|
# The user could have moved the cursor backwards on the command-line.
|
||||||
|
# We need to trigger completion from the $CursorPosition location, so we need
|
||||||
|
# to truncate the command-line ($Command) up to the $CursorPosition location.
|
||||||
|
# Make sure the $Command is longer then the $CursorPosition before we truncate.
|
||||||
|
# This happens because the $Command does not include the last space.
|
||||||
|
if ($Command.Length -gt $CursorPosition) {
|
||||||
|
$Command=$Command.Substring(0,$CursorPosition)
|
||||||
|
}
|
||||||
|
__%[1]s_debug "Truncated command: $Command"
|
||||||
|
|
||||||
|
$ShellCompDirectiveError=%[4]d
|
||||||
|
$ShellCompDirectiveNoSpace=%[5]d
|
||||||
|
$ShellCompDirectiveNoFileComp=%[6]d
|
||||||
|
$ShellCompDirectiveFilterFileExt=%[7]d
|
||||||
|
$ShellCompDirectiveFilterDirs=%[8]d
|
||||||
|
$ShellCompDirectiveKeepOrder=%[9]d
|
||||||
|
|
||||||
|
# Prepare the command to request completions for the program.
|
||||||
|
# Split the command at the first space to separate the program and arguments.
|
||||||
|
$Program,$Arguments = $Command.Split(" ",2)
|
||||||
|
|
||||||
|
$RequestComp="$Program %[3]s $Arguments"
|
||||||
|
__%[1]s_debug "RequestComp: $RequestComp"
|
||||||
|
|
||||||
|
# we cannot use $WordToComplete because it
|
||||||
|
# has the wrong values if the cursor was moved
|
||||||
|
# so use the last argument
|
||||||
|
if ($WordToComplete -ne "" ) {
|
||||||
|
$WordToComplete = $Arguments.Split(" ")[-1]
|
||||||
|
}
|
||||||
|
__%[1]s_debug "New WordToComplete: $WordToComplete"
|
||||||
|
|
||||||
|
|
||||||
|
# Check for flag with equal sign
|
||||||
|
$IsEqualFlag = ($WordToComplete -Like "--*=*" )
|
||||||
|
if ( $IsEqualFlag ) {
|
||||||
|
__%[1]s_debug "Completing equal sign flag"
|
||||||
|
# Remove the flag part
|
||||||
|
$Flag,$WordToComplete = $WordToComplete.Split("=",2)
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( $WordToComplete -eq "" -And ( -Not $IsEqualFlag )) {
|
||||||
|
# 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.
|
||||||
|
__%[1]s_debug "Adding extra empty parameter"
|
||||||
|
# PowerShell 7.2+ changed the way how the arguments are passed to executables,
|
||||||
|
# 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"
|
||||||
|
# First disable ActiveHelp which is not supported for Powershell
|
||||||
|
${env:%[10]s}=0
|
||||||
|
|
||||||
|
#call the command store the output in $out and redirect stderr and stdout to null
|
||||||
|
# $Out is an array contains each line per element
|
||||||
|
Invoke-Expression -OutVariable out "$RequestComp" 2>&1 | Out-Null
|
||||||
|
|
||||||
|
# get directive from last line
|
||||||
|
[int]$Directive = $Out[-1].TrimStart(':')
|
||||||
|
if ($Directive -eq "") {
|
||||||
|
# There is no directive specified
|
||||||
|
$Directive = 0
|
||||||
|
}
|
||||||
|
__%[1]s_debug "The completion directive is: $Directive"
|
||||||
|
|
||||||
|
# remove directive (last element) from out
|
||||||
|
$Out = $Out | Where-Object { $_ -ne $Out[-1] }
|
||||||
|
__%[1]s_debug "The completions are: $Out"
|
||||||
|
|
||||||
|
if (($Directive -band $ShellCompDirectiveError) -ne 0 ) {
|
||||||
|
# Error code. No completion.
|
||||||
|
__%[1]s_debug "Received error from custom completion go code"
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$Longest = 0
|
||||||
|
[Array]$Values = $Out | ForEach-Object {
|
||||||
|
#Split the output in name and description
|
||||||
|
`+" $Name, $Description = $_.Split(\"`t\",2)"+`
|
||||||
|
__%[1]s_debug "Name: $Name Description: $Description"
|
||||||
|
|
||||||
|
# Look for the longest completion so that we can format things nicely
|
||||||
|
if ($Longest -lt $Name.Length) {
|
||||||
|
$Longest = $Name.Length
|
||||||
|
}
|
||||||
|
|
||||||
|
# Set the description to a one space string if there is none set.
|
||||||
|
# This is needed because the CompletionResult does not accept an empty string as argument
|
||||||
|
if (-Not $Description) {
|
||||||
|
$Description = " "
|
||||||
|
}
|
||||||
|
New-Object -TypeName PSCustomObject -Property @{
|
||||||
|
Name = "$Name"
|
||||||
|
Description = "$Description"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
$Space = " "
|
||||||
|
if (($Directive -band $ShellCompDirectiveNoSpace) -ne 0 ) {
|
||||||
|
# remove the space here
|
||||||
|
__%[1]s_debug "ShellCompDirectiveNoSpace is called"
|
||||||
|
$Space = ""
|
||||||
|
}
|
||||||
|
|
||||||
|
if ((($Directive -band $ShellCompDirectiveFilterFileExt) -ne 0 ) -or
|
||||||
|
(($Directive -band $ShellCompDirectiveFilterDirs) -ne 0 )) {
|
||||||
|
__%[1]s_debug "ShellCompDirectiveFilterFileExt ShellCompDirectiveFilterDirs are not supported"
|
||||||
|
|
||||||
|
# return here to prevent the completion of the extensions
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
$Values = $Values | Where-Object {
|
||||||
|
# filter the result
|
||||||
|
$_.Name -like "$WordToComplete*"
|
||||||
|
|
||||||
|
# Join the flag back if we have an equal sign flag
|
||||||
|
if ( $IsEqualFlag ) {
|
||||||
|
__%[1]s_debug "Join the equal sign flag back to the completion value"
|
||||||
|
$_.Name = $Flag + "=" + $_.Name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# 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 ) {
|
||||||
|
__%[1]s_debug "ShellCompDirectiveNoFileComp is called"
|
||||||
|
|
||||||
|
if ($Values.Length -eq 0) {
|
||||||
|
# Just print an empty string here so the
|
||||||
|
# shell does not start to complete paths.
|
||||||
|
# We cannot use CompletionResult here because
|
||||||
|
# it does not accept an empty string as argument.
|
||||||
|
""
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Get the current mode
|
||||||
|
$Mode = (Get-PSReadLineKeyHandler | Where-Object {$_.Key -eq "Tab" }).Function
|
||||||
|
__%[1]s_debug "Mode: $Mode"
|
||||||
|
|
||||||
|
$Values | ForEach-Object {
|
||||||
|
|
||||||
|
# store temporary because switch will overwrite $_
|
||||||
|
$comp = $_
|
||||||
|
|
||||||
|
# PowerShell supports three different completion modes
|
||||||
|
# - TabCompleteNext (default windows style - on each key press the next option is displayed)
|
||||||
|
# - Complete (works like bash)
|
||||||
|
# - MenuComplete (works like zsh)
|
||||||
|
# You set the mode with Set-PSReadLineKeyHandler -Key Tab -Function <mode>
|
||||||
|
|
||||||
|
# CompletionResult Arguments:
|
||||||
|
# 1) CompletionText text to be used as the auto completion result
|
||||||
|
# 2) ListItemText text to be displayed in the suggestion list
|
||||||
|
# 3) ResultType type of completion result
|
||||||
|
# 4) ToolTip text for the tooltip with details about the object
|
||||||
|
|
||||||
|
switch ($Mode) {
|
||||||
|
|
||||||
|
# bash like
|
||||||
|
"Complete" {
|
||||||
|
|
||||||
|
if ($Values.Length -eq 1) {
|
||||||
|
__%[1]s_debug "Only one completion left"
|
||||||
|
|
||||||
|
# insert space after value
|
||||||
|
$CompletionText = $($comp.Name | __%[1]s_escapeStringWithSpecialChars) + $Space
|
||||||
|
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
|
||||||
|
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
|
||||||
|
} else {
|
||||||
|
$CompletionText
|
||||||
|
}
|
||||||
|
|
||||||
|
} else {
|
||||||
|
# Add the proper number of spaces to align the descriptions
|
||||||
|
while($comp.Name.Length -lt $Longest) {
|
||||||
|
$comp.Name = $comp.Name + " "
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check for empty description and only add parentheses if needed
|
||||||
|
if ($($comp.Description) -eq " " ) {
|
||||||
|
$Description = ""
|
||||||
|
} else {
|
||||||
|
$Description = " ($($comp.Description))"
|
||||||
|
}
|
||||||
|
|
||||||
|
$CompletionText = "$($comp.Name)$Description"
|
||||||
|
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
|
||||||
|
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)$Description", 'ParameterValue', "$($comp.Description)")
|
||||||
|
} else {
|
||||||
|
$CompletionText
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# zsh like
|
||||||
|
"MenuComplete" {
|
||||||
|
# insert space after value
|
||||||
|
# MenuComplete will automatically show the ToolTip of
|
||||||
|
# the highlighted value at the bottom of the suggestions.
|
||||||
|
|
||||||
|
$CompletionText = $($comp.Name | __%[1]s_escapeStringWithSpecialChars) + $Space
|
||||||
|
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
|
||||||
|
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
|
||||||
|
} else {
|
||||||
|
$CompletionText
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# TabCompleteNext and in case we get something unknown
|
||||||
|
Default {
|
||||||
|
# Like MenuComplete but we don't want to add a space here because
|
||||||
|
# the user need to press space anyway to get the completion.
|
||||||
|
# Description will not be shown because that's not possible with TabCompleteNext
|
||||||
|
|
||||||
|
$CompletionText = $($comp.Name | __%[1]s_escapeStringWithSpecialChars)
|
||||||
|
if ($ExecutionContext.SessionState.LanguageMode -eq "FullLanguage"){
|
||||||
|
[System.Management.Automation.CompletionResult]::new($CompletionText, "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
|
||||||
|
} else {
|
||||||
|
$CompletionText
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Register-ArgumentCompleter -CommandName '%[1]s' -ScriptBlock ${__%[2]sCompleterBlock}
|
||||||
|
`, name, nameForVar, compCmd,
|
||||||
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder, activeHelpEnvVar(name)))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genPowerShellCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
genPowerShellComp(buf, c.Name(), includeDesc)
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genPowerShellCompletionFile(filename string, includeDesc bool) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.genPowerShellCompletion(outFile, includeDesc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenPowerShellCompletionFile generates powershell completion file without descriptions.
|
||||||
|
func (c *Command) GenPowerShellCompletionFile(filename string) error {
|
||||||
|
return c.genPowerShellCompletionFile(filename, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenPowerShellCompletion generates powershell completion file without descriptions
|
||||||
|
// and writes it to the passed writer.
|
||||||
|
func (c *Command) GenPowerShellCompletion(w io.Writer) error {
|
||||||
|
return c.genPowerShellCompletion(w, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenPowerShellCompletionFileWithDesc generates powershell completion file with descriptions.
|
||||||
|
func (c *Command) GenPowerShellCompletionFileWithDesc(filename string) error {
|
||||||
|
return c.genPowerShellCompletionFile(filename, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenPowerShellCompletionWithDesc generates powershell completion file with descriptions
|
||||||
|
// and writes it to the passed writer.
|
||||||
|
func (c *Command) GenPowerShellCompletionWithDesc(w io.Writer) error {
|
||||||
|
return c.genPowerShellCompletion(w, true)
|
||||||
|
}
|
||||||
98
vendor/github.com/spf13/cobra/shell_completions.go
generated
vendored
Normal file
98
vendor/github.com/spf13/cobra/shell_completions.go
generated
vendored
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MarkFlagRequired instructs the various shell completion implementations to
|
||||||
|
// prioritize the named flag when performing completion,
|
||||||
|
// and causes your command to report an error if invoked without the flag.
|
||||||
|
func (c *Command) MarkFlagRequired(name string) error {
|
||||||
|
return MarkFlagRequired(c.Flags(), name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkPersistentFlagRequired instructs the various shell completion implementations to
|
||||||
|
// prioritize the named persistent flag when performing completion,
|
||||||
|
// and causes your command to report an error if invoked without the flag.
|
||||||
|
func (c *Command) MarkPersistentFlagRequired(name string) error {
|
||||||
|
return MarkFlagRequired(c.PersistentFlags(), name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagRequired instructs the various shell completion implementations to
|
||||||
|
// prioritize the named flag when performing completion,
|
||||||
|
// and causes your command to report an error if invoked without the flag.
|
||||||
|
func MarkFlagRequired(flags *pflag.FlagSet, name string) error {
|
||||||
|
return flags.SetAnnotation(name, BashCompOneRequiredFlag, []string{"true"})
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagFilename instructs the various shell completion implementations to
|
||||||
|
// limit completions for the named flag to the specified file extensions.
|
||||||
|
func (c *Command) MarkFlagFilename(name string, extensions ...string) error {
|
||||||
|
return MarkFlagFilename(c.Flags(), name, extensions...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists.
|
||||||
|
// The bash completion script will call the bash function f for the flag.
|
||||||
|
//
|
||||||
|
// This will only work for bash completion.
|
||||||
|
// It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows
|
||||||
|
// to register a Go function which will work across all shells.
|
||||||
|
func (c *Command) MarkFlagCustom(name string, f string) error {
|
||||||
|
return MarkFlagCustom(c.Flags(), name, f)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkPersistentFlagFilename instructs the various shell completion
|
||||||
|
// implementations to limit completions for the named persistent flag to the
|
||||||
|
// specified file extensions.
|
||||||
|
func (c *Command) MarkPersistentFlagFilename(name string, extensions ...string) error {
|
||||||
|
return MarkFlagFilename(c.PersistentFlags(), name, extensions...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagFilename instructs the various shell completion implementations to
|
||||||
|
// limit completions for the named flag to the specified file extensions.
|
||||||
|
func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error {
|
||||||
|
return flags.SetAnnotation(name, BashCompFilenameExt, extensions)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists.
|
||||||
|
// The bash completion script will call the bash function f for the flag.
|
||||||
|
//
|
||||||
|
// This will only work for bash completion.
|
||||||
|
// It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows
|
||||||
|
// to register a Go function which will work across all shells.
|
||||||
|
func MarkFlagCustom(flags *pflag.FlagSet, name string, f string) error {
|
||||||
|
return flags.SetAnnotation(name, BashCompCustom, []string{f})
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagDirname instructs the various shell completion implementations to
|
||||||
|
// limit completions for the named flag to directory names.
|
||||||
|
func (c *Command) MarkFlagDirname(name string) error {
|
||||||
|
return MarkFlagDirname(c.Flags(), name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkPersistentFlagDirname instructs the various shell completion
|
||||||
|
// implementations to limit completions for the named persistent flag to
|
||||||
|
// directory names.
|
||||||
|
func (c *Command) MarkPersistentFlagDirname(name string) error {
|
||||||
|
return MarkFlagDirname(c.PersistentFlags(), name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkFlagDirname instructs the various shell completion implementations to
|
||||||
|
// limit completions for the named flag to directory names.
|
||||||
|
func MarkFlagDirname(flags *pflag.FlagSet, name string) error {
|
||||||
|
return flags.SetAnnotation(name, BashCompSubdirsInDir, []string{})
|
||||||
|
}
|
||||||
308
vendor/github.com/spf13/cobra/zsh_completions.go
generated
vendored
Normal file
308
vendor/github.com/spf13/cobra/zsh_completions.go
generated
vendored
Normal file
@@ -0,0 +1,308 @@
|
|||||||
|
// Copyright 2013-2023 The Cobra Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package cobra
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
// GenZshCompletionFile generates zsh completion file including descriptions.
|
||||||
|
func (c *Command) GenZshCompletionFile(filename string) error {
|
||||||
|
return c.genZshCompletionFile(filename, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenZshCompletion generates zsh completion file including descriptions
|
||||||
|
// and writes it to the passed writer.
|
||||||
|
func (c *Command) GenZshCompletion(w io.Writer) error {
|
||||||
|
return c.genZshCompletion(w, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenZshCompletionFileNoDesc generates zsh completion file without descriptions.
|
||||||
|
func (c *Command) GenZshCompletionFileNoDesc(filename string) error {
|
||||||
|
return c.genZshCompletionFile(filename, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenZshCompletionNoDesc generates zsh completion file without descriptions
|
||||||
|
// and writes it to the passed writer.
|
||||||
|
func (c *Command) GenZshCompletionNoDesc(w io.Writer) error {
|
||||||
|
return c.genZshCompletion(w, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkZshCompPositionalArgumentFile only worked for zsh and its behavior was
|
||||||
|
// not consistent with Bash completion. It has therefore been disabled.
|
||||||
|
// Instead, when no other completion is specified, file completion is done by
|
||||||
|
// default for every argument. One can disable file completion on a per-argument
|
||||||
|
// basis by using ValidArgsFunction and ShellCompDirectiveNoFileComp.
|
||||||
|
// To achieve file extension filtering, one can use ValidArgsFunction and
|
||||||
|
// ShellCompDirectiveFilterFileExt.
|
||||||
|
//
|
||||||
|
// Deprecated
|
||||||
|
func (c *Command) MarkZshCompPositionalArgumentFile(argPosition int, patterns ...string) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarkZshCompPositionalArgumentWords only worked for zsh. It has therefore
|
||||||
|
// been disabled.
|
||||||
|
// To achieve the same behavior across all shells, one can use
|
||||||
|
// ValidArgs (for the first argument only) or ValidArgsFunction for
|
||||||
|
// any argument (can include the first one also).
|
||||||
|
//
|
||||||
|
// Deprecated
|
||||||
|
func (c *Command) MarkZshCompPositionalArgumentWords(argPosition int, words ...string) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genZshCompletionFile(filename string, includeDesc bool) error {
|
||||||
|
outFile, err := os.Create(filename)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer outFile.Close()
|
||||||
|
|
||||||
|
return c.genZshCompletion(outFile, includeDesc)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Command) genZshCompletion(w io.Writer, includeDesc bool) error {
|
||||||
|
buf := new(bytes.Buffer)
|
||||||
|
genZshComp(buf, c.Name(), includeDesc)
|
||||||
|
_, err := buf.WriteTo(w)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func genZshComp(buf io.StringWriter, name string, includeDesc bool) {
|
||||||
|
compCmd := ShellCompRequestCmd
|
||||||
|
if !includeDesc {
|
||||||
|
compCmd = ShellCompNoDescRequestCmd
|
||||||
|
}
|
||||||
|
WriteStringAndCheck(buf, fmt.Sprintf(`#compdef %[1]s
|
||||||
|
compdef _%[1]s %[1]s
|
||||||
|
|
||||||
|
# zsh completion for %-36[1]s -*- shell-script -*-
|
||||||
|
|
||||||
|
__%[1]s_debug()
|
||||||
|
{
|
||||||
|
local file="$BASH_COMP_DEBUG_FILE"
|
||||||
|
if [[ -n ${file} ]]; then
|
||||||
|
echo "$*" >> "${file}"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
_%[1]s()
|
||||||
|
{
|
||||||
|
local shellCompDirectiveError=%[3]d
|
||||||
|
local shellCompDirectiveNoSpace=%[4]d
|
||||||
|
local shellCompDirectiveNoFileComp=%[5]d
|
||||||
|
local shellCompDirectiveFilterFileExt=%[6]d
|
||||||
|
local shellCompDirectiveFilterDirs=%[7]d
|
||||||
|
local shellCompDirectiveKeepOrder=%[8]d
|
||||||
|
|
||||||
|
local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace keepOrder
|
||||||
|
local -a completions
|
||||||
|
|
||||||
|
__%[1]s_debug "\n========= starting completion logic =========="
|
||||||
|
__%[1]s_debug "CURRENT: ${CURRENT}, words[*]: ${words[*]}"
|
||||||
|
|
||||||
|
# The user could have moved the cursor backwards on the command-line.
|
||||||
|
# We need to trigger completion from the $CURRENT location, so we need
|
||||||
|
# to truncate the command-line ($words) up to the $CURRENT location.
|
||||||
|
# (We cannot use $CURSOR as its value does not work when a command is an alias.)
|
||||||
|
words=("${=words[1,CURRENT]}")
|
||||||
|
__%[1]s_debug "Truncated words[*]: ${words[*]},"
|
||||||
|
|
||||||
|
lastParam=${words[-1]}
|
||||||
|
lastChar=${lastParam[-1]}
|
||||||
|
__%[1]s_debug "lastParam: ${lastParam}, lastChar: ${lastChar}"
|
||||||
|
|
||||||
|
# For zsh, when completing a flag with an = (e.g., %[1]s -n=<TAB>)
|
||||||
|
# completions must be prefixed with the flag
|
||||||
|
setopt local_options BASH_REMATCH
|
||||||
|
if [[ "${lastParam}" =~ '-.*=' ]]; then
|
||||||
|
# We are dealing with a flag with an =
|
||||||
|
flagPrefix="-P ${BASH_REMATCH}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Prepare the command to obtain completions
|
||||||
|
requestComp="${words[1]} %[2]s ${words[2,-1]}"
|
||||||
|
if [ "${lastChar}" = "" ]; then
|
||||||
|
# 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 completion code.
|
||||||
|
__%[1]s_debug "Adding extra empty parameter"
|
||||||
|
requestComp="${requestComp} \"\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug "About to call: eval ${requestComp}"
|
||||||
|
|
||||||
|
# Use eval to handle any environment variables and such
|
||||||
|
out=$(eval ${requestComp} 2>/dev/null)
|
||||||
|
__%[1]s_debug "completion output: ${out}"
|
||||||
|
|
||||||
|
# Extract the directive integer following a : from the last line
|
||||||
|
local lastLine
|
||||||
|
while IFS='\n' read -r line; do
|
||||||
|
lastLine=${line}
|
||||||
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
__%[1]s_debug "last line: ${lastLine}"
|
||||||
|
|
||||||
|
if [ "${lastLine[1]}" = : ]; then
|
||||||
|
directive=${lastLine[2,-1]}
|
||||||
|
# Remove the directive including the : and the newline
|
||||||
|
local suffix
|
||||||
|
(( suffix=${#lastLine}+2))
|
||||||
|
out=${out[1,-$suffix]}
|
||||||
|
else
|
||||||
|
# There is no directive specified. Leave $out as is.
|
||||||
|
__%[1]s_debug "No directive found. Setting do default"
|
||||||
|
directive=0
|
||||||
|
fi
|
||||||
|
|
||||||
|
__%[1]s_debug "directive: ${directive}"
|
||||||
|
__%[1]s_debug "completions: ${out}"
|
||||||
|
__%[1]s_debug "flagPrefix: ${flagPrefix}"
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "Completion received error. Ignoring completions."
|
||||||
|
return
|
||||||
|
fi
|
||||||
|
|
||||||
|
local activeHelpMarker="%[9]s"
|
||||||
|
local endIndex=${#activeHelpMarker}
|
||||||
|
local startIndex=$((${#activeHelpMarker}+1))
|
||||||
|
local hasActiveHelp=0
|
||||||
|
while IFS='\n' read -r comp; do
|
||||||
|
# Check if this is an activeHelp statement (i.e., prefixed with $activeHelpMarker)
|
||||||
|
if [ "${comp[1,$endIndex]}" = "$activeHelpMarker" ];then
|
||||||
|
__%[1]s_debug "ActiveHelp found: $comp"
|
||||||
|
comp="${comp[$startIndex,-1]}"
|
||||||
|
if [ -n "$comp" ]; then
|
||||||
|
compadd -x "${comp}"
|
||||||
|
__%[1]s_debug "ActiveHelp will need delimiter"
|
||||||
|
hasActiveHelp=1
|
||||||
|
fi
|
||||||
|
|
||||||
|
continue
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$comp" ]; then
|
||||||
|
# If requested, completions are returned with a description.
|
||||||
|
# The description is preceded by a TAB character.
|
||||||
|
# For zsh's _describe, we need to use a : instead of a TAB.
|
||||||
|
# We first need to escape any : as part of the completion itself.
|
||||||
|
comp=${comp//:/\\:}
|
||||||
|
|
||||||
|
local tab="$(printf '\t')"
|
||||||
|
comp=${comp//$tab/:}
|
||||||
|
|
||||||
|
__%[1]s_debug "Adding completion: ${comp}"
|
||||||
|
completions+=${comp}
|
||||||
|
lastComp=$comp
|
||||||
|
fi
|
||||||
|
done < <(printf "%%s\n" "${out[@]}")
|
||||||
|
|
||||||
|
# Add a delimiter after the activeHelp statements, but only if:
|
||||||
|
# - there are completions following the activeHelp statements, or
|
||||||
|
# - file completion will be performed (so there will be choices after the activeHelp)
|
||||||
|
if [ $hasActiveHelp -eq 1 ]; then
|
||||||
|
if [ ${#completions} -ne 0 ] || [ $((directive & shellCompDirectiveNoFileComp)) -eq 0 ]; then
|
||||||
|
__%[1]s_debug "Adding activeHelp delimiter"
|
||||||
|
compadd -x "--"
|
||||||
|
hasActiveHelp=0
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "Activating nospace."
|
||||||
|
noSpace="-S ''"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveKeepOrder)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "Activating keep order."
|
||||||
|
keepOrder="-V"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
|
||||||
|
# File extension filtering
|
||||||
|
local filteringCmd
|
||||||
|
filteringCmd='_files'
|
||||||
|
for filter in ${completions[@]}; do
|
||||||
|
if [ ${filter[1]} != '*' ]; then
|
||||||
|
# zsh requires a glob pattern to do file filtering
|
||||||
|
filter="\*.$filter"
|
||||||
|
fi
|
||||||
|
filteringCmd+=" -g $filter"
|
||||||
|
done
|
||||||
|
filteringCmd+=" ${flagPrefix}"
|
||||||
|
|
||||||
|
__%[1]s_debug "File filtering command: $filteringCmd"
|
||||||
|
_arguments '*:filename:'"$filteringCmd"
|
||||||
|
elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
|
||||||
|
# File completion for directories only
|
||||||
|
local subdir
|
||||||
|
subdir="${completions[1]}"
|
||||||
|
if [ -n "$subdir" ]; then
|
||||||
|
__%[1]s_debug "Listing directories in $subdir"
|
||||||
|
pushd "${subdir}" >/dev/null 2>&1
|
||||||
|
else
|
||||||
|
__%[1]s_debug "Listing directories in ."
|
||||||
|
fi
|
||||||
|
|
||||||
|
local result
|
||||||
|
_arguments '*:dirname:_files -/'" ${flagPrefix}"
|
||||||
|
result=$?
|
||||||
|
if [ -n "$subdir" ]; then
|
||||||
|
popd >/dev/null 2>&1
|
||||||
|
fi
|
||||||
|
return $result
|
||||||
|
else
|
||||||
|
__%[1]s_debug "Calling _describe"
|
||||||
|
if eval _describe $keepOrder "completions" completions $flagPrefix $noSpace; then
|
||||||
|
__%[1]s_debug "_describe found some completions"
|
||||||
|
|
||||||
|
# Return the success of having called _describe
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
__%[1]s_debug "_describe did not find completions."
|
||||||
|
__%[1]s_debug "Checking if we should do file completion."
|
||||||
|
if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
|
||||||
|
__%[1]s_debug "deactivating file completion"
|
||||||
|
|
||||||
|
# We must return an error code here to let zsh know that there were no
|
||||||
|
# completions found by _describe; this is what will trigger other
|
||||||
|
# matching algorithms to attempt to find completions.
|
||||||
|
# For example zsh can match letters in the middle of words.
|
||||||
|
return 1
|
||||||
|
else
|
||||||
|
# Perform file completion
|
||||||
|
__%[1]s_debug "Activating file completion"
|
||||||
|
|
||||||
|
# We must return the result of this command, so it must be the
|
||||||
|
# last command, or else we must store its result to return it.
|
||||||
|
_arguments '*:filename:_files'" ${flagPrefix}"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# don't run the completion function when being source-ed or eval-ed
|
||||||
|
if [ "$funcstack[1]" = "_%[1]s" ]; then
|
||||||
|
_%[1]s
|
||||||
|
fi
|
||||||
|
`, name, compCmd,
|
||||||
|
ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp,
|
||||||
|
ShellCompDirectiveFilterFileExt, ShellCompDirectiveFilterDirs, ShellCompDirectiveKeepOrder,
|
||||||
|
activeHelpMarker))
|
||||||
|
}
|
||||||
12
vendor/github.com/spf13/pflag/.editorconfig
generated
vendored
Normal file
12
vendor/github.com/spf13/pflag/.editorconfig
generated
vendored
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
charset = utf-8
|
||||||
|
end_of_line = lf
|
||||||
|
indent_size = 4
|
||||||
|
indent_style = space
|
||||||
|
insert_final_newline = true
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
|
||||||
|
[*.go]
|
||||||
|
indent_style = tab
|
||||||
2
vendor/github.com/spf13/pflag/.gitignore
generated
vendored
Normal file
2
vendor/github.com/spf13/pflag/.gitignore
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
.idea/*
|
||||||
|
|
||||||
4
vendor/github.com/spf13/pflag/.golangci.yaml
generated
vendored
Normal file
4
vendor/github.com/spf13/pflag/.golangci.yaml
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
linters:
|
||||||
|
disable-all: true
|
||||||
|
enable:
|
||||||
|
- nolintlint
|
||||||
22
vendor/github.com/spf13/pflag/.travis.yml
generated
vendored
Normal file
22
vendor/github.com/spf13/pflag/.travis.yml
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
sudo: false
|
||||||
|
|
||||||
|
language: go
|
||||||
|
|
||||||
|
go:
|
||||||
|
- 1.9.x
|
||||||
|
- 1.10.x
|
||||||
|
- 1.11.x
|
||||||
|
- tip
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
allow_failures:
|
||||||
|
- go: tip
|
||||||
|
|
||||||
|
install:
|
||||||
|
- go get golang.org/x/lint/golint
|
||||||
|
- export PATH=$GOPATH/bin:$PATH
|
||||||
|
- go install ./...
|
||||||
|
|
||||||
|
script:
|
||||||
|
- verify/all.sh -v
|
||||||
|
- go test ./...
|
||||||
28
vendor/github.com/spf13/pflag/LICENSE
generated
vendored
Normal file
28
vendor/github.com/spf13/pflag/LICENSE
generated
vendored
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
Copyright (c) 2012 Alex Ogier. All rights reserved.
|
||||||
|
Copyright (c) 2012 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are
|
||||||
|
met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright
|
||||||
|
notice, this list of conditions and the following disclaimer.
|
||||||
|
* Redistributions in binary form must reproduce the above
|
||||||
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the
|
||||||
|
distribution.
|
||||||
|
* Neither the name of Google Inc. nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
323
vendor/github.com/spf13/pflag/README.md
generated
vendored
Normal file
323
vendor/github.com/spf13/pflag/README.md
generated
vendored
Normal file
@@ -0,0 +1,323 @@
|
|||||||
|
[](https://travis-ci.org/spf13/pflag)
|
||||||
|
[](https://goreportcard.com/report/github.com/spf13/pflag)
|
||||||
|
[](https://godoc.org/github.com/spf13/pflag)
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
pflag is a drop-in replacement for Go's flag package, implementing
|
||||||
|
POSIX/GNU-style --flags.
|
||||||
|
|
||||||
|
pflag is compatible with the [GNU extensions to the POSIX recommendations
|
||||||
|
for command-line options][1]. For a more precise description, see the
|
||||||
|
"Command-line flag syntax" section below.
|
||||||
|
|
||||||
|
[1]: http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
|
||||||
|
|
||||||
|
pflag is available under the same style of BSD license as the Go language,
|
||||||
|
which can be found in the LICENSE file.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
pflag is available using the standard `go get` command.
|
||||||
|
|
||||||
|
Install by running:
|
||||||
|
|
||||||
|
go get github.com/spf13/pflag
|
||||||
|
|
||||||
|
Run tests by running:
|
||||||
|
|
||||||
|
go test github.com/spf13/pflag
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
pflag is a drop-in replacement of Go's native flag package. If you import
|
||||||
|
pflag under the name "flag" then all code should continue to function
|
||||||
|
with no changes.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
import flag "github.com/spf13/pflag"
|
||||||
|
```
|
||||||
|
|
||||||
|
There is one exception to this: if you directly instantiate the Flag struct
|
||||||
|
there is one more field "Shorthand" that you will need to set.
|
||||||
|
Most code never instantiates this struct directly, and instead uses
|
||||||
|
functions such as String(), BoolVar(), and Var(), and is therefore
|
||||||
|
unaffected.
|
||||||
|
|
||||||
|
Define flags using flag.String(), Bool(), Int(), etc.
|
||||||
|
|
||||||
|
This declares an integer flag, -flagname, stored in the pointer ip, with type *int.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
var ip *int = flag.Int("flagname", 1234, "help message for flagname")
|
||||||
|
```
|
||||||
|
|
||||||
|
If you like, you can bind the flag to a variable using the Var() functions.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
var flagvar int
|
||||||
|
func init() {
|
||||||
|
flag.IntVar(&flagvar, "flagname", 1234, "help message for flagname")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Or you can create custom flags that satisfy the Value interface (with
|
||||||
|
pointer receivers) and couple them to flag parsing by
|
||||||
|
|
||||||
|
``` go
|
||||||
|
flag.Var(&flagVal, "name", "help message for flagname")
|
||||||
|
```
|
||||||
|
|
||||||
|
For such flags, the default value is just the initial value of the variable.
|
||||||
|
|
||||||
|
After all flags are defined, call
|
||||||
|
|
||||||
|
``` go
|
||||||
|
flag.Parse()
|
||||||
|
```
|
||||||
|
|
||||||
|
to parse the command line into the defined flags.
|
||||||
|
|
||||||
|
Flags may then be used directly. If you're using the flags themselves,
|
||||||
|
they are all pointers; if you bind to variables, they're values.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
fmt.Println("ip has value ", *ip)
|
||||||
|
fmt.Println("flagvar has value ", flagvar)
|
||||||
|
```
|
||||||
|
|
||||||
|
There are helper functions available to get the value stored in a Flag if you have a FlagSet but find
|
||||||
|
it difficult to keep up with all of the pointers in your code.
|
||||||
|
If you have a pflag.FlagSet with a flag called 'flagname' of type int you
|
||||||
|
can use GetInt() to get the int value. But notice that 'flagname' must exist
|
||||||
|
and it must be an int. GetString("flagname") will fail.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
i, err := flagset.GetInt("flagname")
|
||||||
|
```
|
||||||
|
|
||||||
|
After parsing, the arguments after the flag are available as the
|
||||||
|
slice flag.Args() or individually as flag.Arg(i).
|
||||||
|
The arguments are indexed from 0 through flag.NArg()-1.
|
||||||
|
|
||||||
|
The pflag package also defines some new functions that are not in flag,
|
||||||
|
that give one-letter shorthands for flags. You can use these by appending
|
||||||
|
'P' to the name of any function that defines a flag.
|
||||||
|
|
||||||
|
``` go
|
||||||
|
var ip = flag.IntP("flagname", "f", 1234, "help message")
|
||||||
|
var flagvar bool
|
||||||
|
func init() {
|
||||||
|
flag.BoolVarP(&flagvar, "boolname", "b", true, "help message")
|
||||||
|
}
|
||||||
|
flag.VarP(&flagVal, "varname", "v", "help message")
|
||||||
|
```
|
||||||
|
|
||||||
|
Shorthand letters can be used with single dashes on the command line.
|
||||||
|
Boolean shorthand flags can be combined with other shorthand flags.
|
||||||
|
|
||||||
|
The default set of command-line flags is controlled by
|
||||||
|
top-level functions. The FlagSet type allows one to define
|
||||||
|
independent sets of flags, such as to implement subcommands
|
||||||
|
in a command-line interface. The methods of FlagSet are
|
||||||
|
analogous to the top-level functions for the command-line
|
||||||
|
flag set.
|
||||||
|
|
||||||
|
## Setting no option default values for flags
|
||||||
|
|
||||||
|
After you create a flag it is possible to set the pflag.NoOptDefVal for
|
||||||
|
the given flag. Doing this changes the meaning of the flag slightly. If
|
||||||
|
a flag has a NoOptDefVal and the flag is set on the command line without
|
||||||
|
an option the flag will be set to the NoOptDefVal. For example given:
|
||||||
|
|
||||||
|
``` go
|
||||||
|
var ip = flag.IntP("flagname", "f", 1234, "help message")
|
||||||
|
flag.Lookup("flagname").NoOptDefVal = "4321"
|
||||||
|
```
|
||||||
|
|
||||||
|
Would result in something like
|
||||||
|
|
||||||
|
| Parsed Arguments | Resulting Value |
|
||||||
|
| ------------- | ------------- |
|
||||||
|
| --flagname=1357 | ip=1357 |
|
||||||
|
| --flagname | ip=4321 |
|
||||||
|
| [nothing] | ip=1234 |
|
||||||
|
|
||||||
|
## Command line flag syntax
|
||||||
|
|
||||||
|
```
|
||||||
|
--flag // boolean flags, or flags with no option default values
|
||||||
|
--flag x // only on flags without a default value
|
||||||
|
--flag=x
|
||||||
|
```
|
||||||
|
|
||||||
|
Unlike the flag package, a single dash before an option means something
|
||||||
|
different than a double dash. Single dashes signify a series of shorthand
|
||||||
|
letters for flags. All but the last shorthand letter must be boolean flags
|
||||||
|
or a flag with a default value
|
||||||
|
|
||||||
|
```
|
||||||
|
// boolean or flags where the 'no option default value' is set
|
||||||
|
-f
|
||||||
|
-f=true
|
||||||
|
-abc
|
||||||
|
but
|
||||||
|
-b true is INVALID
|
||||||
|
|
||||||
|
// non-boolean and flags without a 'no option default value'
|
||||||
|
-n 1234
|
||||||
|
-n=1234
|
||||||
|
-n1234
|
||||||
|
|
||||||
|
// mixed
|
||||||
|
-abcs "hello"
|
||||||
|
-absd="hello"
|
||||||
|
-abcs1234
|
||||||
|
```
|
||||||
|
|
||||||
|
Flag parsing stops after the terminator "--". Unlike the flag package,
|
||||||
|
flags can be interspersed with arguments anywhere on the command line
|
||||||
|
before this terminator.
|
||||||
|
|
||||||
|
Integer flags accept 1234, 0664, 0x1234 and may be negative.
|
||||||
|
Boolean flags (in their long form) accept 1, 0, t, f, true, false,
|
||||||
|
TRUE, FALSE, True, False.
|
||||||
|
Duration flags accept any input valid for time.ParseDuration.
|
||||||
|
|
||||||
|
## Mutating or "Normalizing" Flag names
|
||||||
|
|
||||||
|
It is possible to set a custom flag name 'normalization function.' It allows flag names to be mutated both when created in the code and when used on the command line to some 'normalized' form. The 'normalized' form is used for comparison. Two examples of using the custom normalization func follow.
|
||||||
|
|
||||||
|
**Example #1**: You want -, _, and . in flags to compare the same. aka --my-flag == --my_flag == --my.flag
|
||||||
|
|
||||||
|
``` go
|
||||||
|
func wordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
||||||
|
from := []string{"-", "_"}
|
||||||
|
to := "."
|
||||||
|
for _, sep := range from {
|
||||||
|
name = strings.Replace(name, sep, to, -1)
|
||||||
|
}
|
||||||
|
return pflag.NormalizedName(name)
|
||||||
|
}
|
||||||
|
|
||||||
|
myFlagSet.SetNormalizeFunc(wordSepNormalizeFunc)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Example #2**: You want to alias two flags. aka --old-flag-name == --new-flag-name
|
||||||
|
|
||||||
|
``` go
|
||||||
|
func aliasNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName {
|
||||||
|
switch name {
|
||||||
|
case "old-flag-name":
|
||||||
|
name = "new-flag-name"
|
||||||
|
break
|
||||||
|
}
|
||||||
|
return pflag.NormalizedName(name)
|
||||||
|
}
|
||||||
|
|
||||||
|
myFlagSet.SetNormalizeFunc(aliasNormalizeFunc)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Deprecating a flag or its shorthand
|
||||||
|
It is possible to deprecate a flag, or just its shorthand. Deprecating a flag/shorthand hides it from help text and prints a usage message when the deprecated flag/shorthand is used.
|
||||||
|
|
||||||
|
**Example #1**: You want to deprecate a flag named "badflag" as well as inform the users what flag they should use instead.
|
||||||
|
```go
|
||||||
|
// deprecate a flag by specifying its name and a usage message
|
||||||
|
flags.MarkDeprecated("badflag", "please use --good-flag instead")
|
||||||
|
```
|
||||||
|
This hides "badflag" from help text, and prints `Flag --badflag has been deprecated, please use --good-flag instead` when "badflag" is used.
|
||||||
|
|
||||||
|
**Example #2**: You want to keep a flag name "noshorthandflag" but deprecate its shortname "n".
|
||||||
|
```go
|
||||||
|
// deprecate a flag shorthand by specifying its flag name and a usage message
|
||||||
|
flags.MarkShorthandDeprecated("noshorthandflag", "please use --noshorthandflag only")
|
||||||
|
```
|
||||||
|
This hides the shortname "n" from help text, and prints `Flag shorthand -n has been deprecated, please use --noshorthandflag only` when the shorthand "n" is used.
|
||||||
|
|
||||||
|
Note that usage message is essential here, and it should not be empty.
|
||||||
|
|
||||||
|
## Hidden flags
|
||||||
|
It is possible to mark a flag as hidden, meaning it will still function as normal, however will not show up in usage/help text.
|
||||||
|
|
||||||
|
**Example**: You have a flag named "secretFlag" that you need for internal use only and don't want it showing up in help text, or for its usage text to be available.
|
||||||
|
```go
|
||||||
|
// hide a flag by specifying its name
|
||||||
|
flags.MarkHidden("secretFlag")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Disable sorting of flags
|
||||||
|
`pflag` allows you to disable sorting of flags for help and usage message.
|
||||||
|
|
||||||
|
**Example**:
|
||||||
|
```go
|
||||||
|
flags.BoolP("verbose", "v", false, "verbose output")
|
||||||
|
flags.String("coolflag", "yeaah", "it's really cool flag")
|
||||||
|
flags.Int("usefulflag", 777, "sometimes it's very useful")
|
||||||
|
flags.SortFlags = false
|
||||||
|
flags.PrintDefaults()
|
||||||
|
```
|
||||||
|
**Output**:
|
||||||
|
```
|
||||||
|
-v, --verbose verbose output
|
||||||
|
--coolflag string it's really cool flag (default "yeaah")
|
||||||
|
--usefulflag int sometimes it's very useful (default 777)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Supporting Go flags when using pflag
|
||||||
|
In order to support flags defined using Go's `flag` package, they must be added to the `pflag` flagset. This is usually necessary
|
||||||
|
to support flags defined by third-party dependencies (e.g. `golang/glog`).
|
||||||
|
|
||||||
|
**Example**: You want to add the Go flags to the `CommandLine` flagset
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
goflag "flag"
|
||||||
|
flag "github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ip *int = flag.Int("flagname", 1234, "help message for flagname")
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
flag.CommandLine.AddGoFlagSet(goflag.CommandLine)
|
||||||
|
flag.Parse()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using pflag with go test
|
||||||
|
`pflag` does not parse the shorthand versions of go test's built-in flags (i.e., those starting with `-test.`).
|
||||||
|
For more context, see issues [#63](https://github.com/spf13/pflag/issues/63) and [#238](https://github.com/spf13/pflag/issues/238) for more details.
|
||||||
|
|
||||||
|
For example, if you use pflag in your `TestMain` function and call `pflag.Parse()` after defining your custom flags, running a test like this:
|
||||||
|
```bash
|
||||||
|
go test /your/tests -run ^YourTest -v --your-test-pflags
|
||||||
|
```
|
||||||
|
will result in the `-v` flag being ignored. This happens because of the way pflag handles flag parsing, skipping over go test's built-in shorthand flags.
|
||||||
|
To work around this, you can use the `ParseSkippedFlags` function, which ensures that go test's flags are parsed separately using the standard flag package.
|
||||||
|
|
||||||
|
**Example**: You want to parse go test flags that are otherwise ignore by `pflag.Parse()`
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
goflag "flag"
|
||||||
|
flag "github.com/spf13/pflag"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ip *int = flag.Int("flagname", 1234, "help message for flagname")
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
flag.CommandLine.AddGoFlagSet(goflag.CommandLine)
|
||||||
|
flag.ParseSkippedFlags(os.Args[1:], goflag.CommandLine)
|
||||||
|
flag.Parse()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## More info
|
||||||
|
|
||||||
|
You can see the full reference documentation of the pflag package
|
||||||
|
[at godoc.org][3], or through go's standard documentation system by
|
||||||
|
running `godoc -http=:6060` and browsing to
|
||||||
|
[http://localhost:6060/pkg/github.com/spf13/pflag][2] after
|
||||||
|
installation.
|
||||||
|
|
||||||
|
[2]: http://localhost:6060/pkg/github.com/spf13/pflag
|
||||||
|
[3]: http://godoc.org/github.com/spf13/pflag
|
||||||
94
vendor/github.com/spf13/pflag/bool.go
generated
vendored
Normal file
94
vendor/github.com/spf13/pflag/bool.go
generated
vendored
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// optional interface to indicate boolean flags that can be
|
||||||
|
// supplied without "=value" text
|
||||||
|
type boolFlag interface {
|
||||||
|
Value
|
||||||
|
IsBoolFlag() bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// -- bool Value
|
||||||
|
type boolValue bool
|
||||||
|
|
||||||
|
func newBoolValue(val bool, p *bool) *boolValue {
|
||||||
|
*p = val
|
||||||
|
return (*boolValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *boolValue) Set(s string) error {
|
||||||
|
v, err := strconv.ParseBool(s)
|
||||||
|
*b = boolValue(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *boolValue) Type() string {
|
||||||
|
return "bool"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *boolValue) String() string { return strconv.FormatBool(bool(*b)) }
|
||||||
|
|
||||||
|
func (b *boolValue) IsBoolFlag() bool { return true }
|
||||||
|
|
||||||
|
func boolConv(sval string) (interface{}, error) {
|
||||||
|
return strconv.ParseBool(sval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBool return the bool value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetBool(name string) (bool, error) {
|
||||||
|
val, err := f.getFlagType(name, "bool", boolConv)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return val.(bool), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolVar defines a bool flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a bool variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) BoolVar(p *bool, name string, value bool, usage string) {
|
||||||
|
f.BoolVarP(p, name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolVarP is like BoolVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BoolVarP(p *bool, name, shorthand string, value bool, usage string) {
|
||||||
|
flag := f.VarPF(newBoolValue(value, p), name, shorthand, usage)
|
||||||
|
flag.NoOptDefVal = "true"
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolVar defines a bool flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a bool variable in which to store the value of the flag.
|
||||||
|
func BoolVar(p *bool, name string, value bool, usage string) {
|
||||||
|
BoolVarP(p, name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolVarP is like BoolVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BoolVarP(p *bool, name, shorthand string, value bool, usage string) {
|
||||||
|
flag := CommandLine.VarPF(newBoolValue(value, p), name, shorthand, usage)
|
||||||
|
flag.NoOptDefVal = "true"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bool defines a bool flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a bool variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Bool(name string, value bool, usage string) *bool {
|
||||||
|
return f.BoolP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolP is like Bool, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BoolP(name, shorthand string, value bool, usage string) *bool {
|
||||||
|
p := new(bool)
|
||||||
|
f.BoolVarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bool defines a bool flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a bool variable that stores the value of the flag.
|
||||||
|
func Bool(name string, value bool, usage string) *bool {
|
||||||
|
return BoolP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolP is like Bool, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BoolP(name, shorthand string, value bool, usage string) *bool {
|
||||||
|
b := CommandLine.BoolP(name, shorthand, value, usage)
|
||||||
|
return b
|
||||||
|
}
|
||||||
40
vendor/github.com/spf13/pflag/bool_func.go
generated
vendored
Normal file
40
vendor/github.com/spf13/pflag/bool_func.go
generated
vendored
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
// -- func Value
|
||||||
|
type boolfuncValue func(string) error
|
||||||
|
|
||||||
|
func (f boolfuncValue) Set(s string) error { return f(s) }
|
||||||
|
|
||||||
|
func (f boolfuncValue) Type() string { return "boolfunc" }
|
||||||
|
|
||||||
|
func (f boolfuncValue) String() string { return "" } // same behavior as stdlib 'flag' package
|
||||||
|
|
||||||
|
func (f boolfuncValue) IsBoolFlag() bool { return true }
|
||||||
|
|
||||||
|
// BoolFunc defines a func flag with specified name, callback function and usage string.
|
||||||
|
//
|
||||||
|
// The callback function will be called every time "--{name}" (or any form that matches the flag) is parsed
|
||||||
|
// on the command line.
|
||||||
|
func (f *FlagSet) BoolFunc(name string, usage string, fn func(string) error) {
|
||||||
|
f.BoolFuncP(name, "", usage, fn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolFuncP is like BoolFunc, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BoolFuncP(name, shorthand string, usage string, fn func(string) error) {
|
||||||
|
var val Value = boolfuncValue(fn)
|
||||||
|
flag := f.VarPF(val, name, shorthand, usage)
|
||||||
|
flag.NoOptDefVal = "true"
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolFunc defines a func flag with specified name, callback function and usage string.
|
||||||
|
//
|
||||||
|
// The callback function will be called every time "--{name}" (or any form that matches the flag) is parsed
|
||||||
|
// on the command line.
|
||||||
|
func BoolFunc(name string, usage string, fn func(string) error) {
|
||||||
|
CommandLine.BoolFuncP(name, "", usage, fn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolFuncP is like BoolFunc, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BoolFuncP(name, shorthand string, usage string, fn func(string) error) {
|
||||||
|
CommandLine.BoolFuncP(name, shorthand, usage, fn)
|
||||||
|
}
|
||||||
185
vendor/github.com/spf13/pflag/bool_slice.go
generated
vendored
Normal file
185
vendor/github.com/spf13/pflag/bool_slice.go
generated
vendored
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- boolSlice Value
|
||||||
|
type boolSliceValue struct {
|
||||||
|
value *[]bool
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBoolSliceValue(val []bool, p *[]bool) *boolSliceValue {
|
||||||
|
bsv := new(boolSliceValue)
|
||||||
|
bsv.value = p
|
||||||
|
*bsv.value = val
|
||||||
|
return bsv
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set converts, and assigns, the comma-separated boolean argument string representation as the []bool value of this flag.
|
||||||
|
// If Set is called on a flag that already has a []bool assigned, the newly converted values will be appended.
|
||||||
|
func (s *boolSliceValue) Set(val string) error {
|
||||||
|
|
||||||
|
// remove all quote characters
|
||||||
|
rmQuote := strings.NewReplacer(`"`, "", `'`, "", "`", "")
|
||||||
|
|
||||||
|
// read flag arguments with CSV parser
|
||||||
|
boolStrSlice, err := readAsCSV(rmQuote.Replace(val))
|
||||||
|
if err != nil && err != io.EOF {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// parse boolean values into slice
|
||||||
|
out := make([]bool, 0, len(boolStrSlice))
|
||||||
|
for _, boolStr := range boolStrSlice {
|
||||||
|
b, err := strconv.ParseBool(strings.TrimSpace(boolStr))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out = append(out, b)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.changed = true
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Type returns a string that uniquely represents this flag's type.
|
||||||
|
func (s *boolSliceValue) Type() string {
|
||||||
|
return "boolSlice"
|
||||||
|
}
|
||||||
|
|
||||||
|
// String defines a "native" format for this boolean slice flag value.
|
||||||
|
func (s *boolSliceValue) String() string {
|
||||||
|
|
||||||
|
boolStrSlice := make([]string, len(*s.value))
|
||||||
|
for i, b := range *s.value {
|
||||||
|
boolStrSlice[i] = strconv.FormatBool(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
out, _ := writeAsCSV(boolStrSlice)
|
||||||
|
|
||||||
|
return "[" + out + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *boolSliceValue) fromString(val string) (bool, error) {
|
||||||
|
return strconv.ParseBool(val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *boolSliceValue) toString(val bool) string {
|
||||||
|
return strconv.FormatBool(val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *boolSliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *boolSliceValue) Replace(val []string) error {
|
||||||
|
out := make([]bool, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *boolSliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func boolSliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []bool{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]bool, len(ss))
|
||||||
|
for i, t := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.ParseBool(t)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBoolSlice returns the []bool value of a flag with the given name.
|
||||||
|
func (f *FlagSet) GetBoolSlice(name string) ([]bool, error) {
|
||||||
|
val, err := f.getFlagType(name, "boolSlice", boolSliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []bool{}, err
|
||||||
|
}
|
||||||
|
return val.([]bool), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceVar defines a boolSlice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []bool variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) BoolSliceVar(p *[]bool, name string, value []bool, usage string) {
|
||||||
|
f.VarP(newBoolSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceVarP is like BoolSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string) {
|
||||||
|
f.VarP(newBoolSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceVar defines a []bool flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []bool variable in which to store the value of the flag.
|
||||||
|
func BoolSliceVar(p *[]bool, name string, value []bool, usage string) {
|
||||||
|
CommandLine.VarP(newBoolSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceVarP is like BoolSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BoolSliceVarP(p *[]bool, name, shorthand string, value []bool, usage string) {
|
||||||
|
CommandLine.VarP(newBoolSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSlice defines a []bool flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []bool variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) BoolSlice(name string, value []bool, usage string) *[]bool {
|
||||||
|
p := []bool{}
|
||||||
|
f.BoolSliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceP is like BoolSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BoolSliceP(name, shorthand string, value []bool, usage string) *[]bool {
|
||||||
|
p := []bool{}
|
||||||
|
f.BoolSliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSlice defines a []bool flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []bool variable that stores the value of the flag.
|
||||||
|
func BoolSlice(name string, value []bool, usage string) *[]bool {
|
||||||
|
return CommandLine.BoolSliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BoolSliceP is like BoolSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BoolSliceP(name, shorthand string, value []bool, usage string) *[]bool {
|
||||||
|
return CommandLine.BoolSliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
209
vendor/github.com/spf13/pflag/bytes.go
generated
vendored
Normal file
209
vendor/github.com/spf13/pflag/bytes.go
generated
vendored
Normal file
@@ -0,0 +1,209 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// BytesHex adapts []byte for use as a flag. Value of flag is HEX encoded
|
||||||
|
type bytesHexValue []byte
|
||||||
|
|
||||||
|
// String implements pflag.Value.String.
|
||||||
|
func (bytesHex bytesHexValue) String() string {
|
||||||
|
return fmt.Sprintf("%X", []byte(bytesHex))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set implements pflag.Value.Set.
|
||||||
|
func (bytesHex *bytesHexValue) Set(value string) error {
|
||||||
|
bin, err := hex.DecodeString(strings.TrimSpace(value))
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
*bytesHex = bin
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Type implements pflag.Value.Type.
|
||||||
|
func (*bytesHexValue) Type() string {
|
||||||
|
return "bytesHex"
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBytesHexValue(val []byte, p *[]byte) *bytesHexValue {
|
||||||
|
*p = val
|
||||||
|
return (*bytesHexValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func bytesHexConv(sval string) (interface{}, error) {
|
||||||
|
|
||||||
|
bin, err := hex.DecodeString(sval)
|
||||||
|
|
||||||
|
if err == nil {
|
||||||
|
return bin, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("invalid string being converted to Bytes: %s %s", sval, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBytesHex return the []byte value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetBytesHex(name string) ([]byte, error) {
|
||||||
|
val, err := f.getFlagType(name, "bytesHex", bytesHexConv)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return []byte{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return val.([]byte), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexVar defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an []byte variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) BytesHexVar(p *[]byte, name string, value []byte, usage string) {
|
||||||
|
f.VarP(newBytesHexValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexVarP is like BytesHexVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string) {
|
||||||
|
f.VarP(newBytesHexValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexVar defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an []byte variable in which to store the value of the flag.
|
||||||
|
func BytesHexVar(p *[]byte, name string, value []byte, usage string) {
|
||||||
|
CommandLine.VarP(newBytesHexValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexVarP is like BytesHexVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BytesHexVarP(p *[]byte, name, shorthand string, value []byte, usage string) {
|
||||||
|
CommandLine.VarP(newBytesHexValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHex defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an []byte variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) BytesHex(name string, value []byte, usage string) *[]byte {
|
||||||
|
p := new([]byte)
|
||||||
|
f.BytesHexVarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexP is like BytesHex, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BytesHexP(name, shorthand string, value []byte, usage string) *[]byte {
|
||||||
|
p := new([]byte)
|
||||||
|
f.BytesHexVarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHex defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an []byte variable that stores the value of the flag.
|
||||||
|
func BytesHex(name string, value []byte, usage string) *[]byte {
|
||||||
|
return CommandLine.BytesHexP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesHexP is like BytesHex, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BytesHexP(name, shorthand string, value []byte, usage string) *[]byte {
|
||||||
|
return CommandLine.BytesHexP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64 adapts []byte for use as a flag. Value of flag is Base64 encoded
|
||||||
|
type bytesBase64Value []byte
|
||||||
|
|
||||||
|
// String implements pflag.Value.String.
|
||||||
|
func (bytesBase64 bytesBase64Value) String() string {
|
||||||
|
return base64.StdEncoding.EncodeToString([]byte(bytesBase64))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set implements pflag.Value.Set.
|
||||||
|
func (bytesBase64 *bytesBase64Value) Set(value string) error {
|
||||||
|
bin, err := base64.StdEncoding.DecodeString(strings.TrimSpace(value))
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
*bytesBase64 = bin
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Type implements pflag.Value.Type.
|
||||||
|
func (*bytesBase64Value) Type() string {
|
||||||
|
return "bytesBase64"
|
||||||
|
}
|
||||||
|
|
||||||
|
func newBytesBase64Value(val []byte, p *[]byte) *bytesBase64Value {
|
||||||
|
*p = val
|
||||||
|
return (*bytesBase64Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func bytesBase64ValueConv(sval string) (interface{}, error) {
|
||||||
|
|
||||||
|
bin, err := base64.StdEncoding.DecodeString(sval)
|
||||||
|
if err == nil {
|
||||||
|
return bin, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, fmt.Errorf("invalid string being converted to Bytes: %s %s", sval, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetBytesBase64 return the []byte value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetBytesBase64(name string) ([]byte, error) {
|
||||||
|
val, err := f.getFlagType(name, "bytesBase64", bytesBase64ValueConv)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return []byte{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return val.([]byte), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64Var defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an []byte variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) BytesBase64Var(p *[]byte, name string, value []byte, usage string) {
|
||||||
|
f.VarP(newBytesBase64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64VarP is like BytesBase64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string) {
|
||||||
|
f.VarP(newBytesBase64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64Var defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an []byte variable in which to store the value of the flag.
|
||||||
|
func BytesBase64Var(p *[]byte, name string, value []byte, usage string) {
|
||||||
|
CommandLine.VarP(newBytesBase64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64VarP is like BytesBase64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BytesBase64VarP(p *[]byte, name, shorthand string, value []byte, usage string) {
|
||||||
|
CommandLine.VarP(newBytesBase64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64 defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an []byte variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) BytesBase64(name string, value []byte, usage string) *[]byte {
|
||||||
|
p := new([]byte)
|
||||||
|
f.BytesBase64VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64P is like BytesBase64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) BytesBase64P(name, shorthand string, value []byte, usage string) *[]byte {
|
||||||
|
p := new([]byte)
|
||||||
|
f.BytesBase64VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64 defines an []byte flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an []byte variable that stores the value of the flag.
|
||||||
|
func BytesBase64(name string, value []byte, usage string) *[]byte {
|
||||||
|
return CommandLine.BytesBase64P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BytesBase64P is like BytesBase64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func BytesBase64P(name, shorthand string, value []byte, usage string) *[]byte {
|
||||||
|
return CommandLine.BytesBase64P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
96
vendor/github.com/spf13/pflag/count.go
generated
vendored
Normal file
96
vendor/github.com/spf13/pflag/count.go
generated
vendored
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- count Value
|
||||||
|
type countValue int
|
||||||
|
|
||||||
|
func newCountValue(val int, p *int) *countValue {
|
||||||
|
*p = val
|
||||||
|
return (*countValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *countValue) Set(s string) error {
|
||||||
|
// "+1" means that no specific value was passed, so increment
|
||||||
|
if s == "+1" {
|
||||||
|
*i = countValue(*i + 1)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
v, err := strconv.ParseInt(s, 0, 0)
|
||||||
|
*i = countValue(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *countValue) Type() string {
|
||||||
|
return "count"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *countValue) String() string { return strconv.Itoa(int(*i)) }
|
||||||
|
|
||||||
|
func countConv(sval string) (interface{}, error) {
|
||||||
|
i, err := strconv.Atoi(sval)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return i, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetCount return the int value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetCount(name string) (int, error) {
|
||||||
|
val, err := f.getFlagType(name, "count", countConv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountVar defines a count flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int variable in which to store the value of the flag.
|
||||||
|
// A count flag will add 1 to its value every time it is found on the command line
|
||||||
|
func (f *FlagSet) CountVar(p *int, name string, usage string) {
|
||||||
|
f.CountVarP(p, name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountVarP is like CountVar only take a shorthand for the flag name.
|
||||||
|
func (f *FlagSet) CountVarP(p *int, name, shorthand string, usage string) {
|
||||||
|
flag := f.VarPF(newCountValue(0, p), name, shorthand, usage)
|
||||||
|
flag.NoOptDefVal = "+1"
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountVar like CountVar only the flag is placed on the CommandLine instead of a given flag set
|
||||||
|
func CountVar(p *int, name string, usage string) {
|
||||||
|
CommandLine.CountVar(p, name, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountVarP is like CountVar only take a shorthand for the flag name.
|
||||||
|
func CountVarP(p *int, name, shorthand string, usage string) {
|
||||||
|
CommandLine.CountVarP(p, name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count defines a count flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int variable that stores the value of the flag.
|
||||||
|
// A count flag will add 1 to its value every time it is found on the command line
|
||||||
|
func (f *FlagSet) Count(name string, usage string) *int {
|
||||||
|
p := new(int)
|
||||||
|
f.CountVarP(p, name, "", usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountP is like Count only takes a shorthand for the flag name.
|
||||||
|
func (f *FlagSet) CountP(name, shorthand string, usage string) *int {
|
||||||
|
p := new(int)
|
||||||
|
f.CountVarP(p, name, shorthand, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count defines a count flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int variable that stores the value of the flag.
|
||||||
|
// A count flag will add 1 to its value every time it is found on the command line
|
||||||
|
func Count(name string, usage string) *int {
|
||||||
|
return CommandLine.CountP(name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountP is like Count only takes a shorthand for the flag name.
|
||||||
|
func CountP(name, shorthand string, usage string) *int {
|
||||||
|
return CommandLine.CountP(name, shorthand, usage)
|
||||||
|
}
|
||||||
86
vendor/github.com/spf13/pflag/duration.go
generated
vendored
Normal file
86
vendor/github.com/spf13/pflag/duration.go
generated
vendored
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- time.Duration Value
|
||||||
|
type durationValue time.Duration
|
||||||
|
|
||||||
|
func newDurationValue(val time.Duration, p *time.Duration) *durationValue {
|
||||||
|
*p = val
|
||||||
|
return (*durationValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *durationValue) Set(s string) error {
|
||||||
|
v, err := time.ParseDuration(s)
|
||||||
|
*d = durationValue(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *durationValue) Type() string {
|
||||||
|
return "duration"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *durationValue) String() string { return (*time.Duration)(d).String() }
|
||||||
|
|
||||||
|
func durationConv(sval string) (interface{}, error) {
|
||||||
|
return time.ParseDuration(sval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetDuration return the duration value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetDuration(name string) (time.Duration, error) {
|
||||||
|
val, err := f.getFlagType(name, "duration", durationConv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(time.Duration), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationVar defines a time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a time.Duration variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string) {
|
||||||
|
f.VarP(newDurationValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationVarP is like DurationVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string) {
|
||||||
|
f.VarP(newDurationValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationVar defines a time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a time.Duration variable in which to store the value of the flag.
|
||||||
|
func DurationVar(p *time.Duration, name string, value time.Duration, usage string) {
|
||||||
|
CommandLine.VarP(newDurationValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationVarP is like DurationVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func DurationVarP(p *time.Duration, name, shorthand string, value time.Duration, usage string) {
|
||||||
|
CommandLine.VarP(newDurationValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Duration defines a time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a time.Duration variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration {
|
||||||
|
p := new(time.Duration)
|
||||||
|
f.DurationVarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationP is like Duration, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) DurationP(name, shorthand string, value time.Duration, usage string) *time.Duration {
|
||||||
|
p := new(time.Duration)
|
||||||
|
f.DurationVarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Duration defines a time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a time.Duration variable that stores the value of the flag.
|
||||||
|
func Duration(name string, value time.Duration, usage string) *time.Duration {
|
||||||
|
return CommandLine.DurationP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationP is like Duration, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func DurationP(name, shorthand string, value time.Duration, usage string) *time.Duration {
|
||||||
|
return CommandLine.DurationP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
166
vendor/github.com/spf13/pflag/duration_slice.go
generated
vendored
Normal file
166
vendor/github.com/spf13/pflag/duration_slice.go
generated
vendored
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- durationSlice Value
|
||||||
|
type durationSliceValue struct {
|
||||||
|
value *[]time.Duration
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newDurationSliceValue(val []time.Duration, p *[]time.Duration) *durationSliceValue {
|
||||||
|
dsv := new(durationSliceValue)
|
||||||
|
dsv.value = p
|
||||||
|
*dsv.value = val
|
||||||
|
return dsv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]time.Duration, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = time.ParseDuration(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) Type() string {
|
||||||
|
return "durationSlice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%s", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) fromString(val string) (time.Duration, error) {
|
||||||
|
return time.ParseDuration(val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) toString(val time.Duration) string {
|
||||||
|
return fmt.Sprintf("%s", val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) Replace(val []string) error {
|
||||||
|
out := make([]time.Duration, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *durationSliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func durationSliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []time.Duration{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]time.Duration, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = time.ParseDuration(d)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetDurationSlice returns the []time.Duration value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetDurationSlice(name string) ([]time.Duration, error) {
|
||||||
|
val, err := f.getFlagType(name, "durationSlice", durationSliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []time.Duration{}, err
|
||||||
|
}
|
||||||
|
return val.([]time.Duration), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceVar defines a durationSlice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []time.Duration variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string) {
|
||||||
|
f.VarP(newDurationSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceVarP is like DurationSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, usage string) {
|
||||||
|
f.VarP(newDurationSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceVar defines a duration[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a duration[] variable in which to store the value of the flag.
|
||||||
|
func DurationSliceVar(p *[]time.Duration, name string, value []time.Duration, usage string) {
|
||||||
|
CommandLine.VarP(newDurationSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceVarP is like DurationSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func DurationSliceVarP(p *[]time.Duration, name, shorthand string, value []time.Duration, usage string) {
|
||||||
|
CommandLine.VarP(newDurationSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSlice defines a []time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []time.Duration variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) DurationSlice(name string, value []time.Duration, usage string) *[]time.Duration {
|
||||||
|
p := []time.Duration{}
|
||||||
|
f.DurationSliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceP is like DurationSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) DurationSliceP(name, shorthand string, value []time.Duration, usage string) *[]time.Duration {
|
||||||
|
p := []time.Duration{}
|
||||||
|
f.DurationSliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSlice defines a []time.Duration flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []time.Duration variable that stores the value of the flag.
|
||||||
|
func DurationSlice(name string, value []time.Duration, usage string) *[]time.Duration {
|
||||||
|
return CommandLine.DurationSliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DurationSliceP is like DurationSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func DurationSliceP(name, shorthand string, value []time.Duration, usage string) *[]time.Duration {
|
||||||
|
return CommandLine.DurationSliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
149
vendor/github.com/spf13/pflag/errors.go
generated
vendored
Normal file
149
vendor/github.com/spf13/pflag/errors.go
generated
vendored
Normal file
@@ -0,0 +1,149 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
|
// notExistErrorMessageType specifies which flavor of "flag does not exist"
|
||||||
|
// is printed by NotExistError. This allows the related errors to be grouped
|
||||||
|
// under a single NotExistError struct without making a breaking change to
|
||||||
|
// the error message text.
|
||||||
|
type notExistErrorMessageType int
|
||||||
|
|
||||||
|
const (
|
||||||
|
flagNotExistMessage notExistErrorMessageType = iota
|
||||||
|
flagNotDefinedMessage
|
||||||
|
flagNoSuchFlagMessage
|
||||||
|
flagUnknownFlagMessage
|
||||||
|
flagUnknownShorthandFlagMessage
|
||||||
|
)
|
||||||
|
|
||||||
|
// NotExistError is the error returned when trying to access a flag that
|
||||||
|
// does not exist in the FlagSet.
|
||||||
|
type NotExistError struct {
|
||||||
|
name string
|
||||||
|
specifiedShorthands string
|
||||||
|
messageType notExistErrorMessageType
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error implements error.
|
||||||
|
func (e *NotExistError) Error() string {
|
||||||
|
switch e.messageType {
|
||||||
|
case flagNotExistMessage:
|
||||||
|
return fmt.Sprintf("flag %q does not exist", e.name)
|
||||||
|
|
||||||
|
case flagNotDefinedMessage:
|
||||||
|
return fmt.Sprintf("flag accessed but not defined: %s", e.name)
|
||||||
|
|
||||||
|
case flagNoSuchFlagMessage:
|
||||||
|
return fmt.Sprintf("no such flag -%v", e.name)
|
||||||
|
|
||||||
|
case flagUnknownFlagMessage:
|
||||||
|
return fmt.Sprintf("unknown flag: --%s", e.name)
|
||||||
|
|
||||||
|
case flagUnknownShorthandFlagMessage:
|
||||||
|
c := rune(e.name[0])
|
||||||
|
return fmt.Sprintf("unknown shorthand flag: %q in -%s", c, e.specifiedShorthands)
|
||||||
|
}
|
||||||
|
|
||||||
|
panic(fmt.Errorf("unknown flagNotExistErrorMessageType: %v", e.messageType))
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSpecifiedName returns the name of the flag (without dashes) as it
|
||||||
|
// appeared in the parsed arguments.
|
||||||
|
func (e *NotExistError) GetSpecifiedName() string {
|
||||||
|
return e.name
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSpecifiedShortnames returns the group of shorthand arguments
|
||||||
|
// (without dashes) that the flag appeared within. If the flag was not in a
|
||||||
|
// shorthand group, this will return an empty string.
|
||||||
|
func (e *NotExistError) GetSpecifiedShortnames() string {
|
||||||
|
return e.specifiedShorthands
|
||||||
|
}
|
||||||
|
|
||||||
|
// ValueRequiredError is the error returned when a flag needs an argument but
|
||||||
|
// no argument was provided.
|
||||||
|
type ValueRequiredError struct {
|
||||||
|
flag *Flag
|
||||||
|
specifiedName string
|
||||||
|
specifiedShorthands string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error implements error.
|
||||||
|
func (e *ValueRequiredError) Error() string {
|
||||||
|
if len(e.specifiedShorthands) > 0 {
|
||||||
|
c := rune(e.specifiedName[0])
|
||||||
|
return fmt.Sprintf("flag needs an argument: %q in -%s", c, e.specifiedShorthands)
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("flag needs an argument: --%s", e.specifiedName)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFlag returns the flag for which the error occurred.
|
||||||
|
func (e *ValueRequiredError) GetFlag() *Flag {
|
||||||
|
return e.flag
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSpecifiedName returns the name of the flag (without dashes) as it
|
||||||
|
// appeared in the parsed arguments.
|
||||||
|
func (e *ValueRequiredError) GetSpecifiedName() string {
|
||||||
|
return e.specifiedName
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSpecifiedShortnames returns the group of shorthand arguments
|
||||||
|
// (without dashes) that the flag appeared within. If the flag was not in a
|
||||||
|
// shorthand group, this will return an empty string.
|
||||||
|
func (e *ValueRequiredError) GetSpecifiedShortnames() string {
|
||||||
|
return e.specifiedShorthands
|
||||||
|
}
|
||||||
|
|
||||||
|
// InvalidValueError is the error returned when an invalid value is used
|
||||||
|
// for a flag.
|
||||||
|
type InvalidValueError struct {
|
||||||
|
flag *Flag
|
||||||
|
value string
|
||||||
|
cause error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error implements error.
|
||||||
|
func (e *InvalidValueError) Error() string {
|
||||||
|
flag := e.flag
|
||||||
|
var flagName string
|
||||||
|
if flag.Shorthand != "" && flag.ShorthandDeprecated == "" {
|
||||||
|
flagName = fmt.Sprintf("-%s, --%s", flag.Shorthand, flag.Name)
|
||||||
|
} else {
|
||||||
|
flagName = fmt.Sprintf("--%s", flag.Name)
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("invalid argument %q for %q flag: %v", e.value, flagName, e.cause)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unwrap implements errors.Unwrap.
|
||||||
|
func (e *InvalidValueError) Unwrap() error {
|
||||||
|
return e.cause
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFlag returns the flag for which the error occurred.
|
||||||
|
func (e *InvalidValueError) GetFlag() *Flag {
|
||||||
|
return e.flag
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetValue returns the invalid value that was provided.
|
||||||
|
func (e *InvalidValueError) GetValue() string {
|
||||||
|
return e.value
|
||||||
|
}
|
||||||
|
|
||||||
|
// InvalidSyntaxError is the error returned when a bad flag name is passed on
|
||||||
|
// the command line.
|
||||||
|
type InvalidSyntaxError struct {
|
||||||
|
specifiedFlag string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Error implements error.
|
||||||
|
func (e *InvalidSyntaxError) Error() string {
|
||||||
|
return fmt.Sprintf("bad flag syntax: %s", e.specifiedFlag)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetSpecifiedName returns the exact flag (with dashes) as it
|
||||||
|
// appeared in the parsed arguments.
|
||||||
|
func (e *InvalidSyntaxError) GetSpecifiedFlag() string {
|
||||||
|
return e.specifiedFlag
|
||||||
|
}
|
||||||
1287
vendor/github.com/spf13/pflag/flag.go
generated
vendored
Normal file
1287
vendor/github.com/spf13/pflag/flag.go
generated
vendored
Normal file
File diff suppressed because it is too large
Load Diff
88
vendor/github.com/spf13/pflag/float32.go
generated
vendored
Normal file
88
vendor/github.com/spf13/pflag/float32.go
generated
vendored
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- float32 Value
|
||||||
|
type float32Value float32
|
||||||
|
|
||||||
|
func newFloat32Value(val float32, p *float32) *float32Value {
|
||||||
|
*p = val
|
||||||
|
return (*float32Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float32Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseFloat(s, 32)
|
||||||
|
*f = float32Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float32Value) Type() string {
|
||||||
|
return "float32"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float32Value) String() string { return strconv.FormatFloat(float64(*f), 'g', -1, 32) }
|
||||||
|
|
||||||
|
func float32Conv(sval string) (interface{}, error) {
|
||||||
|
v, err := strconv.ParseFloat(sval, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return float32(v), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFloat32 return the float32 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetFloat32(name string) (float32, error) {
|
||||||
|
val, err := f.getFlagType(name, "float32", float32Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(float32), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32Var defines a float32 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float32 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Float32Var(p *float32, name string, value float32, usage string) {
|
||||||
|
f.VarP(newFloat32Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32VarP is like Float32Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float32VarP(p *float32, name, shorthand string, value float32, usage string) {
|
||||||
|
f.VarP(newFloat32Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32Var defines a float32 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float32 variable in which to store the value of the flag.
|
||||||
|
func Float32Var(p *float32, name string, value float32, usage string) {
|
||||||
|
CommandLine.VarP(newFloat32Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32VarP is like Float32Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float32VarP(p *float32, name, shorthand string, value float32, usage string) {
|
||||||
|
CommandLine.VarP(newFloat32Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32 defines a float32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a float32 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Float32(name string, value float32, usage string) *float32 {
|
||||||
|
p := new(float32)
|
||||||
|
f.Float32VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32P is like Float32, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float32P(name, shorthand string, value float32, usage string) *float32 {
|
||||||
|
p := new(float32)
|
||||||
|
f.Float32VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32 defines a float32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a float32 variable that stores the value of the flag.
|
||||||
|
func Float32(name string, value float32, usage string) *float32 {
|
||||||
|
return CommandLine.Float32P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32P is like Float32, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float32P(name, shorthand string, value float32, usage string) *float32 {
|
||||||
|
return CommandLine.Float32P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
174
vendor/github.com/spf13/pflag/float32_slice.go
generated
vendored
Normal file
174
vendor/github.com/spf13/pflag/float32_slice.go
generated
vendored
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- float32Slice Value
|
||||||
|
type float32SliceValue struct {
|
||||||
|
value *[]float32
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFloat32SliceValue(val []float32, p *[]float32) *float32SliceValue {
|
||||||
|
isv := new(float32SliceValue)
|
||||||
|
isv.value = p
|
||||||
|
*isv.value = val
|
||||||
|
return isv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]float32, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
var temp64 float64
|
||||||
|
temp64, err = strconv.ParseFloat(d, 32)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out[i] = float32(temp64)
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) Type() string {
|
||||||
|
return "float32Slice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%f", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) fromString(val string) (float32, error) {
|
||||||
|
t64, err := strconv.ParseFloat(val, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return float32(t64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) toString(val float32) string {
|
||||||
|
return fmt.Sprintf("%f", val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) Replace(val []string) error {
|
||||||
|
out := make([]float32, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float32SliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func float32SliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []float32{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]float32, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
var temp64 float64
|
||||||
|
temp64, err = strconv.ParseFloat(d, 32)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out[i] = float32(temp64)
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFloat32Slice return the []float32 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetFloat32Slice(name string) ([]float32, error) {
|
||||||
|
val, err := f.getFlagType(name, "float32Slice", float32SliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []float32{}, err
|
||||||
|
}
|
||||||
|
return val.([]float32), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceVar defines a float32Slice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []float32 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Float32SliceVar(p *[]float32, name string, value []float32, usage string) {
|
||||||
|
f.VarP(newFloat32SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceVarP is like Float32SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string) {
|
||||||
|
f.VarP(newFloat32SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceVar defines a float32[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float32[] variable in which to store the value of the flag.
|
||||||
|
func Float32SliceVar(p *[]float32, name string, value []float32, usage string) {
|
||||||
|
CommandLine.VarP(newFloat32SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceVarP is like Float32SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float32SliceVarP(p *[]float32, name, shorthand string, value []float32, usage string) {
|
||||||
|
CommandLine.VarP(newFloat32SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32Slice defines a []float32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []float32 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Float32Slice(name string, value []float32, usage string) *[]float32 {
|
||||||
|
p := []float32{}
|
||||||
|
f.Float32SliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceP is like Float32Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float32SliceP(name, shorthand string, value []float32, usage string) *[]float32 {
|
||||||
|
p := []float32{}
|
||||||
|
f.Float32SliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32Slice defines a []float32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []float32 variable that stores the value of the flag.
|
||||||
|
func Float32Slice(name string, value []float32, usage string) *[]float32 {
|
||||||
|
return CommandLine.Float32SliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float32SliceP is like Float32Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float32SliceP(name, shorthand string, value []float32, usage string) *[]float32 {
|
||||||
|
return CommandLine.Float32SliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
84
vendor/github.com/spf13/pflag/float64.go
generated
vendored
Normal file
84
vendor/github.com/spf13/pflag/float64.go
generated
vendored
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- float64 Value
|
||||||
|
type float64Value float64
|
||||||
|
|
||||||
|
func newFloat64Value(val float64, p *float64) *float64Value {
|
||||||
|
*p = val
|
||||||
|
return (*float64Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float64Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseFloat(s, 64)
|
||||||
|
*f = float64Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float64Value) Type() string {
|
||||||
|
return "float64"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *float64Value) String() string { return strconv.FormatFloat(float64(*f), 'g', -1, 64) }
|
||||||
|
|
||||||
|
func float64Conv(sval string) (interface{}, error) {
|
||||||
|
return strconv.ParseFloat(sval, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFloat64 return the float64 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetFloat64(name string) (float64, error) {
|
||||||
|
val, err := f.getFlagType(name, "float64", float64Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(float64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64Var defines a float64 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float64 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Float64Var(p *float64, name string, value float64, usage string) {
|
||||||
|
f.VarP(newFloat64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64VarP is like Float64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float64VarP(p *float64, name, shorthand string, value float64, usage string) {
|
||||||
|
f.VarP(newFloat64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64Var defines a float64 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float64 variable in which to store the value of the flag.
|
||||||
|
func Float64Var(p *float64, name string, value float64, usage string) {
|
||||||
|
CommandLine.VarP(newFloat64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64VarP is like Float64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float64VarP(p *float64, name, shorthand string, value float64, usage string) {
|
||||||
|
CommandLine.VarP(newFloat64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64 defines a float64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a float64 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Float64(name string, value float64, usage string) *float64 {
|
||||||
|
p := new(float64)
|
||||||
|
f.Float64VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64P is like Float64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float64P(name, shorthand string, value float64, usage string) *float64 {
|
||||||
|
p := new(float64)
|
||||||
|
f.Float64VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64 defines a float64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a float64 variable that stores the value of the flag.
|
||||||
|
func Float64(name string, value float64, usage string) *float64 {
|
||||||
|
return CommandLine.Float64P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64P is like Float64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float64P(name, shorthand string, value float64, usage string) *float64 {
|
||||||
|
return CommandLine.Float64P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
166
vendor/github.com/spf13/pflag/float64_slice.go
generated
vendored
Normal file
166
vendor/github.com/spf13/pflag/float64_slice.go
generated
vendored
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- float64Slice Value
|
||||||
|
type float64SliceValue struct {
|
||||||
|
value *[]float64
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFloat64SliceValue(val []float64, p *[]float64) *float64SliceValue {
|
||||||
|
isv := new(float64SliceValue)
|
||||||
|
isv.value = p
|
||||||
|
*isv.value = val
|
||||||
|
return isv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]float64, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.ParseFloat(d, 64)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) Type() string {
|
||||||
|
return "float64Slice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%f", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) fromString(val string) (float64, error) {
|
||||||
|
return strconv.ParseFloat(val, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) toString(val float64) string {
|
||||||
|
return fmt.Sprintf("%f", val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) Replace(val []string) error {
|
||||||
|
out := make([]float64, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *float64SliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func float64SliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []float64{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]float64, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.ParseFloat(d, 64)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetFloat64Slice return the []float64 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetFloat64Slice(name string) ([]float64, error) {
|
||||||
|
val, err := f.getFlagType(name, "float64Slice", float64SliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []float64{}, err
|
||||||
|
}
|
||||||
|
return val.([]float64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceVar defines a float64Slice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []float64 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Float64SliceVar(p *[]float64, name string, value []float64, usage string) {
|
||||||
|
f.VarP(newFloat64SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceVarP is like Float64SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string) {
|
||||||
|
f.VarP(newFloat64SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceVar defines a float64[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a float64[] variable in which to store the value of the flag.
|
||||||
|
func Float64SliceVar(p *[]float64, name string, value []float64, usage string) {
|
||||||
|
CommandLine.VarP(newFloat64SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceVarP is like Float64SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float64SliceVarP(p *[]float64, name, shorthand string, value []float64, usage string) {
|
||||||
|
CommandLine.VarP(newFloat64SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64Slice defines a []float64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []float64 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Float64Slice(name string, value []float64, usage string) *[]float64 {
|
||||||
|
p := []float64{}
|
||||||
|
f.Float64SliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceP is like Float64Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Float64SliceP(name, shorthand string, value []float64, usage string) *[]float64 {
|
||||||
|
p := []float64{}
|
||||||
|
f.Float64SliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64Slice defines a []float64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []float64 variable that stores the value of the flag.
|
||||||
|
func Float64Slice(name string, value []float64, usage string) *[]float64 {
|
||||||
|
return CommandLine.Float64SliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Float64SliceP is like Float64Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Float64SliceP(name, shorthand string, value []float64, usage string) *[]float64 {
|
||||||
|
return CommandLine.Float64SliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
37
vendor/github.com/spf13/pflag/func.go
generated
vendored
Normal file
37
vendor/github.com/spf13/pflag/func.go
generated
vendored
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
// -- func Value
|
||||||
|
type funcValue func(string) error
|
||||||
|
|
||||||
|
func (f funcValue) Set(s string) error { return f(s) }
|
||||||
|
|
||||||
|
func (f funcValue) Type() string { return "func" }
|
||||||
|
|
||||||
|
func (f funcValue) String() string { return "" } // same behavior as stdlib 'flag' package
|
||||||
|
|
||||||
|
// Func defines a func flag with specified name, callback function and usage string.
|
||||||
|
//
|
||||||
|
// The callback function will be called every time "--{name}={value}" (or equivalent) is
|
||||||
|
// parsed on the command line, with "{value}" as an argument.
|
||||||
|
func (f *FlagSet) Func(name string, usage string, fn func(string) error) {
|
||||||
|
f.FuncP(name, "", usage, fn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FuncP is like Func, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) FuncP(name string, shorthand string, usage string, fn func(string) error) {
|
||||||
|
var val Value = funcValue(fn)
|
||||||
|
f.VarP(val, name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Func defines a func flag with specified name, callback function and usage string.
|
||||||
|
//
|
||||||
|
// The callback function will be called every time "--{name}={value}" (or equivalent) is
|
||||||
|
// parsed on the command line, with "{value}" as an argument.
|
||||||
|
func Func(name string, usage string, fn func(string) error) {
|
||||||
|
CommandLine.FuncP(name, "", usage, fn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FuncP is like Func, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func FuncP(name, shorthand string, usage string, fn func(string) error) {
|
||||||
|
CommandLine.FuncP(name, shorthand, usage, fn)
|
||||||
|
}
|
||||||
161
vendor/github.com/spf13/pflag/golangflag.go
generated
vendored
Normal file
161
vendor/github.com/spf13/pflag/golangflag.go
generated
vendored
Normal file
@@ -0,0 +1,161 @@
|
|||||||
|
// Copyright 2009 The Go Authors. All rights reserved.
|
||||||
|
// Use of this source code is governed by a BSD-style
|
||||||
|
// license that can be found in the LICENSE file.
|
||||||
|
|
||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
goflag "flag"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// go test flags prefixes
|
||||||
|
func isGotestFlag(flag string) bool {
|
||||||
|
return strings.HasPrefix(flag, "-test.")
|
||||||
|
}
|
||||||
|
|
||||||
|
func isGotestShorthandFlag(flag string) bool {
|
||||||
|
return strings.HasPrefix(flag, "test.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// flagValueWrapper implements pflag.Value around a flag.Value. The main
|
||||||
|
// difference here is the addition of the Type method that returns a string
|
||||||
|
// name of the type. As this is generally unknown, we approximate that with
|
||||||
|
// reflection.
|
||||||
|
type flagValueWrapper struct {
|
||||||
|
inner goflag.Value
|
||||||
|
flagType string
|
||||||
|
}
|
||||||
|
|
||||||
|
// We are just copying the boolFlag interface out of goflag as that is what
|
||||||
|
// they use to decide if a flag should get "true" when no arg is given.
|
||||||
|
type goBoolFlag interface {
|
||||||
|
goflag.Value
|
||||||
|
IsBoolFlag() bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func wrapFlagValue(v goflag.Value) Value {
|
||||||
|
// If the flag.Value happens to also be a pflag.Value, just use it directly.
|
||||||
|
if pv, ok := v.(Value); ok {
|
||||||
|
return pv
|
||||||
|
}
|
||||||
|
|
||||||
|
pv := &flagValueWrapper{
|
||||||
|
inner: v,
|
||||||
|
}
|
||||||
|
|
||||||
|
t := reflect.TypeOf(v)
|
||||||
|
if t.Kind() == reflect.Interface || t.Kind() == reflect.Ptr {
|
||||||
|
t = t.Elem()
|
||||||
|
}
|
||||||
|
|
||||||
|
pv.flagType = strings.TrimSuffix(t.Name(), "Value")
|
||||||
|
return pv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (v *flagValueWrapper) String() string {
|
||||||
|
return v.inner.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (v *flagValueWrapper) Set(s string) error {
|
||||||
|
return v.inner.Set(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (v *flagValueWrapper) Type() string {
|
||||||
|
return v.flagType
|
||||||
|
}
|
||||||
|
|
||||||
|
// PFlagFromGoFlag will return a *pflag.Flag given a *flag.Flag
|
||||||
|
// If the *flag.Flag.Name was a single character (ex: `v`) it will be accessiblei
|
||||||
|
// with both `-v` and `--v` in flags. If the golang flag was more than a single
|
||||||
|
// character (ex: `verbose`) it will only be accessible via `--verbose`
|
||||||
|
func PFlagFromGoFlag(goflag *goflag.Flag) *Flag {
|
||||||
|
// Remember the default value as a string; it won't change.
|
||||||
|
flag := &Flag{
|
||||||
|
Name: goflag.Name,
|
||||||
|
Usage: goflag.Usage,
|
||||||
|
Value: wrapFlagValue(goflag.Value),
|
||||||
|
// Looks like golang flags don't set DefValue correctly :-(
|
||||||
|
//DefValue: goflag.DefValue,
|
||||||
|
DefValue: goflag.Value.String(),
|
||||||
|
}
|
||||||
|
// Ex: if the golang flag was -v, allow both -v and --v to work
|
||||||
|
if len(flag.Name) == 1 {
|
||||||
|
flag.Shorthand = flag.Name
|
||||||
|
}
|
||||||
|
if fv, ok := goflag.Value.(goBoolFlag); ok && fv.IsBoolFlag() {
|
||||||
|
flag.NoOptDefVal = "true"
|
||||||
|
}
|
||||||
|
return flag
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddGoFlag will add the given *flag.Flag to the pflag.FlagSet
|
||||||
|
func (f *FlagSet) AddGoFlag(goflag *goflag.Flag) {
|
||||||
|
if f.Lookup(goflag.Name) != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
newflag := PFlagFromGoFlag(goflag)
|
||||||
|
f.AddFlag(newflag)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AddGoFlagSet will add the given *flag.FlagSet to the pflag.FlagSet
|
||||||
|
func (f *FlagSet) AddGoFlagSet(newSet *goflag.FlagSet) {
|
||||||
|
if newSet == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
newSet.VisitAll(func(goflag *goflag.Flag) {
|
||||||
|
f.AddGoFlag(goflag)
|
||||||
|
})
|
||||||
|
if f.addedGoFlagSets == nil {
|
||||||
|
f.addedGoFlagSets = make([]*goflag.FlagSet, 0)
|
||||||
|
}
|
||||||
|
f.addedGoFlagSets = append(f.addedGoFlagSets, newSet)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CopyToGoFlagSet will add all current flags to the given Go flag set.
|
||||||
|
// Deprecation remarks get copied into the usage description.
|
||||||
|
// Whenever possible, a flag gets added for which Go flags shows
|
||||||
|
// a proper type in the help message.
|
||||||
|
func (f *FlagSet) CopyToGoFlagSet(newSet *goflag.FlagSet) {
|
||||||
|
f.VisitAll(func(flag *Flag) {
|
||||||
|
usage := flag.Usage
|
||||||
|
if flag.Deprecated != "" {
|
||||||
|
usage += " (DEPRECATED: " + flag.Deprecated + ")"
|
||||||
|
}
|
||||||
|
|
||||||
|
switch value := flag.Value.(type) {
|
||||||
|
case *stringValue:
|
||||||
|
newSet.StringVar((*string)(value), flag.Name, flag.DefValue, usage)
|
||||||
|
case *intValue:
|
||||||
|
newSet.IntVar((*int)(value), flag.Name, *(*int)(value), usage)
|
||||||
|
case *int64Value:
|
||||||
|
newSet.Int64Var((*int64)(value), flag.Name, *(*int64)(value), usage)
|
||||||
|
case *uintValue:
|
||||||
|
newSet.UintVar((*uint)(value), flag.Name, *(*uint)(value), usage)
|
||||||
|
case *uint64Value:
|
||||||
|
newSet.Uint64Var((*uint64)(value), flag.Name, *(*uint64)(value), usage)
|
||||||
|
case *durationValue:
|
||||||
|
newSet.DurationVar((*time.Duration)(value), flag.Name, *(*time.Duration)(value), usage)
|
||||||
|
case *float64Value:
|
||||||
|
newSet.Float64Var((*float64)(value), flag.Name, *(*float64)(value), usage)
|
||||||
|
default:
|
||||||
|
newSet.Var(flag.Value, flag.Name, usage)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseSkippedFlags explicitly Parses go test flags (i.e. the one starting with '-test.') with goflag.Parse(),
|
||||||
|
// since by default those are skipped by pflag.Parse().
|
||||||
|
// Typical usage example: `ParseGoTestFlags(os.Args[1:], goflag.CommandLine)`
|
||||||
|
func ParseSkippedFlags(osArgs []string, goFlagSet *goflag.FlagSet) error {
|
||||||
|
var skippedFlags []string
|
||||||
|
for _, f := range osArgs {
|
||||||
|
if isGotestFlag(f) {
|
||||||
|
skippedFlags = append(skippedFlags, f)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return goFlagSet.Parse(skippedFlags)
|
||||||
|
}
|
||||||
|
|
||||||
84
vendor/github.com/spf13/pflag/int.go
generated
vendored
Normal file
84
vendor/github.com/spf13/pflag/int.go
generated
vendored
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- int Value
|
||||||
|
type intValue int
|
||||||
|
|
||||||
|
func newIntValue(val int, p *int) *intValue {
|
||||||
|
*p = val
|
||||||
|
return (*intValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *intValue) Set(s string) error {
|
||||||
|
v, err := strconv.ParseInt(s, 0, 64)
|
||||||
|
*i = intValue(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *intValue) Type() string {
|
||||||
|
return "int"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *intValue) String() string { return strconv.Itoa(int(*i)) }
|
||||||
|
|
||||||
|
func intConv(sval string) (interface{}, error) {
|
||||||
|
return strconv.Atoi(sval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt return the int value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt(name string) (int, error) {
|
||||||
|
val, err := f.getFlagType(name, "int", intConv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntVar defines an int flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) IntVar(p *int, name string, value int, usage string) {
|
||||||
|
f.VarP(newIntValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntVarP is like IntVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IntVarP(p *int, name, shorthand string, value int, usage string) {
|
||||||
|
f.VarP(newIntValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntVar defines an int flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int variable in which to store the value of the flag.
|
||||||
|
func IntVar(p *int, name string, value int, usage string) {
|
||||||
|
CommandLine.VarP(newIntValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntVarP is like IntVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IntVarP(p *int, name, shorthand string, value int, usage string) {
|
||||||
|
CommandLine.VarP(newIntValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int defines an int flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int(name string, value int, usage string) *int {
|
||||||
|
p := new(int)
|
||||||
|
f.IntVarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntP is like Int, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IntP(name, shorthand string, value int, usage string) *int {
|
||||||
|
p := new(int)
|
||||||
|
f.IntVarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int defines an int flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int variable that stores the value of the flag.
|
||||||
|
func Int(name string, value int, usage string) *int {
|
||||||
|
return CommandLine.IntP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntP is like Int, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IntP(name, shorthand string, value int, usage string) *int {
|
||||||
|
return CommandLine.IntP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
88
vendor/github.com/spf13/pflag/int16.go
generated
vendored
Normal file
88
vendor/github.com/spf13/pflag/int16.go
generated
vendored
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- int16 Value
|
||||||
|
type int16Value int16
|
||||||
|
|
||||||
|
func newInt16Value(val int16, p *int16) *int16Value {
|
||||||
|
*p = val
|
||||||
|
return (*int16Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int16Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseInt(s, 0, 16)
|
||||||
|
*i = int16Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int16Value) Type() string {
|
||||||
|
return "int16"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int16Value) String() string { return strconv.FormatInt(int64(*i), 10) }
|
||||||
|
|
||||||
|
func int16Conv(sval string) (interface{}, error) {
|
||||||
|
v, err := strconv.ParseInt(sval, 0, 16)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return int16(v), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt16 returns the int16 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt16(name string) (int16, error) {
|
||||||
|
val, err := f.getFlagType(name, "int16", int16Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int16), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16Var defines an int16 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int16 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int16Var(p *int16, name string, value int16, usage string) {
|
||||||
|
f.VarP(newInt16Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16VarP is like Int16Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int16VarP(p *int16, name, shorthand string, value int16, usage string) {
|
||||||
|
f.VarP(newInt16Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16Var defines an int16 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int16 variable in which to store the value of the flag.
|
||||||
|
func Int16Var(p *int16, name string, value int16, usage string) {
|
||||||
|
CommandLine.VarP(newInt16Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16VarP is like Int16Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int16VarP(p *int16, name, shorthand string, value int16, usage string) {
|
||||||
|
CommandLine.VarP(newInt16Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16 defines an int16 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int16 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int16(name string, value int16, usage string) *int16 {
|
||||||
|
p := new(int16)
|
||||||
|
f.Int16VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16P is like Int16, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int16P(name, shorthand string, value int16, usage string) *int16 {
|
||||||
|
p := new(int16)
|
||||||
|
f.Int16VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16 defines an int16 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int16 variable that stores the value of the flag.
|
||||||
|
func Int16(name string, value int16, usage string) *int16 {
|
||||||
|
return CommandLine.Int16P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int16P is like Int16, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int16P(name, shorthand string, value int16, usage string) *int16 {
|
||||||
|
return CommandLine.Int16P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
88
vendor/github.com/spf13/pflag/int32.go
generated
vendored
Normal file
88
vendor/github.com/spf13/pflag/int32.go
generated
vendored
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- int32 Value
|
||||||
|
type int32Value int32
|
||||||
|
|
||||||
|
func newInt32Value(val int32, p *int32) *int32Value {
|
||||||
|
*p = val
|
||||||
|
return (*int32Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int32Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseInt(s, 0, 32)
|
||||||
|
*i = int32Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int32Value) Type() string {
|
||||||
|
return "int32"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int32Value) String() string { return strconv.FormatInt(int64(*i), 10) }
|
||||||
|
|
||||||
|
func int32Conv(sval string) (interface{}, error) {
|
||||||
|
v, err := strconv.ParseInt(sval, 0, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return int32(v), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt32 return the int32 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt32(name string) (int32, error) {
|
||||||
|
val, err := f.getFlagType(name, "int32", int32Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int32), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32Var defines an int32 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int32 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int32Var(p *int32, name string, value int32, usage string) {
|
||||||
|
f.VarP(newInt32Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32VarP is like Int32Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int32VarP(p *int32, name, shorthand string, value int32, usage string) {
|
||||||
|
f.VarP(newInt32Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32Var defines an int32 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int32 variable in which to store the value of the flag.
|
||||||
|
func Int32Var(p *int32, name string, value int32, usage string) {
|
||||||
|
CommandLine.VarP(newInt32Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32VarP is like Int32Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int32VarP(p *int32, name, shorthand string, value int32, usage string) {
|
||||||
|
CommandLine.VarP(newInt32Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32 defines an int32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int32 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int32(name string, value int32, usage string) *int32 {
|
||||||
|
p := new(int32)
|
||||||
|
f.Int32VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32P is like Int32, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int32P(name, shorthand string, value int32, usage string) *int32 {
|
||||||
|
p := new(int32)
|
||||||
|
f.Int32VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32 defines an int32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int32 variable that stores the value of the flag.
|
||||||
|
func Int32(name string, value int32, usage string) *int32 {
|
||||||
|
return CommandLine.Int32P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32P is like Int32, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int32P(name, shorthand string, value int32, usage string) *int32 {
|
||||||
|
return CommandLine.Int32P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
174
vendor/github.com/spf13/pflag/int32_slice.go
generated
vendored
Normal file
174
vendor/github.com/spf13/pflag/int32_slice.go
generated
vendored
Normal file
@@ -0,0 +1,174 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- int32Slice Value
|
||||||
|
type int32SliceValue struct {
|
||||||
|
value *[]int32
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newInt32SliceValue(val []int32, p *[]int32) *int32SliceValue {
|
||||||
|
isv := new(int32SliceValue)
|
||||||
|
isv.value = p
|
||||||
|
*isv.value = val
|
||||||
|
return isv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int32, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
var temp64 int64
|
||||||
|
temp64, err = strconv.ParseInt(d, 0, 32)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out[i] = int32(temp64)
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) Type() string {
|
||||||
|
return "int32Slice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%d", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) fromString(val string) (int32, error) {
|
||||||
|
t64, err := strconv.ParseInt(val, 0, 32)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return int32(t64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) toString(val int32) string {
|
||||||
|
return fmt.Sprintf("%d", val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) Replace(val []string) error {
|
||||||
|
out := make([]int32, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int32SliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func int32SliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []int32{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int32, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
var temp64 int64
|
||||||
|
temp64, err = strconv.ParseInt(d, 0, 32)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out[i] = int32(temp64)
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt32Slice return the []int32 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt32Slice(name string) ([]int32, error) {
|
||||||
|
val, err := f.getFlagType(name, "int32Slice", int32SliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []int32{}, err
|
||||||
|
}
|
||||||
|
return val.([]int32), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceVar defines a int32Slice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []int32 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int32SliceVar(p *[]int32, name string, value []int32, usage string) {
|
||||||
|
f.VarP(newInt32SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceVarP is like Int32SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string) {
|
||||||
|
f.VarP(newInt32SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceVar defines a int32[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a int32[] variable in which to store the value of the flag.
|
||||||
|
func Int32SliceVar(p *[]int32, name string, value []int32, usage string) {
|
||||||
|
CommandLine.VarP(newInt32SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceVarP is like Int32SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int32SliceVarP(p *[]int32, name, shorthand string, value []int32, usage string) {
|
||||||
|
CommandLine.VarP(newInt32SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32Slice defines a []int32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int32 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int32Slice(name string, value []int32, usage string) *[]int32 {
|
||||||
|
p := []int32{}
|
||||||
|
f.Int32SliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceP is like Int32Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int32SliceP(name, shorthand string, value []int32, usage string) *[]int32 {
|
||||||
|
p := []int32{}
|
||||||
|
f.Int32SliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32Slice defines a []int32 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int32 variable that stores the value of the flag.
|
||||||
|
func Int32Slice(name string, value []int32, usage string) *[]int32 {
|
||||||
|
return CommandLine.Int32SliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int32SliceP is like Int32Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int32SliceP(name, shorthand string, value []int32, usage string) *[]int32 {
|
||||||
|
return CommandLine.Int32SliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
84
vendor/github.com/spf13/pflag/int64.go
generated
vendored
Normal file
84
vendor/github.com/spf13/pflag/int64.go
generated
vendored
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- int64 Value
|
||||||
|
type int64Value int64
|
||||||
|
|
||||||
|
func newInt64Value(val int64, p *int64) *int64Value {
|
||||||
|
*p = val
|
||||||
|
return (*int64Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int64Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseInt(s, 0, 64)
|
||||||
|
*i = int64Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int64Value) Type() string {
|
||||||
|
return "int64"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int64Value) String() string { return strconv.FormatInt(int64(*i), 10) }
|
||||||
|
|
||||||
|
func int64Conv(sval string) (interface{}, error) {
|
||||||
|
return strconv.ParseInt(sval, 0, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt64 return the int64 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt64(name string) (int64, error) {
|
||||||
|
val, err := f.getFlagType(name, "int64", int64Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64Var defines an int64 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int64 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int64Var(p *int64, name string, value int64, usage string) {
|
||||||
|
f.VarP(newInt64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64VarP is like Int64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int64VarP(p *int64, name, shorthand string, value int64, usage string) {
|
||||||
|
f.VarP(newInt64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64Var defines an int64 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int64 variable in which to store the value of the flag.
|
||||||
|
func Int64Var(p *int64, name string, value int64, usage string) {
|
||||||
|
CommandLine.VarP(newInt64Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64VarP is like Int64Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int64VarP(p *int64, name, shorthand string, value int64, usage string) {
|
||||||
|
CommandLine.VarP(newInt64Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64 defines an int64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int64 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int64(name string, value int64, usage string) *int64 {
|
||||||
|
p := new(int64)
|
||||||
|
f.Int64VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64P is like Int64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int64P(name, shorthand string, value int64, usage string) *int64 {
|
||||||
|
p := new(int64)
|
||||||
|
f.Int64VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64 defines an int64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int64 variable that stores the value of the flag.
|
||||||
|
func Int64(name string, value int64, usage string) *int64 {
|
||||||
|
return CommandLine.Int64P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64P is like Int64, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int64P(name, shorthand string, value int64, usage string) *int64 {
|
||||||
|
return CommandLine.Int64P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
166
vendor/github.com/spf13/pflag/int64_slice.go
generated
vendored
Normal file
166
vendor/github.com/spf13/pflag/int64_slice.go
generated
vendored
Normal file
@@ -0,0 +1,166 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- int64Slice Value
|
||||||
|
type int64SliceValue struct {
|
||||||
|
value *[]int64
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newInt64SliceValue(val []int64, p *[]int64) *int64SliceValue {
|
||||||
|
isv := new(int64SliceValue)
|
||||||
|
isv.value = p
|
||||||
|
*isv.value = val
|
||||||
|
return isv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int64, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.ParseInt(d, 0, 64)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) Type() string {
|
||||||
|
return "int64Slice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%d", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) fromString(val string) (int64, error) {
|
||||||
|
return strconv.ParseInt(val, 0, 64)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) toString(val int64) string {
|
||||||
|
return fmt.Sprintf("%d", val)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) Append(val string) error {
|
||||||
|
i, err := s.fromString(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) Replace(val []string) error {
|
||||||
|
out := make([]int64, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = s.fromString(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *int64SliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = s.toString(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func int64SliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []int64{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int64, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.ParseInt(d, 0, 64)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt64Slice return the []int64 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt64Slice(name string) ([]int64, error) {
|
||||||
|
val, err := f.getFlagType(name, "int64Slice", int64SliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []int64{}, err
|
||||||
|
}
|
||||||
|
return val.([]int64), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceVar defines a int64Slice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []int64 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int64SliceVar(p *[]int64, name string, value []int64, usage string) {
|
||||||
|
f.VarP(newInt64SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceVarP is like Int64SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string) {
|
||||||
|
f.VarP(newInt64SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceVar defines a int64[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a int64[] variable in which to store the value of the flag.
|
||||||
|
func Int64SliceVar(p *[]int64, name string, value []int64, usage string) {
|
||||||
|
CommandLine.VarP(newInt64SliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceVarP is like Int64SliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int64SliceVarP(p *[]int64, name, shorthand string, value []int64, usage string) {
|
||||||
|
CommandLine.VarP(newInt64SliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64Slice defines a []int64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int64 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int64Slice(name string, value []int64, usage string) *[]int64 {
|
||||||
|
p := []int64{}
|
||||||
|
f.Int64SliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceP is like Int64Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int64SliceP(name, shorthand string, value []int64, usage string) *[]int64 {
|
||||||
|
p := []int64{}
|
||||||
|
f.Int64SliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64Slice defines a []int64 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int64 variable that stores the value of the flag.
|
||||||
|
func Int64Slice(name string, value []int64, usage string) *[]int64 {
|
||||||
|
return CommandLine.Int64SliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int64SliceP is like Int64Slice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int64SliceP(name, shorthand string, value []int64, usage string) *[]int64 {
|
||||||
|
return CommandLine.Int64SliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
88
vendor/github.com/spf13/pflag/int8.go
generated
vendored
Normal file
88
vendor/github.com/spf13/pflag/int8.go
generated
vendored
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import "strconv"
|
||||||
|
|
||||||
|
// -- int8 Value
|
||||||
|
type int8Value int8
|
||||||
|
|
||||||
|
func newInt8Value(val int8, p *int8) *int8Value {
|
||||||
|
*p = val
|
||||||
|
return (*int8Value)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int8Value) Set(s string) error {
|
||||||
|
v, err := strconv.ParseInt(s, 0, 8)
|
||||||
|
*i = int8Value(v)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int8Value) Type() string {
|
||||||
|
return "int8"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *int8Value) String() string { return strconv.FormatInt(int64(*i), 10) }
|
||||||
|
|
||||||
|
func int8Conv(sval string) (interface{}, error) {
|
||||||
|
v, err := strconv.ParseInt(sval, 0, 8)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return int8(v), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetInt8 return the int8 value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetInt8(name string) (int8, error) {
|
||||||
|
val, err := f.getFlagType(name, "int8", int8Conv)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return val.(int8), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8Var defines an int8 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int8 variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) Int8Var(p *int8, name string, value int8, usage string) {
|
||||||
|
f.VarP(newInt8Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8VarP is like Int8Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int8VarP(p *int8, name, shorthand string, value int8, usage string) {
|
||||||
|
f.VarP(newInt8Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8Var defines an int8 flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an int8 variable in which to store the value of the flag.
|
||||||
|
func Int8Var(p *int8, name string, value int8, usage string) {
|
||||||
|
CommandLine.VarP(newInt8Value(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8VarP is like Int8Var, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int8VarP(p *int8, name, shorthand string, value int8, usage string) {
|
||||||
|
CommandLine.VarP(newInt8Value(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8 defines an int8 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int8 variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) Int8(name string, value int8, usage string) *int8 {
|
||||||
|
p := new(int8)
|
||||||
|
f.Int8VarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8P is like Int8, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) Int8P(name, shorthand string, value int8, usage string) *int8 {
|
||||||
|
p := new(int8)
|
||||||
|
f.Int8VarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8 defines an int8 flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an int8 variable that stores the value of the flag.
|
||||||
|
func Int8(name string, value int8, usage string) *int8 {
|
||||||
|
return CommandLine.Int8P(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Int8P is like Int8, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func Int8P(name, shorthand string, value int8, usage string) *int8 {
|
||||||
|
return CommandLine.Int8P(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
158
vendor/github.com/spf13/pflag/int_slice.go
generated
vendored
Normal file
158
vendor/github.com/spf13/pflag/int_slice.go
generated
vendored
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- intSlice Value
|
||||||
|
type intSliceValue struct {
|
||||||
|
value *[]int
|
||||||
|
changed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func newIntSliceValue(val []int, p *[]int) *intSliceValue {
|
||||||
|
isv := new(intSliceValue)
|
||||||
|
isv.value = p
|
||||||
|
*isv.value = val
|
||||||
|
return isv
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) Set(val string) error {
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.Atoi(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
if !s.changed {
|
||||||
|
*s.value = out
|
||||||
|
} else {
|
||||||
|
*s.value = append(*s.value, out...)
|
||||||
|
}
|
||||||
|
s.changed = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) Type() string {
|
||||||
|
return "intSlice"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) String() string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = fmt.Sprintf("%d", d)
|
||||||
|
}
|
||||||
|
return "[" + strings.Join(out, ",") + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) Append(val string) error {
|
||||||
|
i, err := strconv.Atoi(val)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
*s.value = append(*s.value, i)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) Replace(val []string) error {
|
||||||
|
out := make([]int, len(val))
|
||||||
|
for i, d := range val {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.Atoi(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*s.value = out
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *intSliceValue) GetSlice() []string {
|
||||||
|
out := make([]string, len(*s.value))
|
||||||
|
for i, d := range *s.value {
|
||||||
|
out[i] = strconv.Itoa(d)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func intSliceConv(val string) (interface{}, error) {
|
||||||
|
val = strings.Trim(val, "[]")
|
||||||
|
// Empty string would cause a slice with one (empty) entry
|
||||||
|
if len(val) == 0 {
|
||||||
|
return []int{}, nil
|
||||||
|
}
|
||||||
|
ss := strings.Split(val, ",")
|
||||||
|
out := make([]int, len(ss))
|
||||||
|
for i, d := range ss {
|
||||||
|
var err error
|
||||||
|
out[i], err = strconv.Atoi(d)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetIntSlice return the []int value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetIntSlice(name string) ([]int, error) {
|
||||||
|
val, err := f.getFlagType(name, "intSlice", intSliceConv)
|
||||||
|
if err != nil {
|
||||||
|
return []int{}, err
|
||||||
|
}
|
||||||
|
return val.([]int), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceVar defines a intSlice flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a []int variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) IntSliceVar(p *[]int, name string, value []int, usage string) {
|
||||||
|
f.VarP(newIntSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceVarP is like IntSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string) {
|
||||||
|
f.VarP(newIntSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceVar defines a int[] flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to a int[] variable in which to store the value of the flag.
|
||||||
|
func IntSliceVar(p *[]int, name string, value []int, usage string) {
|
||||||
|
CommandLine.VarP(newIntSliceValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceVarP is like IntSliceVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IntSliceVarP(p *[]int, name, shorthand string, value []int, usage string) {
|
||||||
|
CommandLine.VarP(newIntSliceValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSlice defines a []int flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) IntSlice(name string, value []int, usage string) *[]int {
|
||||||
|
p := []int{}
|
||||||
|
f.IntSliceVarP(&p, name, "", value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceP is like IntSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IntSliceP(name, shorthand string, value []int, usage string) *[]int {
|
||||||
|
p := []int{}
|
||||||
|
f.IntSliceVarP(&p, name, shorthand, value, usage)
|
||||||
|
return &p
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSlice defines a []int flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of a []int variable that stores the value of the flag.
|
||||||
|
func IntSlice(name string, value []int, usage string) *[]int {
|
||||||
|
return CommandLine.IntSliceP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IntSliceP is like IntSlice, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IntSliceP(name, shorthand string, value []int, usage string) *[]int {
|
||||||
|
return CommandLine.IntSliceP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
97
vendor/github.com/spf13/pflag/ip.go
generated
vendored
Normal file
97
vendor/github.com/spf13/pflag/ip.go
generated
vendored
Normal file
@@ -0,0 +1,97 @@
|
|||||||
|
package pflag
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// -- net.IP value
|
||||||
|
type ipValue net.IP
|
||||||
|
|
||||||
|
func newIPValue(val net.IP, p *net.IP) *ipValue {
|
||||||
|
*p = val
|
||||||
|
return (*ipValue)(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *ipValue) String() string { return net.IP(*i).String() }
|
||||||
|
func (i *ipValue) Set(s string) error {
|
||||||
|
if s == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
ip := net.ParseIP(strings.TrimSpace(s))
|
||||||
|
if ip == nil {
|
||||||
|
return fmt.Errorf("failed to parse IP: %q", s)
|
||||||
|
}
|
||||||
|
*i = ipValue(ip)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (i *ipValue) Type() string {
|
||||||
|
return "ip"
|
||||||
|
}
|
||||||
|
|
||||||
|
func ipConv(sval string) (interface{}, error) {
|
||||||
|
ip := net.ParseIP(sval)
|
||||||
|
if ip != nil {
|
||||||
|
return ip, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("invalid string being converted to IP address: %s", sval)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetIP return the net.IP value of a flag with the given name
|
||||||
|
func (f *FlagSet) GetIP(name string) (net.IP, error) {
|
||||||
|
val, err := f.getFlagType(name, "ip", ipConv)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return val.(net.IP), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPVar defines an net.IP flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an net.IP variable in which to store the value of the flag.
|
||||||
|
func (f *FlagSet) IPVar(p *net.IP, name string, value net.IP, usage string) {
|
||||||
|
f.VarP(newIPValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPVarP is like IPVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string) {
|
||||||
|
f.VarP(newIPValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPVar defines an net.IP flag with specified name, default value, and usage string.
|
||||||
|
// The argument p points to an net.IP variable in which to store the value of the flag.
|
||||||
|
func IPVar(p *net.IP, name string, value net.IP, usage string) {
|
||||||
|
CommandLine.VarP(newIPValue(value, p), name, "", usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPVarP is like IPVar, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IPVarP(p *net.IP, name, shorthand string, value net.IP, usage string) {
|
||||||
|
CommandLine.VarP(newIPValue(value, p), name, shorthand, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IP defines an net.IP flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an net.IP variable that stores the value of the flag.
|
||||||
|
func (f *FlagSet) IP(name string, value net.IP, usage string) *net.IP {
|
||||||
|
p := new(net.IP)
|
||||||
|
f.IPVarP(p, name, "", value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPP is like IP, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func (f *FlagSet) IPP(name, shorthand string, value net.IP, usage string) *net.IP {
|
||||||
|
p := new(net.IP)
|
||||||
|
f.IPVarP(p, name, shorthand, value, usage)
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// IP defines an net.IP flag with specified name, default value, and usage string.
|
||||||
|
// The return value is the address of an net.IP variable that stores the value of the flag.
|
||||||
|
func IP(name string, value net.IP, usage string) *net.IP {
|
||||||
|
return CommandLine.IPP(name, "", value, usage)
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPP is like IP, but accepts a shorthand letter that can be used after a single dash.
|
||||||
|
func IPP(name, shorthand string, value net.IP, usage string) *net.IP {
|
||||||
|
return CommandLine.IPP(name, shorthand, value, usage)
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user