diff --git a/.gitignore b/.gitignore index 7090e44..9b9a4a2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,20 +1,7 @@ -# Binaries for programs and plugins -*.exe -*.dll -*.so -*.dylib - -# Test binary, build with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 -.glide/ - -in *.bak *.swp -*~ -in-*.* +*.tmp +Cargo.lock +include.txt +release/ +target/ diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..268cf2f --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,12 @@ +[package] +name = "in" +version = "1.7.0" +authors = ["Alexander F. Rødseth "] +edition = "2018" + +# Dependencies +[dependencies] +clap = "2.33" +log = "0.4" +env_logger = "0.9" +glob = "0.3" diff --git a/README.md b/README.md index 73b915f..5f4d309 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,9 @@ # in ![Build](https://github.com/xyproto/in/workflows/Build/badge.svg) -A utility for running a command within another directory (or directories matching a glob pattern). +Utility to execute commands in directories, and create directories if needed. -It will also create the directories, if missing. If the top level directory is empty after executing the command, it will be removed. This means that `in testdirectory pwd` leaves no traces. When running in multiple directories, it will not create any new directories. - -NOTE: This project is a work in progress! Please don't use it in production just yet. +It will also create the directories, if missing. If the top level directory is empty after executing the command, it will be removed. This means that `in testdirectory pwd` leaves no traces. ## Example 1 @@ -46,31 +44,22 @@ Or: ## Example 3 -Globbing (note the double quotes to avoid shell expansion): +Globbing (note the double quotes to avoid shell expansion). No directories are created when using globbing, but the given command will be run in each directory where a matching file is found, for each matching file. in "./**/*pom.xml" mvn clean ## Installation -Either download the binary release (for 64-bit Linux), or install the development version (using `go install` like this requires Go 1.19 or later): - - go install github.com/xyproto/in@latest - -Manual installation, using `git`, `go`, `sudo` and `install`: +Manual installation, using `git`, `rust`, `sudo` and `install`: git clone https://github.com/xyproto/in cd in - go build - sudo install -Dm755 in /usr/bin/in - -## Dependencies - -* Go 1.19 or later - -When compiling with GCC 10.2.0 (`gccgo`), the `in` executable is only 41k here. + cargo build --release + mkdir -p /usr/bin + sudo install -m755 target/release/in /usr/bin/in ## General info -* Version: 1.6.0 +* Version: 1.7.0 * License: BSD-3 * Author: Alexander F. Rødseth <xyproto@archlinux.org> diff --git a/directory.go b/directory.go deleted file mode 100644 index 92311f2..0000000 --- a/directory.go +++ /dev/null @@ -1,103 +0,0 @@ -package main - -import ( - "fmt" - "os" - "path/filepath" - "strings" - "syscall" -) - -// getParentPermissions retrieves the file permissions of the closest existing parent of the given directory. -func getParentPermissions(dir string) (os.FileMode, error) { - parent := filepath.Dir(dir) - _, err := os.Stat(parent) - if os.IsNotExist(err) { - // If the parent doesn't exist, try the parent's parent, and so on. - return getParentPermissions(parent) - } else if err != nil { - return 0, err - } - - // If parent exists, retrieve its permissions - info, err := os.Stat(parent) - if err != nil { - return 0, err - } - return info.Mode().Perm(), nil -} - -// createAndEnter will create a directory if needed, and then enter it. -// Returns the number of directories created. -func createAndEnter(path string, verbose bool) (int, error) { - if verbose { - fmt.Printf("createAndEnter(%s)\n", path) - } - - if err := os.Chdir(path); err == nil { // success - return 0, nil - } else if !os.IsNotExist(err) { // an error that is something else than a missing directory - return 0, err - } - - perm, err := getParentPermissions(path) - if err != nil { - perm = 0o755 // default permission if parent permission couldn't be determined - } - - // Split the path into parts - parts := strings.Split(path, string(os.PathSeparator)) - if len(parts) == 0 { - return 0, fmt.Errorf("invalid path") - } - - dirCount := 0 - currentPath := parts[0] - - if len(path) > 0 && path[0] == os.PathSeparator { - currentPath = string(os.PathSeparator) + currentPath - } - - // Start from the root or the first directory and try creating each one - for _, part := range parts[1:] { - currentPath = filepath.Join(currentPath, part) - if err := os.Mkdir(currentPath, perm); err != nil { - if os.IsExist(err) { - continue - } - return dirCount, err - } - dirCount++ - } - - // Enter the directory - return dirCount, os.Chdir(path) -} - -// removeIfEmpty will remove the directory structure if all directories are empty -func removeIfEmpty(path string, depth int, verbose bool) error { - if verbose { - fmt.Printf("removeIfEmpty(%s, %d)\n", path, depth) - } - - if depth <= 0 { - return nil - } - - // Check if the path is a directory before attempting to remove it - if info, err := os.Stat(path); err == nil && !info.IsDir() { - return fmt.Errorf("path is not a directory: %s", path) - } - - if err := os.Remove(path); err != nil { - if os.IsNotExist(err) { - return nil // it's already gone, which is fine - } - if pathErr, ok := err.(*os.PathError); ok && pathErr.Err == syscall.ENOTEMPTY { - return nil // directory isn't empty, which is fine - } - return err - } - // if successful, move up to the parent directory and try again - return removeIfEmpty(filepath.Dir(path), depth-1, verbose) -} diff --git a/directory_test.go b/directory_test.go deleted file mode 100644 index f999dc3..0000000 --- a/directory_test.go +++ /dev/null @@ -1,93 +0,0 @@ -package main - -import ( - "os" - "path/filepath" - "testing" -) - -const verbose = true - -func TestCreateAndEnter(t *testing.T) { - t.Run("enter existing directory", func(t *testing.T) { - tmpDir, err := os.MkdirTemp("", "test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) - - created, err := createAndEnter(tmpDir, verbose) - if err != nil { - t.Fatalf("Expected no error, got %v", err) - } - if created != 0 { - t.Error("Expected no directories to be created since it exists") - } - }) - - t.Run("create and enter new directory", func(t *testing.T) { - tmpDir, err := os.MkdirTemp("", "test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) - - newDir := filepath.Join(tmpDir, "new-dir") - - created, err := createAndEnter(newDir, verbose) - if err != nil { - t.Fatalf("Expected no error, got %v", err) - } - if created == 0 { - t.Error("Expected at least one directory to be created since it doesn't exist") - } - }) - - t.Run("error for invalid directory", func(t *testing.T) { - invalidDir := "" // assuming empty string is an invalid directory - - created, err := createAndEnter(invalidDir, verbose) - if err == nil { - t.Fatalf("Expected an error for invalid directory") - } - if created != 0 { - t.Error("Expected no directories to be created due to an error") - } - }) - - t.Run("create multiple directories and remove if empty", func(t *testing.T) { - tmpDir, err := os.MkdirTemp("", "test") - if err != nil { - t.Fatal(err) - } - defer os.RemoveAll(tmpDir) - - multiDirPath := filepath.Join(tmpDir, "a/b/c") - - created, err := createAndEnter(multiDirPath, verbose) - if err != nil { - t.Fatalf("Expected no error, got %v", err) - } - if created == 0 { - t.Error("Expected directories to be created since they don't exist") - } - - cwd, err := os.Getwd() - if err != nil { - t.Fatalf("Failed to get current directory: %v", err) - } - if cwd != multiDirPath { - t.Errorf("Expected current directory to be %s, got %s", multiDirPath, cwd) - } - - err = removeIfEmpty(multiDirPath, created, verbose) // start removal from 'b', as 'c' is our current directory - if err != nil { - t.Fatalf("Expected no error while removing, got %v", err) - } - - _, err = os.Stat(filepath.Join(tmpDir, "a")) - if !os.IsNotExist(err) { - t.Error("Expected directory 'a' to be removed as it is empty") - } - }) -} diff --git a/go.mod b/go.mod deleted file mode 100644 index 860b62b..0000000 --- a/go.mod +++ /dev/null @@ -1,5 +0,0 @@ -module github.com/xyproto/in - -go 1.13 - -require github.com/urfave/cli/v2 v2.25.7 diff --git a/go.sum b/go.sum deleted file mode 100644 index 2b559e8..0000000 --- a/go.sum +++ /dev/null @@ -1,11 +0,0 @@ -github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= -github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= -github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= -github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= -github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs= -github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ= -github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU= -github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/in.1 b/in.1 index 954c866..c9f0f44 100644 --- a/in.1 +++ b/in.1 @@ -1,6 +1,6 @@ .\" -*-Nroff-*- .\" -.TH "in" 1 "14 Aug 2023" "" "" +.TH "in" 1 "15 Aug 2023" "" "" .SH NAME in \- execute a command in a given directory .SH SYNOPSIS @@ -12,7 +12,7 @@ Run the given command in the given directory, creating the directory if needed. If the top directory is empty after running the command, remove it. .sp .SH VERSION -1.6.0 +1.7.0 .SH BUGS No known bugs so far. Issues can be reported at: https://github.com/xyproto/in/issues .SH AUTHOR diff --git a/main.go b/main.go deleted file mode 100644 index ebaa986..0000000 --- a/main.go +++ /dev/null @@ -1,93 +0,0 @@ -package main - -import ( - "fmt" - "log" - "os" - "path/filepath" - "strings" - - "github.com/urfave/cli/v2" -) - -const versionString = "in 1.6.0" - -func main() { - app := &cli.App{ - Name: "in", - Usage: "for executing commands within directories and create them if needed", - Version: versionString, - Flags: []cli.Flag{ - &cli.BoolFlag{ - Name: "verbose", - Usage: "print verbose logs", - Aliases: []string{"V"}, - }, - }, - Action: func(c *cli.Context) error { - verbose := c.Bool("verbose") - - // If no arguments, print the current directory - if c.NArg() == 0 { - dir, err := os.Getwd() - if err != nil { - return err - } - resolvedDir, err := filepath.EvalSymlinks(dir) - if err != nil { - return err - } - fmt.Println(resolvedDir) - return nil - } - - // Target directory to operate within or glob pattern - dirOrPattern := c.Args().Get(0) - - if verbose { - fmt.Println("Directory or pattern:", dirOrPattern) - } - - // If it's a glob pattern, run the command in all matching directories - if strings.Contains(dirOrPattern, "*") { - return runInAllMatching(dirOrPattern, c.Args().Tail(), verbose) - } - - absDir, err := filepath.Abs(dirOrPattern) - if err != nil { - return err - } - - // Otherwise, it's treated as a directory - dirCreated, err := createAndEnter(dirOrPattern, verbose) - if err != nil { - return err - } - defer func() { - if verbose { - fmt.Printf("directories created: %d\n", dirCreated) - } - if dirCreated > 0 { - if err := removeIfEmpty(dirOrPattern, dirCreated, verbose); err != nil { - log.Println("Failed to remove the directory:", err) - } - } - }() - - // If there's a command to run, run it - if c.NArg() > 1 { - if verbose { - fmt.Println("Command:", c.Args().Tail()) - } - return run(absDir, c.Args().Tail(), verbose) - } - - return nil - }, - } - - err := app.Run(os.Args) - if err != nil { - log.Fatal(err) - } -} diff --git a/run.go b/run.go deleted file mode 100644 index c43f7c7..0000000 --- a/run.go +++ /dev/null @@ -1,69 +0,0 @@ -package main - -import ( - "fmt" - "os" - "os/exec" - "path/filepath" -) - -// run a command within the given directory -func run(directory string, commandArgs []string, verbose bool) error { - if verbose { - fmt.Printf("run(%s, %v, %v)\n", directory, commandArgs, verbose) - } - - commandName := commandArgs[0] - - cmd := exec.Command(commandName, commandArgs[1:]...) - - // Convert the given directory to an absolute path - absDirectory, err := filepath.Abs(directory) - if err != nil { - return err - } - - if verbose { - fmt.Printf("absdir: %s\ncommandName: %s\n", absDirectory, commandName) - } - - cmd.Dir = absDirectory - - // Append the PWD and INDIR environment variables - cmd.Env = append(os.Environ(), "PWD="+absDirectory) - cmd.Env = append(cmd.Env, "INDIR="+absDirectory) - - cmd.Stdout = os.Stdout - cmd.Stderr = os.Stderr - - if err := cmd.Start(); err != nil { - return err - } - return cmd.Wait() -} - -// runInAllMatching runs the given command in all the directories matching the given glob pattern -func runInAllMatching(pattern string, commandArgs []string, verbose bool) error { - if verbose { - fmt.Printf("runInAllMatching(%s, %v, %v)\n", pattern, commandArgs, verbose) - } - - matches, err := filepath.Glob(pattern) - if err != nil { - return err - } - - seenDirs := map[string]bool{} - for _, match := range matches { - dir := filepath.Dir(match) - if seenDirs[dir] { - continue // skip directories we've already seen - } - seenDirs[dir] = true - - if err := run(dir, commandArgs, verbose); err != nil { - return err - } - } - return nil -} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..fc61f01 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,119 @@ +extern crate clap; +extern crate env_logger; +extern crate log; + +use clap::{App, Arg}; +use glob::glob; +use log::{error, info}; +use std::fs; +use std::path::{Path, PathBuf}; +use std::process::Command; + +fn run_command_and_cleanup( + dir: &Path, + command_parts: &[&str], + created_dirs: &[PathBuf], +) -> Result<(), Box> { + run_command_in_dir(dir, command_parts)?; + cleanup_empty_directories_if_created(dir, created_dirs)?; + Ok(()) +} + +fn cleanup_empty_directories_if_created( + dir: &Path, + created_dirs: &[PathBuf], +) -> Result<(), Box> { + if created_dirs.contains(&dir.to_path_buf()) && is_directory_empty(dir)? { + fs::remove_dir(dir)?; + info!("Removed empty directory: {:?}", dir); + } + Ok(()) +} + +fn is_directory_empty(dir: &Path) -> Result> { + Ok(dir.read_dir()?.next().is_none()) +} + +fn ensure_directory_exists(path: &Path) -> Result, Box> { + let mut created_dirs = Vec::new(); + let mut current_path = path.to_path_buf(); + + if !current_path.exists() { + created_dirs.push(current_path.clone()); + fs::create_dir_all(¤t_path)?; + } + + while let Some(parent) = current_path.parent() { + if !parent.exists() { + created_dirs.push(parent.to_path_buf()); + } + current_path.pop(); + } + + Ok(created_dirs) +} + +fn run_command_in_dir( + dir: &Path, + command_parts: &[&str], +) -> Result<(), Box> { + info!("Running command in directory: {:?}", dir); + let status = Command::new(command_parts[0]) + .args(&command_parts[1..]) + .current_dir(dir) + .status()?; + + if !status.success() { + error!("Command exited with error."); + return Err(Box::new(std::io::Error::new( + std::io::ErrorKind::Other, + "Command execution failed", + ))); + } + Ok(()) +} + +fn main() -> Result<(), Box> { + env_logger::init(); + + let matches = App::new("in") + .version("1.7.0") + .author("Alexander F. Rødseth ") + .about("Utility to execute commands in directories, and create directories if needed.") + .arg( + Arg::with_name("DIRECTORY_OR_PATTERN") + .help("Target directory or pattern") + .required(true), + ) + .arg( + Arg::with_name("COMMAND") + .help("Command to run") + .required(true) + .multiple(true), + ) + .get_matches(); + + let path = matches.value_of("DIRECTORY_OR_PATTERN").unwrap(); + let command_parts: Vec<&str> = matches.values_of("COMMAND").unwrap().collect(); + + if path.contains("**") { + // Glob/wildcard mode + for entry in glob(path)? { + match entry { + Ok(path_buf) => { + if path_buf.is_file() { + let dir = path_buf.parent().unwrap_or(Path::new(".")); + run_command_in_dir(dir, &command_parts)?; + } + } + Err(e) => error!("Error with glob entry: {}", e), + } + } + } else { + // Standard mode + let path = PathBuf::from(path); + let created_dirs = ensure_directory_exists(&path)?; + run_command_and_cleanup(&path, &command_parts, &created_dirs)?; + } + Ok(()) +} diff --git a/vendor/github.com/cpuguy83/go-md2man/v2/LICENSE.md b/vendor/github.com/cpuguy83/go-md2man/v2/LICENSE.md deleted file mode 100644 index 1cade6c..0000000 --- a/vendor/github.com/cpuguy83/go-md2man/v2/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2014 Brian Goff - -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. diff --git a/vendor/github.com/cpuguy83/go-md2man/v2/md2man/md2man.go b/vendor/github.com/cpuguy83/go-md2man/v2/md2man/md2man.go deleted file mode 100644 index b480056..0000000 --- a/vendor/github.com/cpuguy83/go-md2man/v2/md2man/md2man.go +++ /dev/null @@ -1,14 +0,0 @@ -package md2man - -import ( - "github.com/russross/blackfriday/v2" -) - -// Render converts a markdown document into a roff formatted document. -func Render(doc []byte) []byte { - renderer := NewRoffRenderer() - - return blackfriday.Run(doc, - []blackfriday.Option{blackfriday.WithRenderer(renderer), - blackfriday.WithExtensions(renderer.GetExtensions())}...) -} diff --git a/vendor/github.com/cpuguy83/go-md2man/v2/md2man/roff.go b/vendor/github.com/cpuguy83/go-md2man/v2/md2man/roff.go deleted file mode 100644 index be2b343..0000000 --- a/vendor/github.com/cpuguy83/go-md2man/v2/md2man/roff.go +++ /dev/null @@ -1,336 +0,0 @@ -package md2man - -import ( - "fmt" - "io" - "os" - "strings" - - "github.com/russross/blackfriday/v2" -) - -// roffRenderer implements the blackfriday.Renderer interface for creating -// roff format (manpages) from markdown text -type roffRenderer struct { - extensions blackfriday.Extensions - listCounters []int - firstHeader bool - firstDD bool - listDepth int -} - -const ( - titleHeader = ".TH " - topLevelHeader = "\n\n.SH " - secondLevelHdr = "\n.SH " - otherHeader = "\n.SS " - crTag = "\n" - emphTag = "\\fI" - emphCloseTag = "\\fP" - strongTag = "\\fB" - strongCloseTag = "\\fP" - breakTag = "\n.br\n" - paraTag = "\n.PP\n" - hruleTag = "\n.ti 0\n\\l'\\n(.lu'\n" - linkTag = "\n\\[la]" - linkCloseTag = "\\[ra]" - codespanTag = "\\fB\\fC" - codespanCloseTag = "\\fR" - codeTag = "\n.PP\n.RS\n\n.nf\n" - codeCloseTag = "\n.fi\n.RE\n" - quoteTag = "\n.PP\n.RS\n" - quoteCloseTag = "\n.RE\n" - listTag = "\n.RS\n" - listCloseTag = "\n.RE\n" - dtTag = "\n.TP\n" - dd2Tag = "\n" - tableStart = "\n.TS\nallbox;\n" - tableEnd = ".TE\n" - tableCellStart = "T{\n" - tableCellEnd = "\nT}\n" -) - -// NewRoffRenderer creates a new blackfriday Renderer for generating roff documents -// from markdown -func NewRoffRenderer() *roffRenderer { // nolint: golint - var extensions blackfriday.Extensions - - extensions |= blackfriday.NoIntraEmphasis - extensions |= blackfriday.Tables - extensions |= blackfriday.FencedCode - extensions |= blackfriday.SpaceHeadings - extensions |= blackfriday.Footnotes - extensions |= blackfriday.Titleblock - extensions |= blackfriday.DefinitionLists - return &roffRenderer{ - extensions: extensions, - } -} - -// GetExtensions returns the list of extensions used by this renderer implementation -func (r *roffRenderer) GetExtensions() blackfriday.Extensions { - return r.extensions -} - -// RenderHeader handles outputting the header at document start -func (r *roffRenderer) RenderHeader(w io.Writer, ast *blackfriday.Node) { - // disable hyphenation - out(w, ".nh\n") -} - -// RenderFooter handles outputting the footer at the document end; the roff -// renderer has no footer information -func (r *roffRenderer) RenderFooter(w io.Writer, ast *blackfriday.Node) { -} - -// RenderNode is called for each node in a markdown document; based on the node -// type the equivalent roff output is sent to the writer -func (r *roffRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus { - - var walkAction = blackfriday.GoToNext - - switch node.Type { - case blackfriday.Text: - escapeSpecialChars(w, node.Literal) - case blackfriday.Softbreak: - out(w, crTag) - case blackfriday.Hardbreak: - out(w, breakTag) - case blackfriday.Emph: - if entering { - out(w, emphTag) - } else { - out(w, emphCloseTag) - } - case blackfriday.Strong: - if entering { - out(w, strongTag) - } else { - out(w, strongCloseTag) - } - case blackfriday.Link: - if !entering { - out(w, linkTag+string(node.LinkData.Destination)+linkCloseTag) - } - case blackfriday.Image: - // ignore images - walkAction = blackfriday.SkipChildren - case blackfriday.Code: - out(w, codespanTag) - escapeSpecialChars(w, node.Literal) - out(w, codespanCloseTag) - case blackfriday.Document: - break - case blackfriday.Paragraph: - // roff .PP markers break lists - if r.listDepth > 0 { - return blackfriday.GoToNext - } - if entering { - out(w, paraTag) - } else { - out(w, crTag) - } - case blackfriday.BlockQuote: - if entering { - out(w, quoteTag) - } else { - out(w, quoteCloseTag) - } - case blackfriday.Heading: - r.handleHeading(w, node, entering) - case blackfriday.HorizontalRule: - out(w, hruleTag) - case blackfriday.List: - r.handleList(w, node, entering) - case blackfriday.Item: - r.handleItem(w, node, entering) - case blackfriday.CodeBlock: - out(w, codeTag) - escapeSpecialChars(w, node.Literal) - out(w, codeCloseTag) - case blackfriday.Table: - r.handleTable(w, node, entering) - case blackfriday.TableHead: - case blackfriday.TableBody: - case blackfriday.TableRow: - // no action as cell entries do all the nroff formatting - return blackfriday.GoToNext - case blackfriday.TableCell: - r.handleTableCell(w, node, entering) - case blackfriday.HTMLSpan: - // ignore other HTML tags - default: - fmt.Fprintln(os.Stderr, "WARNING: go-md2man does not handle node type "+node.Type.String()) - } - return walkAction -} - -func (r *roffRenderer) handleHeading(w io.Writer, node *blackfriday.Node, entering bool) { - if entering { - switch node.Level { - case 1: - if !r.firstHeader { - out(w, titleHeader) - r.firstHeader = true - break - } - out(w, topLevelHeader) - case 2: - out(w, secondLevelHdr) - default: - out(w, otherHeader) - } - } -} - -func (r *roffRenderer) handleList(w io.Writer, node *blackfriday.Node, entering bool) { - openTag := listTag - closeTag := listCloseTag - if node.ListFlags&blackfriday.ListTypeDefinition != 0 { - // tags for definition lists handled within Item node - openTag = "" - closeTag = "" - } - if entering { - r.listDepth++ - if node.ListFlags&blackfriday.ListTypeOrdered != 0 { - r.listCounters = append(r.listCounters, 1) - } - out(w, openTag) - } else { - if node.ListFlags&blackfriday.ListTypeOrdered != 0 { - r.listCounters = r.listCounters[:len(r.listCounters)-1] - } - out(w, closeTag) - r.listDepth-- - } -} - -func (r *roffRenderer) handleItem(w io.Writer, node *blackfriday.Node, entering bool) { - if entering { - if node.ListFlags&blackfriday.ListTypeOrdered != 0 { - out(w, fmt.Sprintf(".IP \"%3d.\" 5\n", r.listCounters[len(r.listCounters)-1])) - r.listCounters[len(r.listCounters)-1]++ - } else if node.ListFlags&blackfriday.ListTypeTerm != 0 { - // DT (definition term): line just before DD (see below). - out(w, dtTag) - r.firstDD = true - } else if node.ListFlags&blackfriday.ListTypeDefinition != 0 { - // DD (definition description): line that starts with ": ". - // - // We have to distinguish between the first DD and the - // subsequent ones, as there should be no vertical - // whitespace between the DT and the first DD. - if r.firstDD { - r.firstDD = false - } else { - out(w, dd2Tag) - } - } else { - out(w, ".IP \\(bu 2\n") - } - } else { - out(w, "\n") - } -} - -func (r *roffRenderer) handleTable(w io.Writer, node *blackfriday.Node, entering bool) { - if entering { - out(w, tableStart) - // call walker to count cells (and rows?) so format section can be produced - columns := countColumns(node) - out(w, strings.Repeat("l ", columns)+"\n") - out(w, strings.Repeat("l ", columns)+".\n") - } else { - out(w, tableEnd) - } -} - -func (r *roffRenderer) handleTableCell(w io.Writer, node *blackfriday.Node, entering bool) { - if entering { - var start string - if node.Prev != nil && node.Prev.Type == blackfriday.TableCell { - start = "\t" - } - if node.IsHeader { - start += codespanTag - } else if nodeLiteralSize(node) > 30 { - start += tableCellStart - } - out(w, start) - } else { - var end string - if node.IsHeader { - end = codespanCloseTag - } else if nodeLiteralSize(node) > 30 { - end = tableCellEnd - } - if node.Next == nil && end != tableCellEnd { - // Last cell: need to carriage return if we are at the end of the - // header row and content isn't wrapped in a "tablecell" - end += crTag - } - out(w, end) - } -} - -func nodeLiteralSize(node *blackfriday.Node) int { - total := 0 - for n := node.FirstChild; n != nil; n = n.FirstChild { - total += len(n.Literal) - } - return total -} - -// because roff format requires knowing the column count before outputting any table -// data we need to walk a table tree and count the columns -func countColumns(node *blackfriday.Node) int { - var columns int - - node.Walk(func(node *blackfriday.Node, entering bool) blackfriday.WalkStatus { - switch node.Type { - case blackfriday.TableRow: - if !entering { - return blackfriday.Terminate - } - case blackfriday.TableCell: - if entering { - columns++ - } - default: - } - return blackfriday.GoToNext - }) - return columns -} - -func out(w io.Writer, output string) { - io.WriteString(w, output) // nolint: errcheck -} - -func escapeSpecialChars(w io.Writer, text []byte) { - for i := 0; i < len(text); i++ { - // escape initial apostrophe or period - if len(text) >= 1 && (text[0] == '\'' || text[0] == '.') { - out(w, "\\&") - } - - // directly copy normal characters - org := i - - for i < len(text) && text[i] != '\\' { - i++ - } - if i > org { - w.Write(text[org:i]) // nolint: errcheck - } - - // escape a character - if i >= len(text) { - break - } - - w.Write([]byte{'\\', text[i]}) // nolint: errcheck - } -} diff --git a/vendor/github.com/russross/blackfriday/v2/.gitignore b/vendor/github.com/russross/blackfriday/v2/.gitignore deleted file mode 100644 index 75623dc..0000000 --- a/vendor/github.com/russross/blackfriday/v2/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -*.out -*.swp -*.8 -*.6 -_obj -_test* -markdown -tags diff --git a/vendor/github.com/russross/blackfriday/v2/.travis.yml b/vendor/github.com/russross/blackfriday/v2/.travis.yml deleted file mode 100644 index b0b525a..0000000 --- a/vendor/github.com/russross/blackfriday/v2/.travis.yml +++ /dev/null @@ -1,17 +0,0 @@ -sudo: false -language: go -go: - - "1.10.x" - - "1.11.x" - - tip -matrix: - fast_finish: true - allow_failures: - - go: tip -install: - - # Do nothing. This is needed to prevent default install action "go get -t -v ./..." from happening here (we want it to happen inside script step). -script: - - go get -t -v ./... - - diff -u <(echo -n) <(gofmt -d -s .) - - go tool vet . - - go test -v ./... diff --git a/vendor/github.com/russross/blackfriday/v2/LICENSE.txt b/vendor/github.com/russross/blackfriday/v2/LICENSE.txt deleted file mode 100644 index 2885af3..0000000 --- a/vendor/github.com/russross/blackfriday/v2/LICENSE.txt +++ /dev/null @@ -1,29 +0,0 @@ -Blackfriday is distributed under the Simplified BSD License: - -> Copyright © 2011 Russ Ross -> All rights reserved. -> -> Redistribution and use in source and binary forms, with or without -> modification, are permitted provided that the following conditions -> are met: -> -> 1. Redistributions of source code must retain the above copyright -> notice, this list of conditions and the following disclaimer. -> -> 2. 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. -> -> 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 HOLDER 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. diff --git a/vendor/github.com/russross/blackfriday/v2/README.md b/vendor/github.com/russross/blackfriday/v2/README.md deleted file mode 100644 index d9c08a2..0000000 --- a/vendor/github.com/russross/blackfriday/v2/README.md +++ /dev/null @@ -1,335 +0,0 @@ -Blackfriday -[![Build Status][BuildV2SVG]][BuildV2URL] -[![PkgGoDev][PkgGoDevV2SVG]][PkgGoDevV2URL] -=========== - -Blackfriday is a [Markdown][1] processor implemented in [Go][2]. It -is paranoid about its input (so you can safely feed it user-supplied -data), it is fast, it supports common extensions (tables, smart -punctuation substitutions, etc.), and it is safe for all utf-8 -(unicode) input. - -HTML output is currently supported, along with Smartypants -extensions. - -It started as a translation from C of [Sundown][3]. - - -Installation ------------- - -Blackfriday is compatible with modern Go releases in module mode. -With Go installed: - - go get github.com/russross/blackfriday/v2 - -will resolve and add the package to the current development module, -then build and install it. Alternatively, you can achieve the same -if you import it in a package: - - import "github.com/russross/blackfriday/v2" - -and `go get` without parameters. - -Legacy GOPATH mode is unsupported. - - -Versions --------- - -Currently maintained and recommended version of Blackfriday is `v2`. It's being -developed on its own branch: https://github.com/russross/blackfriday/tree/v2 and the -documentation is available at -https://pkg.go.dev/github.com/russross/blackfriday/v2. - -It is `go get`-able in module mode at `github.com/russross/blackfriday/v2`. - -Version 2 offers a number of improvements over v1: - -* Cleaned up API -* A separate call to [`Parse`][4], which produces an abstract syntax tree for - the document -* Latest bug fixes -* Flexibility to easily add your own rendering extensions - -Potential drawbacks: - -* Our benchmarks show v2 to be slightly slower than v1. Currently in the - ballpark of around 15%. -* API breakage. If you can't afford modifying your code to adhere to the new API - and don't care too much about the new features, v2 is probably not for you. -* Several bug fixes are trailing behind and still need to be forward-ported to - v2. See issue [#348](https://github.com/russross/blackfriday/issues/348) for - tracking. - -If you are still interested in the legacy `v1`, you can import it from -`github.com/russross/blackfriday`. Documentation for the legacy v1 can be found -here: https://pkg.go.dev/github.com/russross/blackfriday. - - -Usage ------ - -For the most sensible markdown processing, it is as simple as getting your input -into a byte slice and calling: - -```go -output := blackfriday.Run(input) -``` - -Your input will be parsed and the output rendered with a set of most popular -extensions enabled. If you want the most basic feature set, corresponding with -the bare Markdown specification, use: - -```go -output := blackfriday.Run(input, blackfriday.WithNoExtensions()) -``` - -### Sanitize untrusted content - -Blackfriday itself does nothing to protect against malicious content. If you are -dealing with user-supplied markdown, we recommend running Blackfriday's output -through HTML sanitizer such as [Bluemonday][5]. - -Here's an example of simple usage of Blackfriday together with Bluemonday: - -```go -import ( - "github.com/microcosm-cc/bluemonday" - "github.com/russross/blackfriday/v2" -) - -// ... -unsafe := blackfriday.Run(input) -html := bluemonday.UGCPolicy().SanitizeBytes(unsafe) -``` - -### Custom options - -If you want to customize the set of options, use `blackfriday.WithExtensions`, -`blackfriday.WithRenderer` and `blackfriday.WithRefOverride`. - -### `blackfriday-tool` - -You can also check out `blackfriday-tool` for a more complete example -of how to use it. Download and install it using: - - go get github.com/russross/blackfriday-tool - -This is a simple command-line tool that allows you to process a -markdown file using a standalone program. You can also browse the -source directly on github if you are just looking for some example -code: - -* - -Note that if you have not already done so, installing -`blackfriday-tool` will be sufficient to download and install -blackfriday in addition to the tool itself. The tool binary will be -installed in `$GOPATH/bin`. This is a statically-linked binary that -can be copied to wherever you need it without worrying about -dependencies and library versions. - -### Sanitized anchor names - -Blackfriday includes an algorithm for creating sanitized anchor names -corresponding to a given input text. This algorithm is used to create -anchors for headings when `AutoHeadingIDs` extension is enabled. The -algorithm has a specification, so that other packages can create -compatible anchor names and links to those anchors. - -The specification is located at https://pkg.go.dev/github.com/russross/blackfriday/v2#hdr-Sanitized_Anchor_Names. - -[`SanitizedAnchorName`](https://pkg.go.dev/github.com/russross/blackfriday/v2#SanitizedAnchorName) exposes this functionality, and can be used to -create compatible links to the anchor names generated by blackfriday. -This algorithm is also implemented in a small standalone package at -[`github.com/shurcooL/sanitized_anchor_name`](https://pkg.go.dev/github.com/shurcooL/sanitized_anchor_name). It can be useful for clients -that want a small package and don't need full functionality of blackfriday. - - -Features --------- - -All features of Sundown are supported, including: - -* **Compatibility**. The Markdown v1.0.3 test suite passes with - the `--tidy` option. Without `--tidy`, the differences are - mostly in whitespace and entity escaping, where blackfriday is - more consistent and cleaner. - -* **Common extensions**, including table support, fenced code - blocks, autolinks, strikethroughs, non-strict emphasis, etc. - -* **Safety**. Blackfriday is paranoid when parsing, making it safe - to feed untrusted user input without fear of bad things - happening. The test suite stress tests this and there are no - known inputs that make it crash. If you find one, please let me - know and send me the input that does it. - - NOTE: "safety" in this context means *runtime safety only*. In order to - protect yourself against JavaScript injection in untrusted content, see - [this example](https://github.com/russross/blackfriday#sanitize-untrusted-content). - -* **Fast processing**. It is fast enough to render on-demand in - most web applications without having to cache the output. - -* **Thread safety**. You can run multiple parsers in different - goroutines without ill effect. There is no dependence on global - shared state. - -* **Minimal dependencies**. Blackfriday only depends on standard - library packages in Go. The source code is pretty - self-contained, so it is easy to add to any project, including - Google App Engine projects. - -* **Standards compliant**. Output successfully validates using the - W3C validation tool for HTML 4.01 and XHTML 1.0 Transitional. - - -Extensions ----------- - -In addition to the standard markdown syntax, this package -implements the following extensions: - -* **Intra-word emphasis supression**. The `_` character is - commonly used inside words when discussing code, so having - markdown interpret it as an emphasis command is usually the - wrong thing. Blackfriday lets you treat all emphasis markers as - normal characters when they occur inside a word. - -* **Tables**. Tables can be created by drawing them in the input - using a simple syntax: - - ``` - Name | Age - --------|------ - Bob | 27 - Alice | 23 - ``` - -* **Fenced code blocks**. In addition to the normal 4-space - indentation to mark code blocks, you can explicitly mark them - and supply a language (to make syntax highlighting simple). Just - mark it like this: - - ```go - func getTrue() bool { - return true - } - ``` - - You can use 3 or more backticks to mark the beginning of the - block, and the same number to mark the end of the block. - - To preserve classes of fenced code blocks while using the bluemonday - HTML sanitizer, use the following policy: - - ```go - p := bluemonday.UGCPolicy() - p.AllowAttrs("class").Matching(regexp.MustCompile("^language-[a-zA-Z0-9]+$")).OnElements("code") - html := p.SanitizeBytes(unsafe) - ``` - -* **Definition lists**. A simple definition list is made of a single-line - term followed by a colon and the definition for that term. - - Cat - : Fluffy animal everyone likes - - Internet - : Vector of transmission for pictures of cats - - Terms must be separated from the previous definition by a blank line. - -* **Footnotes**. A marker in the text that will become a superscript number; - a footnote definition that will be placed in a list of footnotes at the - end of the document. A footnote looks like this: - - This is a footnote.[^1] - - [^1]: the footnote text. - -* **Autolinking**. Blackfriday can find URLs that have not been - explicitly marked as links and turn them into links. - -* **Strikethrough**. Use two tildes (`~~`) to mark text that - should be crossed out. - -* **Hard line breaks**. With this extension enabled newlines in the input - translate into line breaks in the output. This extension is off by default. - -* **Smart quotes**. Smartypants-style punctuation substitution is - supported, turning normal double- and single-quote marks into - curly quotes, etc. - -* **LaTeX-style dash parsing** is an additional option, where `--` - is translated into `–`, and `---` is translated into - `—`. This differs from most smartypants processors, which - turn a single hyphen into an ndash and a double hyphen into an - mdash. - -* **Smart fractions**, where anything that looks like a fraction - is translated into suitable HTML (instead of just a few special - cases like most smartypant processors). For example, `4/5` - becomes `4⁄5`, which renders as - 4⁄5. - - -Other renderers ---------------- - -Blackfriday is structured to allow alternative rendering engines. Here -are a few of note: - -* [github_flavored_markdown](https://pkg.go.dev/github.com/shurcooL/github_flavored_markdown): - provides a GitHub Flavored Markdown renderer with fenced code block - highlighting, clickable heading anchor links. - - It's not customizable, and its goal is to produce HTML output - equivalent to the [GitHub Markdown API endpoint](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode), - except the rendering is performed locally. - -* [markdownfmt](https://github.com/shurcooL/markdownfmt): like gofmt, - but for markdown. - -* [LaTeX output](https://gitlab.com/ambrevar/blackfriday-latex): - renders output as LaTeX. - -* [bfchroma](https://github.com/Depado/bfchroma/): provides convenience - integration with the [Chroma](https://github.com/alecthomas/chroma) code - highlighting library. bfchroma is only compatible with v2 of Blackfriday and - provides a drop-in renderer ready to use with Blackfriday, as well as - options and means for further customization. - -* [Blackfriday-Confluence](https://github.com/kentaro-m/blackfriday-confluence): provides a [Confluence Wiki Markup](https://confluence.atlassian.com/doc/confluence-wiki-markup-251003035.html) renderer. - -* [Blackfriday-Slack](https://github.com/karriereat/blackfriday-slack): converts markdown to slack message style - - -TODO ----- - -* More unit testing -* Improve Unicode support. It does not understand all Unicode - rules (about what constitutes a letter, a punctuation symbol, - etc.), so it may fail to detect word boundaries correctly in - some instances. It is safe on all UTF-8 input. - - -License -------- - -[Blackfriday is distributed under the Simplified BSD License](LICENSE.txt) - - - [1]: https://daringfireball.net/projects/markdown/ "Markdown" - [2]: https://golang.org/ "Go Language" - [3]: https://github.com/vmg/sundown "Sundown" - [4]: https://pkg.go.dev/github.com/russross/blackfriday/v2#Parse "Parse func" - [5]: https://github.com/microcosm-cc/bluemonday "Bluemonday" - - [BuildV2SVG]: https://travis-ci.org/russross/blackfriday.svg?branch=v2 - [BuildV2URL]: https://travis-ci.org/russross/blackfriday - [PkgGoDevV2SVG]: https://pkg.go.dev/badge/github.com/russross/blackfriday/v2 - [PkgGoDevV2URL]: https://pkg.go.dev/github.com/russross/blackfriday/v2 diff --git a/vendor/github.com/russross/blackfriday/v2/block.go b/vendor/github.com/russross/blackfriday/v2/block.go deleted file mode 100644 index dcd61e6..0000000 --- a/vendor/github.com/russross/blackfriday/v2/block.go +++ /dev/null @@ -1,1612 +0,0 @@ -// -// Blackfriday Markdown Processor -// Available at http://github.com/russross/blackfriday -// -// Copyright © 2011 Russ Ross . -// Distributed under the Simplified BSD License. -// See README.md for details. -// - -// -// Functions to parse block-level elements. -// - -package blackfriday - -import ( - "bytes" - "html" - "regexp" - "strings" - "unicode" -) - -const ( - charEntity = "&(?:#x[a-f0-9]{1,8}|#[0-9]{1,8}|[a-z][a-z0-9]{1,31});" - escapable = "[!\"#$%&'()*+,./:;<=>?@[\\\\\\]^_`{|}~-]" -) - -var ( - reBackslashOrAmp = regexp.MustCompile("[\\&]") - reEntityOrEscapedChar = regexp.MustCompile("(?i)\\\\" + escapable + "|" + charEntity) -) - -// Parse block-level data. -// Note: this function and many that it calls assume that -// the input buffer ends with a newline. -func (p *Markdown) block(data []byte) { - // this is called recursively: enforce a maximum depth - if p.nesting >= p.maxNesting { - return - } - p.nesting++ - - // parse out one block-level construct at a time - for len(data) > 0 { - // prefixed heading: - // - // # Heading 1 - // ## Heading 2 - // ... - // ###### Heading 6 - if p.isPrefixHeading(data) { - data = data[p.prefixHeading(data):] - continue - } - - // block of preformatted HTML: - // - //
- // ... - //
- if data[0] == '<' { - if i := p.html(data, true); i > 0 { - data = data[i:] - continue - } - } - - // title block - // - // % stuff - // % more stuff - // % even more stuff - if p.extensions&Titleblock != 0 { - if data[0] == '%' { - if i := p.titleBlock(data, true); i > 0 { - data = data[i:] - continue - } - } - } - - // blank lines. note: returns the # of bytes to skip - if i := p.isEmpty(data); i > 0 { - data = data[i:] - continue - } - - // indented code block: - // - // func max(a, b int) int { - // if a > b { - // return a - // } - // return b - // } - if p.codePrefix(data) > 0 { - data = data[p.code(data):] - continue - } - - // fenced code block: - // - // ``` go - // func fact(n int) int { - // if n <= 1 { - // return n - // } - // return n * fact(n-1) - // } - // ``` - if p.extensions&FencedCode != 0 { - if i := p.fencedCodeBlock(data, true); i > 0 { - data = data[i:] - continue - } - } - - // horizontal rule: - // - // ------ - // or - // ****** - // or - // ______ - if p.isHRule(data) { - p.addBlock(HorizontalRule, nil) - var i int - for i = 0; i < len(data) && data[i] != '\n'; i++ { - } - data = data[i:] - continue - } - - // block quote: - // - // > A big quote I found somewhere - // > on the web - if p.quotePrefix(data) > 0 { - data = data[p.quote(data):] - continue - } - - // table: - // - // Name | Age | Phone - // ------|-----|--------- - // Bob | 31 | 555-1234 - // Alice | 27 | 555-4321 - if p.extensions&Tables != 0 { - if i := p.table(data); i > 0 { - data = data[i:] - continue - } - } - - // an itemized/unordered list: - // - // * Item 1 - // * Item 2 - // - // also works with + or - - if p.uliPrefix(data) > 0 { - data = data[p.list(data, 0):] - continue - } - - // a numbered/ordered list: - // - // 1. Item 1 - // 2. Item 2 - if p.oliPrefix(data) > 0 { - data = data[p.list(data, ListTypeOrdered):] - continue - } - - // definition lists: - // - // Term 1 - // : Definition a - // : Definition b - // - // Term 2 - // : Definition c - if p.extensions&DefinitionLists != 0 { - if p.dliPrefix(data) > 0 { - data = data[p.list(data, ListTypeDefinition):] - continue - } - } - - // anything else must look like a normal paragraph - // note: this finds underlined headings, too - data = data[p.paragraph(data):] - } - - p.nesting-- -} - -func (p *Markdown) addBlock(typ NodeType, content []byte) *Node { - p.closeUnmatchedBlocks() - container := p.addChild(typ, 0) - container.content = content - return container -} - -func (p *Markdown) isPrefixHeading(data []byte) bool { - if data[0] != '#' { - return false - } - - if p.extensions&SpaceHeadings != 0 { - level := 0 - for level < 6 && level < len(data) && data[level] == '#' { - level++ - } - if level == len(data) || data[level] != ' ' { - return false - } - } - return true -} - -func (p *Markdown) prefixHeading(data []byte) int { - level := 0 - for level < 6 && level < len(data) && data[level] == '#' { - level++ - } - i := skipChar(data, level, ' ') - end := skipUntilChar(data, i, '\n') - skip := end - id := "" - if p.extensions&HeadingIDs != 0 { - j, k := 0, 0 - // find start/end of heading id - for j = i; j < end-1 && (data[j] != '{' || data[j+1] != '#'); j++ { - } - for k = j + 1; k < end && data[k] != '}'; k++ { - } - // extract heading id iff found - if j < end && k < end { - id = string(data[j+2 : k]) - end = j - skip = k + 1 - for end > 0 && data[end-1] == ' ' { - end-- - } - } - } - for end > 0 && data[end-1] == '#' { - if isBackslashEscaped(data, end-1) { - break - } - end-- - } - for end > 0 && data[end-1] == ' ' { - end-- - } - if end > i { - if id == "" && p.extensions&AutoHeadingIDs != 0 { - id = SanitizedAnchorName(string(data[i:end])) - } - block := p.addBlock(Heading, data[i:end]) - block.HeadingID = id - block.Level = level - } - return skip -} - -func (p *Markdown) isUnderlinedHeading(data []byte) int { - // test of level 1 heading - if data[0] == '=' { - i := skipChar(data, 1, '=') - i = skipChar(data, i, ' ') - if i < len(data) && data[i] == '\n' { - return 1 - } - return 0 - } - - // test of level 2 heading - if data[0] == '-' { - i := skipChar(data, 1, '-') - i = skipChar(data, i, ' ') - if i < len(data) && data[i] == '\n' { - return 2 - } - return 0 - } - - return 0 -} - -func (p *Markdown) titleBlock(data []byte, doRender bool) int { - if data[0] != '%' { - return 0 - } - splitData := bytes.Split(data, []byte("\n")) - var i int - for idx, b := range splitData { - if !bytes.HasPrefix(b, []byte("%")) { - i = idx // - 1 - break - } - } - - data = bytes.Join(splitData[0:i], []byte("\n")) - consumed := len(data) - data = bytes.TrimPrefix(data, []byte("% ")) - data = bytes.Replace(data, []byte("\n% "), []byte("\n"), -1) - block := p.addBlock(Heading, data) - block.Level = 1 - block.IsTitleblock = true - - return consumed -} - -func (p *Markdown) html(data []byte, doRender bool) int { - var i, j int - - // identify the opening tag - if data[0] != '<' { - return 0 - } - curtag, tagfound := p.htmlFindTag(data[1:]) - - // handle special cases - if !tagfound { - // check for an HTML comment - if size := p.htmlComment(data, doRender); size > 0 { - return size - } - - // check for an
tag - if size := p.htmlHr(data, doRender); size > 0 { - return size - } - - // no special case recognized - return 0 - } - - // look for an unindented matching closing tag - // followed by a blank line - found := false - /* - closetag := []byte("\n") - j = len(curtag) + 1 - for !found { - // scan for a closing tag at the beginning of a line - if skip := bytes.Index(data[j:], closetag); skip >= 0 { - j += skip + len(closetag) - } else { - break - } - - // see if it is the only thing on the line - if skip := p.isEmpty(data[j:]); skip > 0 { - // see if it is followed by a blank line/eof - j += skip - if j >= len(data) { - found = true - i = j - } else { - if skip := p.isEmpty(data[j:]); skip > 0 { - j += skip - found = true - i = j - } - } - } - } - */ - - // if not found, try a second pass looking for indented match - // but not if tag is "ins" or "del" (following original Markdown.pl) - if !found && curtag != "ins" && curtag != "del" { - i = 1 - for i < len(data) { - i++ - for i < len(data) && !(data[i-1] == '<' && data[i] == '/') { - i++ - } - - if i+2+len(curtag) >= len(data) { - break - } - - j = p.htmlFindEnd(curtag, data[i-1:]) - - if j > 0 { - i += j - 1 - found = true - break - } - } - } - - if !found { - return 0 - } - - // the end of the block has been found - if doRender { - // trim newlines - end := i - for end > 0 && data[end-1] == '\n' { - end-- - } - finalizeHTMLBlock(p.addBlock(HTMLBlock, data[:end])) - } - - return i -} - -func finalizeHTMLBlock(block *Node) { - block.Literal = block.content - block.content = nil -} - -// HTML comment, lax form -func (p *Markdown) htmlComment(data []byte, doRender bool) int { - i := p.inlineHTMLComment(data) - // needs to end with a blank line - if j := p.isEmpty(data[i:]); j > 0 { - size := i + j - if doRender { - // trim trailing newlines - end := size - for end > 0 && data[end-1] == '\n' { - end-- - } - block := p.addBlock(HTMLBlock, data[:end]) - finalizeHTMLBlock(block) - } - return size - } - return 0 -} - -// HR, which is the only self-closing block tag considered -func (p *Markdown) htmlHr(data []byte, doRender bool) int { - if len(data) < 4 { - return 0 - } - if data[0] != '<' || (data[1] != 'h' && data[1] != 'H') || (data[2] != 'r' && data[2] != 'R') { - return 0 - } - if data[3] != ' ' && data[3] != '/' && data[3] != '>' { - // not an
tag after all; at least not a valid one - return 0 - } - i := 3 - for i < len(data) && data[i] != '>' && data[i] != '\n' { - i++ - } - if i < len(data) && data[i] == '>' { - i++ - if j := p.isEmpty(data[i:]); j > 0 { - size := i + j - if doRender { - // trim newlines - end := size - for end > 0 && data[end-1] == '\n' { - end-- - } - finalizeHTMLBlock(p.addBlock(HTMLBlock, data[:end])) - } - return size - } - } - return 0 -} - -func (p *Markdown) htmlFindTag(data []byte) (string, bool) { - i := 0 - for i < len(data) && isalnum(data[i]) { - i++ - } - key := string(data[:i]) - if _, ok := blockTags[key]; ok { - return key, true - } - return "", false -} - -func (p *Markdown) htmlFindEnd(tag string, data []byte) int { - // assume data[0] == '<' && data[1] == '/' already tested - if tag == "hr" { - return 2 - } - // check if tag is a match - closetag := []byte("") - if !bytes.HasPrefix(data, closetag) { - return 0 - } - i := len(closetag) - - // check that the rest of the line is blank - skip := 0 - if skip = p.isEmpty(data[i:]); skip == 0 { - return 0 - } - i += skip - skip = 0 - - if i >= len(data) { - return i - } - - if p.extensions&LaxHTMLBlocks != 0 { - return i - } - if skip = p.isEmpty(data[i:]); skip == 0 { - // following line must be blank - return 0 - } - - return i + skip -} - -func (*Markdown) isEmpty(data []byte) int { - // it is okay to call isEmpty on an empty buffer - if len(data) == 0 { - return 0 - } - - var i int - for i = 0; i < len(data) && data[i] != '\n'; i++ { - if data[i] != ' ' && data[i] != '\t' { - return 0 - } - } - if i < len(data) && data[i] == '\n' { - i++ - } - return i -} - -func (*Markdown) isHRule(data []byte) bool { - i := 0 - - // skip up to three spaces - for i < 3 && data[i] == ' ' { - i++ - } - - // look at the hrule char - if data[i] != '*' && data[i] != '-' && data[i] != '_' { - return false - } - c := data[i] - - // the whole line must be the char or whitespace - n := 0 - for i < len(data) && data[i] != '\n' { - switch { - case data[i] == c: - n++ - case data[i] != ' ': - return false - } - i++ - } - - return n >= 3 -} - -// isFenceLine checks if there's a fence line (e.g., ``` or ``` go) at the beginning of data, -// and returns the end index if so, or 0 otherwise. It also returns the marker found. -// If info is not nil, it gets set to the syntax specified in the fence line. -func isFenceLine(data []byte, info *string, oldmarker string) (end int, marker string) { - i, size := 0, 0 - - // skip up to three spaces - for i < len(data) && i < 3 && data[i] == ' ' { - i++ - } - - // check for the marker characters: ~ or ` - if i >= len(data) { - return 0, "" - } - if data[i] != '~' && data[i] != '`' { - return 0, "" - } - - c := data[i] - - // the whole line must be the same char or whitespace - for i < len(data) && data[i] == c { - size++ - i++ - } - - // the marker char must occur at least 3 times - if size < 3 { - return 0, "" - } - marker = string(data[i-size : i]) - - // if this is the end marker, it must match the beginning marker - if oldmarker != "" && marker != oldmarker { - return 0, "" - } - - // TODO(shurcooL): It's probably a good idea to simplify the 2 code paths here - // into one, always get the info string, and discard it if the caller doesn't care. - if info != nil { - infoLength := 0 - i = skipChar(data, i, ' ') - - if i >= len(data) { - if i == len(data) { - return i, marker - } - return 0, "" - } - - infoStart := i - - if data[i] == '{' { - i++ - infoStart++ - - for i < len(data) && data[i] != '}' && data[i] != '\n' { - infoLength++ - i++ - } - - if i >= len(data) || data[i] != '}' { - return 0, "" - } - - // strip all whitespace at the beginning and the end - // of the {} block - for infoLength > 0 && isspace(data[infoStart]) { - infoStart++ - infoLength-- - } - - for infoLength > 0 && isspace(data[infoStart+infoLength-1]) { - infoLength-- - } - i++ - i = skipChar(data, i, ' ') - } else { - for i < len(data) && !isverticalspace(data[i]) { - infoLength++ - i++ - } - } - - *info = strings.TrimSpace(string(data[infoStart : infoStart+infoLength])) - } - - if i == len(data) { - return i, marker - } - if i > len(data) || data[i] != '\n' { - return 0, "" - } - return i + 1, marker // Take newline into account. -} - -// fencedCodeBlock returns the end index if data contains a fenced code block at the beginning, -// or 0 otherwise. It writes to out if doRender is true, otherwise it has no side effects. -// If doRender is true, a final newline is mandatory to recognize the fenced code block. -func (p *Markdown) fencedCodeBlock(data []byte, doRender bool) int { - var info string - beg, marker := isFenceLine(data, &info, "") - if beg == 0 || beg >= len(data) { - return 0 - } - fenceLength := beg - 1 - - var work bytes.Buffer - work.Write([]byte(info)) - work.WriteByte('\n') - - for { - // safe to assume beg < len(data) - - // check for the end of the code block - fenceEnd, _ := isFenceLine(data[beg:], nil, marker) - if fenceEnd != 0 { - beg += fenceEnd - break - } - - // copy the current line - end := skipUntilChar(data, beg, '\n') + 1 - - // did we reach the end of the buffer without a closing marker? - if end >= len(data) { - return 0 - } - - // verbatim copy to the working buffer - if doRender { - work.Write(data[beg:end]) - } - beg = end - } - - if doRender { - block := p.addBlock(CodeBlock, work.Bytes()) // TODO: get rid of temp buffer - block.IsFenced = true - block.FenceLength = fenceLength - finalizeCodeBlock(block) - } - - return beg -} - -func unescapeChar(str []byte) []byte { - if str[0] == '\\' { - return []byte{str[1]} - } - return []byte(html.UnescapeString(string(str))) -} - -func unescapeString(str []byte) []byte { - if reBackslashOrAmp.Match(str) { - return reEntityOrEscapedChar.ReplaceAllFunc(str, unescapeChar) - } - return str -} - -func finalizeCodeBlock(block *Node) { - if block.IsFenced { - newlinePos := bytes.IndexByte(block.content, '\n') - firstLine := block.content[:newlinePos] - rest := block.content[newlinePos+1:] - block.Info = unescapeString(bytes.Trim(firstLine, "\n")) - block.Literal = rest - } else { - block.Literal = block.content - } - block.content = nil -} - -func (p *Markdown) table(data []byte) int { - table := p.addBlock(Table, nil) - i, columns := p.tableHeader(data) - if i == 0 { - p.tip = table.Parent - table.Unlink() - return 0 - } - - p.addBlock(TableBody, nil) - - for i < len(data) { - pipes, rowStart := 0, i - for ; i < len(data) && data[i] != '\n'; i++ { - if data[i] == '|' { - pipes++ - } - } - - if pipes == 0 { - i = rowStart - break - } - - // include the newline in data sent to tableRow - if i < len(data) && data[i] == '\n' { - i++ - } - p.tableRow(data[rowStart:i], columns, false) - } - - return i -} - -// check if the specified position is preceded by an odd number of backslashes -func isBackslashEscaped(data []byte, i int) bool { - backslashes := 0 - for i-backslashes-1 >= 0 && data[i-backslashes-1] == '\\' { - backslashes++ - } - return backslashes&1 == 1 -} - -func (p *Markdown) tableHeader(data []byte) (size int, columns []CellAlignFlags) { - i := 0 - colCount := 1 - for i = 0; i < len(data) && data[i] != '\n'; i++ { - if data[i] == '|' && !isBackslashEscaped(data, i) { - colCount++ - } - } - - // doesn't look like a table header - if colCount == 1 { - return - } - - // include the newline in the data sent to tableRow - j := i - if j < len(data) && data[j] == '\n' { - j++ - } - header := data[:j] - - // column count ignores pipes at beginning or end of line - if data[0] == '|' { - colCount-- - } - if i > 2 && data[i-1] == '|' && !isBackslashEscaped(data, i-1) { - colCount-- - } - - columns = make([]CellAlignFlags, colCount) - - // move on to the header underline - i++ - if i >= len(data) { - return - } - - if data[i] == '|' && !isBackslashEscaped(data, i) { - i++ - } - i = skipChar(data, i, ' ') - - // each column header is of form: / *:?-+:? *|/ with # dashes + # colons >= 3 - // and trailing | optional on last column - col := 0 - for i < len(data) && data[i] != '\n' { - dashes := 0 - - if data[i] == ':' { - i++ - columns[col] |= TableAlignmentLeft - dashes++ - } - for i < len(data) && data[i] == '-' { - i++ - dashes++ - } - if i < len(data) && data[i] == ':' { - i++ - columns[col] |= TableAlignmentRight - dashes++ - } - for i < len(data) && data[i] == ' ' { - i++ - } - if i == len(data) { - return - } - // end of column test is messy - switch { - case dashes < 3: - // not a valid column - return - - case data[i] == '|' && !isBackslashEscaped(data, i): - // marker found, now skip past trailing whitespace - col++ - i++ - for i < len(data) && data[i] == ' ' { - i++ - } - - // trailing junk found after last column - if col >= colCount && i < len(data) && data[i] != '\n' { - return - } - - case (data[i] != '|' || isBackslashEscaped(data, i)) && col+1 < colCount: - // something else found where marker was required - return - - case data[i] == '\n': - // marker is optional for the last column - col++ - - default: - // trailing junk found after last column - return - } - } - if col != colCount { - return - } - - p.addBlock(TableHead, nil) - p.tableRow(header, columns, true) - size = i - if size < len(data) && data[size] == '\n' { - size++ - } - return -} - -func (p *Markdown) tableRow(data []byte, columns []CellAlignFlags, header bool) { - p.addBlock(TableRow, nil) - i, col := 0, 0 - - if data[i] == '|' && !isBackslashEscaped(data, i) { - i++ - } - - for col = 0; col < len(columns) && i < len(data); col++ { - for i < len(data) && data[i] == ' ' { - i++ - } - - cellStart := i - - for i < len(data) && (data[i] != '|' || isBackslashEscaped(data, i)) && data[i] != '\n' { - i++ - } - - cellEnd := i - - // skip the end-of-cell marker, possibly taking us past end of buffer - i++ - - for cellEnd > cellStart && cellEnd-1 < len(data) && data[cellEnd-1] == ' ' { - cellEnd-- - } - - cell := p.addBlock(TableCell, data[cellStart:cellEnd]) - cell.IsHeader = header - cell.Align = columns[col] - } - - // pad it out with empty columns to get the right number - for ; col < len(columns); col++ { - cell := p.addBlock(TableCell, nil) - cell.IsHeader = header - cell.Align = columns[col] - } - - // silently ignore rows with too many cells -} - -// returns blockquote prefix length -func (p *Markdown) quotePrefix(data []byte) int { - i := 0 - for i < 3 && i < len(data) && data[i] == ' ' { - i++ - } - if i < len(data) && data[i] == '>' { - if i+1 < len(data) && data[i+1] == ' ' { - return i + 2 - } - return i + 1 - } - return 0 -} - -// blockquote ends with at least one blank line -// followed by something without a blockquote prefix -func (p *Markdown) terminateBlockquote(data []byte, beg, end int) bool { - if p.isEmpty(data[beg:]) <= 0 { - return false - } - if end >= len(data) { - return true - } - return p.quotePrefix(data[end:]) == 0 && p.isEmpty(data[end:]) == 0 -} - -// parse a blockquote fragment -func (p *Markdown) quote(data []byte) int { - block := p.addBlock(BlockQuote, nil) - var raw bytes.Buffer - beg, end := 0, 0 - for beg < len(data) { - end = beg - // Step over whole lines, collecting them. While doing that, check for - // fenced code and if one's found, incorporate it altogether, - // irregardless of any contents inside it - for end < len(data) && data[end] != '\n' { - if p.extensions&FencedCode != 0 { - if i := p.fencedCodeBlock(data[end:], false); i > 0 { - // -1 to compensate for the extra end++ after the loop: - end += i - 1 - break - } - } - end++ - } - if end < len(data) && data[end] == '\n' { - end++ - } - if pre := p.quotePrefix(data[beg:]); pre > 0 { - // skip the prefix - beg += pre - } else if p.terminateBlockquote(data, beg, end) { - break - } - // this line is part of the blockquote - raw.Write(data[beg:end]) - beg = end - } - p.block(raw.Bytes()) - p.finalize(block) - return end -} - -// returns prefix length for block code -func (p *Markdown) codePrefix(data []byte) int { - if len(data) >= 1 && data[0] == '\t' { - return 1 - } - if len(data) >= 4 && data[0] == ' ' && data[1] == ' ' && data[2] == ' ' && data[3] == ' ' { - return 4 - } - return 0 -} - -func (p *Markdown) code(data []byte) int { - var work bytes.Buffer - - i := 0 - for i < len(data) { - beg := i - for i < len(data) && data[i] != '\n' { - i++ - } - if i < len(data) && data[i] == '\n' { - i++ - } - - blankline := p.isEmpty(data[beg:i]) > 0 - if pre := p.codePrefix(data[beg:i]); pre > 0 { - beg += pre - } else if !blankline { - // non-empty, non-prefixed line breaks the pre - i = beg - break - } - - // verbatim copy to the working buffer - if blankline { - work.WriteByte('\n') - } else { - work.Write(data[beg:i]) - } - } - - // trim all the \n off the end of work - workbytes := work.Bytes() - eol := len(workbytes) - for eol > 0 && workbytes[eol-1] == '\n' { - eol-- - } - if eol != len(workbytes) { - work.Truncate(eol) - } - - work.WriteByte('\n') - - block := p.addBlock(CodeBlock, work.Bytes()) // TODO: get rid of temp buffer - block.IsFenced = false - finalizeCodeBlock(block) - - return i -} - -// returns unordered list item prefix -func (p *Markdown) uliPrefix(data []byte) int { - i := 0 - // start with up to 3 spaces - for i < len(data) && i < 3 && data[i] == ' ' { - i++ - } - if i >= len(data)-1 { - return 0 - } - // need one of {'*', '+', '-'} followed by a space or a tab - if (data[i] != '*' && data[i] != '+' && data[i] != '-') || - (data[i+1] != ' ' && data[i+1] != '\t') { - return 0 - } - return i + 2 -} - -// returns ordered list item prefix -func (p *Markdown) oliPrefix(data []byte) int { - i := 0 - - // start with up to 3 spaces - for i < 3 && i < len(data) && data[i] == ' ' { - i++ - } - - // count the digits - start := i - for i < len(data) && data[i] >= '0' && data[i] <= '9' { - i++ - } - if start == i || i >= len(data)-1 { - return 0 - } - - // we need >= 1 digits followed by a dot and a space or a tab - if data[i] != '.' || !(data[i+1] == ' ' || data[i+1] == '\t') { - return 0 - } - return i + 2 -} - -// returns definition list item prefix -func (p *Markdown) dliPrefix(data []byte) int { - if len(data) < 2 { - return 0 - } - i := 0 - // need a ':' followed by a space or a tab - if data[i] != ':' || !(data[i+1] == ' ' || data[i+1] == '\t') { - return 0 - } - for i < len(data) && data[i] == ' ' { - i++ - } - return i + 2 -} - -// parse ordered or unordered list block -func (p *Markdown) list(data []byte, flags ListType) int { - i := 0 - flags |= ListItemBeginningOfList - block := p.addBlock(List, nil) - block.ListFlags = flags - block.Tight = true - - for i < len(data) { - skip := p.listItem(data[i:], &flags) - if flags&ListItemContainsBlock != 0 { - block.ListData.Tight = false - } - i += skip - if skip == 0 || flags&ListItemEndOfList != 0 { - break - } - flags &= ^ListItemBeginningOfList - } - - above := block.Parent - finalizeList(block) - p.tip = above - return i -} - -// Returns true if the list item is not the same type as its parent list -func (p *Markdown) listTypeChanged(data []byte, flags *ListType) bool { - if p.dliPrefix(data) > 0 && *flags&ListTypeDefinition == 0 { - return true - } else if p.oliPrefix(data) > 0 && *flags&ListTypeOrdered == 0 { - return true - } else if p.uliPrefix(data) > 0 && (*flags&ListTypeOrdered != 0 || *flags&ListTypeDefinition != 0) { - return true - } - return false -} - -// Returns true if block ends with a blank line, descending if needed -// into lists and sublists. -func endsWithBlankLine(block *Node) bool { - // TODO: figure this out. Always false now. - for block != nil { - //if block.lastLineBlank { - //return true - //} - t := block.Type - if t == List || t == Item { - block = block.LastChild - } else { - break - } - } - return false -} - -func finalizeList(block *Node) { - block.open = false - item := block.FirstChild - for item != nil { - // check for non-final list item ending with blank line: - if endsWithBlankLine(item) && item.Next != nil { - block.ListData.Tight = false - break - } - // recurse into children of list item, to see if there are spaces - // between any of them: - subItem := item.FirstChild - for subItem != nil { - if endsWithBlankLine(subItem) && (item.Next != nil || subItem.Next != nil) { - block.ListData.Tight = false - break - } - subItem = subItem.Next - } - item = item.Next - } -} - -// Parse a single list item. -// Assumes initial prefix is already removed if this is a sublist. -func (p *Markdown) listItem(data []byte, flags *ListType) int { - // keep track of the indentation of the first line - itemIndent := 0 - if data[0] == '\t' { - itemIndent += 4 - } else { - for itemIndent < 3 && data[itemIndent] == ' ' { - itemIndent++ - } - } - - var bulletChar byte = '*' - i := p.uliPrefix(data) - if i == 0 { - i = p.oliPrefix(data) - } else { - bulletChar = data[i-2] - } - if i == 0 { - i = p.dliPrefix(data) - // reset definition term flag - if i > 0 { - *flags &= ^ListTypeTerm - } - } - if i == 0 { - // if in definition list, set term flag and continue - if *flags&ListTypeDefinition != 0 { - *flags |= ListTypeTerm - } else { - return 0 - } - } - - // skip leading whitespace on first line - for i < len(data) && data[i] == ' ' { - i++ - } - - // find the end of the line - line := i - for i > 0 && i < len(data) && data[i-1] != '\n' { - i++ - } - - // get working buffer - var raw bytes.Buffer - - // put the first line into the working buffer - raw.Write(data[line:i]) - line = i - - // process the following lines - containsBlankLine := false - sublist := 0 - codeBlockMarker := "" - -gatherlines: - for line < len(data) { - i++ - - // find the end of this line - for i < len(data) && data[i-1] != '\n' { - i++ - } - - // if it is an empty line, guess that it is part of this item - // and move on to the next line - if p.isEmpty(data[line:i]) > 0 { - containsBlankLine = true - line = i - continue - } - - // calculate the indentation - indent := 0 - indentIndex := 0 - if data[line] == '\t' { - indentIndex++ - indent += 4 - } else { - for indent < 4 && line+indent < i && data[line+indent] == ' ' { - indent++ - indentIndex++ - } - } - - chunk := data[line+indentIndex : i] - - if p.extensions&FencedCode != 0 { - // determine if in or out of codeblock - // if in codeblock, ignore normal list processing - _, marker := isFenceLine(chunk, nil, codeBlockMarker) - if marker != "" { - if codeBlockMarker == "" { - // start of codeblock - codeBlockMarker = marker - } else { - // end of codeblock. - codeBlockMarker = "" - } - } - // we are in a codeblock, write line, and continue - if codeBlockMarker != "" || marker != "" { - raw.Write(data[line+indentIndex : i]) - line = i - continue gatherlines - } - } - - // evaluate how this line fits in - switch { - // is this a nested list item? - case (p.uliPrefix(chunk) > 0 && !p.isHRule(chunk)) || - p.oliPrefix(chunk) > 0 || - p.dliPrefix(chunk) > 0: - - // to be a nested list, it must be indented more - // if not, it is either a different kind of list - // or the next item in the same list - if indent <= itemIndent { - if p.listTypeChanged(chunk, flags) { - *flags |= ListItemEndOfList - } else if containsBlankLine { - *flags |= ListItemContainsBlock - } - - break gatherlines - } - - if containsBlankLine { - *flags |= ListItemContainsBlock - } - - // is this the first item in the nested list? - if sublist == 0 { - sublist = raw.Len() - } - - // is this a nested prefix heading? - case p.isPrefixHeading(chunk): - // if the heading is not indented, it is not nested in the list - // and thus ends the list - if containsBlankLine && indent < 4 { - *flags |= ListItemEndOfList - break gatherlines - } - *flags |= ListItemContainsBlock - - // anything following an empty line is only part - // of this item if it is indented 4 spaces - // (regardless of the indentation of the beginning of the item) - case containsBlankLine && indent < 4: - if *flags&ListTypeDefinition != 0 && i < len(data)-1 { - // is the next item still a part of this list? - next := i - for next < len(data) && data[next] != '\n' { - next++ - } - for next < len(data)-1 && data[next] == '\n' { - next++ - } - if i < len(data)-1 && data[i] != ':' && data[next] != ':' { - *flags |= ListItemEndOfList - } - } else { - *flags |= ListItemEndOfList - } - break gatherlines - - // a blank line means this should be parsed as a block - case containsBlankLine: - raw.WriteByte('\n') - *flags |= ListItemContainsBlock - } - - // if this line was preceded by one or more blanks, - // re-introduce the blank into the buffer - if containsBlankLine { - containsBlankLine = false - raw.WriteByte('\n') - } - - // add the line into the working buffer without prefix - raw.Write(data[line+indentIndex : i]) - - line = i - } - - rawBytes := raw.Bytes() - - block := p.addBlock(Item, nil) - block.ListFlags = *flags - block.Tight = false - block.BulletChar = bulletChar - block.Delimiter = '.' // Only '.' is possible in Markdown, but ')' will also be possible in CommonMark - - // render the contents of the list item - if *flags&ListItemContainsBlock != 0 && *flags&ListTypeTerm == 0 { - // intermediate render of block item, except for definition term - if sublist > 0 { - p.block(rawBytes[:sublist]) - p.block(rawBytes[sublist:]) - } else { - p.block(rawBytes) - } - } else { - // intermediate render of inline item - if sublist > 0 { - child := p.addChild(Paragraph, 0) - child.content = rawBytes[:sublist] - p.block(rawBytes[sublist:]) - } else { - child := p.addChild(Paragraph, 0) - child.content = rawBytes - } - } - return line -} - -// render a single paragraph that has already been parsed out -func (p *Markdown) renderParagraph(data []byte) { - if len(data) == 0 { - return - } - - // trim leading spaces - beg := 0 - for data[beg] == ' ' { - beg++ - } - - end := len(data) - // trim trailing newline - if data[len(data)-1] == '\n' { - end-- - } - - // trim trailing spaces - for end > beg && data[end-1] == ' ' { - end-- - } - - p.addBlock(Paragraph, data[beg:end]) -} - -func (p *Markdown) paragraph(data []byte) int { - // prev: index of 1st char of previous line - // line: index of 1st char of current line - // i: index of cursor/end of current line - var prev, line, i int - tabSize := TabSizeDefault - if p.extensions&TabSizeEight != 0 { - tabSize = TabSizeDouble - } - // keep going until we find something to mark the end of the paragraph - for i < len(data) { - // mark the beginning of the current line - prev = line - current := data[i:] - line = i - - // did we find a reference or a footnote? If so, end a paragraph - // preceding it and report that we have consumed up to the end of that - // reference: - if refEnd := isReference(p, current, tabSize); refEnd > 0 { - p.renderParagraph(data[:i]) - return i + refEnd - } - - // did we find a blank line marking the end of the paragraph? - if n := p.isEmpty(current); n > 0 { - // did this blank line followed by a definition list item? - if p.extensions&DefinitionLists != 0 { - if i < len(data)-1 && data[i+1] == ':' { - return p.list(data[prev:], ListTypeDefinition) - } - } - - p.renderParagraph(data[:i]) - return i + n - } - - // an underline under some text marks a heading, so our paragraph ended on prev line - if i > 0 { - if level := p.isUnderlinedHeading(current); level > 0 { - // render the paragraph - p.renderParagraph(data[:prev]) - - // ignore leading and trailing whitespace - eol := i - 1 - for prev < eol && data[prev] == ' ' { - prev++ - } - for eol > prev && data[eol-1] == ' ' { - eol-- - } - - id := "" - if p.extensions&AutoHeadingIDs != 0 { - id = SanitizedAnchorName(string(data[prev:eol])) - } - - block := p.addBlock(Heading, data[prev:eol]) - block.Level = level - block.HeadingID = id - - // find the end of the underline - for i < len(data) && data[i] != '\n' { - i++ - } - return i - } - } - - // if the next line starts a block of HTML, then the paragraph ends here - if p.extensions&LaxHTMLBlocks != 0 { - if data[i] == '<' && p.html(current, false) > 0 { - // rewind to before the HTML block - p.renderParagraph(data[:i]) - return i - } - } - - // if there's a prefixed heading or a horizontal rule after this, paragraph is over - if p.isPrefixHeading(current) || p.isHRule(current) { - p.renderParagraph(data[:i]) - return i - } - - // if there's a fenced code block, paragraph is over - if p.extensions&FencedCode != 0 { - if p.fencedCodeBlock(current, false) > 0 { - p.renderParagraph(data[:i]) - return i - } - } - - // if there's a definition list item, prev line is a definition term - if p.extensions&DefinitionLists != 0 { - if p.dliPrefix(current) != 0 { - ret := p.list(data[prev:], ListTypeDefinition) - return ret - } - } - - // if there's a list after this, paragraph is over - if p.extensions&NoEmptyLineBeforeBlock != 0 { - if p.uliPrefix(current) != 0 || - p.oliPrefix(current) != 0 || - p.quotePrefix(current) != 0 || - p.codePrefix(current) != 0 { - p.renderParagraph(data[:i]) - return i - } - } - - // otherwise, scan to the beginning of the next line - nl := bytes.IndexByte(data[i:], '\n') - if nl >= 0 { - i += nl + 1 - } else { - i += len(data[i:]) - } - } - - p.renderParagraph(data[:i]) - return i -} - -func skipChar(data []byte, start int, char byte) int { - i := start - for i < len(data) && data[i] == char { - i++ - } - return i -} - -func skipUntilChar(text []byte, start int, char byte) int { - i := start - for i < len(text) && text[i] != char { - i++ - } - return i -} - -// SanitizedAnchorName returns a sanitized anchor name for the given text. -// -// It implements the algorithm specified in the package comment. -func SanitizedAnchorName(text string) string { - var anchorName []rune - futureDash := false - for _, r := range text { - switch { - case unicode.IsLetter(r) || unicode.IsNumber(r): - if futureDash && len(anchorName) > 0 { - anchorName = append(anchorName, '-') - } - futureDash = false - anchorName = append(anchorName, unicode.ToLower(r)) - default: - futureDash = true - } - } - return string(anchorName) -} diff --git a/vendor/github.com/russross/blackfriday/v2/doc.go b/vendor/github.com/russross/blackfriday/v2/doc.go deleted file mode 100644 index 57ff152..0000000 --- a/vendor/github.com/russross/blackfriday/v2/doc.go +++ /dev/null @@ -1,46 +0,0 @@ -// Package blackfriday is a markdown processor. -// -// It translates plain text with simple formatting rules into an AST, which can -// then be further processed to HTML (provided by Blackfriday itself) or other -// formats (provided by the community). -// -// The simplest way to invoke Blackfriday is to call the Run function. It will -// take a text input and produce a text output in HTML (or other format). -// -// A slightly more sophisticated way to use Blackfriday is to create a Markdown -// processor and to call Parse, which returns a syntax tree for the input -// document. You can leverage Blackfriday's parsing for content extraction from -// markdown documents. You can assign a custom renderer and set various options -// to the Markdown processor. -// -// If you're interested in calling Blackfriday from command line, see -// https://github.com/russross/blackfriday-tool. -// -// Sanitized Anchor Names -// -// Blackfriday includes an algorithm for creating sanitized anchor names -// corresponding to a given input text. This algorithm is used to create -// anchors for headings when AutoHeadingIDs extension is enabled. The -// algorithm is specified below, so that other packages can create -// compatible anchor names and links to those anchors. -// -// The algorithm iterates over the input text, interpreted as UTF-8, -// one Unicode code point (rune) at a time. All runes that are letters (category L) -// or numbers (category N) are considered valid characters. They are mapped to -// lower case, and included in the output. All other runes are considered -// invalid characters. Invalid characters that precede the first valid character, -// as well as invalid character that follow the last valid character -// are dropped completely. All other sequences of invalid characters -// between two valid characters are replaced with a single dash character '-'. -// -// SanitizedAnchorName exposes this functionality, and can be used to -// create compatible links to the anchor names generated by blackfriday. -// This algorithm is also implemented in a small standalone package at -// github.com/shurcooL/sanitized_anchor_name. It can be useful for clients -// that want a small package and don't need full functionality of blackfriday. -package blackfriday - -// NOTE: Keep Sanitized Anchor Name algorithm in sync with package -// github.com/shurcooL/sanitized_anchor_name. -// Otherwise, users of sanitized_anchor_name will get anchor names -// that are incompatible with those generated by blackfriday. diff --git a/vendor/github.com/russross/blackfriday/v2/entities.go b/vendor/github.com/russross/blackfriday/v2/entities.go deleted file mode 100644 index a2c3edb..0000000 --- a/vendor/github.com/russross/blackfriday/v2/entities.go +++ /dev/null @@ -1,2236 +0,0 @@ -package blackfriday - -// Extracted from https://html.spec.whatwg.org/multipage/entities.json -var entities = map[string]bool{ - "Æ": true, - "Æ": true, - "&": true, - "&": true, - "Á": true, - "Á": true, - "Ă": true, - "Â": true, - "Â": true, - "А": true, - "𝔄": true, - "À": true, - "À": true, - "Α": true, - "Ā": true, - "⩓": true, - "Ą": true, - "𝔸": true, - "⁡": true, - "Å": true, - "Å": true, - "𝒜": true, - "≔": true, - "Ã": true, - "Ã": true, - "Ä": true, - "Ä": true, - "∖": true, - "⫧": true, - "⌆": true, - "Б": true, - "∵": true, - "ℬ": true, - "Β": true, - "𝔅": true, - "𝔹": true, - "˘": true, - "ℬ": true, - "≎": true, - "Ч": true, - "©": true, - "©": true, - "Ć": true, - "⋒": true, - "ⅅ": true, - "ℭ": true, - "Č": true, - "Ç": true, - "Ç": true, - "Ĉ": true, - "∰": true, - "Ċ": true, - "¸": true, - "·": true, - "ℭ": true, - "Χ": true, - "⊙": true, - "⊖": true, - "⊕": true, - "⊗": true, - "∲": true, - "”": true, - "’": true, - "∷": true, - "⩴": true, - "≡": true, - "∯": true, - "∮": true, - "ℂ": true, - "∐": true, - "∳": true, - "⨯": true, - "𝒞": true, - "⋓": true, - "≍": true, - "ⅅ": true, - "⤑": true, - "Ђ": true, - "Ѕ": true, - "Џ": true, - "‡": true, - "↡": true, - "⫤": true, - "Ď": true, - "Д": true, - "∇": true, - "Δ": true, - "𝔇": true, - "´": true, - "˙": true, - "˝": true, - "`": true, - "˜": true, - "⋄": true, - "ⅆ": true, - "𝔻": true, - "¨": true, - "⃜": true, - "≐": true, - "∯": true, - "¨": true, - "⇓": true, - "⇐": true, - "⇔": true, - "⫤": true, - "⟸": true, - "⟺": true, - "⟹": true, - "⇒": true, - "⊨": true, - "⇑": true, - "⇕": true, - "∥": true, - "↓": true, - "⤓": true, - "⇵": true, - "̑": true, - "⥐": true, - "⥞": true, - "↽": true, - "⥖": true, - "⥟": true, - "⇁": true, - "⥗": true, - "⊤": true, - "↧": true, - "⇓": true, - "𝒟": true, - "Đ": true, - "Ŋ": true, - "Ð": true, - "Ð": true, - "É": true, - "É": true, - "Ě": true, - "Ê": true, - "Ê": true, - "Э": true, - "Ė": true, - "𝔈": true, - "È": true, - "È": true, - "∈": true, - "Ē": true, - "◻": true, - "▫": true, - "Ę": true, - "𝔼": true, - "Ε": true, - "⩵": true, - "≂": true, - "⇌": true, - "ℰ": true, - "⩳": true, - "Η": true, - "Ë": true, - "Ë": true, - "∃": true, - "ⅇ": true, - "Ф": true, - "𝔉": true, - "◼": true, - "▪": true, - "𝔽": true, - "∀": true, - "ℱ": true, - "ℱ": true, - "Ѓ": true, - ">": true, - ">": true, - "Γ": true, - "Ϝ": true, - "Ğ": true, - "Ģ": true, - "Ĝ": true, - "Г": true, - "Ġ": true, - "𝔊": true, - "⋙": true, - "𝔾": true, - "≥": true, - "⋛": true, - "≧": true, - "⪢": true, - "≷": true, - "⩾": true, - "≳": true, - "𝒢": true, - "≫": true, - "Ъ": true, - "ˇ": true, - "^": true, - "Ĥ": true, - "ℌ": true, - "ℋ": true, - "ℍ": true, - "─": true, - "ℋ": true, - "Ħ": true, - "≎": true, - "≏": true, - "Е": true, - "IJ": true, - "Ё": true, - "Í": true, - "Í": true, - "Î": true, - "Î": true, - "И": true, - "İ": true, - "ℑ": true, - "Ì": true, - "Ì": true, - "ℑ": true, - "Ī": true, - "ⅈ": true, - "⇒": true, - "∬": true, - "∫": true, - "⋂": true, - "⁣": true, - "⁢": true, - "Į": true, - "𝕀": true, - "Ι": true, - "ℐ": true, - "Ĩ": true, - "І": true, - "Ï": true, - "Ï": true, - "Ĵ": true, - "Й": true, - "𝔍": true, - "𝕁": true, - "𝒥": true, - "Ј": true, - "Є": true, - "Х": true, - "Ќ": true, - "Κ": true, - "Ķ": true, - "К": true, - "𝔎": true, - "𝕂": true, - "𝒦": true, - "Љ": true, - "<": true, - "<": true, - "Ĺ": true, - "Λ": true, - "⟪": true, - "ℒ": true, - "↞": true, - "Ľ": true, - "Ļ": true, - "Л": true, - "⟨": true, - "←": true, - "⇤": true, - "⇆": true, - "⌈": true, - "⟦": true, - "⥡": true, - "⇃": true, - "⥙": true, - "⌊": true, - "↔": true, - "⥎": true, - "⊣": true, - "↤": true, - "⥚": true, - "⊲": true, - "⧏": true, - "⊴": true, - "⥑": true, - "⥠": true, - "↿": true, - "⥘": true, - "↼": true, - "⥒": true, - "⇐": true, - "⇔": true, - "⋚": true, - "≦": true, - "≶": true, - "⪡": true, - "⩽": true, - "≲": true, - "𝔏": true, - "⋘": true, - "⇚": true, - "Ŀ": true, - "⟵": true, - "⟷": true, - "⟶": true, - "⟸": true, - "⟺": true, - "⟹": true, - "𝕃": true, - "↙": true, - "↘": true, - "ℒ": true, - "↰": true, - "Ł": true, - "≪": true, - "⤅": true, - "М": true, - " ": true, - "ℳ": true, - "𝔐": true, - "∓": true, - "𝕄": true, - "ℳ": true, - "Μ": true, - "Њ": true, - "Ń": true, - "Ň": true, - "Ņ": true, - "Н": true, - "​": true, - "​": true, - "​": true, - "​": true, - "≫": true, - "≪": true, - " ": true, - "𝔑": true, - "⁠": true, - " ": true, - "ℕ": true, - "⫬": true, - "≢": true, - "≭": true, - "∦": true, - "∉": true, - "≠": true, - "≂̸": true, - "∄": true, - "≯": true, - "≱": true, - "≧̸": true, - "≫̸": true, - "≹": true, - "⩾̸": true, - "≵": true, - "≎̸": true, - "≏̸": true, - "⋪": true, - "⧏̸": true, - "⋬": true, - "≮": true, - "≰": true, - "≸": true, - "≪̸": true, - "⩽̸": true, - "≴": true, - "⪢̸": true, - "⪡̸": true, - "⊀": true, - "⪯̸": true, - "⋠": true, - "∌": true, - "⋫": true, - "⧐̸": true, - "⋭": true, - "⊏̸": true, - "⋢": true, - "⊐̸": true, - "⋣": true, - "⊂⃒": true, - "⊈": true, - "⊁": true, - "⪰̸": true, - "⋡": true, - "≿̸": true, - "⊃⃒": true, - "⊉": true, - "≁": true, - "≄": true, - "≇": true, - "≉": true, - "∤": true, - "𝒩": true, - "Ñ": true, - "Ñ": true, - "Ν": true, - "Œ": true, - "Ó": true, - "Ó": true, - "Ô": true, - "Ô": true, - "О": true, - "Ő": true, - "𝔒": true, - "Ò": true, - "Ò": true, - "Ō": true, - "Ω": true, - "Ο": true, - "𝕆": true, - "“": true, - "‘": true, - "⩔": true, - "𝒪": true, - "Ø": true, - "Ø": true, - "Õ": true, - "Õ": true, - "⨷": true, - "Ö": true, - "Ö": true, - "‾": true, - "⏞": true, - "⎴": true, - "⏜": true, - "∂": true, - "П": true, - "𝔓": true, - "Φ": true, - "Π": true, - "±": true, - "ℌ": true, - "ℙ": true, - "⪻": true, - "≺": true, - "⪯": true, - "≼": true, - "≾": true, - "″": true, - "∏": true, - "∷": true, - "∝": true, - "𝒫": true, - "Ψ": true, - """: true, - """: true, - "𝔔": true, - "ℚ": true, - "𝒬": true, - "⤐": true, - "®": true, - "®": true, - "Ŕ": true, - "⟫": true, - "↠": true, - "⤖": true, - "Ř": true, - "Ŗ": true, - "Р": true, - "ℜ": true, - "∋": true, - "⇋": true, - "⥯": true, - "ℜ": true, - "Ρ": true, - "⟩": true, - "→": true, - "⇥": true, - "⇄": true, - "⌉": true, - "⟧": true, - "⥝": true, - "⇂": true, - "⥕": true, - "⌋": true, - "⊢": true, - "↦": true, - "⥛": true, - "⊳": true, - "⧐": true, - "⊵": true, - "⥏": true, - "⥜": true, - "↾": true, - "⥔": true, - "⇀": true, - "⥓": true, - "⇒": true, - "ℝ": true, - "⥰": true, - "⇛": true, - "ℛ": true, - "↱": true, - "⧴": true, - "Щ": true, - "Ш": true, - "Ь": true, - "Ś": true, - "⪼": true, - "Š": true, - "Ş": true, - "Ŝ": true, - "С": true, - "𝔖": true, - "↓": true, - "←": true, - "→": true, - "↑": true, - "Σ": true, - "∘": true, - "𝕊": true, - "√": true, - "□": true, - "⊓": true, - "⊏": true, - "⊑": true, - "⊐": true, - "⊒": true, - "⊔": true, - "𝒮": true, - "⋆": true, - "⋐": true, - "⋐": true, - "⊆": true, - "≻": true, - "⪰": true, - "≽": true, - "≿": true, - "∋": true, - "∑": true, - "⋑": true, - "⊃": true, - "⊇": true, - "⋑": true, - "Þ": true, - "Þ": true, - "™": true, - "Ћ": true, - "Ц": true, - " ": true, - "Τ": true, - "Ť": true, - "Ţ": true, - "Т": true, - "𝔗": true, - "∴": true, - "Θ": true, - "  ": true, - " ": true, - "∼": true, - "≃": true, - "≅": true, - "≈": true, - "𝕋": true, - "⃛": true, - "𝒯": true, - "Ŧ": true, - "Ú": true, - "Ú": true, - "↟": true, - "⥉": true, - "Ў": true, - "Ŭ": true, - "Û": true, - "Û": true, - "У": true, - "Ű": true, - "𝔘": true, - "Ù": true, - "Ù": true, - "Ū": true, - "_": true, - "⏟": true, - "⎵": true, - "⏝": true, - "⋃": true, - "⊎": true, - "Ų": true, - "𝕌": true, - "↑": true, - "⤒": true, - "⇅": true, - "↕": true, - "⥮": true, - "⊥": true, - "↥": true, - "⇑": true, - "⇕": true, - "↖": true, - "↗": true, - "ϒ": true, - "Υ": true, - "Ů": true, - "𝒰": true, - "Ũ": true, - "Ü": true, - "Ü": true, - "⊫": true, - "⫫": true, - "В": true, - "⊩": true, - "⫦": true, - "⋁": true, - "‖": true, - "‖": true, - "∣": true, - "|": true, - "❘": true, - "≀": true, - " ": true, - "𝔙": true, - "𝕍": true, - "𝒱": true, - "⊪": true, - "Ŵ": true, - "⋀": true, - "𝔚": true, - "𝕎": true, - "𝒲": true, - "𝔛": true, - "Ξ": true, - "𝕏": true, - "𝒳": true, - "Я": true, - "Ї": true, - "Ю": true, - "Ý": true, - "Ý": true, - "Ŷ": true, - "Ы": true, - "𝔜": true, - "𝕐": true, - "𝒴": true, - "Ÿ": true, - "Ж": true, - "Ź": true, - "Ž": true, - "З": true, - "Ż": true, - "​": true, - "Ζ": true, - "ℨ": true, - "ℤ": true, - "𝒵": true, - "á": true, - "á": true, - "ă": true, - "∾": true, - "∾̳": true, - "∿": true, - "â": true, - "â": true, - "´": true, - "´": true, - "а": true, - "æ": true, - "æ": true, - "⁡": true, - "𝔞": true, - "à": true, - "à": true, - "ℵ": true, - "ℵ": true, - "α": true, - "ā": true, - "⨿": true, - "&": true, - "&": true, - "∧": true, - "⩕": true, - "⩜": true, - "⩘": true, - "⩚": true, - "∠": true, - "⦤": true, - "∠": true, - "∡": true, - "⦨": true, - "⦩": true, - "⦪": true, - "⦫": true, - "⦬": true, - "⦭": true, - "⦮": true, - "⦯": true, - "∟": true, - "⊾": true, - "⦝": true, - "∢": true, - "Å": true, - "⍼": true, - "ą": true, - "𝕒": true, - "≈": true, - "⩰": true, - "⩯": true, - "≊": true, - "≋": true, - "'": true, - "≈": true, - "≊": true, - "å": true, - "å": true, - "𝒶": true, - "*": true, - "≈": true, - "≍": true, - "ã": true, - "ã": true, - "ä": true, - "ä": true, - "∳": true, - "⨑": true, - "⫭": true, - "≌": true, - "϶": true, - "‵": true, - "∽": true, - "⋍": true, - "⊽": true, - "⌅": true, - "⌅": true, - "⎵": true, - "⎶": true, - "≌": true, - "б": true, - "„": true, - "∵": true, - "∵": true, - "⦰": true, - "϶": true, - "ℬ": true, - "β": true, - "ℶ": true, - "≬": true, - "𝔟": true, - "⋂": true, - "◯": true, - "⋃": true, - "⨀": true, - "⨁": true, - "⨂": true, - "⨆": true, - "★": true, - "▽": true, - "△": true, - "⨄": true, - "⋁": true, - "⋀": true, - "⤍": true, - "⧫": true, - "▪": true, - "▴": true, - "▾": true, - "◂": true, - "▸": true, - "␣": true, - "▒": true, - "░": true, - "▓": true, - "█": true, - "=⃥": true, - "≡⃥": true, - "⌐": true, - "𝕓": true, - "⊥": true, - "⊥": true, - "⋈": true, - "╗": true, - "╔": true, - "╖": true, - "╓": true, - "═": true, - "╦": true, - "╩": true, - "╤": true, - "╧": true, - "╝": true, - "╚": true, - "╜": true, - "╙": true, - "║": true, - "╬": true, - "╣": true, - "╠": true, - "╫": true, - "╢": true, - "╟": true, - "⧉": true, - "╕": true, - "╒": true, - "┐": true, - "┌": true, - "─": true, - "╥": true, - "╨": true, - "┬": true, - "┴": true, - "⊟": true, - "⊞": true, - "⊠": true, - "╛": true, - "╘": true, - "┘": true, - "└": true, - "│": true, - "╪": true, - "╡": true, - "╞": true, - "┼": true, - "┤": true, - "├": true, - "‵": true, - "˘": true, - "¦": true, - "¦": true, - "𝒷": true, - "⁏": true, - "∽": true, - "⋍": true, - "\": true, - "⧅": true, - "⟈": true, - "•": true, - "•": true, - "≎": true, - "⪮": true, - "≏": true, - "≏": true, - "ć": true, - "∩": true, - "⩄": true, - "⩉": true, - "⩋": true, - "⩇": true, - "⩀": true, - "∩︀": true, - "⁁": true, - "ˇ": true, - "⩍": true, - "č": true, - "ç": true, - "ç": true, - "ĉ": true, - "⩌": true, - "⩐": true, - "ċ": true, - "¸": true, - "¸": true, - "⦲": true, - "¢": true, - "¢": true, - "·": true, - "𝔠": true, - "ч": true, - "✓": true, - "✓": true, - "χ": true, - "○": true, - "⧃": true, - "ˆ": true, - "≗": true, - "↺": true, - "↻": true, - "®": true, - "Ⓢ": true, - "⊛": true, - "⊚": true, - "⊝": true, - "≗": true, - "⨐": true, - "⫯": true, - "⧂": true, - "♣": true, - "♣": true, - ":": true, - "≔": true, - "≔": true, - ",": true, - "@": true, - "∁": true, - "∘": true, - "∁": true, - "ℂ": true, - "≅": true, - "⩭": true, - "∮": true, - "𝕔": true, - "∐": true, - "©": true, - "©": true, - "℗": true, - "↵": true, - "✗": true, - "𝒸": true, - "⫏": true, - "⫑": true, - "⫐": true, - "⫒": true, - "⋯": true, - "⤸": true, - "⤵": true, - "⋞": true, - "⋟": true, - "↶": true, - "⤽": true, - "∪": true, - "⩈": true, - "⩆": true, - "⩊": true, - "⊍": true, - "⩅": true, - "∪︀": true, - "↷": true, - "⤼": true, - "⋞": true, - "⋟": true, - "⋎": true, - "⋏": true, - "¤": true, - "¤": true, - "↶": true, - "↷": true, - "⋎": true, - "⋏": true, - "∲": true, - "∱": true, - "⌭": true, - "⇓": true, - "⥥": true, - "†": true, - "ℸ": true, - "↓": true, - "‐": true, - "⊣": true, - "⤏": true, - "˝": true, - "ď": true, - "д": true, - "ⅆ": true, - "‡": true, - "⇊": true, - "⩷": true, - "°": true, - "°": true, - "δ": true, - "⦱": true, - "⥿": true, - "𝔡": true, - "⇃": true, - "⇂": true, - "⋄": true, - "⋄": true, - "♦": true, - "♦": true, - "¨": true, - "ϝ": true, - "⋲": true, - "÷": true, - "÷": true, - "÷": true, - "⋇": true, - "⋇": true, - "ђ": true, - "⌞": true, - "⌍": true, - "$": true, - "𝕕": true, - "˙": true, - "≐": true, - "≑": true, - "∸": true, - "∔": true, - "⊡": true, - "⌆": true, - "↓": true, - "⇊": true, - "⇃": true, - "⇂": true, - "⤐": true, - "⌟": true, - "⌌": true, - "𝒹": true, - "ѕ": true, - "⧶": true, - "đ": true, - "⋱": true, - "▿": true, - "▾": true, - "⇵": true, - "⥯": true, - "⦦": true, - "џ": true, - "⟿": true, - "⩷": true, - "≑": true, - "é": true, - "é": true, - "⩮": true, - "ě": true, - "≖": true, - "ê": true, - "ê": true, - "≕": true, - "э": true, - "ė": true, - "ⅇ": true, - "≒": true, - "𝔢": true, - "⪚": true, - "è": true, - "è": true, - "⪖": true, - "⪘": true, - "⪙": true, - "⏧": true, - "ℓ": true, - "⪕": true, - "⪗": true, - "ē": true, - "∅": true, - "∅": true, - "∅": true, - " ": true, - " ": true, - " ": true, - "ŋ": true, - " ": true, - "ę": true, - "𝕖": true, - "⋕": true, - "⧣": true, - "⩱": true, - "ε": true, - "ε": true, - "ϵ": true, - "≖": true, - "≕": true, - "≂": true, - "⪖": true, - "⪕": true, - "=": true, - "≟": true, - "≡": true, - "⩸": true, - "⧥": true, - "≓": true, - "⥱": true, - "ℯ": true, - "≐": true, - "≂": true, - "η": true, - "ð": true, - "ð": true, - "ë": true, - "ë": true, - "€": true, - "!": true, - "∃": true, - "ℰ": true, - "ⅇ": true, - "≒": true, - "ф": true, - "♀": true, - "ffi": true, - "ff": true, - "ffl": true, - "𝔣": true, - "fi": true, - "fj": true, - "♭": true, - "fl": true, - "▱": true, - "ƒ": true, - "𝕗": true, - "∀": true, - "⋔": true, - "⫙": true, - "⨍": true, - "½": true, - "½": true, - "⅓": true, - "¼": true, - "¼": true, - "⅕": true, - "⅙": true, - "⅛": true, - "⅔": true, - "⅖": true, - "¾": true, - "¾": true, - "⅗": true, - "⅜": true, - "⅘": true, - "⅚": true, - "⅝": true, - "⅞": true, - "⁄": true, - "⌢": true, - "𝒻": true, - "≧": true, - "⪌": true, - "ǵ": true, - "γ": true, - "ϝ": true, - "⪆": true, - "ğ": true, - "ĝ": true, - "г": true, - "ġ": true, - "≥": true, - "⋛": true, - "≥": true, - "≧": true, - "⩾": true, - "⩾": true, - "⪩": true, - "⪀": true, - "⪂": true, - "⪄": true, - "⋛︀": true, - "⪔": true, - "𝔤": true, - "≫": true, - "⋙": true, - "ℷ": true, - "ѓ": true, - "≷": true, - "⪒": true, - "⪥": true, - "⪤": true, - "≩": true, - "⪊": true, - "⪊": true, - "⪈": true, - "⪈": true, - "≩": true, - "⋧": true, - "𝕘": true, - "`": true, - "ℊ": true, - "≳": true, - "⪎": true, - "⪐": true, - ">": true, - ">": true, - "⪧": true, - "⩺": true, - "⋗": true, - "⦕": true, - "⩼": true, - "⪆": true, - "⥸": true, - "⋗": true, - "⋛": true, - "⪌": true, - "≷": true, - "≳": true, - "≩︀": true, - "≩︀": true, - "⇔": true, - " ": true, - "½": true, - "ℋ": true, - "ъ": true, - "↔": true, - "⥈": true, - "↭": true, - "ℏ": true, - "ĥ": true, - "♥": true, - "♥": true, - "…": true, - "⊹": true, - "𝔥": true, - "⤥": true, - "⤦": true, - "⇿": true, - "∻": true, - "↩": true, - "↪": true, - "𝕙": true, - "―": true, - "𝒽": true, - "ℏ": true, - "ħ": true, - "⁃": true, - "‐": true, - "í": true, - "í": true, - "⁣": true, - "î": true, - "î": true, - "и": true, - "е": true, - "¡": true, - "¡": true, - "⇔": true, - "𝔦": true, - "ì": true, - "ì": true, - "ⅈ": true, - "⨌": true, - "∭": true, - "⧜": true, - "℩": true, - "ij": true, - "ī": true, - "ℑ": true, - "ℐ": true, - "ℑ": true, - "ı": true, - "⊷": true, - "Ƶ": true, - "∈": true, - "℅": true, - "∞": true, - "⧝": true, - "ı": true, - "∫": true, - "⊺": true, - "ℤ": true, - "⊺": true, - "⨗": true, - "⨼": true, - "ё": true, - "į": true, - "𝕚": true, - "ι": true, - "⨼": true, - "¿": true, - "¿": true, - "𝒾": true, - "∈": true, - "⋹": true, - "⋵": true, - "⋴": true, - "⋳": true, - "∈": true, - "⁢": true, - "ĩ": true, - "і": true, - "ï": true, - "ï": true, - "ĵ": true, - "й": true, - "𝔧": true, - "ȷ": true, - "𝕛": true, - "𝒿": true, - "ј": true, - "є": true, - "κ": true, - "ϰ": true, - "ķ": true, - "к": true, - "𝔨": true, - "ĸ": true, - "х": true, - "ќ": true, - "𝕜": true, - "𝓀": true, - "⇚": true, - "⇐": true, - "⤛": true, - "⤎": true, - "≦": true, - "⪋": true, - "⥢": true, - "ĺ": true, - "⦴": true, - "ℒ": true, - "λ": true, - "⟨": true, - "⦑": true, - "⟨": true, - "⪅": true, - "«": true, - "«": true, - "←": true, - "⇤": true, - "⤟": true, - "⤝": true, - "↩": true, - "↫": true, - "⤹": true, - "⥳": true, - "↢": true, - "⪫": true, - "⤙": true, - "⪭": true, - "⪭︀": true, - "⤌": true, - "❲": true, - "{": true, - "[": true, - "⦋": true, - "⦏": true, - "⦍": true, - "ľ": true, - "ļ": true, - "⌈": true, - "{": true, - "л": true, - "⤶": true, - "“": true, - "„": true, - "⥧": true, - "⥋": true, - "↲": true, - "≤": true, - "←": true, - "↢": true, - "↽": true, - "↼": true, - "⇇": true, - "↔": true, - "⇆": true, - "⇋": true, - "↭": true, - "⋋": true, - "⋚": true, - "≤": true, - "≦": true, - "⩽": true, - "⩽": true, - "⪨": true, - "⩿": true, - "⪁": true, - "⪃": true, - "⋚︀": true, - "⪓": true, - "⪅": true, - "⋖": true, - "⋚": true, - "⪋": true, - "≶": true, - "≲": true, - "⥼": true, - "⌊": true, - "𝔩": true, - "≶": true, - "⪑": true, - "↽": true, - "↼": true, - "⥪": true, - "▄": true, - "љ": true, - "≪": true, - "⇇": true, - "⌞": true, - "⥫": true, - "◺": true, - "ŀ": true, - "⎰": true, - "⎰": true, - "≨": true, - "⪉": true, - "⪉": true, - "⪇": true, - "⪇": true, - "≨": true, - "⋦": true, - "⟬": true, - "⇽": true, - "⟦": true, - "⟵": true, - "⟷": true, - "⟼": true, - "⟶": true, - "↫": true, - "↬": true, - "⦅": true, - "𝕝": true, - "⨭": true, - "⨴": true, - "∗": true, - "_": true, - "◊": true, - "◊": true, - "⧫": true, - "(": true, - "⦓": true, - "⇆": true, - "⌟": true, - "⇋": true, - "⥭": true, - "‎": true, - "⊿": true, - "‹": true, - "𝓁": true, - "↰": true, - "≲": true, - "⪍": true, - "⪏": true, - "[": true, - "‘": true, - "‚": true, - "ł": true, - "<": true, - "<": true, - "⪦": true, - "⩹": true, - "⋖": true, - "⋋": true, - "⋉": true, - "⥶": true, - "⩻": true, - "⦖": true, - "◃": true, - "⊴": true, - "◂": true, - "⥊": true, - "⥦": true, - "≨︀": true, - "≨︀": true, - "∺": true, - "¯": true, - "¯": true, - "♂": true, - "✠": true, - "✠": true, - "↦": true, - "↦": true, - "↧": true, - "↤": true, - "↥": true, - "▮": true, - "⨩": true, - "м": true, - "—": true, - "∡": true, - "𝔪": true, - "℧": true, - "µ": true, - "µ": true, - "∣": true, - "*": true, - "⫰": true, - "·": true, - "·": true, - "−": true, - "⊟": true, - "∸": true, - "⨪": true, - "⫛": true, - "…": true, - "∓": true, - "⊧": true, - "𝕞": true, - "∓": true, - "𝓂": true, - "∾": true, - "μ": true, - "⊸": true, - "⊸": true, - "⋙̸": true, - "≫⃒": true, - "≫̸": true, - "⇍": true, - "⇎": true, - "⋘̸": true, - "≪⃒": true, - "≪̸": true, - "⇏": true, - "⊯": true, - "⊮": true, - "∇": true, - "ń": true, - "∠⃒": true, - "≉": true, - "⩰̸": true, - "≋̸": true, - "ʼn": true, - "≉": true, - "♮": true, - "♮": true, - "ℕ": true, - " ": true, - " ": true, - "≎̸": true, - "≏̸": true, - "⩃": true, - "ň": true, - "ņ": true, - "≇": true, - "⩭̸": true, - "⩂": true, - "н": true, - "–": true, - "≠": true, - "⇗": true, - "⤤": true, - "↗": true, - "↗": true, - "≐̸": true, - "≢": true, - "⤨": true, - "≂̸": true, - "∄": true, - "∄": true, - "𝔫": true, - "≧̸": true, - "≱": true, - "≱": true, - "≧̸": true, - "⩾̸": true, - "⩾̸": true, - "≵": true, - "≯": true, - "≯": true, - "⇎": true, - "↮": true, - "⫲": true, - "∋": true, - "⋼": true, - "⋺": true, - "∋": true, - "њ": true, - "⇍": true, - "≦̸": true, - "↚": true, - "‥": true, - "≰": true, - "↚": true, - "↮": true, - "≰": true, - "≦̸": true, - "⩽̸": true, - "⩽̸": true, - "≮": true, - "≴": true, - "≮": true, - "⋪": true, - "⋬": true, - "∤": true, - "𝕟": true, - "¬": true, - "¬": true, - "∉": true, - "⋹̸": true, - "⋵̸": true, - "∉": true, - "⋷": true, - "⋶": true, - "∌": true, - "∌": true, - "⋾": true, - "⋽": true, - "∦": true, - "∦": true, - "⫽⃥": true, - "∂̸": true, - "⨔": true, - "⊀": true, - "⋠": true, - "⪯̸": true, - "⊀": true, - "⪯̸": true, - "⇏": true, - "↛": true, - "⤳̸": true, - "↝̸": true, - "↛": true, - "⋫": true, - "⋭": true, - "⊁": true, - "⋡": true, - "⪰̸": true, - "𝓃": true, - "∤": true, - "∦": true, - "≁": true, - "≄": true, - "≄": true, - "∤": true, - "∦": true, - "⋢": true, - "⋣": true, - "⊄": true, - "⫅̸": true, - "⊈": true, - "⊂⃒": true, - "⊈": true, - "⫅̸": true, - "⊁": true, - "⪰̸": true, - "⊅": true, - "⫆̸": true, - "⊉": true, - "⊃⃒": true, - "⊉": true, - "⫆̸": true, - "≹": true, - "ñ": true, - "ñ": true, - "≸": true, - "⋪": true, - "⋬": true, - "⋫": true, - "⋭": true, - "ν": true, - "#": true, - "№": true, - " ": true, - "⊭": true, - "⤄": true, - "≍⃒": true, - "⊬": true, - "≥⃒": true, - ">⃒": true, - "⧞": true, - "⤂": true, - "≤⃒": true, - "<⃒": true, - "⊴⃒": true, - "⤃": true, - "⊵⃒": true, - "∼⃒": true, - "⇖": true, - "⤣": true, - "↖": true, - "↖": true, - "⤧": true, - "Ⓢ": true, - "ó": true, - "ó": true, - "⊛": true, - "⊚": true, - "ô": true, - "ô": true, - "о": true, - "⊝": true, - "ő": true, - "⨸": true, - "⊙": true, - "⦼": true, - "œ": true, - "⦿": true, - "𝔬": true, - "˛": true, - "ò": true, - "ò": true, - "⧁": true, - "⦵": true, - "Ω": true, - "∮": true, - "↺": true, - "⦾": true, - "⦻": true, - "‾": true, - "⧀": true, - "ō": true, - "ω": true, - "ο": true, - "⦶": true, - "⊖": true, - "𝕠": true, - "⦷": true, - "⦹": true, - "⊕": true, - "∨": true, - "↻": true, - "⩝": true, - "ℴ": true, - "ℴ": true, - "ª": true, - "ª": true, - "º": true, - "º": true, - "⊶": true, - "⩖": true, - "⩗": true, - "⩛": true, - "ℴ": true, - "ø": true, - "ø": true, - "⊘": true, - "õ": true, - "õ": true, - "⊗": true, - "⨶": true, - "ö": true, - "ö": true, - "⌽": true, - "∥": true, - "¶": true, - "¶": true, - "∥": true, - "⫳": true, - "⫽": true, - "∂": true, - "п": true, - "%": true, - ".": true, - "‰": true, - "⊥": true, - "‱": true, - "𝔭": true, - "φ": true, - "ϕ": true, - "ℳ": true, - "☎": true, - "π": true, - "⋔": true, - "ϖ": true, - "ℏ": true, - "ℎ": true, - "ℏ": true, - "+": true, - "⨣": true, - "⊞": true, - "⨢": true, - "∔": true, - "⨥": true, - "⩲": true, - "±": true, - "±": true, - "⨦": true, - "⨧": true, - "±": true, - "⨕": true, - "𝕡": true, - "£": true, - "£": true, - "≺": true, - "⪳": true, - "⪷": true, - "≼": true, - "⪯": true, - "≺": true, - "⪷": true, - "≼": true, - "⪯": true, - "⪹": true, - "⪵": true, - "⋨": true, - "≾": true, - "′": true, - "ℙ": true, - "⪵": true, - "⪹": true, - "⋨": true, - "∏": true, - "⌮": true, - "⌒": true, - "⌓": true, - "∝": true, - "∝": true, - "≾": true, - "⊰": true, - "𝓅": true, - "ψ": true, - " ": true, - "𝔮": true, - "⨌": true, - "𝕢": true, - "⁗": true, - "𝓆": true, - "ℍ": true, - "⨖": true, - "?": true, - "≟": true, - """: true, - """: true, - "⇛": true, - "⇒": true, - "⤜": true, - "⤏": true, - "⥤": true, - "∽̱": true, - "ŕ": true, - "√": true, - "⦳": true, - "⟩": true, - "⦒": true, - "⦥": true, - "⟩": true, - "»": true, - "»": true, - "→": true, - "⥵": true, - "⇥": true, - "⤠": true, - "⤳": true, - "⤞": true, - "↪": true, - "↬": true, - "⥅": true, - "⥴": true, - "↣": true, - "↝": true, - "⤚": true, - "∶": true, - "ℚ": true, - "⤍": true, - "❳": true, - "}": true, - "]": true, - "⦌": true, - "⦎": true, - "⦐": true, - "ř": true, - "ŗ": true, - "⌉": true, - "}": true, - "р": true, - "⤷": true, - "⥩": true, - "”": true, - "”": true, - "↳": true, - "ℜ": true, - "ℛ": true, - "ℜ": true, - "ℝ": true, - "▭": true, - "®": true, - "®": true, - "⥽": true, - "⌋": true, - "𝔯": true, - "⇁": true, - "⇀": true, - "⥬": true, - "ρ": true, - "ϱ": true, - "→": true, - "↣": true, - "⇁": true, - "⇀": true, - "⇄": true, - "⇌": true, - "⇉": true, - "↝": true, - "⋌": true, - "˚": true, - "≓": true, - "⇄": true, - "⇌": true, - "‏": true, - "⎱": true, - "⎱": true, - "⫮": true, - "⟭": true, - "⇾": true, - "⟧": true, - "⦆": true, - "𝕣": true, - "⨮": true, - "⨵": true, - ")": true, - "⦔": true, - "⨒": true, - "⇉": true, - "›": true, - "𝓇": true, - "↱": true, - "]": true, - "’": true, - "’": true, - "⋌": true, - "⋊": true, - "▹": true, - "⊵": true, - "▸": true, - "⧎": true, - "⥨": true, - "℞": true, - "ś": true, - "‚": true, - "≻": true, - "⪴": true, - "⪸": true, - "š": true, - "≽": true, - "⪰": true, - "ş": true, - "ŝ": true, - "⪶": true, - "⪺": true, - "⋩": true, - "⨓": true, - "≿": true, - "с": true, - "⋅": true, - "⊡": true, - "⩦": true, - "⇘": true, - "⤥": true, - "↘": true, - "↘": true, - "§": true, - "§": true, - ";": true, - "⤩": true, - "∖": true, - "∖": true, - "✶": true, - "𝔰": true, - "⌢": true, - "♯": true, - "щ": true, - "ш": true, - "∣": true, - "∥": true, - "­": true, - "­": true, - "σ": true, - "ς": true, - "ς": true, - "∼": true, - "⩪": true, - "≃": true, - "≃": true, - "⪞": true, - "⪠": true, - "⪝": true, - "⪟": true, - "≆": true, - "⨤": true, - "⥲": true, - "←": true, - "∖": true, - "⨳": true, - "⧤": true, - "∣": true, - "⌣": true, - "⪪": true, - "⪬": true, - "⪬︀": true, - "ь": true, - "/": true, - "⧄": true, - "⌿": true, - "𝕤": true, - "♠": true, - "♠": true, - "∥": true, - "⊓": true, - "⊓︀": true, - "⊔": true, - "⊔︀": true, - "⊏": true, - "⊑": true, - "⊏": true, - "⊑": true, - "⊐": true, - "⊒": true, - "⊐": true, - "⊒": true, - "□": true, - "□": true, - "▪": true, - "▪": true, - "→": true, - "𝓈": true, - "∖": true, - "⌣": true, - "⋆": true, - "☆": true, - "★": true, - "ϵ": true, - "ϕ": true, - "¯": true, - "⊂": true, - "⫅": true, - "⪽": true, - "⊆": true, - "⫃": true, - "⫁": true, - "⫋": true, - "⊊": true, - "⪿": true, - "⥹": true, - "⊂": true, - "⊆": true, - "⫅": true, - "⊊": true, - "⫋": true, - "⫇": true, - "⫕": true, - "⫓": true, - "≻": true, - "⪸": true, - "≽": true, - "⪰": true, - "⪺": true, - "⪶": true, - "⋩": true, - "≿": true, - "∑": true, - "♪": true, - "¹": true, - "¹": true, - "²": true, - "²": true, - "³": true, - "³": true, - "⊃": true, - "⫆": true, - "⪾": true, - "⫘": true, - "⊇": true, - "⫄": true, - "⟉": true, - "⫗": true, - "⥻": true, - "⫂": true, - "⫌": true, - "⊋": true, - "⫀": true, - "⊃": true, - "⊇": true, - "⫆": true, - "⊋": true, - "⫌": true, - "⫈": true, - "⫔": true, - "⫖": true, - "⇙": true, - "⤦": true, - "↙": true, - "↙": true, - "⤪": true, - "ß": true, - "ß": true, - "⌖": true, - "τ": true, - "⎴": true, - "ť": true, - "ţ": true, - "т": true, - "⃛": true, - "⌕": true, - "𝔱": true, - "∴": true, - "∴": true, - "θ": true, - "ϑ": true, - "ϑ": true, - "≈": true, - "∼": true, - " ": true, - "≈": true, - "∼": true, - "þ": true, - "þ": true, - "˜": true, - "×": true, - "×": true, - "⊠": true, - "⨱": true, - "⨰": true, - "∭": true, - "⤨": true, - "⊤": true, - "⌶": true, - "⫱": true, - "𝕥": true, - "⫚": true, - "⤩": true, - "‴": true, - "™": true, - "▵": true, - "▿": true, - "◃": true, - "⊴": true, - "≜": true, - "▹": true, - "⊵": true, - "◬": true, - "≜": true, - "⨺": true, - "⨹": true, - "⧍": true, - "⨻": true, - "⏢": true, - "𝓉": true, - "ц": true, - "ћ": true, - "ŧ": true, - "≬": true, - "↞": true, - "↠": true, - "⇑": true, - "⥣": true, - "ú": true, - "ú": true, - "↑": true, - "ў": true, - "ŭ": true, - "û": true, - "û": true, - "у": true, - "⇅": true, - "ű": true, - "⥮": true, - "⥾": true, - "𝔲": true, - "ù": true, - "ù": true, - "↿": true, - "↾": true, - "▀": true, - "⌜": true, - "⌜": true, - "⌏": true, - "◸": true, - "ū": true, - "¨": true, - "¨": true, - "ų": true, - "𝕦": true, - "↑": true, - "↕": true, - "↿": true, - "↾": true, - "⊎": true, - "υ": true, - "ϒ": true, - "υ": true, - "⇈": true, - "⌝": true, - "⌝": true, - "⌎": true, - "ů": true, - "◹": true, - "𝓊": true, - "⋰": true, - "ũ": true, - "▵": true, - "▴": true, - "⇈": true, - "ü": true, - "ü": true, - "⦧": true, - "⇕": true, - "⫨": true, - "⫩": true, - "⊨": true, - "⦜": true, - "ϵ": true, - "ϰ": true, - "∅": true, - "ϕ": true, - "ϖ": true, - "∝": true, - "↕": true, - "ϱ": true, - "ς": true, - "⊊︀": true, - "⫋︀": true, - "⊋︀": true, - "⫌︀": true, - "ϑ": true, - "⊲": true, - "⊳": true, - "в": true, - "⊢": true, - "∨": true, - "⊻": true, - "≚": true, - "⋮": true, - "|": true, - "|": true, - "𝔳": true, - "⊲": true, - "⊂⃒": true, - "⊃⃒": true, - "𝕧": true, - "∝": true, - "⊳": true, - "𝓋": true, - "⫋︀": true, - "⊊︀": true, - "⫌︀": true, - "⊋︀": true, - "⦚": true, - "ŵ": true, - "⩟": true, - "∧": true, - "≙": true, - "℘": true, - "𝔴": true, - "𝕨": true, - "℘": true, - "≀": true, - "≀": true, - "𝓌": true, - "⋂": true, - "◯": true, - "⋃": true, - "▽": true, - "𝔵": true, - "⟺": true, - "⟷": true, - "ξ": true, - "⟸": true, - "⟵": true, - "⟼": true, - "⋻": true, - "⨀": true, - "𝕩": true, - "⨁": true, - "⨂": true, - "⟹": true, - "⟶": true, - "𝓍": true, - "⨆": true, - "⨄": true, - "△": true, - "⋁": true, - "⋀": true, - "ý": true, - "ý": true, - "я": true, - "ŷ": true, - "ы": true, - "¥": true, - "¥": true, - "𝔶": true, - "ї": true, - "𝕪": true, - "𝓎": true, - "ю": true, - "ÿ": true, - "ÿ": true, - "ź": true, - "ž": true, - "з": true, - "ż": true, - "ℨ": true, - "ζ": true, - "𝔷": true, - "ж": true, - "⇝": true, - "𝕫": true, - "𝓏": true, - "‍": true, - "‌": true, -} diff --git a/vendor/github.com/russross/blackfriday/v2/esc.go b/vendor/github.com/russross/blackfriday/v2/esc.go deleted file mode 100644 index 6ab6010..0000000 --- a/vendor/github.com/russross/blackfriday/v2/esc.go +++ /dev/null @@ -1,70 +0,0 @@ -package blackfriday - -import ( - "html" - "io" -) - -var htmlEscaper = [256][]byte{ - '&': []byte("&"), - '<': []byte("<"), - '>': []byte(">"), - '"': []byte("""), -} - -func escapeHTML(w io.Writer, s []byte) { - escapeEntities(w, s, false) -} - -func escapeAllHTML(w io.Writer, s []byte) { - escapeEntities(w, s, true) -} - -func escapeEntities(w io.Writer, s []byte, escapeValidEntities bool) { - var start, end int - for end < len(s) { - escSeq := htmlEscaper[s[end]] - if escSeq != nil { - isEntity, entityEnd := nodeIsEntity(s, end) - if isEntity && !escapeValidEntities { - w.Write(s[start : entityEnd+1]) - start = entityEnd + 1 - } else { - w.Write(s[start:end]) - w.Write(escSeq) - start = end + 1 - } - } - end++ - } - if start < len(s) && end <= len(s) { - w.Write(s[start:end]) - } -} - -func nodeIsEntity(s []byte, end int) (isEntity bool, endEntityPos int) { - isEntity = false - endEntityPos = end + 1 - - if s[end] == '&' { - for endEntityPos < len(s) { - if s[endEntityPos] == ';' { - if entities[string(s[end:endEntityPos+1])] { - isEntity = true - break - } - } - if !isalnum(s[endEntityPos]) && s[endEntityPos] != '&' && s[endEntityPos] != '#' { - break - } - endEntityPos++ - } - } - - return isEntity, endEntityPos -} - -func escLink(w io.Writer, text []byte) { - unesc := html.UnescapeString(string(text)) - escapeHTML(w, []byte(unesc)) -} diff --git a/vendor/github.com/russross/blackfriday/v2/go.mod b/vendor/github.com/russross/blackfriday/v2/go.mod deleted file mode 100644 index 620b74e..0000000 --- a/vendor/github.com/russross/blackfriday/v2/go.mod +++ /dev/null @@ -1 +0,0 @@ -module github.com/russross/blackfriday/v2 diff --git a/vendor/github.com/russross/blackfriday/v2/html.go b/vendor/github.com/russross/blackfriday/v2/html.go deleted file mode 100644 index cb4f26e..0000000 --- a/vendor/github.com/russross/blackfriday/v2/html.go +++ /dev/null @@ -1,952 +0,0 @@ -// -// Blackfriday Markdown Processor -// Available at http://github.com/russross/blackfriday -// -// Copyright © 2011 Russ Ross . -// Distributed under the Simplified BSD License. -// See README.md for details. -// - -// -// -// HTML rendering backend -// -// - -package blackfriday - -import ( - "bytes" - "fmt" - "io" - "regexp" - "strings" -) - -// HTMLFlags control optional behavior of HTML renderer. -type HTMLFlags int - -// HTML renderer configuration options. -const ( - HTMLFlagsNone HTMLFlags = 0 - SkipHTML HTMLFlags = 1 << iota // Skip preformatted HTML blocks - SkipImages // Skip embedded images - SkipLinks // Skip all links - Safelink // Only link to trusted protocols - NofollowLinks // Only link with rel="nofollow" - NoreferrerLinks // Only link with rel="noreferrer" - NoopenerLinks // Only link with rel="noopener" - HrefTargetBlank // Add a blank target - CompletePage // Generate a complete HTML page - UseXHTML // Generate XHTML output instead of HTML - FootnoteReturnLinks // Generate a link at the end of a footnote to return to the source - Smartypants // Enable smart punctuation substitutions - SmartypantsFractions // Enable smart fractions (with Smartypants) - SmartypantsDashes // Enable smart dashes (with Smartypants) - SmartypantsLatexDashes // Enable LaTeX-style dashes (with Smartypants) - SmartypantsAngledQuotes // Enable angled double quotes (with Smartypants) for double quotes rendering - SmartypantsQuotesNBSP // Enable « French guillemets » (with Smartypants) - TOC // Generate a table of contents -) - -var ( - htmlTagRe = regexp.MustCompile("(?i)^" + htmlTag) -) - -const ( - htmlTag = "(?:" + openTag + "|" + closeTag + "|" + htmlComment + "|" + - processingInstruction + "|" + declaration + "|" + cdata + ")" - closeTag = "]" - openTag = "<" + tagName + attribute + "*" + "\\s*/?>" - attribute = "(?:" + "\\s+" + attributeName + attributeValueSpec + "?)" - attributeValue = "(?:" + unquotedValue + "|" + singleQuotedValue + "|" + doubleQuotedValue + ")" - attributeValueSpec = "(?:" + "\\s*=" + "\\s*" + attributeValue + ")" - attributeName = "[a-zA-Z_:][a-zA-Z0-9:._-]*" - cdata = "" - declaration = "]*>" - doubleQuotedValue = "\"[^\"]*\"" - htmlComment = "|" - processingInstruction = "[<][?].*?[?][>]" - singleQuotedValue = "'[^']*'" - tagName = "[A-Za-z][A-Za-z0-9-]*" - unquotedValue = "[^\"'=<>`\\x00-\\x20]+" -) - -// HTMLRendererParameters is a collection of supplementary parameters tweaking -// the behavior of various parts of HTML renderer. -type HTMLRendererParameters struct { - // Prepend this text to each relative URL. - AbsolutePrefix string - // Add this text to each footnote anchor, to ensure uniqueness. - FootnoteAnchorPrefix string - // Show this text inside the tag for a footnote return link, if the - // HTML_FOOTNOTE_RETURN_LINKS flag is enabled. If blank, the string - // [return] is used. - FootnoteReturnLinkContents string - // If set, add this text to the front of each Heading ID, to ensure - // uniqueness. - HeadingIDPrefix string - // If set, add this text to the back of each Heading ID, to ensure uniqueness. - HeadingIDSuffix string - // Increase heading levels: if the offset is 1,

becomes

etc. - // Negative offset is also valid. - // Resulting levels are clipped between 1 and 6. - HeadingLevelOffset int - - Title string // Document title (used if CompletePage is set) - CSS string // Optional CSS file URL (used if CompletePage is set) - Icon string // Optional icon file URL (used if CompletePage is set) - - Flags HTMLFlags // Flags allow customizing this renderer's behavior -} - -// HTMLRenderer is a type that implements the Renderer interface for HTML output. -// -// Do not create this directly, instead use the NewHTMLRenderer function. -type HTMLRenderer struct { - HTMLRendererParameters - - closeTag string // how to end singleton tags: either " />" or ">" - - // Track heading IDs to prevent ID collision in a single generation. - headingIDs map[string]int - - lastOutputLen int - disableTags int - - sr *SPRenderer -} - -const ( - xhtmlClose = " />" - htmlClose = ">" -) - -// NewHTMLRenderer creates and configures an HTMLRenderer object, which -// satisfies the Renderer interface. -func NewHTMLRenderer(params HTMLRendererParameters) *HTMLRenderer { - // configure the rendering engine - closeTag := htmlClose - if params.Flags&UseXHTML != 0 { - closeTag = xhtmlClose - } - - if params.FootnoteReturnLinkContents == "" { - // U+FE0E is VARIATION SELECTOR-15. - // It suppresses automatic emoji presentation of the preceding - // U+21A9 LEFTWARDS ARROW WITH HOOK on iOS and iPadOS. - params.FootnoteReturnLinkContents = "↩\ufe0e" - } - - return &HTMLRenderer{ - HTMLRendererParameters: params, - - closeTag: closeTag, - headingIDs: make(map[string]int), - - sr: NewSmartypantsRenderer(params.Flags), - } -} - -func isHTMLTag(tag []byte, tagname string) bool { - found, _ := findHTMLTagPos(tag, tagname) - return found -} - -// Look for a character, but ignore it when it's in any kind of quotes, it -// might be JavaScript -func skipUntilCharIgnoreQuotes(html []byte, start int, char byte) int { - inSingleQuote := false - inDoubleQuote := false - inGraveQuote := false - i := start - for i < len(html) { - switch { - case html[i] == char && !inSingleQuote && !inDoubleQuote && !inGraveQuote: - return i - case html[i] == '\'': - inSingleQuote = !inSingleQuote - case html[i] == '"': - inDoubleQuote = !inDoubleQuote - case html[i] == '`': - inGraveQuote = !inGraveQuote - } - i++ - } - return start -} - -func findHTMLTagPos(tag []byte, tagname string) (bool, int) { - i := 0 - if i < len(tag) && tag[0] != '<' { - return false, -1 - } - i++ - i = skipSpace(tag, i) - - if i < len(tag) && tag[i] == '/' { - i++ - } - - i = skipSpace(tag, i) - j := 0 - for ; i < len(tag); i, j = i+1, j+1 { - if j >= len(tagname) { - break - } - - if strings.ToLower(string(tag[i]))[0] != tagname[j] { - return false, -1 - } - } - - if i == len(tag) { - return false, -1 - } - - rightAngle := skipUntilCharIgnoreQuotes(tag, i, '>') - if rightAngle >= i { - return true, rightAngle - } - - return false, -1 -} - -func skipSpace(tag []byte, i int) int { - for i < len(tag) && isspace(tag[i]) { - i++ - } - return i -} - -func isRelativeLink(link []byte) (yes bool) { - // a tag begin with '#' - if link[0] == '#' { - return true - } - - // link begin with '/' but not '//', the second maybe a protocol relative link - if len(link) >= 2 && link[0] == '/' && link[1] != '/' { - return true - } - - // only the root '/' - if len(link) == 1 && link[0] == '/' { - return true - } - - // current directory : begin with "./" - if bytes.HasPrefix(link, []byte("./")) { - return true - } - - // parent directory : begin with "../" - if bytes.HasPrefix(link, []byte("../")) { - return true - } - - return false -} - -func (r *HTMLRenderer) ensureUniqueHeadingID(id string) string { - for count, found := r.headingIDs[id]; found; count, found = r.headingIDs[id] { - tmp := fmt.Sprintf("%s-%d", id, count+1) - - if _, tmpFound := r.headingIDs[tmp]; !tmpFound { - r.headingIDs[id] = count + 1 - id = tmp - } else { - id = id + "-1" - } - } - - if _, found := r.headingIDs[id]; !found { - r.headingIDs[id] = 0 - } - - return id -} - -func (r *HTMLRenderer) addAbsPrefix(link []byte) []byte { - if r.AbsolutePrefix != "" && isRelativeLink(link) && link[0] != '.' { - newDest := r.AbsolutePrefix - if link[0] != '/' { - newDest += "/" - } - newDest += string(link) - return []byte(newDest) - } - return link -} - -func appendLinkAttrs(attrs []string, flags HTMLFlags, link []byte) []string { - if isRelativeLink(link) { - return attrs - } - val := []string{} - if flags&NofollowLinks != 0 { - val = append(val, "nofollow") - } - if flags&NoreferrerLinks != 0 { - val = append(val, "noreferrer") - } - if flags&NoopenerLinks != 0 { - val = append(val, "noopener") - } - if flags&HrefTargetBlank != 0 { - attrs = append(attrs, "target=\"_blank\"") - } - if len(val) == 0 { - return attrs - } - attr := fmt.Sprintf("rel=%q", strings.Join(val, " ")) - return append(attrs, attr) -} - -func isMailto(link []byte) bool { - return bytes.HasPrefix(link, []byte("mailto:")) -} - -func needSkipLink(flags HTMLFlags, dest []byte) bool { - if flags&SkipLinks != 0 { - return true - } - return flags&Safelink != 0 && !isSafeLink(dest) && !isMailto(dest) -} - -func isSmartypantable(node *Node) bool { - pt := node.Parent.Type - return pt != Link && pt != CodeBlock && pt != Code -} - -func appendLanguageAttr(attrs []string, info []byte) []string { - if len(info) == 0 { - return attrs - } - endOfLang := bytes.IndexAny(info, "\t ") - if endOfLang < 0 { - endOfLang = len(info) - } - return append(attrs, fmt.Sprintf("class=\"language-%s\"", info[:endOfLang])) -} - -func (r *HTMLRenderer) tag(w io.Writer, name []byte, attrs []string) { - w.Write(name) - if len(attrs) > 0 { - w.Write(spaceBytes) - w.Write([]byte(strings.Join(attrs, " "))) - } - w.Write(gtBytes) - r.lastOutputLen = 1 -} - -func footnoteRef(prefix string, node *Node) []byte { - urlFrag := prefix + string(slugify(node.Destination)) - anchor := fmt.Sprintf(`%d`, urlFrag, node.NoteID) - return []byte(fmt.Sprintf(`%s`, urlFrag, anchor)) -} - -func footnoteItem(prefix string, slug []byte) []byte { - return []byte(fmt.Sprintf(`
  • `, prefix, slug)) -} - -func footnoteReturnLink(prefix, returnLink string, slug []byte) []byte { - const format = ` %s` - return []byte(fmt.Sprintf(format, prefix, slug, returnLink)) -} - -func itemOpenCR(node *Node) bool { - if node.Prev == nil { - return false - } - ld := node.Parent.ListData - return !ld.Tight && ld.ListFlags&ListTypeDefinition == 0 -} - -func skipParagraphTags(node *Node) bool { - grandparent := node.Parent.Parent - if grandparent == nil || grandparent.Type != List { - return false - } - tightOrTerm := grandparent.Tight || node.Parent.ListFlags&ListTypeTerm != 0 - return grandparent.Type == List && tightOrTerm -} - -func cellAlignment(align CellAlignFlags) string { - switch align { - case TableAlignmentLeft: - return "left" - case TableAlignmentRight: - return "right" - case TableAlignmentCenter: - return "center" - default: - return "" - } -} - -func (r *HTMLRenderer) out(w io.Writer, text []byte) { - if r.disableTags > 0 { - w.Write(htmlTagRe.ReplaceAll(text, []byte{})) - } else { - w.Write(text) - } - r.lastOutputLen = len(text) -} - -func (r *HTMLRenderer) cr(w io.Writer) { - if r.lastOutputLen > 0 { - r.out(w, nlBytes) - } -} - -var ( - nlBytes = []byte{'\n'} - gtBytes = []byte{'>'} - spaceBytes = []byte{' '} -) - -var ( - brTag = []byte("
    ") - brXHTMLTag = []byte("
    ") - emTag = []byte("") - emCloseTag = []byte("") - strongTag = []byte("") - strongCloseTag = []byte("") - delTag = []byte("") - delCloseTag = []byte("") - ttTag = []byte("") - ttCloseTag = []byte("") - aTag = []byte("") - preTag = []byte("
    ")
-	preCloseTag        = []byte("
    ") - codeTag = []byte("") - codeCloseTag = []byte("") - pTag = []byte("

    ") - pCloseTag = []byte("

    ") - blockquoteTag = []byte("
    ") - blockquoteCloseTag = []byte("
    ") - hrTag = []byte("
    ") - hrXHTMLTag = []byte("
    ") - ulTag = []byte("
      ") - ulCloseTag = []byte("
    ") - olTag = []byte("
      ") - olCloseTag = []byte("
    ") - dlTag = []byte("
    ") - dlCloseTag = []byte("
    ") - liTag = []byte("
  • ") - liCloseTag = []byte("
    • ") - ddTag = []byte("
    ") - ddCloseTag = []byte("
    ") - dtTag = []byte("
    ") - dtCloseTag = []byte("
    ") - tableTag = []byte("") - tableCloseTag = []byte("
    ") - tdTag = []byte("") - thTag = []byte("") - theadTag = []byte("") - theadCloseTag = []byte("") - tbodyTag = []byte("") - tbodyCloseTag = []byte("") - trTag = []byte("") - trCloseTag = []byte("") - h1Tag = []byte("") - h2Tag = []byte("") - h3Tag = []byte("") - h4Tag = []byte("") - h5Tag = []byte("") - h6Tag = []byte("") - - footnotesDivBytes = []byte("\n
    \n\n") - footnotesCloseDivBytes = []byte("\n
    \n") -) - -func headingTagsFromLevel(level int) ([]byte, []byte) { - if level <= 1 { - return h1Tag, h1CloseTag - } - switch level { - case 2: - return h2Tag, h2CloseTag - case 3: - return h3Tag, h3CloseTag - case 4: - return h4Tag, h4CloseTag - case 5: - return h5Tag, h5CloseTag - } - return h6Tag, h6CloseTag -} - -func (r *HTMLRenderer) outHRTag(w io.Writer) { - if r.Flags&UseXHTML == 0 { - r.out(w, hrTag) - } else { - r.out(w, hrXHTMLTag) - } -} - -// RenderNode is a default renderer of a single node of a syntax tree. For -// block nodes it will be called twice: first time with entering=true, second -// time with entering=false, so that it could know when it's working on an open -// tag and when on close. It writes the result to w. -// -// The return value is a way to tell the calling walker to adjust its walk -// pattern: e.g. it can terminate the traversal by returning Terminate. Or it -// can ask the walker to skip a subtree of this node by returning SkipChildren. -// The typical behavior is to return GoToNext, which asks for the usual -// traversal to the next node. -func (r *HTMLRenderer) RenderNode(w io.Writer, node *Node, entering bool) WalkStatus { - attrs := []string{} - switch node.Type { - case Text: - if r.Flags&Smartypants != 0 { - var tmp bytes.Buffer - escapeHTML(&tmp, node.Literal) - r.sr.Process(w, tmp.Bytes()) - } else { - if node.Parent.Type == Link { - escLink(w, node.Literal) - } else { - escapeHTML(w, node.Literal) - } - } - case Softbreak: - r.cr(w) - // TODO: make it configurable via out(renderer.softbreak) - case Hardbreak: - if r.Flags&UseXHTML == 0 { - r.out(w, brTag) - } else { - r.out(w, brXHTMLTag) - } - r.cr(w) - case Emph: - if entering { - r.out(w, emTag) - } else { - r.out(w, emCloseTag) - } - case Strong: - if entering { - r.out(w, strongTag) - } else { - r.out(w, strongCloseTag) - } - case Del: - if entering { - r.out(w, delTag) - } else { - r.out(w, delCloseTag) - } - case HTMLSpan: - if r.Flags&SkipHTML != 0 { - break - } - r.out(w, node.Literal) - case Link: - // mark it but don't link it if it is not a safe link: no smartypants - dest := node.LinkData.Destination - if needSkipLink(r.Flags, dest) { - if entering { - r.out(w, ttTag) - } else { - r.out(w, ttCloseTag) - } - } else { - if entering { - dest = r.addAbsPrefix(dest) - var hrefBuf bytes.Buffer - hrefBuf.WriteString("href=\"") - escLink(&hrefBuf, dest) - hrefBuf.WriteByte('"') - attrs = append(attrs, hrefBuf.String()) - if node.NoteID != 0 { - r.out(w, footnoteRef(r.FootnoteAnchorPrefix, node)) - break - } - attrs = appendLinkAttrs(attrs, r.Flags, dest) - if len(node.LinkData.Title) > 0 { - var titleBuff bytes.Buffer - titleBuff.WriteString("title=\"") - escapeHTML(&titleBuff, node.LinkData.Title) - titleBuff.WriteByte('"') - attrs = append(attrs, titleBuff.String()) - } - r.tag(w, aTag, attrs) - } else { - if node.NoteID != 0 { - break - } - r.out(w, aCloseTag) - } - } - case Image: - if r.Flags&SkipImages != 0 { - return SkipChildren - } - if entering { - dest := node.LinkData.Destination - dest = r.addAbsPrefix(dest) - if r.disableTags == 0 { - //if options.safe && potentiallyUnsafe(dest) { - //out(w, ``) - //} else { - r.out(w, []byte(`<img src=`)) - } - } - case Code: - r.out(w, codeTag) - escapeAllHTML(w, node.Literal) - r.out(w, codeCloseTag) - case Document: - break - case Paragraph: - if skipParagraphTags(node) { - break - } - if entering { - // TODO: untangle this clusterfuck about when the newlines need - // to be added and when not. - if node.Prev != nil { - switch node.Prev.Type { - case HTMLBlock, List, Paragraph, Heading, CodeBlock, BlockQuote, HorizontalRule: - r.cr(w) - } - } - if node.Parent.Type == BlockQuote && node.Prev == nil { - r.cr(w) - } - r.out(w, pTag) - } else { - r.out(w, pCloseTag) - if !(node.Parent.Type == Item && node.Next == nil) { - r.cr(w) - } - } - case BlockQuote: - if entering { - r.cr(w) - r.out(w, blockquoteTag) - } else { - r.out(w, blockquoteCloseTag) - r.cr(w) - } - case HTMLBlock: - if r.Flags&SkipHTML != 0 { - break - } - r.cr(w) - r.out(w, node.Literal) - r.cr(w) - case Heading: - headingLevel := r.HTMLRendererParameters.HeadingLevelOffset + node.Level - openTag, closeTag := headingTagsFromLevel(headingLevel) - if entering { - if node.IsTitleblock { - attrs = append(attrs, `class="title"`) - } - if node.HeadingID != "" { - id := r.ensureUniqueHeadingID(node.HeadingID) - if r.HeadingIDPrefix != "" { - id = r.HeadingIDPrefix + id - } - if r.HeadingIDSuffix != "" { - id = id + r.HeadingIDSuffix - } - attrs = append(attrs, fmt.Sprintf(`id="%s"`, id)) - } - r.cr(w) - r.tag(w, openTag, attrs) - } else { - r.out(w, closeTag) - if !(node.Parent.Type == Item && node.Next == nil) { - r.cr(w) - } - } - case HorizontalRule: - r.cr(w) - r.outHRTag(w) - r.cr(w) - case List: - openTag := ulTag - closeTag := ulCloseTag - if node.ListFlags&ListTypeOrdered != 0 { - openTag = olTag - closeTag = olCloseTag - } - if node.ListFlags&ListTypeDefinition != 0 { - openTag = dlTag - closeTag = dlCloseTag - } - if entering { - if node.IsFootnotesList { - r.out(w, footnotesDivBytes) - r.outHRTag(w) - r.cr(w) - } - r.cr(w) - if node.Parent.Type == Item && node.Parent.Parent.Tight { - r.cr(w) - } - r.tag(w, openTag[:len(openTag)-1], attrs) - r.cr(w) - } else { - r.out(w, closeTag) - //cr(w) - //if node.parent.Type != Item { - // cr(w) - //} - if node.Parent.Type == Item && node.Next != nil { - r.cr(w) - } - if node.Parent.Type == Document || node.Parent.Type == BlockQuote { - r.cr(w) - } - if node.IsFootnotesList { - r.out(w, footnotesCloseDivBytes) - } - } - case Item: - openTag := liTag - closeTag := liCloseTag - if node.ListFlags&ListTypeDefinition != 0 { - openTag = ddTag - closeTag = ddCloseTag - } - if node.ListFlags&ListTypeTerm != 0 { - openTag = dtTag - closeTag = dtCloseTag - } - if entering { - if itemOpenCR(node) { - r.cr(w) - } - if node.ListData.RefLink != nil { - slug := slugify(node.ListData.RefLink) - r.out(w, footnoteItem(r.FootnoteAnchorPrefix, slug)) - break - } - r.out(w, openTag) - } else { - if node.ListData.RefLink != nil { - slug := slugify(node.ListData.RefLink) - if r.Flags&FootnoteReturnLinks != 0 { - r.out(w, footnoteReturnLink(r.FootnoteAnchorPrefix, r.FootnoteReturnLinkContents, slug)) - } - } - r.out(w, closeTag) - r.cr(w) - } - case CodeBlock: - attrs = appendLanguageAttr(attrs, node.Info) - r.cr(w) - r.out(w, preTag) - r.tag(w, codeTag[:len(codeTag)-1], attrs) - escapeAllHTML(w, node.Literal) - r.out(w, codeCloseTag) - r.out(w, preCloseTag) - if node.Parent.Type != Item { - r.cr(w) - } - case Table: - if entering { - r.cr(w) - r.out(w, tableTag) - } else { - r.out(w, tableCloseTag) - r.cr(w) - } - case TableCell: - openTag := tdTag - closeTag := tdCloseTag - if node.IsHeader { - openTag = thTag - closeTag = thCloseTag - } - if entering { - align := cellAlignment(node.Align) - if align != "" { - attrs = append(attrs, fmt.Sprintf(`align="%s"`, align)) - } - if node.Prev == nil { - r.cr(w) - } - r.tag(w, openTag, attrs) - } else { - r.out(w, closeTag) - r.cr(w) - } - case TableHead: - if entering { - r.cr(w) - r.out(w, theadTag) - } else { - r.out(w, theadCloseTag) - r.cr(w) - } - case TableBody: - if entering { - r.cr(w) - r.out(w, tbodyTag) - // XXX: this is to adhere to a rather silly test. Should fix test. - if node.FirstChild == nil { - r.cr(w) - } - } else { - r.out(w, tbodyCloseTag) - r.cr(w) - } - case TableRow: - if entering { - r.cr(w) - r.out(w, trTag) - } else { - r.out(w, trCloseTag) - r.cr(w) - } - default: - panic("Unknown node type " + node.Type.String()) - } - return GoToNext -} - -// RenderHeader writes HTML document preamble and TOC if requested. -func (r *HTMLRenderer) RenderHeader(w io.Writer, ast *Node) { - r.writeDocumentHeader(w) - if r.Flags&TOC != 0 { - r.writeTOC(w, ast) - } -} - -// RenderFooter writes HTML document footer. -func (r *HTMLRenderer) RenderFooter(w io.Writer, ast *Node) { - if r.Flags&CompletePage == 0 { - return - } - io.WriteString(w, "\n\n\n") -} - -func (r *HTMLRenderer) writeDocumentHeader(w io.Writer) { - if r.Flags&CompletePage == 0 { - return - } - ending := "" - if r.Flags&UseXHTML != 0 { - io.WriteString(w, "\n") - io.WriteString(w, "\n") - ending = " /" - } else { - io.WriteString(w, "\n") - io.WriteString(w, "\n") - } - io.WriteString(w, "\n") - io.WriteString(w, " ") - if r.Flags&Smartypants != 0 { - r.sr.Process(w, []byte(r.Title)) - } else { - escapeHTML(w, []byte(r.Title)) - } - io.WriteString(w, "\n") - io.WriteString(w, " \n") - io.WriteString(w, " \n") - if r.CSS != "" { - io.WriteString(w, " \n") - } - if r.Icon != "" { - io.WriteString(w, " \n") - } - io.WriteString(w, "\n") - io.WriteString(w, "\n\n") -} - -func (r *HTMLRenderer) writeTOC(w io.Writer, ast *Node) { - buf := bytes.Buffer{} - - inHeading := false - tocLevel := 0 - headingCount := 0 - - ast.Walk(func(node *Node, entering bool) WalkStatus { - if node.Type == Heading && !node.HeadingData.IsTitleblock { - inHeading = entering - if entering { - node.HeadingID = fmt.Sprintf("toc_%d", headingCount) - if node.Level == tocLevel { - buf.WriteString("\n\n
  • ") - } else if node.Level < tocLevel { - for node.Level < tocLevel { - tocLevel-- - buf.WriteString("
    • \n") - } - buf.WriteString("\n\n
  • ") - } else { - for node.Level > tocLevel { - tocLevel++ - buf.WriteString("\n") - } - - if buf.Len() > 0 { - io.WriteString(w, "\n") - } - r.lastOutputLen = buf.Len() -} diff --git a/vendor/github.com/russross/blackfriday/v2/inline.go b/vendor/github.com/russross/blackfriday/v2/inline.go deleted file mode 100644 index d45bd94..0000000 --- a/vendor/github.com/russross/blackfriday/v2/inline.go +++ /dev/null @@ -1,1228 +0,0 @@ -// -// Blackfriday Markdown Processor -// Available at http://github.com/russross/blackfriday -// -// Copyright © 2011 Russ Ross . -// Distributed under the Simplified BSD License. -// See README.md for details. -// - -// -// Functions to parse inline elements. -// - -package blackfriday - -import ( - "bytes" - "regexp" - "strconv" -) - -var ( - urlRe = `((https?|ftp):\/\/|\/)[-A-Za-z0-9+&@#\/%?=~_|!:,.;\(\)]+` - anchorRe = regexp.MustCompile(`^(]+")?\s?>` + urlRe + `<\/a>)`) - - // https://www.w3.org/TR/html5/syntax.html#character-references - // highest unicode code point in 17 planes (2^20): 1,114,112d = - // 7 dec digits or 6 hex digits - // named entity references can be 2-31 characters with stuff like < - // at one end and ∳ at the other. There - // are also sometimes numbers at the end, although this isn't inherent - // in the specification; there are never numbers anywhere else in - // current character references, though; see ¾ and ▒, etc. - // https://www.w3.org/TR/html5/syntax.html#named-character-references - // - // entity := "&" (named group | number ref) ";" - // named group := [a-zA-Z]{2,31}[0-9]{0,2} - // number ref := "#" (dec ref | hex ref) - // dec ref := [0-9]{1,7} - // hex ref := ("x" | "X") [0-9a-fA-F]{1,6} - htmlEntityRe = regexp.MustCompile(`&([a-zA-Z]{2,31}[0-9]{0,2}|#([0-9]{1,7}|[xX][0-9a-fA-F]{1,6}));`) -) - -// Functions to parse text within a block -// Each function returns the number of chars taken care of -// data is the complete block being rendered -// offset is the number of valid chars before the current cursor - -func (p *Markdown) inline(currBlock *Node, data []byte) { - // handlers might call us recursively: enforce a maximum depth - if p.nesting >= p.maxNesting || len(data) == 0 { - return - } - p.nesting++ - beg, end := 0, 0 - for end < len(data) { - handler := p.inlineCallback[data[end]] - if handler != nil { - if consumed, node := handler(p, data, end); consumed == 0 { - // No action from the callback. - end++ - } else { - // Copy inactive chars into the output. - currBlock.AppendChild(text(data[beg:end])) - if node != nil { - currBlock.AppendChild(node) - } - // Skip past whatever the callback used. - beg = end + consumed - end = beg - } - } else { - end++ - } - } - if beg < len(data) { - if data[end-1] == '\n' { - end-- - } - currBlock.AppendChild(text(data[beg:end])) - } - p.nesting-- -} - -// single and double emphasis parsing -func emphasis(p *Markdown, data []byte, offset int) (int, *Node) { - data = data[offset:] - c := data[0] - - if len(data) > 2 && data[1] != c { - // whitespace cannot follow an opening emphasis; - // strikethrough only takes two characters '~~' - if c == '~' || isspace(data[1]) { - return 0, nil - } - ret, node := helperEmphasis(p, data[1:], c) - if ret == 0 { - return 0, nil - } - - return ret + 1, node - } - - if len(data) > 3 && data[1] == c && data[2] != c { - if isspace(data[2]) { - return 0, nil - } - ret, node := helperDoubleEmphasis(p, data[2:], c) - if ret == 0 { - return 0, nil - } - - return ret + 2, node - } - - if len(data) > 4 && data[1] == c && data[2] == c && data[3] != c { - if c == '~' || isspace(data[3]) { - return 0, nil - } - ret, node := helperTripleEmphasis(p, data, 3, c) - if ret == 0 { - return 0, nil - } - - return ret + 3, node - } - - return 0, nil -} - -func codeSpan(p *Markdown, data []byte, offset int) (int, *Node) { - data = data[offset:] - - nb := 0 - - // count the number of backticks in the delimiter - for nb < len(data) && data[nb] == '`' { - nb++ - } - - // find the next delimiter - i, end := 0, 0 - for end = nb; end < len(data) && i < nb; end++ { - if data[end] == '`' { - i++ - } else { - i = 0 - } - } - - // no matching delimiter? - if i < nb && end >= len(data) { - return 0, nil - } - - // trim outside whitespace - fBegin := nb - for fBegin < end && data[fBegin] == ' ' { - fBegin++ - } - - fEnd := end - nb - for fEnd > fBegin && data[fEnd-1] == ' ' { - fEnd-- - } - - // render the code span - if fBegin != fEnd { - code := NewNode(Code) - code.Literal = data[fBegin:fEnd] - return end, code - } - - return end, nil -} - -// newline preceded by two spaces becomes
    -func maybeLineBreak(p *Markdown, data []byte, offset int) (int, *Node) { - origOffset := offset - for offset < len(data) && data[offset] == ' ' { - offset++ - } - - if offset < len(data) && data[offset] == '\n' { - if offset-origOffset >= 2 { - return offset - origOffset + 1, NewNode(Hardbreak) - } - return offset - origOffset, nil - } - return 0, nil -} - -// newline without two spaces works when HardLineBreak is enabled -func lineBreak(p *Markdown, data []byte, offset int) (int, *Node) { - if p.extensions&HardLineBreak != 0 { - return 1, NewNode(Hardbreak) - } - return 0, nil -} - -type linkType int - -const ( - linkNormal linkType = iota - linkImg - linkDeferredFootnote - linkInlineFootnote -) - -func isReferenceStyleLink(data []byte, pos int, t linkType) bool { - if t == linkDeferredFootnote { - return false - } - return pos < len(data)-1 && data[pos] == '[' && data[pos+1] != '^' -} - -func maybeImage(p *Markdown, data []byte, offset int) (int, *Node) { - if offset < len(data)-1 && data[offset+1] == '[' { - return link(p, data, offset) - } - return 0, nil -} - -func maybeInlineFootnote(p *Markdown, data []byte, offset int) (int, *Node) { - if offset < len(data)-1 && data[offset+1] == '[' { - return link(p, data, offset) - } - return 0, nil -} - -// '[': parse a link or an image or a footnote -func link(p *Markdown, data []byte, offset int) (int, *Node) { - // no links allowed inside regular links, footnote, and deferred footnotes - if p.insideLink && (offset > 0 && data[offset-1] == '[' || len(data)-1 > offset && data[offset+1] == '^') { - return 0, nil - } - - var t linkType - switch { - // special case: ![^text] == deferred footnote (that follows something with - // an exclamation point) - case p.extensions&Footnotes != 0 && len(data)-1 > offset && data[offset+1] == '^': - t = linkDeferredFootnote - // ![alt] == image - case offset >= 0 && data[offset] == '!': - t = linkImg - offset++ - // ^[text] == inline footnote - // [^refId] == deferred footnote - case p.extensions&Footnotes != 0: - if offset >= 0 && data[offset] == '^' { - t = linkInlineFootnote - offset++ - } else if len(data)-1 > offset && data[offset+1] == '^' { - t = linkDeferredFootnote - } - // [text] == regular link - default: - t = linkNormal - } - - data = data[offset:] - - var ( - i = 1 - noteID int - title, link, altContent []byte - textHasNl = false - ) - - if t == linkDeferredFootnote { - i++ - } - - // look for the matching closing bracket - for level := 1; level > 0 && i < len(data); i++ { - switch { - case data[i] == '\n': - textHasNl = true - - case isBackslashEscaped(data, i): - continue - - case data[i] == '[': - level++ - - case data[i] == ']': - level-- - if level <= 0 { - i-- // compensate for extra i++ in for loop - } - } - } - - if i >= len(data) { - return 0, nil - } - - txtE := i - i++ - var footnoteNode *Node - - // skip any amount of whitespace or newline - // (this is much more lax than original markdown syntax) - for i < len(data) && isspace(data[i]) { - i++ - } - - // inline style link - switch { - case i < len(data) && data[i] == '(': - // skip initial whitespace - i++ - - for i < len(data) && isspace(data[i]) { - i++ - } - - linkB := i - - // look for link end: ' " ) - findlinkend: - for i < len(data) { - switch { - case data[i] == '\\': - i += 2 - - case data[i] == ')' || data[i] == '\'' || data[i] == '"': - break findlinkend - - default: - i++ - } - } - - if i >= len(data) { - return 0, nil - } - linkE := i - - // look for title end if present - titleB, titleE := 0, 0 - if data[i] == '\'' || data[i] == '"' { - i++ - titleB = i - - findtitleend: - for i < len(data) { - switch { - case data[i] == '\\': - i += 2 - - case data[i] == ')': - break findtitleend - - default: - i++ - } - } - - if i >= len(data) { - return 0, nil - } - - // skip whitespace after title - titleE = i - 1 - for titleE > titleB && isspace(data[titleE]) { - titleE-- - } - - // check for closing quote presence - if data[titleE] != '\'' && data[titleE] != '"' { - titleB, titleE = 0, 0 - linkE = i - } - } - - // remove whitespace at the end of the link - for linkE > linkB && isspace(data[linkE-1]) { - linkE-- - } - - // remove optional angle brackets around the link - if data[linkB] == '<' { - linkB++ - } - if data[linkE-1] == '>' { - linkE-- - } - - // build escaped link and title - if linkE > linkB { - link = data[linkB:linkE] - } - - if titleE > titleB { - title = data[titleB:titleE] - } - - i++ - - // reference style link - case isReferenceStyleLink(data, i, t): - var id []byte - altContentConsidered := false - - // look for the id - i++ - linkB := i - for i < len(data) && data[i] != ']' { - i++ - } - if i >= len(data) { - return 0, nil - } - linkE := i - - // find the reference - if linkB == linkE { - if textHasNl { - var b bytes.Buffer - - for j := 1; j < txtE; j++ { - switch { - case data[j] != '\n': - b.WriteByte(data[j]) - case data[j-1] != ' ': - b.WriteByte(' ') - } - } - - id = b.Bytes() - } else { - id = data[1:txtE] - altContentConsidered = true - } - } else { - id = data[linkB:linkE] - } - - // find the reference with matching id - lr, ok := p.getRef(string(id)) - if !ok { - return 0, nil - } - - // keep link and title from reference - link = lr.link - title = lr.title - if altContentConsidered { - altContent = lr.text - } - i++ - - // shortcut reference style link or reference or inline footnote - default: - var id []byte - - // craft the id - if textHasNl { - var b bytes.Buffer - - for j := 1; j < txtE; j++ { - switch { - case data[j] != '\n': - b.WriteByte(data[j]) - case data[j-1] != ' ': - b.WriteByte(' ') - } - } - - id = b.Bytes() - } else { - if t == linkDeferredFootnote { - id = data[2:txtE] // get rid of the ^ - } else { - id = data[1:txtE] - } - } - - footnoteNode = NewNode(Item) - if t == linkInlineFootnote { - // create a new reference - noteID = len(p.notes) + 1 - - var fragment []byte - if len(id) > 0 { - if len(id) < 16 { - fragment = make([]byte, len(id)) - } else { - fragment = make([]byte, 16) - } - copy(fragment, slugify(id)) - } else { - fragment = append([]byte("footnote-"), []byte(strconv.Itoa(noteID))...) - } - - ref := &reference{ - noteID: noteID, - hasBlock: false, - link: fragment, - title: id, - footnote: footnoteNode, - } - - p.notes = append(p.notes, ref) - - link = ref.link - title = ref.title - } else { - // find the reference with matching id - lr, ok := p.getRef(string(id)) - if !ok { - return 0, nil - } - - if t == linkDeferredFootnote { - lr.noteID = len(p.notes) + 1 - lr.footnote = footnoteNode - p.notes = append(p.notes, lr) - } - - // keep link and title from reference - link = lr.link - // if inline footnote, title == footnote contents - title = lr.title - noteID = lr.noteID - } - - // rewind the whitespace - i = txtE + 1 - } - - var uLink []byte - if t == linkNormal || t == linkImg { - if len(link) > 0 { - var uLinkBuf bytes.Buffer - unescapeText(&uLinkBuf, link) - uLink = uLinkBuf.Bytes() - } - - // links need something to click on and somewhere to go - if len(uLink) == 0 || (t == linkNormal && txtE <= 1) { - return 0, nil - } - } - - // call the relevant rendering function - var linkNode *Node - switch t { - case linkNormal: - linkNode = NewNode(Link) - linkNode.Destination = normalizeURI(uLink) - linkNode.Title = title - if len(altContent) > 0 { - linkNode.AppendChild(text(altContent)) - } else { - // links cannot contain other links, so turn off link parsing - // temporarily and recurse - insideLink := p.insideLink - p.insideLink = true - p.inline(linkNode, data[1:txtE]) - p.insideLink = insideLink - } - - case linkImg: - linkNode = NewNode(Image) - linkNode.Destination = uLink - linkNode.Title = title - linkNode.AppendChild(text(data[1:txtE])) - i++ - - case linkInlineFootnote, linkDeferredFootnote: - linkNode = NewNode(Link) - linkNode.Destination = link - linkNode.Title = title - linkNode.NoteID = noteID - linkNode.Footnote = footnoteNode - if t == linkInlineFootnote { - i++ - } - - default: - return 0, nil - } - - return i, linkNode -} - -func (p *Markdown) inlineHTMLComment(data []byte) int { - if len(data) < 5 { - return 0 - } - if data[0] != '<' || data[1] != '!' || data[2] != '-' || data[3] != '-' { - return 0 - } - i := 5 - // scan for an end-of-comment marker, across lines if necessary - for i < len(data) && !(data[i-2] == '-' && data[i-1] == '-' && data[i] == '>') { - i++ - } - // no end-of-comment marker - if i >= len(data) { - return 0 - } - return i + 1 -} - -func stripMailto(link []byte) []byte { - if bytes.HasPrefix(link, []byte("mailto://")) { - return link[9:] - } else if bytes.HasPrefix(link, []byte("mailto:")) { - return link[7:] - } else { - return link - } -} - -// autolinkType specifies a kind of autolink that gets detected. -type autolinkType int - -// These are the possible flag values for the autolink renderer. -const ( - notAutolink autolinkType = iota - normalAutolink - emailAutolink -) - -// '<' when tags or autolinks are allowed -func leftAngle(p *Markdown, data []byte, offset int) (int, *Node) { - data = data[offset:] - altype, end := tagLength(data) - if size := p.inlineHTMLComment(data); size > 0 { - end = size - } - if end > 2 { - if altype != notAutolink { - var uLink bytes.Buffer - unescapeText(&uLink, data[1:end+1-2]) - if uLink.Len() > 0 { - link := uLink.Bytes() - node := NewNode(Link) - node.Destination = link - if altype == emailAutolink { - node.Destination = append([]byte("mailto:"), link...) - } - node.AppendChild(text(stripMailto(link))) - return end, node - } - } else { - htmlTag := NewNode(HTMLSpan) - htmlTag.Literal = data[:end] - return end, htmlTag - } - } - - return end, nil -} - -// '\\' backslash escape -var escapeChars = []byte("\\`*_{}[]()#+-.!:|&<>~") - -func escape(p *Markdown, data []byte, offset int) (int, *Node) { - data = data[offset:] - - if len(data) > 1 { - if p.extensions&BackslashLineBreak != 0 && data[1] == '\n' { - return 2, NewNode(Hardbreak) - } - if bytes.IndexByte(escapeChars, data[1]) < 0 { - return 0, nil - } - - return 2, text(data[1:2]) - } - - return 2, nil -} - -func unescapeText(ob *bytes.Buffer, src []byte) { - i := 0 - for i < len(src) { - org := i - for i < len(src) && src[i] != '\\' { - i++ - } - - if i > org { - ob.Write(src[org:i]) - } - - if i+1 >= len(src) { - break - } - - ob.WriteByte(src[i+1]) - i += 2 - } -} - -// '&' escaped when it doesn't belong to an entity -// valid entities are assumed to be anything matching &#?[A-Za-z0-9]+; -func entity(p *Markdown, data []byte, offset int) (int, *Node) { - data = data[offset:] - - end := 1 - - if end < len(data) && data[end] == '#' { - end++ - } - - for end < len(data) && isalnum(data[end]) { - end++ - } - - if end < len(data) && data[end] == ';' { - end++ // real entity - } else { - return 0, nil // lone '&' - } - - ent := data[:end] - // undo & escaping or it will be converted to &amp; by another - // escaper in the renderer - if bytes.Equal(ent, []byte("&")) { - ent = []byte{'&'} - } - - return end, text(ent) -} - -func linkEndsWithEntity(data []byte, linkEnd int) bool { - entityRanges := htmlEntityRe.FindAllIndex(data[:linkEnd], -1) - return entityRanges != nil && entityRanges[len(entityRanges)-1][1] == linkEnd -} - -// hasPrefixCaseInsensitive is a custom implementation of -// strings.HasPrefix(strings.ToLower(s), prefix) -// we rolled our own because ToLower pulls in a huge machinery of lowercasing -// anything from Unicode and that's very slow. Since this func will only be -// used on ASCII protocol prefixes, we can take shortcuts. -func hasPrefixCaseInsensitive(s, prefix []byte) bool { - if len(s) < len(prefix) { - return false - } - delta := byte('a' - 'A') - for i, b := range prefix { - if b != s[i] && b != s[i]+delta { - return false - } - } - return true -} - -var protocolPrefixes = [][]byte{ - []byte("http://"), - []byte("https://"), - []byte("ftp://"), - []byte("file://"), - []byte("mailto:"), -} - -const shortestPrefix = 6 // len("ftp://"), the shortest of the above - -func maybeAutoLink(p *Markdown, data []byte, offset int) (int, *Node) { - // quick check to rule out most false hits - if p.insideLink || len(data) < offset+shortestPrefix { - return 0, nil - } - for _, prefix := range protocolPrefixes { - endOfHead := offset + 8 // 8 is the len() of the longest prefix - if endOfHead > len(data) { - endOfHead = len(data) - } - if hasPrefixCaseInsensitive(data[offset:endOfHead], prefix) { - return autoLink(p, data, offset) - } - } - return 0, nil -} - -func autoLink(p *Markdown, data []byte, offset int) (int, *Node) { - // Now a more expensive check to see if we're not inside an anchor element - anchorStart := offset - offsetFromAnchor := 0 - for anchorStart > 0 && data[anchorStart] != '<' { - anchorStart-- - offsetFromAnchor++ - } - - anchorStr := anchorRe.Find(data[anchorStart:]) - if anchorStr != nil { - anchorClose := NewNode(HTMLSpan) - anchorClose.Literal = anchorStr[offsetFromAnchor:] - return len(anchorStr) - offsetFromAnchor, anchorClose - } - - // scan backward for a word boundary - rewind := 0 - for offset-rewind > 0 && rewind <= 7 && isletter(data[offset-rewind-1]) { - rewind++ - } - if rewind > 6 { // longest supported protocol is "mailto" which has 6 letters - return 0, nil - } - - origData := data - data = data[offset-rewind:] - - if !isSafeLink(data) { - return 0, nil - } - - linkEnd := 0 - for linkEnd < len(data) && !isEndOfLink(data[linkEnd]) { - linkEnd++ - } - - // Skip punctuation at the end of the link - if (data[linkEnd-1] == '.' || data[linkEnd-1] == ',') && data[linkEnd-2] != '\\' { - linkEnd-- - } - - // But don't skip semicolon if it's a part of escaped entity: - if data[linkEnd-1] == ';' && data[linkEnd-2] != '\\' && !linkEndsWithEntity(data, linkEnd) { - linkEnd-- - } - - // See if the link finishes with a punctuation sign that can be closed. - var copen byte - switch data[linkEnd-1] { - case '"': - copen = '"' - case '\'': - copen = '\'' - case ')': - copen = '(' - case ']': - copen = '[' - case '}': - copen = '{' - default: - copen = 0 - } - - if copen != 0 { - bufEnd := offset - rewind + linkEnd - 2 - - openDelim := 1 - - /* Try to close the final punctuation sign in this same line; - * if we managed to close it outside of the URL, that means that it's - * not part of the URL. If it closes inside the URL, that means it - * is part of the URL. - * - * Examples: - * - * foo http://www.pokemon.com/Pikachu_(Electric) bar - * => http://www.pokemon.com/Pikachu_(Electric) - * - * foo (http://www.pokemon.com/Pikachu_(Electric)) bar - * => http://www.pokemon.com/Pikachu_(Electric) - * - * foo http://www.pokemon.com/Pikachu_(Electric)) bar - * => http://www.pokemon.com/Pikachu_(Electric)) - * - * (foo http://www.pokemon.com/Pikachu_(Electric)) bar - * => foo http://www.pokemon.com/Pikachu_(Electric) - */ - - for bufEnd >= 0 && origData[bufEnd] != '\n' && openDelim != 0 { - if origData[bufEnd] == data[linkEnd-1] { - openDelim++ - } - - if origData[bufEnd] == copen { - openDelim-- - } - - bufEnd-- - } - - if openDelim == 0 { - linkEnd-- - } - } - - var uLink bytes.Buffer - unescapeText(&uLink, data[:linkEnd]) - - if uLink.Len() > 0 { - node := NewNode(Link) - node.Destination = uLink.Bytes() - node.AppendChild(text(uLink.Bytes())) - return linkEnd, node - } - - return linkEnd, nil -} - -func isEndOfLink(char byte) bool { - return isspace(char) || char == '<' -} - -var validUris = [][]byte{[]byte("http://"), []byte("https://"), []byte("ftp://"), []byte("mailto://")} -var validPaths = [][]byte{[]byte("/"), []byte("./"), []byte("../")} - -func isSafeLink(link []byte) bool { - for _, path := range validPaths { - if len(link) >= len(path) && bytes.Equal(link[:len(path)], path) { - if len(link) == len(path) { - return true - } else if isalnum(link[len(path)]) { - return true - } - } - } - - for _, prefix := range validUris { - // TODO: handle unicode here - // case-insensitive prefix test - if len(link) > len(prefix) && bytes.Equal(bytes.ToLower(link[:len(prefix)]), prefix) && isalnum(link[len(prefix)]) { - return true - } - } - - return false -} - -// return the length of the given tag, or 0 is it's not valid -func tagLength(data []byte) (autolink autolinkType, end int) { - var i, j int - - // a valid tag can't be shorter than 3 chars - if len(data) < 3 { - return notAutolink, 0 - } - - // begins with a '<' optionally followed by '/', followed by letter or number - if data[0] != '<' { - return notAutolink, 0 - } - if data[1] == '/' { - i = 2 - } else { - i = 1 - } - - if !isalnum(data[i]) { - return notAutolink, 0 - } - - // scheme test - autolink = notAutolink - - // try to find the beginning of an URI - for i < len(data) && (isalnum(data[i]) || data[i] == '.' || data[i] == '+' || data[i] == '-') { - i++ - } - - if i > 1 && i < len(data) && data[i] == '@' { - if j = isMailtoAutoLink(data[i:]); j != 0 { - return emailAutolink, i + j - } - } - - if i > 2 && i < len(data) && data[i] == ':' { - autolink = normalAutolink - i++ - } - - // complete autolink test: no whitespace or ' or " - switch { - case i >= len(data): - autolink = notAutolink - case autolink != notAutolink: - j = i - - for i < len(data) { - if data[i] == '\\' { - i += 2 - } else if data[i] == '>' || data[i] == '\'' || data[i] == '"' || isspace(data[i]) { - break - } else { - i++ - } - - } - - if i >= len(data) { - return autolink, 0 - } - if i > j && data[i] == '>' { - return autolink, i + 1 - } - - // one of the forbidden chars has been found - autolink = notAutolink - } - i += bytes.IndexByte(data[i:], '>') - if i < 0 { - return autolink, 0 - } - return autolink, i + 1 -} - -// look for the address part of a mail autolink and '>' -// this is less strict than the original markdown e-mail address matching -func isMailtoAutoLink(data []byte) int { - nb := 0 - - // address is assumed to be: [-@._a-zA-Z0-9]+ with exactly one '@' - for i := 0; i < len(data); i++ { - if isalnum(data[i]) { - continue - } - - switch data[i] { - case '@': - nb++ - - case '-', '.', '_': - break - - case '>': - if nb == 1 { - return i + 1 - } - return 0 - default: - return 0 - } - } - - return 0 -} - -// look for the next emph char, skipping other constructs -func helperFindEmphChar(data []byte, c byte) int { - i := 0 - - for i < len(data) { - for i < len(data) && data[i] != c && data[i] != '`' && data[i] != '[' { - i++ - } - if i >= len(data) { - return 0 - } - // do not count escaped chars - if i != 0 && data[i-1] == '\\' { - i++ - continue - } - if data[i] == c { - return i - } - - if data[i] == '`' { - // skip a code span - tmpI := 0 - i++ - for i < len(data) && data[i] != '`' { - if tmpI == 0 && data[i] == c { - tmpI = i - } - i++ - } - if i >= len(data) { - return tmpI - } - i++ - } else if data[i] == '[' { - // skip a link - tmpI := 0 - i++ - for i < len(data) && data[i] != ']' { - if tmpI == 0 && data[i] == c { - tmpI = i - } - i++ - } - i++ - for i < len(data) && (data[i] == ' ' || data[i] == '\n') { - i++ - } - if i >= len(data) { - return tmpI - } - if data[i] != '[' && data[i] != '(' { // not a link - if tmpI > 0 { - return tmpI - } - continue - } - cc := data[i] - i++ - for i < len(data) && data[i] != cc { - if tmpI == 0 && data[i] == c { - return i - } - i++ - } - if i >= len(data) { - return tmpI - } - i++ - } - } - return 0 -} - -func helperEmphasis(p *Markdown, data []byte, c byte) (int, *Node) { - i := 0 - - // skip one symbol if coming from emph3 - if len(data) > 1 && data[0] == c && data[1] == c { - i = 1 - } - - for i < len(data) { - length := helperFindEmphChar(data[i:], c) - if length == 0 { - return 0, nil - } - i += length - if i >= len(data) { - return 0, nil - } - - if i+1 < len(data) && data[i+1] == c { - i++ - continue - } - - if data[i] == c && !isspace(data[i-1]) { - - if p.extensions&NoIntraEmphasis != 0 { - if !(i+1 == len(data) || isspace(data[i+1]) || ispunct(data[i+1])) { - continue - } - } - - emph := NewNode(Emph) - p.inline(emph, data[:i]) - return i + 1, emph - } - } - - return 0, nil -} - -func helperDoubleEmphasis(p *Markdown, data []byte, c byte) (int, *Node) { - i := 0 - - for i < len(data) { - length := helperFindEmphChar(data[i:], c) - if length == 0 { - return 0, nil - } - i += length - - if i+1 < len(data) && data[i] == c && data[i+1] == c && i > 0 && !isspace(data[i-1]) { - nodeType := Strong - if c == '~' { - nodeType = Del - } - node := NewNode(nodeType) - p.inline(node, data[:i]) - return i + 2, node - } - i++ - } - return 0, nil -} - -func helperTripleEmphasis(p *Markdown, data []byte, offset int, c byte) (int, *Node) { - i := 0 - origData := data - data = data[offset:] - - for i < len(data) { - length := helperFindEmphChar(data[i:], c) - if length == 0 { - return 0, nil - } - i += length - - // skip whitespace preceded symbols - if data[i] != c || isspace(data[i-1]) { - continue - } - - switch { - case i+2 < len(data) && data[i+1] == c && data[i+2] == c: - // triple symbol found - strong := NewNode(Strong) - em := NewNode(Emph) - strong.AppendChild(em) - p.inline(em, data[:i]) - return i + 3, strong - case (i+1 < len(data) && data[i+1] == c): - // double symbol found, hand over to emph1 - length, node := helperEmphasis(p, origData[offset-2:], c) - if length == 0 { - return 0, nil - } - return length - 2, node - default: - // single symbol found, hand over to emph2 - length, node := helperDoubleEmphasis(p, origData[offset-1:], c) - if length == 0 { - return 0, nil - } - return length - 1, node - } - } - return 0, nil -} - -func text(s []byte) *Node { - node := NewNode(Text) - node.Literal = s - return node -} - -func normalizeURI(s []byte) []byte { - return s // TODO: implement -} diff --git a/vendor/github.com/russross/blackfriday/v2/markdown.go b/vendor/github.com/russross/blackfriday/v2/markdown.go deleted file mode 100644 index 58d2e45..0000000 --- a/vendor/github.com/russross/blackfriday/v2/markdown.go +++ /dev/null @@ -1,950 +0,0 @@ -// Blackfriday Markdown Processor -// Available at http://github.com/russross/blackfriday -// -// Copyright © 2011 Russ Ross . -// Distributed under the Simplified BSD License. -// See README.md for details. - -package blackfriday - -import ( - "bytes" - "fmt" - "io" - "strings" - "unicode/utf8" -) - -// -// Markdown parsing and processing -// - -// Version string of the package. Appears in the rendered document when -// CompletePage flag is on. -const Version = "2.0" - -// Extensions is a bitwise or'ed collection of enabled Blackfriday's -// extensions. -type Extensions int - -// These are the supported markdown parsing extensions. -// OR these values together to select multiple extensions. -const ( - NoExtensions Extensions = 0 - NoIntraEmphasis Extensions = 1 << iota // Ignore emphasis markers inside words - Tables // Render tables - FencedCode // Render fenced code blocks - Autolink // Detect embedded URLs that are not explicitly marked - Strikethrough // Strikethrough text using ~~test~~ - LaxHTMLBlocks // Loosen up HTML block parsing rules - SpaceHeadings // Be strict about prefix heading rules - HardLineBreak // Translate newlines into line breaks - TabSizeEight // Expand tabs to eight spaces instead of four - Footnotes // Pandoc-style footnotes - NoEmptyLineBeforeBlock // No need to insert an empty line to start a (code, quote, ordered list, unordered list) block - HeadingIDs // specify heading IDs with {#id} - Titleblock // Titleblock ala pandoc - AutoHeadingIDs // Create the heading ID from the text - BackslashLineBreak // Translate trailing backslashes into line breaks - DefinitionLists // Render definition lists - - CommonHTMLFlags HTMLFlags = UseXHTML | Smartypants | - SmartypantsFractions | SmartypantsDashes | SmartypantsLatexDashes - - CommonExtensions Extensions = NoIntraEmphasis | Tables | FencedCode | - Autolink | Strikethrough | SpaceHeadings | HeadingIDs | - BackslashLineBreak | DefinitionLists -) - -// ListType contains bitwise or'ed flags for list and list item objects. -type ListType int - -// These are the possible flag values for the ListItem renderer. -// Multiple flag values may be ORed together. -// These are mostly of interest if you are writing a new output format. -const ( - ListTypeOrdered ListType = 1 << iota - ListTypeDefinition - ListTypeTerm - - ListItemContainsBlock - ListItemBeginningOfList // TODO: figure out if this is of any use now - ListItemEndOfList -) - -// CellAlignFlags holds a type of alignment in a table cell. -type CellAlignFlags int - -// These are the possible flag values for the table cell renderer. -// Only a single one of these values will be used; they are not ORed together. -// These are mostly of interest if you are writing a new output format. -const ( - TableAlignmentLeft CellAlignFlags = 1 << iota - TableAlignmentRight - TableAlignmentCenter = (TableAlignmentLeft | TableAlignmentRight) -) - -// The size of a tab stop. -const ( - TabSizeDefault = 4 - TabSizeDouble = 8 -) - -// blockTags is a set of tags that are recognized as HTML block tags. -// Any of these can be included in markdown text without special escaping. -var blockTags = map[string]struct{}{ - "blockquote": {}, - "del": {}, - "div": {}, - "dl": {}, - "fieldset": {}, - "form": {}, - "h1": {}, - "h2": {}, - "h3": {}, - "h4": {}, - "h5": {}, - "h6": {}, - "iframe": {}, - "ins": {}, - "math": {}, - "noscript": {}, - "ol": {}, - "pre": {}, - "p": {}, - "script": {}, - "style": {}, - "table": {}, - "ul": {}, - - // HTML5 - "address": {}, - "article": {}, - "aside": {}, - "canvas": {}, - "figcaption": {}, - "figure": {}, - "footer": {}, - "header": {}, - "hgroup": {}, - "main": {}, - "nav": {}, - "output": {}, - "progress": {}, - "section": {}, - "video": {}, -} - -// Renderer is the rendering interface. This is mostly of interest if you are -// implementing a new rendering format. -// -// Only an HTML implementation is provided in this repository, see the README -// for external implementations. -type Renderer interface { - // RenderNode is the main rendering method. It will be called once for - // every leaf node and twice for every non-leaf node (first with - // entering=true, then with entering=false). The method should write its - // rendition of the node to the supplied writer w. - RenderNode(w io.Writer, node *Node, entering bool) WalkStatus - - // RenderHeader is a method that allows the renderer to produce some - // content preceding the main body of the output document. The header is - // understood in the broad sense here. For example, the default HTML - // renderer will write not only the HTML document preamble, but also the - // table of contents if it was requested. - // - // The method will be passed an entire document tree, in case a particular - // implementation needs to inspect it to produce output. - // - // The output should be written to the supplied writer w. If your - // implementation has no header to write, supply an empty implementation. - RenderHeader(w io.Writer, ast *Node) - - // RenderFooter is a symmetric counterpart of RenderHeader. - RenderFooter(w io.Writer, ast *Node) -} - -// Callback functions for inline parsing. One such function is defined -// for each character that triggers a response when parsing inline data. -type inlineParser func(p *Markdown, data []byte, offset int) (int, *Node) - -// Markdown is a type that holds extensions and the runtime state used by -// Parse, and the renderer. You can not use it directly, construct it with New. -type Markdown struct { - renderer Renderer - referenceOverride ReferenceOverrideFunc - refs map[string]*reference - inlineCallback [256]inlineParser - extensions Extensions - nesting int - maxNesting int - insideLink bool - - // Footnotes need to be ordered as well as available to quickly check for - // presence. If a ref is also a footnote, it's stored both in refs and here - // in notes. Slice is nil if footnotes not enabled. - notes []*reference - - doc *Node - tip *Node // = doc - oldTip *Node - lastMatchedContainer *Node // = doc - allClosed bool -} - -func (p *Markdown) getRef(refid string) (ref *reference, found bool) { - if p.referenceOverride != nil { - r, overridden := p.referenceOverride(refid) - if overridden { - if r == nil { - return nil, false - } - return &reference{ - link: []byte(r.Link), - title: []byte(r.Title), - noteID: 0, - hasBlock: false, - text: []byte(r.Text)}, true - } - } - // refs are case insensitive - ref, found = p.refs[strings.ToLower(refid)] - return ref, found -} - -func (p *Markdown) finalize(block *Node) { - above := block.Parent - block.open = false - p.tip = above -} - -func (p *Markdown) addChild(node NodeType, offset uint32) *Node { - return p.addExistingChild(NewNode(node), offset) -} - -func (p *Markdown) addExistingChild(node *Node, offset uint32) *Node { - for !p.tip.canContain(node.Type) { - p.finalize(p.tip) - } - p.tip.AppendChild(node) - p.tip = node - return node -} - -func (p *Markdown) closeUnmatchedBlocks() { - if !p.allClosed { - for p.oldTip != p.lastMatchedContainer { - parent := p.oldTip.Parent - p.finalize(p.oldTip) - p.oldTip = parent - } - p.allClosed = true - } -} - -// -// -// Public interface -// -// - -// Reference represents the details of a link. -// See the documentation in Options for more details on use-case. -type Reference struct { - // Link is usually the URL the reference points to. - Link string - // Title is the alternate text describing the link in more detail. - Title string - // Text is the optional text to override the ref with if the syntax used was - // [refid][] - Text string -} - -// ReferenceOverrideFunc is expected to be called with a reference string and -// return either a valid Reference type that the reference string maps to or -// nil. If overridden is false, the default reference logic will be executed. -// See the documentation in Options for more details on use-case. -type ReferenceOverrideFunc func(reference string) (ref *Reference, overridden bool) - -// New constructs a Markdown processor. You can use the same With* functions as -// for Run() to customize parser's behavior and the renderer. -func New(opts ...Option) *Markdown { - var p Markdown - for _, opt := range opts { - opt(&p) - } - p.refs = make(map[string]*reference) - p.maxNesting = 16 - p.insideLink = false - docNode := NewNode(Document) - p.doc = docNode - p.tip = docNode - p.oldTip = docNode - p.lastMatchedContainer = docNode - p.allClosed = true - // register inline parsers - p.inlineCallback[' '] = maybeLineBreak - p.inlineCallback['*'] = emphasis - p.inlineCallback['_'] = emphasis - if p.extensions&Strikethrough != 0 { - p.inlineCallback['~'] = emphasis - } - p.inlineCallback['`'] = codeSpan - p.inlineCallback['\n'] = lineBreak - p.inlineCallback['['] = link - p.inlineCallback['<'] = leftAngle - p.inlineCallback['\\'] = escape - p.inlineCallback['&'] = entity - p.inlineCallback['!'] = maybeImage - p.inlineCallback['^'] = maybeInlineFootnote - if p.extensions&Autolink != 0 { - p.inlineCallback['h'] = maybeAutoLink - p.inlineCallback['m'] = maybeAutoLink - p.inlineCallback['f'] = maybeAutoLink - p.inlineCallback['H'] = maybeAutoLink - p.inlineCallback['M'] = maybeAutoLink - p.inlineCallback['F'] = maybeAutoLink - } - if p.extensions&Footnotes != 0 { - p.notes = make([]*reference, 0) - } - return &p -} - -// Option customizes the Markdown processor's default behavior. -type Option func(*Markdown) - -// WithRenderer allows you to override the default renderer. -func WithRenderer(r Renderer) Option { - return func(p *Markdown) { - p.renderer = r - } -} - -// WithExtensions allows you to pick some of the many extensions provided by -// Blackfriday. You can bitwise OR them. -func WithExtensions(e Extensions) Option { - return func(p *Markdown) { - p.extensions = e - } -} - -// WithNoExtensions turns off all extensions and custom behavior. -func WithNoExtensions() Option { - return func(p *Markdown) { - p.extensions = NoExtensions - p.renderer = NewHTMLRenderer(HTMLRendererParameters{ - Flags: HTMLFlagsNone, - }) - } -} - -// WithRefOverride sets an optional function callback that is called every -// time a reference is resolved. -// -// In Markdown, the link reference syntax can be made to resolve a link to -// a reference instead of an inline URL, in one of the following ways: -// -// * [link text][refid] -// * [refid][] -// -// Usually, the refid is defined at the bottom of the Markdown document. If -// this override function is provided, the refid is passed to the override -// function first, before consulting the defined refids at the bottom. If -// the override function indicates an override did not occur, the refids at -// the bottom will be used to fill in the link details. -func WithRefOverride(o ReferenceOverrideFunc) Option { - return func(p *Markdown) { - p.referenceOverride = o - } -} - -// Run is the main entry point to Blackfriday. It parses and renders a -// block of markdown-encoded text. -// -// The simplest invocation of Run takes one argument, input: -// output := Run(input) -// This will parse the input with CommonExtensions enabled and render it with -// the default HTMLRenderer (with CommonHTMLFlags). -// -// Variadic arguments opts can customize the default behavior. Since Markdown -// type does not contain exported fields, you can not use it directly. Instead, -// use the With* functions. For example, this will call the most basic -// functionality, with no extensions: -// output := Run(input, WithNoExtensions()) -// -// You can use any number of With* arguments, even contradicting ones. They -// will be applied in order of appearance and the latter will override the -// former: -// output := Run(input, WithNoExtensions(), WithExtensions(exts), -// WithRenderer(yourRenderer)) -func Run(input []byte, opts ...Option) []byte { - r := NewHTMLRenderer(HTMLRendererParameters{ - Flags: CommonHTMLFlags, - }) - optList := []Option{WithRenderer(r), WithExtensions(CommonExtensions)} - optList = append(optList, opts...) - parser := New(optList...) - ast := parser.Parse(input) - var buf bytes.Buffer - parser.renderer.RenderHeader(&buf, ast) - ast.Walk(func(node *Node, entering bool) WalkStatus { - return parser.renderer.RenderNode(&buf, node, entering) - }) - parser.renderer.RenderFooter(&buf, ast) - return buf.Bytes() -} - -// Parse is an entry point to the parsing part of Blackfriday. It takes an -// input markdown document and produces a syntax tree for its contents. This -// tree can then be rendered with a default or custom renderer, or -// analyzed/transformed by the caller to whatever non-standard needs they have. -// The return value is the root node of the syntax tree. -func (p *Markdown) Parse(input []byte) *Node { - p.block(input) - // Walk the tree and finish up some of unfinished blocks - for p.tip != nil { - p.finalize(p.tip) - } - // Walk the tree again and process inline markdown in each block - p.doc.Walk(func(node *Node, entering bool) WalkStatus { - if node.Type == Paragraph || node.Type == Heading || node.Type == TableCell { - p.inline(node, node.content) - node.content = nil - } - return GoToNext - }) - p.parseRefsToAST() - return p.doc -} - -func (p *Markdown) parseRefsToAST() { - if p.extensions&Footnotes == 0 || len(p.notes) == 0 { - return - } - p.tip = p.doc - block := p.addBlock(List, nil) - block.IsFootnotesList = true - block.ListFlags = ListTypeOrdered - flags := ListItemBeginningOfList - // Note: this loop is intentionally explicit, not range-form. This is - // because the body of the loop will append nested footnotes to p.notes and - // we need to process those late additions. Range form would only walk over - // the fixed initial set. - for i := 0; i < len(p.notes); i++ { - ref := p.notes[i] - p.addExistingChild(ref.footnote, 0) - block := ref.footnote - block.ListFlags = flags | ListTypeOrdered - block.RefLink = ref.link - if ref.hasBlock { - flags |= ListItemContainsBlock - p.block(ref.title) - } else { - p.inline(block, ref.title) - } - flags &^= ListItemBeginningOfList | ListItemContainsBlock - } - above := block.Parent - finalizeList(block) - p.tip = above - block.Walk(func(node *Node, entering bool) WalkStatus { - if node.Type == Paragraph || node.Type == Heading { - p.inline(node, node.content) - node.content = nil - } - return GoToNext - }) -} - -// -// Link references -// -// This section implements support for references that (usually) appear -// as footnotes in a document, and can be referenced anywhere in the document. -// The basic format is: -// -// [1]: http://www.google.com/ "Google" -// [2]: http://www.github.com/ "Github" -// -// Anywhere in the document, the reference can be linked by referring to its -// label, i.e., 1 and 2 in this example, as in: -// -// This library is hosted on [Github][2], a git hosting site. -// -// Actual footnotes as specified in Pandoc and supported by some other Markdown -// libraries such as php-markdown are also taken care of. They look like this: -// -// This sentence needs a bit of further explanation.[^note] -// -// [^note]: This is the explanation. -// -// Footnotes should be placed at the end of the document in an ordered list. -// Finally, there are inline footnotes such as: -// -// Inline footnotes^[Also supported.] provide a quick inline explanation, -// but are rendered at the bottom of the document. -// - -// reference holds all information necessary for a reference-style links or -// footnotes. -// -// Consider this markdown with reference-style links: -// -// [link][ref] -// -// [ref]: /url/ "tooltip title" -// -// It will be ultimately converted to this HTML: -// -//

    link

    -// -// And a reference structure will be populated as follows: -// -// p.refs["ref"] = &reference{ -// link: "/url/", -// title: "tooltip title", -// } -// -// Alternatively, reference can contain information about a footnote. Consider -// this markdown: -// -// Text needing a footnote.[^a] -// -// [^a]: This is the note -// -// A reference structure will be populated as follows: -// -// p.refs["a"] = &reference{ -// link: "a", -// title: "This is the note", -// noteID: , -// } -// -// TODO: As you can see, it begs for splitting into two dedicated structures -// for refs and for footnotes. -type reference struct { - link []byte - title []byte - noteID int // 0 if not a footnote ref - hasBlock bool - footnote *Node // a link to the Item node within a list of footnotes - - text []byte // only gets populated by refOverride feature with Reference.Text -} - -func (r *reference) String() string { - return fmt.Sprintf("{link: %q, title: %q, text: %q, noteID: %d, hasBlock: %v}", - r.link, r.title, r.text, r.noteID, r.hasBlock) -} - -// Check whether or not data starts with a reference link. -// If so, it is parsed and stored in the list of references -// (in the render struct). -// Returns the number of bytes to skip to move past it, -// or zero if the first line is not a reference. -func isReference(p *Markdown, data []byte, tabSize int) int { - // up to 3 optional leading spaces - if len(data) < 4 { - return 0 - } - i := 0 - for i < 3 && data[i] == ' ' { - i++ - } - - noteID := 0 - - // id part: anything but a newline between brackets - if data[i] != '[' { - return 0 - } - i++ - if p.extensions&Footnotes != 0 { - if i < len(data) && data[i] == '^' { - // we can set it to anything here because the proper noteIds will - // be assigned later during the second pass. It just has to be != 0 - noteID = 1 - i++ - } - } - idOffset := i - for i < len(data) && data[i] != '\n' && data[i] != '\r' && data[i] != ']' { - i++ - } - if i >= len(data) || data[i] != ']' { - return 0 - } - idEnd := i - // footnotes can have empty ID, like this: [^], but a reference can not be - // empty like this: []. Break early if it's not a footnote and there's no ID - if noteID == 0 && idOffset == idEnd { - return 0 - } - // spacer: colon (space | tab)* newline? (space | tab)* - i++ - if i >= len(data) || data[i] != ':' { - return 0 - } - i++ - for i < len(data) && (data[i] == ' ' || data[i] == '\t') { - i++ - } - if i < len(data) && (data[i] == '\n' || data[i] == '\r') { - i++ - if i < len(data) && data[i] == '\n' && data[i-1] == '\r' { - i++ - } - } - for i < len(data) && (data[i] == ' ' || data[i] == '\t') { - i++ - } - if i >= len(data) { - return 0 - } - - var ( - linkOffset, linkEnd int - titleOffset, titleEnd int - lineEnd int - raw []byte - hasBlock bool - ) - - if p.extensions&Footnotes != 0 && noteID != 0 { - linkOffset, linkEnd, raw, hasBlock = scanFootnote(p, data, i, tabSize) - lineEnd = linkEnd - } else { - linkOffset, linkEnd, titleOffset, titleEnd, lineEnd = scanLinkRef(p, data, i) - } - if lineEnd == 0 { - return 0 - } - - // a valid ref has been found - - ref := &reference{ - noteID: noteID, - hasBlock: hasBlock, - } - - if noteID > 0 { - // reusing the link field for the id since footnotes don't have links - ref.link = data[idOffset:idEnd] - // if footnote, it's not really a title, it's the contained text - ref.title = raw - } else { - ref.link = data[linkOffset:linkEnd] - ref.title = data[titleOffset:titleEnd] - } - - // id matches are case-insensitive - id := string(bytes.ToLower(data[idOffset:idEnd])) - - p.refs[id] = ref - - return lineEnd -} - -func scanLinkRef(p *Markdown, data []byte, i int) (linkOffset, linkEnd, titleOffset, titleEnd, lineEnd int) { - // link: whitespace-free sequence, optionally between angle brackets - if data[i] == '<' { - i++ - } - linkOffset = i - for i < len(data) && data[i] != ' ' && data[i] != '\t' && data[i] != '\n' && data[i] != '\r' { - i++ - } - linkEnd = i - if data[linkOffset] == '<' && data[linkEnd-1] == '>' { - linkOffset++ - linkEnd-- - } - - // optional spacer: (space | tab)* (newline | '\'' | '"' | '(' ) - for i < len(data) && (data[i] == ' ' || data[i] == '\t') { - i++ - } - if i < len(data) && data[i] != '\n' && data[i] != '\r' && data[i] != '\'' && data[i] != '"' && data[i] != '(' { - return - } - - // compute end-of-line - if i >= len(data) || data[i] == '\r' || data[i] == '\n' { - lineEnd = i - } - if i+1 < len(data) && data[i] == '\r' && data[i+1] == '\n' { - lineEnd++ - } - - // optional (space|tab)* spacer after a newline - if lineEnd > 0 { - i = lineEnd + 1 - for i < len(data) && (data[i] == ' ' || data[i] == '\t') { - i++ - } - } - - // optional title: any non-newline sequence enclosed in '"() alone on its line - if i+1 < len(data) && (data[i] == '\'' || data[i] == '"' || data[i] == '(') { - i++ - titleOffset = i - - // look for EOL - for i < len(data) && data[i] != '\n' && data[i] != '\r' { - i++ - } - if i+1 < len(data) && data[i] == '\n' && data[i+1] == '\r' { - titleEnd = i + 1 - } else { - titleEnd = i - } - - // step back - i-- - for i > titleOffset && (data[i] == ' ' || data[i] == '\t') { - i-- - } - if i > titleOffset && (data[i] == '\'' || data[i] == '"' || data[i] == ')') { - lineEnd = titleEnd - titleEnd = i - } - } - - return -} - -// The first bit of this logic is the same as Parser.listItem, but the rest -// is much simpler. This function simply finds the entire block and shifts it -// over by one tab if it is indeed a block (just returns the line if it's not). -// blockEnd is the end of the section in the input buffer, and contents is the -// extracted text that was shifted over one tab. It will need to be rendered at -// the end of the document. -func scanFootnote(p *Markdown, data []byte, i, indentSize int) (blockStart, blockEnd int, contents []byte, hasBlock bool) { - if i == 0 || len(data) == 0 { - return - } - - // skip leading whitespace on first line - for i < len(data) && data[i] == ' ' { - i++ - } - - blockStart = i - - // find the end of the line - blockEnd = i - for i < len(data) && data[i-1] != '\n' { - i++ - } - - // get working buffer - var raw bytes.Buffer - - // put the first line into the working buffer - raw.Write(data[blockEnd:i]) - blockEnd = i - - // process the following lines - containsBlankLine := false - -gatherLines: - for blockEnd < len(data) { - i++ - - // find the end of this line - for i < len(data) && data[i-1] != '\n' { - i++ - } - - // if it is an empty line, guess that it is part of this item - // and move on to the next line - if p.isEmpty(data[blockEnd:i]) > 0 { - containsBlankLine = true - blockEnd = i - continue - } - - n := 0 - if n = isIndented(data[blockEnd:i], indentSize); n == 0 { - // this is the end of the block. - // we don't want to include this last line in the index. - break gatherLines - } - - // if there were blank lines before this one, insert a new one now - if containsBlankLine { - raw.WriteByte('\n') - containsBlankLine = false - } - - // get rid of that first tab, write to buffer - raw.Write(data[blockEnd+n : i]) - hasBlock = true - - blockEnd = i - } - - if data[blockEnd-1] != '\n' { - raw.WriteByte('\n') - } - - contents = raw.Bytes() - - return -} - -// -// -// Miscellaneous helper functions -// -// - -// Test if a character is a punctuation symbol. -// Taken from a private function in regexp in the stdlib. -func ispunct(c byte) bool { - for _, r := range []byte("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~") { - if c == r { - return true - } - } - return false -} - -// Test if a character is a whitespace character. -func isspace(c byte) bool { - return ishorizontalspace(c) || isverticalspace(c) -} - -// Test if a character is a horizontal whitespace character. -func ishorizontalspace(c byte) bool { - return c == ' ' || c == '\t' -} - -// Test if a character is a vertical character. -func isverticalspace(c byte) bool { - return c == '\n' || c == '\r' || c == '\f' || c == '\v' -} - -// Test if a character is letter. -func isletter(c byte) bool { - return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') -} - -// Test if a character is a letter or a digit. -// TODO: check when this is looking for ASCII alnum and when it should use unicode -func isalnum(c byte) bool { - return (c >= '0' && c <= '9') || isletter(c) -} - -// Replace tab characters with spaces, aligning to the next TAB_SIZE column. -// always ends output with a newline -func expandTabs(out *bytes.Buffer, line []byte, tabSize int) { - // first, check for common cases: no tabs, or only tabs at beginning of line - i, prefix := 0, 0 - slowcase := false - for i = 0; i < len(line); i++ { - if line[i] == '\t' { - if prefix == i { - prefix++ - } else { - slowcase = true - break - } - } - } - - // no need to decode runes if all tabs are at the beginning of the line - if !slowcase { - for i = 0; i < prefix*tabSize; i++ { - out.WriteByte(' ') - } - out.Write(line[prefix:]) - return - } - - // the slow case: we need to count runes to figure out how - // many spaces to insert for each tab - column := 0 - i = 0 - for i < len(line) { - start := i - for i < len(line) && line[i] != '\t' { - _, size := utf8.DecodeRune(line[i:]) - i += size - column++ - } - - if i > start { - out.Write(line[start:i]) - } - - if i >= len(line) { - break - } - - for { - out.WriteByte(' ') - column++ - if column%tabSize == 0 { - break - } - } - - i++ - } -} - -// Find if a line counts as indented or not. -// Returns number of characters the indent is (0 = not indented). -func isIndented(data []byte, indentSize int) int { - if len(data) == 0 { - return 0 - } - if data[0] == '\t' { - return 1 - } - if len(data) < indentSize { - return 0 - } - for i := 0; i < indentSize; i++ { - if data[i] != ' ' { - return 0 - } - } - return indentSize -} - -// Create a url-safe slug for fragments -func slugify(in []byte) []byte { - if len(in) == 0 { - return in - } - out := make([]byte, 0, len(in)) - sym := false - - for _, ch := range in { - if isalnum(ch) { - sym = false - out = append(out, ch) - } else if sym { - continue - } else { - out = append(out, '-') - sym = true - } - } - var a, b int - var ch byte - for a, ch = range out { - if ch != '-' { - break - } - } - for b = len(out) - 1; b > 0; b-- { - if out[b] != '-' { - break - } - } - return out[a : b+1] -} diff --git a/vendor/github.com/russross/blackfriday/v2/node.go b/vendor/github.com/russross/blackfriday/v2/node.go deleted file mode 100644 index 04e6050..0000000 --- a/vendor/github.com/russross/blackfriday/v2/node.go +++ /dev/null @@ -1,360 +0,0 @@ -package blackfriday - -import ( - "bytes" - "fmt" -) - -// NodeType specifies a type of a single node of a syntax tree. Usually one -// node (and its type) corresponds to a single markdown feature, e.g. emphasis -// or code block. -type NodeType int - -// Constants for identifying different types of nodes. See NodeType. -const ( - Document NodeType = iota - BlockQuote - List - Item - Paragraph - Heading - HorizontalRule - Emph - Strong - Del - Link - Image - Text - HTMLBlock - CodeBlock - Softbreak - Hardbreak - Code - HTMLSpan - Table - TableCell - TableHead - TableBody - TableRow -) - -var nodeTypeNames = []string{ - Document: "Document", - BlockQuote: "BlockQuote", - List: "List", - Item: "Item", - Paragraph: "Paragraph", - Heading: "Heading", - HorizontalRule: "HorizontalRule", - Emph: "Emph", - Strong: "Strong", - Del: "Del", - Link: "Link", - Image: "Image", - Text: "Text", - HTMLBlock: "HTMLBlock", - CodeBlock: "CodeBlock", - Softbreak: "Softbreak", - Hardbreak: "Hardbreak", - Code: "Code", - HTMLSpan: "HTMLSpan", - Table: "Table", - TableCell: "TableCell", - TableHead: "TableHead", - TableBody: "TableBody", - TableRow: "TableRow", -} - -func (t NodeType) String() string { - return nodeTypeNames[t] -} - -// ListData contains fields relevant to a List and Item node type. -type ListData struct { - ListFlags ListType - Tight bool // Skip

    s around list item data if true - BulletChar byte // '*', '+' or '-' in bullet lists - Delimiter byte // '.' or ')' after the number in ordered lists - RefLink []byte // If not nil, turns this list item into a footnote item and triggers different rendering - IsFootnotesList bool // This is a list of footnotes -} - -// LinkData contains fields relevant to a Link node type. -type LinkData struct { - Destination []byte // Destination is what goes into a href - Title []byte // Title is the tooltip thing that goes in a title attribute - NoteID int // NoteID contains a serial number of a footnote, zero if it's not a footnote - Footnote *Node // If it's a footnote, this is a direct link to the footnote Node. Otherwise nil. -} - -// CodeBlockData contains fields relevant to a CodeBlock node type. -type CodeBlockData struct { - IsFenced bool // Specifies whether it's a fenced code block or an indented one - Info []byte // This holds the info string - FenceChar byte - FenceLength int - FenceOffset int -} - -// TableCellData contains fields relevant to a TableCell node type. -type TableCellData struct { - IsHeader bool // This tells if it's under the header row - Align CellAlignFlags // This holds the value for align attribute -} - -// HeadingData contains fields relevant to a Heading node type. -type HeadingData struct { - Level int // This holds the heading level number - HeadingID string // This might hold heading ID, if present - IsTitleblock bool // Specifies whether it's a title block -} - -// Node is a single element in the abstract syntax tree of the parsed document. -// It holds connections to the structurally neighboring nodes and, for certain -// types of nodes, additional information that might be needed when rendering. -type Node struct { - Type NodeType // Determines the type of the node - Parent *Node // Points to the parent - FirstChild *Node // Points to the first child, if any - LastChild *Node // Points to the last child, if any - Prev *Node // Previous sibling; nil if it's the first child - Next *Node // Next sibling; nil if it's the last child - - Literal []byte // Text contents of the leaf nodes - - HeadingData // Populated if Type is Heading - ListData // Populated if Type is List - CodeBlockData // Populated if Type is CodeBlock - LinkData // Populated if Type is Link - TableCellData // Populated if Type is TableCell - - content []byte // Markdown content of the block nodes - open bool // Specifies an open block node that has not been finished to process yet -} - -// NewNode allocates a node of a specified type. -func NewNode(typ NodeType) *Node { - return &Node{ - Type: typ, - open: true, - } -} - -func (n *Node) String() string { - ellipsis := "" - snippet := n.Literal - if len(snippet) > 16 { - snippet = snippet[:16] - ellipsis = "..." - } - return fmt.Sprintf("%s: '%s%s'", n.Type, snippet, ellipsis) -} - -// Unlink removes node 'n' from the tree. -// It panics if the node is nil. -func (n *Node) Unlink() { - if n.Prev != nil { - n.Prev.Next = n.Next - } else if n.Parent != nil { - n.Parent.FirstChild = n.Next - } - if n.Next != nil { - n.Next.Prev = n.Prev - } else if n.Parent != nil { - n.Parent.LastChild = n.Prev - } - n.Parent = nil - n.Next = nil - n.Prev = nil -} - -// AppendChild adds a node 'child' as a child of 'n'. -// It panics if either node is nil. -func (n *Node) AppendChild(child *Node) { - child.Unlink() - child.Parent = n - if n.LastChild != nil { - n.LastChild.Next = child - child.Prev = n.LastChild - n.LastChild = child - } else { - n.FirstChild = child - n.LastChild = child - } -} - -// InsertBefore inserts 'sibling' immediately before 'n'. -// It panics if either node is nil. -func (n *Node) InsertBefore(sibling *Node) { - sibling.Unlink() - sibling.Prev = n.Prev - if sibling.Prev != nil { - sibling.Prev.Next = sibling - } - sibling.Next = n - n.Prev = sibling - sibling.Parent = n.Parent - if sibling.Prev == nil { - sibling.Parent.FirstChild = sibling - } -} - -// IsContainer returns true if 'n' can contain children. -func (n *Node) IsContainer() bool { - switch n.Type { - case Document: - fallthrough - case BlockQuote: - fallthrough - case List: - fallthrough - case Item: - fallthrough - case Paragraph: - fallthrough - case Heading: - fallthrough - case Emph: - fallthrough - case Strong: - fallthrough - case Del: - fallthrough - case Link: - fallthrough - case Image: - fallthrough - case Table: - fallthrough - case TableHead: - fallthrough - case TableBody: - fallthrough - case TableRow: - fallthrough - case TableCell: - return true - default: - return false - } -} - -// IsLeaf returns true if 'n' is a leaf node. -func (n *Node) IsLeaf() bool { - return !n.IsContainer() -} - -func (n *Node) canContain(t NodeType) bool { - if n.Type == List { - return t == Item - } - if n.Type == Document || n.Type == BlockQuote || n.Type == Item { - return t != Item - } - if n.Type == Table { - return t == TableHead || t == TableBody - } - if n.Type == TableHead || n.Type == TableBody { - return t == TableRow - } - if n.Type == TableRow { - return t == TableCell - } - return false -} - -// WalkStatus allows NodeVisitor to have some control over the tree traversal. -// It is returned from NodeVisitor and different values allow Node.Walk to -// decide which node to go to next. -type WalkStatus int - -const ( - // GoToNext is the default traversal of every node. - GoToNext WalkStatus = iota - // SkipChildren tells walker to skip all children of current node. - SkipChildren - // Terminate tells walker to terminate the traversal. - Terminate -) - -// NodeVisitor is a callback to be called when traversing the syntax tree. -// Called twice for every node: once with entering=true when the branch is -// first visited, then with entering=false after all the children are done. -type NodeVisitor func(node *Node, entering bool) WalkStatus - -// Walk is a convenience method that instantiates a walker and starts a -// traversal of subtree rooted at n. -func (n *Node) Walk(visitor NodeVisitor) { - w := newNodeWalker(n) - for w.current != nil { - status := visitor(w.current, w.entering) - switch status { - case GoToNext: - w.next() - case SkipChildren: - w.entering = false - w.next() - case Terminate: - return - } - } -} - -type nodeWalker struct { - current *Node - root *Node - entering bool -} - -func newNodeWalker(root *Node) *nodeWalker { - return &nodeWalker{ - current: root, - root: root, - entering: true, - } -} - -func (nw *nodeWalker) next() { - if (!nw.current.IsContainer() || !nw.entering) && nw.current == nw.root { - nw.current = nil - return - } - if nw.entering && nw.current.IsContainer() { - if nw.current.FirstChild != nil { - nw.current = nw.current.FirstChild - nw.entering = true - } else { - nw.entering = false - } - } else if nw.current.Next == nil { - nw.current = nw.current.Parent - nw.entering = false - } else { - nw.current = nw.current.Next - nw.entering = true - } -} - -func dump(ast *Node) { - fmt.Println(dumpString(ast)) -} - -func dumpR(ast *Node, depth int) string { - if ast == nil { - return "" - } - indent := bytes.Repeat([]byte("\t"), depth) - content := ast.Literal - if content == nil { - content = ast.content - } - result := fmt.Sprintf("%s%s(%q)\n", indent, ast.Type, content) - for n := ast.FirstChild; n != nil; n = n.Next { - result += dumpR(n, depth+1) - } - return result -} - -func dumpString(ast *Node) string { - return dumpR(ast, 0) -} diff --git a/vendor/github.com/russross/blackfriday/v2/smartypants.go b/vendor/github.com/russross/blackfriday/v2/smartypants.go deleted file mode 100644 index 3a220e9..0000000 --- a/vendor/github.com/russross/blackfriday/v2/smartypants.go +++ /dev/null @@ -1,457 +0,0 @@ -// -// Blackfriday Markdown Processor -// Available at http://github.com/russross/blackfriday -// -// Copyright © 2011 Russ Ross . -// Distributed under the Simplified BSD License. -// See README.md for details. -// - -// -// -// SmartyPants rendering -// -// - -package blackfriday - -import ( - "bytes" - "io" -) - -// SPRenderer is a struct containing state of a Smartypants renderer. -type SPRenderer struct { - inSingleQuote bool - inDoubleQuote bool - callbacks [256]smartCallback -} - -func wordBoundary(c byte) bool { - return c == 0 || isspace(c) || ispunct(c) -} - -func tolower(c byte) byte { - if c >= 'A' && c <= 'Z' { - return c - 'A' + 'a' - } - return c -} - -func isdigit(c byte) bool { - return c >= '0' && c <= '9' -} - -func smartQuoteHelper(out *bytes.Buffer, previousChar byte, nextChar byte, quote byte, isOpen *bool, addNBSP bool) bool { - // edge of the buffer is likely to be a tag that we don't get to see, - // so we treat it like text sometimes - - // enumerate all sixteen possibilities for (previousChar, nextChar) - // each can be one of {0, space, punct, other} - switch { - case previousChar == 0 && nextChar == 0: - // context is not any help here, so toggle - *isOpen = !*isOpen - case isspace(previousChar) && nextChar == 0: - // [ "] might be [ "foo...] - *isOpen = true - case ispunct(previousChar) && nextChar == 0: - // [!"] hmm... could be [Run!"] or [("...] - *isOpen = false - case /* isnormal(previousChar) && */ nextChar == 0: - // [a"] is probably a close - *isOpen = false - case previousChar == 0 && isspace(nextChar): - // [" ] might be [...foo" ] - *isOpen = false - case isspace(previousChar) && isspace(nextChar): - // [ " ] context is not any help here, so toggle - *isOpen = !*isOpen - case ispunct(previousChar) && isspace(nextChar): - // [!" ] is probably a close - *isOpen = false - case /* isnormal(previousChar) && */ isspace(nextChar): - // [a" ] this is one of the easy cases - *isOpen = false - case previousChar == 0 && ispunct(nextChar): - // ["!] hmm... could be ["$1.95] or ["!...] - *isOpen = false - case isspace(previousChar) && ispunct(nextChar): - // [ "!] looks more like [ "$1.95] - *isOpen = true - case ispunct(previousChar) && ispunct(nextChar): - // [!"!] context is not any help here, so toggle - *isOpen = !*isOpen - case /* isnormal(previousChar) && */ ispunct(nextChar): - // [a"!] is probably a close - *isOpen = false - case previousChar == 0 /* && isnormal(nextChar) */ : - // ["a] is probably an open - *isOpen = true - case isspace(previousChar) /* && isnormal(nextChar) */ : - // [ "a] this is one of the easy cases - *isOpen = true - case ispunct(previousChar) /* && isnormal(nextChar) */ : - // [!"a] is probably an open - *isOpen = true - default: - // [a'b] maybe a contraction? - *isOpen = false - } - - // Note that with the limited lookahead, this non-breaking - // space will also be appended to single double quotes. - if addNBSP && !*isOpen { - out.WriteString(" ") - } - - out.WriteByte('&') - if *isOpen { - out.WriteByte('l') - } else { - out.WriteByte('r') - } - out.WriteByte(quote) - out.WriteString("quo;") - - if addNBSP && *isOpen { - out.WriteString(" ") - } - - return true -} - -func (r *SPRenderer) smartSingleQuote(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 2 { - t1 := tolower(text[1]) - - if t1 == '\'' { - nextChar := byte(0) - if len(text) >= 3 { - nextChar = text[2] - } - if smartQuoteHelper(out, previousChar, nextChar, 'd', &r.inDoubleQuote, false) { - return 1 - } - } - - if (t1 == 's' || t1 == 't' || t1 == 'm' || t1 == 'd') && (len(text) < 3 || wordBoundary(text[2])) { - out.WriteString("’") - return 0 - } - - if len(text) >= 3 { - t2 := tolower(text[2]) - - if ((t1 == 'r' && t2 == 'e') || (t1 == 'l' && t2 == 'l') || (t1 == 'v' && t2 == 'e')) && - (len(text) < 4 || wordBoundary(text[3])) { - out.WriteString("’") - return 0 - } - } - } - - nextChar := byte(0) - if len(text) > 1 { - nextChar = text[1] - } - if smartQuoteHelper(out, previousChar, nextChar, 's', &r.inSingleQuote, false) { - return 0 - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartParens(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 3 { - t1 := tolower(text[1]) - t2 := tolower(text[2]) - - if t1 == 'c' && t2 == ')' { - out.WriteString("©") - return 2 - } - - if t1 == 'r' && t2 == ')' { - out.WriteString("®") - return 2 - } - - if len(text) >= 4 && t1 == 't' && t2 == 'm' && text[3] == ')' { - out.WriteString("™") - return 3 - } - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartDash(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 2 { - if text[1] == '-' { - out.WriteString("—") - return 1 - } - - if wordBoundary(previousChar) && wordBoundary(text[1]) { - out.WriteString("–") - return 0 - } - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartDashLatex(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 3 && text[1] == '-' && text[2] == '-' { - out.WriteString("—") - return 2 - } - if len(text) >= 2 && text[1] == '-' { - out.WriteString("–") - return 1 - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartAmpVariant(out *bytes.Buffer, previousChar byte, text []byte, quote byte, addNBSP bool) int { - if bytes.HasPrefix(text, []byte(""")) { - nextChar := byte(0) - if len(text) >= 7 { - nextChar = text[6] - } - if smartQuoteHelper(out, previousChar, nextChar, quote, &r.inDoubleQuote, addNBSP) { - return 5 - } - } - - if bytes.HasPrefix(text, []byte("�")) { - return 3 - } - - out.WriteByte('&') - return 0 -} - -func (r *SPRenderer) smartAmp(angledQuotes, addNBSP bool) func(*bytes.Buffer, byte, []byte) int { - var quote byte = 'd' - if angledQuotes { - quote = 'a' - } - - return func(out *bytes.Buffer, previousChar byte, text []byte) int { - return r.smartAmpVariant(out, previousChar, text, quote, addNBSP) - } -} - -func (r *SPRenderer) smartPeriod(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 3 && text[1] == '.' && text[2] == '.' { - out.WriteString("…") - return 2 - } - - if len(text) >= 5 && text[1] == ' ' && text[2] == '.' && text[3] == ' ' && text[4] == '.' { - out.WriteString("…") - return 4 - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartBacktick(out *bytes.Buffer, previousChar byte, text []byte) int { - if len(text) >= 2 && text[1] == '`' { - nextChar := byte(0) - if len(text) >= 3 { - nextChar = text[2] - } - if smartQuoteHelper(out, previousChar, nextChar, 'd', &r.inDoubleQuote, false) { - return 1 - } - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartNumberGeneric(out *bytes.Buffer, previousChar byte, text []byte) int { - if wordBoundary(previousChar) && previousChar != '/' && len(text) >= 3 { - // is it of the form digits/digits(word boundary)?, i.e., \d+/\d+\b - // note: check for regular slash (/) or fraction slash (⁄, 0x2044, or 0xe2 81 84 in utf-8) - // and avoid changing dates like 1/23/2005 into fractions. - numEnd := 0 - for len(text) > numEnd && isdigit(text[numEnd]) { - numEnd++ - } - if numEnd == 0 { - out.WriteByte(text[0]) - return 0 - } - denStart := numEnd + 1 - if len(text) > numEnd+3 && text[numEnd] == 0xe2 && text[numEnd+1] == 0x81 && text[numEnd+2] == 0x84 { - denStart = numEnd + 3 - } else if len(text) < numEnd+2 || text[numEnd] != '/' { - out.WriteByte(text[0]) - return 0 - } - denEnd := denStart - for len(text) > denEnd && isdigit(text[denEnd]) { - denEnd++ - } - if denEnd == denStart { - out.WriteByte(text[0]) - return 0 - } - if len(text) == denEnd || wordBoundary(text[denEnd]) && text[denEnd] != '/' { - out.WriteString("") - out.Write(text[:numEnd]) - out.WriteString("⁄") - out.Write(text[denStart:denEnd]) - out.WriteString("") - return denEnd - 1 - } - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartNumber(out *bytes.Buffer, previousChar byte, text []byte) int { - if wordBoundary(previousChar) && previousChar != '/' && len(text) >= 3 { - if text[0] == '1' && text[1] == '/' && text[2] == '2' { - if len(text) < 4 || wordBoundary(text[3]) && text[3] != '/' { - out.WriteString("½") - return 2 - } - } - - if text[0] == '1' && text[1] == '/' && text[2] == '4' { - if len(text) < 4 || wordBoundary(text[3]) && text[3] != '/' || (len(text) >= 5 && tolower(text[3]) == 't' && tolower(text[4]) == 'h') { - out.WriteString("¼") - return 2 - } - } - - if text[0] == '3' && text[1] == '/' && text[2] == '4' { - if len(text) < 4 || wordBoundary(text[3]) && text[3] != '/' || (len(text) >= 6 && tolower(text[3]) == 't' && tolower(text[4]) == 'h' && tolower(text[5]) == 's') { - out.WriteString("¾") - return 2 - } - } - } - - out.WriteByte(text[0]) - return 0 -} - -func (r *SPRenderer) smartDoubleQuoteVariant(out *bytes.Buffer, previousChar byte, text []byte, quote byte) int { - nextChar := byte(0) - if len(text) > 1 { - nextChar = text[1] - } - if !smartQuoteHelper(out, previousChar, nextChar, quote, &r.inDoubleQuote, false) { - out.WriteString(""") - } - - return 0 -} - -func (r *SPRenderer) smartDoubleQuote(out *bytes.Buffer, previousChar byte, text []byte) int { - return r.smartDoubleQuoteVariant(out, previousChar, text, 'd') -} - -func (r *SPRenderer) smartAngledDoubleQuote(out *bytes.Buffer, previousChar byte, text []byte) int { - return r.smartDoubleQuoteVariant(out, previousChar, text, 'a') -} - -func (r *SPRenderer) smartLeftAngle(out *bytes.Buffer, previousChar byte, text []byte) int { - i := 0 - - for i < len(text) && text[i] != '>' { - i++ - } - - out.Write(text[:i+1]) - return i -} - -type smartCallback func(out *bytes.Buffer, previousChar byte, text []byte) int - -// NewSmartypantsRenderer constructs a Smartypants renderer object. -func NewSmartypantsRenderer(flags HTMLFlags) *SPRenderer { - var ( - r SPRenderer - - smartAmpAngled = r.smartAmp(true, false) - smartAmpAngledNBSP = r.smartAmp(true, true) - smartAmpRegular = r.smartAmp(false, false) - smartAmpRegularNBSP = r.smartAmp(false, true) - - addNBSP = flags&SmartypantsQuotesNBSP != 0 - ) - - if flags&SmartypantsAngledQuotes == 0 { - r.callbacks['"'] = r.smartDoubleQuote - if !addNBSP { - r.callbacks['&'] = smartAmpRegular - } else { - r.callbacks['&'] = smartAmpRegularNBSP - } - } else { - r.callbacks['"'] = r.smartAngledDoubleQuote - if !addNBSP { - r.callbacks['&'] = smartAmpAngled - } else { - r.callbacks['&'] = smartAmpAngledNBSP - } - } - r.callbacks['\''] = r.smartSingleQuote - r.callbacks['('] = r.smartParens - if flags&SmartypantsDashes != 0 { - if flags&SmartypantsLatexDashes == 0 { - r.callbacks['-'] = r.smartDash - } else { - r.callbacks['-'] = r.smartDashLatex - } - } - r.callbacks['.'] = r.smartPeriod - if flags&SmartypantsFractions == 0 { - r.callbacks['1'] = r.smartNumber - r.callbacks['3'] = r.smartNumber - } else { - for ch := '1'; ch <= '9'; ch++ { - r.callbacks[ch] = r.smartNumberGeneric - } - } - r.callbacks['<'] = r.smartLeftAngle - r.callbacks['`'] = r.smartBacktick - return &r -} - -// Process is the entry point of the Smartypants renderer. -func (r *SPRenderer) Process(w io.Writer, text []byte) { - mark := 0 - for i := 0; i < len(text); i++ { - if action := r.callbacks[text[i]]; action != nil { - if i > mark { - w.Write(text[mark:i]) - } - previousChar := byte(0) - if i > 0 { - previousChar = text[i-1] - } - var tmp bytes.Buffer - i += action(&tmp, previousChar, text[i:]) - w.Write(tmp.Bytes()) - mark = i + 1 - } - } - if mark < len(text) { - w.Write(text[mark:]) - } -} diff --git a/vendor/github.com/urfave/cli/v2/.flake8 b/vendor/github.com/urfave/cli/v2/.flake8 deleted file mode 100644 index 6deafc2..0000000 --- a/vendor/github.com/urfave/cli/v2/.flake8 +++ /dev/null @@ -1,2 +0,0 @@ -[flake8] -max-line-length = 120 diff --git a/vendor/github.com/urfave/cli/v2/.gitignore b/vendor/github.com/urfave/cli/v2/.gitignore deleted file mode 100644 index d7d26b1..0000000 --- a/vendor/github.com/urfave/cli/v2/.gitignore +++ /dev/null @@ -1,13 +0,0 @@ -*.coverprofile -*.exe -*.orig -.*envrc -.envrc -.idea -/.local/ -/site/ -coverage.txt -internal/*/built-example -vendor -/cmd/urfave-cli-genflags/urfave-cli-genflags -*.exe diff --git a/vendor/github.com/urfave/cli/v2/CODE_OF_CONDUCT.md b/vendor/github.com/urfave/cli/v2/CODE_OF_CONDUCT.md deleted file mode 100644 index 9fee148..0000000 --- a/vendor/github.com/urfave/cli/v2/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,75 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -education, socio-economic status, nationality, personal appearance, race, -religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting urfave-governance@googlegroups.com, a members-only group -that is world-postable. All complaints will be reviewed and investigated and -will result in a response that is deemed necessary and appropriate to the -circumstances. The project team is obligated to maintain confidentiality with -regard to the reporter of an incident. Further details of specific enforcement -policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - diff --git a/vendor/github.com/urfave/cli/v2/LICENSE b/vendor/github.com/urfave/cli/v2/LICENSE deleted file mode 100644 index 2c84c78..0000000 --- a/vendor/github.com/urfave/cli/v2/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2022 urfave/cli maintainers - -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. diff --git a/vendor/github.com/urfave/cli/v2/Makefile b/vendor/github.com/urfave/cli/v2/Makefile deleted file mode 100644 index f0d4190..0000000 --- a/vendor/github.com/urfave/cli/v2/Makefile +++ /dev/null @@ -1,26 +0,0 @@ -# NOTE: this Makefile is meant to provide a simplified entry point for humans to -# run all of the critical steps to verify one's changes are harmonious in -# nature. Keeping target bodies to one line each and abstaining from make magic -# are very important so that maintainers and contributors can focus their -# attention on files that are primarily Go. - -GO_RUN_BUILD := go run internal/build/build.go - -.PHONY: all -all: generate vet test check-binary-size gfmrun yamlfmt v2diff - -# NOTE: this is a special catch-all rule to run any of the commands -# defined in internal/build/build.go with optional arguments passed -# via GFLAGS (global flags) and FLAGS (command-specific flags), e.g.: -# -# $ make test GFLAGS='--packages cli' -%: - $(GO_RUN_BUILD) $(GFLAGS) $* $(FLAGS) - -.PHONY: docs -docs: - mkdocs build - -.PHONY: serve-docs -serve-docs: - mkdocs serve diff --git a/vendor/github.com/urfave/cli/v2/README.md b/vendor/github.com/urfave/cli/v2/README.md deleted file mode 100644 index 9080aee..0000000 --- a/vendor/github.com/urfave/cli/v2/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# cli - -[![Run Tests](https://github.com/urfave/cli/actions/workflows/cli.yml/badge.svg?branch=v2-maint)](https://github.com/urfave/cli/actions/workflows/cli.yml) -[![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli/v2.svg)](https://pkg.go.dev/github.com/urfave/cli/v2) -[![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli/v2)](https://goreportcard.com/report/github.com/urfave/cli/v2) -[![codecov](https://codecov.io/gh/urfave/cli/branch/v2-maint/graph/badge.svg?token=t9YGWLh05g)](https://app.codecov.io/gh/urfave/cli/tree/v2-maint) - -cli is a simple, fast, and fun package for building command line apps in Go. The -goal is to enable developers to write fast and distributable command line -applications in an expressive way. - -## Documentation - -More documentation is available in [`./docs`](./docs) or the hosted -documentation site at . - -## License - -See [`LICENSE`](./LICENSE) diff --git a/vendor/github.com/urfave/cli/v2/app.go b/vendor/github.com/urfave/cli/v2/app.go deleted file mode 100644 index 19b76c9..0000000 --- a/vendor/github.com/urfave/cli/v2/app.go +++ /dev/null @@ -1,556 +0,0 @@ -package cli - -import ( - "context" - "flag" - "fmt" - "io" - "os" - "path/filepath" - "sort" - "strings" - "time" -) - -const suggestDidYouMeanTemplate = "Did you mean %q?" - -var ( - changeLogURL = "https://github.com/urfave/cli/blob/main/docs/CHANGELOG.md" - appActionDeprecationURL = fmt.Sprintf("%s#deprecated-cli-app-action-signature", changeLogURL) - contactSysadmin = "This is an error in the application. Please contact the distributor of this application if this is not you." - errInvalidActionType = NewExitError("ERROR invalid Action type. "+ - fmt.Sprintf("Must be `func(*Context`)` or `func(*Context) error). %s", contactSysadmin)+ - fmt.Sprintf("See %s", appActionDeprecationURL), 2) - ignoreFlagPrefix = "test." // this is to ignore test flags when adding flags from other packages - - SuggestFlag SuggestFlagFunc = suggestFlag - SuggestCommand SuggestCommandFunc = suggestCommand - SuggestDidYouMeanTemplate string = suggestDidYouMeanTemplate -) - -// App is the main structure of a cli application. It is recommended that -// an app be created with the cli.NewApp() function -type App struct { - // The name of the program. Defaults to path.Base(os.Args[0]) - Name string - // Full name of command for help, defaults to Name - HelpName string - // Description of the program. - Usage string - // Text to override the USAGE section of help - UsageText string - // Description of the program argument format. - ArgsUsage string - // Version of the program - Version string - // Description of the program - Description string - // DefaultCommand is the (optional) name of a command - // to run if no command names are passed as CLI arguments. - DefaultCommand string - // List of commands to execute - Commands []*Command - // List of flags to parse - Flags []Flag - // Boolean to enable bash completion commands - EnableBashCompletion bool - // Boolean to hide built-in help command and help flag - HideHelp bool - // Boolean to hide built-in help command but keep help flag. - // Ignored if HideHelp is true. - HideHelpCommand bool - // Boolean to hide built-in version flag and the VERSION section of help - HideVersion bool - // categories contains the categorized commands and is populated on app startup - categories CommandCategories - // flagCategories contains the categorized flags and is populated on app startup - flagCategories FlagCategories - // An action to execute when the shell completion flag is set - BashComplete BashCompleteFunc - // An action to execute before any subcommands are run, but after the context is ready - // If a non-nil error is returned, no subcommands are run - Before BeforeFunc - // An action to execute after any subcommands are run, but after the subcommand has finished - // It is run even if Action() panics - After AfterFunc - // The action to execute when no subcommands are specified - Action ActionFunc - // Execute this function if the proper command cannot be found - CommandNotFound CommandNotFoundFunc - // Execute this function if a usage error occurs - OnUsageError OnUsageErrorFunc - // Execute this function when an invalid flag is accessed from the context - InvalidFlagAccessHandler InvalidFlagAccessFunc - // Compilation date - Compiled time.Time - // List of all authors who contributed - Authors []*Author - // Copyright of the binary if any - Copyright string - // Reader reader to write input to (useful for tests) - Reader io.Reader - // Writer writer to write output to - Writer io.Writer - // ErrWriter writes error output - ErrWriter io.Writer - // ExitErrHandler processes any error encountered while running an App before - // it is returned to the caller. If no function is provided, HandleExitCoder - // is used as the default behavior. - ExitErrHandler ExitErrHandlerFunc - // Other custom info - Metadata map[string]interface{} - // Carries a function which returns app specific info. - ExtraInfo func() map[string]string - // CustomAppHelpTemplate the text template for app help topic. - // cli.go uses text/template to render templates. You can - // render custom help text by setting this variable. - CustomAppHelpTemplate string - // SliceFlagSeparator is used to customize the separator for SliceFlag, the default is "," - SliceFlagSeparator string - // DisableSliceFlagSeparator is used to disable SliceFlagSeparator, the default is false - DisableSliceFlagSeparator bool - // Boolean to enable short-option handling so user can combine several - // single-character bool arguments into one - // i.e. foobar -o -v -> foobar -ov - UseShortOptionHandling bool - // Enable suggestions for commands and flags - Suggest bool - // Allows global flags set by libraries which use flag.XXXVar(...) directly - // to be parsed through this library - AllowExtFlags bool - // Treat all flags as normal arguments if true - SkipFlagParsing bool - - didSetup bool - separator separatorSpec - - rootCommand *Command -} - -type SuggestFlagFunc func(flags []Flag, provided string, hideHelp bool) string - -type SuggestCommandFunc func(commands []*Command, provided string) string - -// Tries to find out when this binary was compiled. -// Returns the current time if it fails to find it. -func compileTime() time.Time { - info, err := os.Stat(os.Args[0]) - if err != nil { - return time.Now() - } - return info.ModTime() -} - -// NewApp creates a new cli Application with some reasonable defaults for Name, -// Usage, Version and Action. -func NewApp() *App { - return &App{ - Name: filepath.Base(os.Args[0]), - Usage: "A new cli application", - UsageText: "", - BashComplete: DefaultAppComplete, - Action: helpCommand.Action, - Compiled: compileTime(), - Reader: os.Stdin, - Writer: os.Stdout, - ErrWriter: os.Stderr, - } -} - -// Setup runs initialization code to ensure all data structures are ready for -// `Run` or inspection prior to `Run`. It is internally called by `Run`, but -// will return early if setup has already happened. -func (a *App) Setup() { - if a.didSetup { - return - } - - a.didSetup = true - - if a.Name == "" { - a.Name = filepath.Base(os.Args[0]) - } - - if a.HelpName == "" { - a.HelpName = a.Name - } - - if a.Usage == "" { - a.Usage = "A new cli application" - } - - if a.Version == "" { - a.HideVersion = true - } - - if a.BashComplete == nil { - a.BashComplete = DefaultAppComplete - } - - if a.Action == nil { - a.Action = helpCommand.Action - } - - if a.Compiled == (time.Time{}) { - a.Compiled = compileTime() - } - - if a.Reader == nil { - a.Reader = os.Stdin - } - - if a.Writer == nil { - a.Writer = os.Stdout - } - - if a.ErrWriter == nil { - a.ErrWriter = os.Stderr - } - - if a.AllowExtFlags { - // add global flags added by other packages - flag.VisitAll(func(f *flag.Flag) { - // skip test flags - if !strings.HasPrefix(f.Name, ignoreFlagPrefix) { - a.Flags = append(a.Flags, &extFlag{f}) - } - }) - } - - if len(a.SliceFlagSeparator) != 0 { - a.separator.customized = true - a.separator.sep = a.SliceFlagSeparator - } - - if a.DisableSliceFlagSeparator { - a.separator.customized = true - a.separator.disabled = true - } - - var newCommands []*Command - - for _, c := range a.Commands { - cname := c.Name - if c.HelpName != "" { - cname = c.HelpName - } - c.separator = a.separator - c.HelpName = fmt.Sprintf("%s %s", a.HelpName, cname) - c.flagCategories = newFlagCategoriesFromFlags(c.Flags) - newCommands = append(newCommands, c) - } - a.Commands = newCommands - - if a.Command(helpCommand.Name) == nil && !a.HideHelp { - if !a.HideHelpCommand { - a.appendCommand(helpCommand) - } - - if HelpFlag != nil { - a.appendFlag(HelpFlag) - } - } - - if !a.HideVersion { - a.appendFlag(VersionFlag) - } - - a.categories = newCommandCategories() - for _, command := range a.Commands { - a.categories.AddCommand(command.Category, command) - } - sort.Sort(a.categories.(*commandCategories)) - - a.flagCategories = newFlagCategoriesFromFlags(a.Flags) - - if a.Metadata == nil { - a.Metadata = make(map[string]interface{}) - } -} - -func (a *App) newRootCommand() *Command { - return &Command{ - Name: a.Name, - Usage: a.Usage, - UsageText: a.UsageText, - Description: a.Description, - ArgsUsage: a.ArgsUsage, - BashComplete: a.BashComplete, - Before: a.Before, - After: a.After, - Action: a.Action, - OnUsageError: a.OnUsageError, - Subcommands: a.Commands, - Flags: a.Flags, - flagCategories: a.flagCategories, - HideHelp: a.HideHelp, - HideHelpCommand: a.HideHelpCommand, - UseShortOptionHandling: a.UseShortOptionHandling, - HelpName: a.HelpName, - CustomHelpTemplate: a.CustomAppHelpTemplate, - categories: a.categories, - SkipFlagParsing: a.SkipFlagParsing, - isRoot: true, - separator: a.separator, - } -} - -func (a *App) newFlagSet() (*flag.FlagSet, error) { - return flagSet(a.Name, a.Flags, a.separator) -} - -func (a *App) useShortOptionHandling() bool { - return a.UseShortOptionHandling -} - -// Run is the entry point to the cli app. Parses the arguments slice and routes -// to the proper flag/args combination -func (a *App) Run(arguments []string) (err error) { - return a.RunContext(context.Background(), arguments) -} - -// RunContext is like Run except it takes a Context that will be -// passed to its commands and sub-commands. Through this, you can -// propagate timeouts and cancellation requests -func (a *App) RunContext(ctx context.Context, arguments []string) (err error) { - a.Setup() - - // handle the completion flag separately from the flagset since - // completion could be attempted after a flag, but before its value was put - // on the command line. this causes the flagset to interpret the completion - // flag name as the value of the flag before it which is undesirable - // note that we can only do this because the shell autocomplete function - // always appends the completion flag at the end of the command - shellComplete, arguments := checkShellCompleteFlag(a, arguments) - - cCtx := NewContext(a, nil, &Context{Context: ctx}) - cCtx.shellComplete = shellComplete - - a.rootCommand = a.newRootCommand() - cCtx.Command = a.rootCommand - - return a.rootCommand.Run(cCtx, arguments...) -} - -// RunAsSubcommand is for legacy/compatibility purposes only. New code should only -// use App.RunContext. This function is slated to be removed in v3. -func (a *App) RunAsSubcommand(ctx *Context) (err error) { - a.Setup() - - cCtx := NewContext(a, nil, ctx) - cCtx.shellComplete = ctx.shellComplete - - a.rootCommand = a.newRootCommand() - cCtx.Command = a.rootCommand - - return a.rootCommand.Run(cCtx, ctx.Args().Slice()...) -} - -func (a *App) suggestFlagFromError(err error, command string) (string, error) { - flag, parseErr := flagFromError(err) - if parseErr != nil { - return "", err - } - - flags := a.Flags - hideHelp := a.HideHelp - if command != "" { - cmd := a.Command(command) - if cmd == nil { - return "", err - } - flags = cmd.Flags - hideHelp = hideHelp || cmd.HideHelp - } - - suggestion := SuggestFlag(flags, flag, hideHelp) - if len(suggestion) == 0 { - return "", err - } - - return fmt.Sprintf(SuggestDidYouMeanTemplate+"\n\n", suggestion), nil -} - -// RunAndExitOnError calls .Run() and exits non-zero if an error was returned -// -// Deprecated: instead you should return an error that fulfills cli.ExitCoder -// to cli.App.Run. This will cause the application to exit with the given error -// code in the cli.ExitCoder -func (a *App) RunAndExitOnError() { - if err := a.Run(os.Args); err != nil { - _, _ = fmt.Fprintln(a.ErrWriter, err) - OsExiter(1) - } -} - -// Command returns the named command on App. Returns nil if the command does not exist -func (a *App) Command(name string) *Command { - for _, c := range a.Commands { - if c.HasName(name) { - return c - } - } - - return nil -} - -// VisibleCategories returns a slice of categories and commands that are -// Hidden=false -func (a *App) VisibleCategories() []CommandCategory { - ret := []CommandCategory{} - for _, category := range a.categories.Categories() { - if visible := func() CommandCategory { - if len(category.VisibleCommands()) > 0 { - return category - } - return nil - }(); visible != nil { - ret = append(ret, visible) - } - } - return ret -} - -// VisibleCommands returns a slice of the Commands with Hidden=false -func (a *App) VisibleCommands() []*Command { - var ret []*Command - for _, command := range a.Commands { - if !command.Hidden { - ret = append(ret, command) - } - } - return ret -} - -// VisibleFlagCategories returns a slice containing all the categories with the flags they contain -func (a *App) VisibleFlagCategories() []VisibleFlagCategory { - if a.flagCategories == nil { - return []VisibleFlagCategory{} - } - return a.flagCategories.VisibleCategories() -} - -// VisibleFlags returns a slice of the Flags with Hidden=false -func (a *App) VisibleFlags() []Flag { - return visibleFlags(a.Flags) -} - -func (a *App) appendFlag(fl Flag) { - if !hasFlag(a.Flags, fl) { - a.Flags = append(a.Flags, fl) - } -} - -func (a *App) appendCommand(c *Command) { - if !hasCommand(a.Commands, c) { - a.Commands = append(a.Commands, c) - } -} - -func (a *App) handleExitCoder(cCtx *Context, err error) { - if a.ExitErrHandler != nil { - a.ExitErrHandler(cCtx, err) - } else { - HandleExitCoder(err) - } -} - -func (a *App) commandNames() []string { - var cmdNames []string - - for _, cmd := range a.Commands { - cmdNames = append(cmdNames, cmd.Names()...) - } - - return cmdNames -} - -func (a *App) validCommandName(checkCmdName string) bool { - valid := false - allCommandNames := a.commandNames() - - for _, cmdName := range allCommandNames { - if checkCmdName == cmdName { - valid = true - break - } - } - - return valid -} - -func (a *App) argsWithDefaultCommand(oldArgs Args) Args { - if a.DefaultCommand != "" { - rawArgs := append([]string{a.DefaultCommand}, oldArgs.Slice()...) - newArgs := args(rawArgs) - - return &newArgs - } - - return oldArgs -} - -func runFlagActions(c *Context, fs []Flag) error { - for _, f := range fs { - isSet := false - for _, name := range f.Names() { - if c.IsSet(name) { - isSet = true - break - } - } - if isSet { - if af, ok := f.(ActionableFlag); ok { - if err := af.RunAction(c); err != nil { - return err - } - } - } - } - return nil -} - -// Author represents someone who has contributed to a cli project. -type Author struct { - Name string // The Authors name - Email string // The Authors email -} - -// String makes Author comply to the Stringer interface, to allow an easy print in the templating process -func (a *Author) String() string { - e := "" - if a.Email != "" { - e = " <" + a.Email + ">" - } - - return fmt.Sprintf("%v%v", a.Name, e) -} - -// HandleAction attempts to figure out which Action signature was used. If -// it's an ActionFunc or a func with the legacy signature for Action, the func -// is run! -func HandleAction(action interface{}, cCtx *Context) (err error) { - switch a := action.(type) { - case ActionFunc: - return a(cCtx) - case func(*Context) error: - return a(cCtx) - case func(*Context): // deprecated function signature - a(cCtx) - return nil - } - - return errInvalidActionType -} - -func checkStringSliceIncludes(want string, sSlice []string) bool { - found := false - for _, s := range sSlice { - if want == s { - found = true - break - } - } - - return found -} diff --git a/vendor/github.com/urfave/cli/v2/args.go b/vendor/github.com/urfave/cli/v2/args.go deleted file mode 100644 index bd65c17..0000000 --- a/vendor/github.com/urfave/cli/v2/args.go +++ /dev/null @@ -1,54 +0,0 @@ -package cli - -type Args interface { - // Get returns the nth argument, or else a blank string - Get(n int) string - // First returns the first argument, or else a blank string - First() string - // Tail returns the rest of the arguments (not the first one) - // or else an empty string slice - Tail() []string - // Len returns the length of the wrapped slice - Len() int - // Present checks if there are any arguments present - Present() bool - // Slice returns a copy of the internal slice - Slice() []string -} - -type args []string - -func (a *args) Get(n int) string { - if len(*a) > n { - return (*a)[n] - } - return "" -} - -func (a *args) First() string { - return a.Get(0) -} - -func (a *args) Tail() []string { - if a.Len() >= 2 { - tail := []string((*a)[1:]) - ret := make([]string, len(tail)) - copy(ret, tail) - return ret - } - return []string{} -} - -func (a *args) Len() int { - return len(*a) -} - -func (a *args) Present() bool { - return a.Len() != 0 -} - -func (a *args) Slice() []string { - ret := make([]string, len(*a)) - copy(ret, *a) - return ret -} diff --git a/vendor/github.com/urfave/cli/v2/category.go b/vendor/github.com/urfave/cli/v2/category.go deleted file mode 100644 index ccc043c..0000000 --- a/vendor/github.com/urfave/cli/v2/category.go +++ /dev/null @@ -1,186 +0,0 @@ -package cli - -import "sort" - -// CommandCategories interface allows for category manipulation -type CommandCategories interface { - // AddCommand adds a command to a category, creating a new category if necessary. - AddCommand(category string, command *Command) - // Categories returns a slice of categories sorted by name - Categories() []CommandCategory -} - -type commandCategories []*commandCategory - -func newCommandCategories() CommandCategories { - ret := commandCategories([]*commandCategory{}) - return &ret -} - -func (c *commandCategories) Less(i, j int) bool { - return lexicographicLess((*c)[i].Name(), (*c)[j].Name()) -} - -func (c *commandCategories) Len() int { - return len(*c) -} - -func (c *commandCategories) Swap(i, j int) { - (*c)[i], (*c)[j] = (*c)[j], (*c)[i] -} - -func (c *commandCategories) AddCommand(category string, command *Command) { - for _, commandCategory := range []*commandCategory(*c) { - if commandCategory.name == category { - commandCategory.commands = append(commandCategory.commands, command) - return - } - } - newVal := append(*c, - &commandCategory{name: category, commands: []*Command{command}}) - *c = newVal -} - -func (c *commandCategories) Categories() []CommandCategory { - ret := make([]CommandCategory, len(*c)) - for i, cat := range *c { - ret[i] = cat - } - return ret -} - -// CommandCategory is a category containing commands. -type CommandCategory interface { - // Name returns the category name string - Name() string - // VisibleCommands returns a slice of the Commands with Hidden=false - VisibleCommands() []*Command -} - -type commandCategory struct { - name string - commands []*Command -} - -func (c *commandCategory) Name() string { - return c.name -} - -func (c *commandCategory) VisibleCommands() []*Command { - if c.commands == nil { - c.commands = []*Command{} - } - - var ret []*Command - for _, command := range c.commands { - if !command.Hidden { - ret = append(ret, command) - } - } - return ret -} - -// FlagCategories interface allows for category manipulation -type FlagCategories interface { - // AddFlags adds a flag to a category, creating a new category if necessary. - AddFlag(category string, fl Flag) - // VisibleCategories returns a slice of visible flag categories sorted by name - VisibleCategories() []VisibleFlagCategory -} - -type defaultFlagCategories struct { - m map[string]*defaultVisibleFlagCategory -} - -func newFlagCategories() FlagCategories { - return &defaultFlagCategories{ - m: map[string]*defaultVisibleFlagCategory{}, - } -} - -func newFlagCategoriesFromFlags(fs []Flag) FlagCategories { - fc := newFlagCategories() - - var categorized bool - for _, fl := range fs { - if cf, ok := fl.(CategorizableFlag); ok { - if cat := cf.GetCategory(); cat != "" { - fc.AddFlag(cat, cf) - categorized = true - } - } - } - - if categorized == true { - for _, fl := range fs { - if cf, ok := fl.(CategorizableFlag); ok { - if cf.GetCategory() == "" { - fc.AddFlag("", fl) - } - } - } - } - - return fc -} - -func (f *defaultFlagCategories) AddFlag(category string, fl Flag) { - if _, ok := f.m[category]; !ok { - f.m[category] = &defaultVisibleFlagCategory{name: category, m: map[string]Flag{}} - } - - f.m[category].m[fl.String()] = fl -} - -func (f *defaultFlagCategories) VisibleCategories() []VisibleFlagCategory { - catNames := []string{} - for name := range f.m { - catNames = append(catNames, name) - } - - sort.Strings(catNames) - - ret := make([]VisibleFlagCategory, len(catNames)) - for i, name := range catNames { - ret[i] = f.m[name] - } - - return ret -} - -// VisibleFlagCategory is a category containing flags. -type VisibleFlagCategory interface { - // Name returns the category name string - Name() string - // Flags returns a slice of VisibleFlag sorted by name - Flags() []VisibleFlag -} - -type defaultVisibleFlagCategory struct { - name string - m map[string]Flag -} - -func (fc *defaultVisibleFlagCategory) Name() string { - return fc.name -} - -func (fc *defaultVisibleFlagCategory) Flags() []VisibleFlag { - vfNames := []string{} - for flName, fl := range fc.m { - if vf, ok := fl.(VisibleFlag); ok { - if vf.IsVisible() { - vfNames = append(vfNames, flName) - } - } - } - - sort.Strings(vfNames) - - ret := make([]VisibleFlag, len(vfNames)) - for i, flName := range vfNames { - ret[i] = fc.m[flName].(VisibleFlag) - } - - return ret -} diff --git a/vendor/github.com/urfave/cli/v2/cli.go b/vendor/github.com/urfave/cli/v2/cli.go deleted file mode 100644 index 28ad058..0000000 --- a/vendor/github.com/urfave/cli/v2/cli.go +++ /dev/null @@ -1,25 +0,0 @@ -// Package cli provides a minimal framework for creating and organizing command line -// Go applications. cli is designed to be easy to understand and write, the most simple -// cli application can be written as follows: -// -// func main() { -// (&cli.App{}).Run(os.Args) -// } -// -// Of course this application does not do much, so let's make this an actual application: -// -// func main() { -// app := &cli.App{ -// Name: "greet", -// Usage: "say a greeting", -// Action: func(c *cli.Context) error { -// fmt.Println("Greetings") -// return nil -// }, -// } -// -// app.Run(os.Args) -// } -package cli - -//go:generate make -C cmd/urfave-cli-genflags run diff --git a/vendor/github.com/urfave/cli/v2/command.go b/vendor/github.com/urfave/cli/v2/command.go deleted file mode 100644 index 69a0fdf..0000000 --- a/vendor/github.com/urfave/cli/v2/command.go +++ /dev/null @@ -1,406 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "reflect" - "sort" - "strings" -) - -// Command is a subcommand for a cli.App. -type Command struct { - // The name of the command - Name string - // A list of aliases for the command - Aliases []string - // A short description of the usage of this command - Usage string - // Custom text to show on USAGE section of help - UsageText string - // A longer explanation of how the command works - Description string - // A short description of the arguments of this command - ArgsUsage string - // The category the command is part of - Category string - // The function to call when checking for bash command completions - BashComplete BashCompleteFunc - // An action to execute before any sub-subcommands are run, but after the context is ready - // If a non-nil error is returned, no sub-subcommands are run - Before BeforeFunc - // An action to execute after any subcommands are run, but after the subcommand has finished - // It is run even if Action() panics - After AfterFunc - // The function to call when this command is invoked - Action ActionFunc - // Execute this function if a usage error occurs. - OnUsageError OnUsageErrorFunc - // List of child commands - Subcommands []*Command - // List of flags to parse - Flags []Flag - flagCategories FlagCategories - // Treat all flags as normal arguments if true - SkipFlagParsing bool - // Boolean to hide built-in help command and help flag - HideHelp bool - // Boolean to hide built-in help command but keep help flag - // Ignored if HideHelp is true. - HideHelpCommand bool - // Boolean to hide this command from help or completion - Hidden bool - // Boolean to enable short-option handling so user can combine several - // single-character bool arguments into one - // i.e. foobar -o -v -> foobar -ov - UseShortOptionHandling bool - - // Full name of command for help, defaults to full command name, including parent commands. - HelpName string - commandNamePath []string - - // CustomHelpTemplate the text template for the command help topic. - // cli.go uses text/template to render templates. You can - // render custom help text by setting this variable. - CustomHelpTemplate string - - // categories contains the categorized commands and is populated on app startup - categories CommandCategories - - // if this is a root "special" command - isRoot bool - - separator separatorSpec -} - -type Commands []*Command - -type CommandsByName []*Command - -func (c CommandsByName) Len() int { - return len(c) -} - -func (c CommandsByName) Less(i, j int) bool { - return lexicographicLess(c[i].Name, c[j].Name) -} - -func (c CommandsByName) Swap(i, j int) { - c[i], c[j] = c[j], c[i] -} - -// FullName returns the full name of the command. -// For subcommands this ensures that parent commands are part of the command path -func (c *Command) FullName() string { - if c.commandNamePath == nil { - return c.Name - } - return strings.Join(c.commandNamePath, " ") -} - -func (cmd *Command) Command(name string) *Command { - for _, c := range cmd.Subcommands { - if c.HasName(name) { - return c - } - } - - return nil -} - -func (c *Command) setup(ctx *Context) { - if c.Command(helpCommand.Name) == nil && !c.HideHelp { - if !c.HideHelpCommand { - c.Subcommands = append(c.Subcommands, helpCommand) - } - } - - if !c.HideHelp && HelpFlag != nil { - // append help to flags - c.appendFlag(HelpFlag) - } - - if ctx.App.UseShortOptionHandling { - c.UseShortOptionHandling = true - } - - c.categories = newCommandCategories() - for _, command := range c.Subcommands { - c.categories.AddCommand(command.Category, command) - } - sort.Sort(c.categories.(*commandCategories)) - - var newCmds []*Command - for _, scmd := range c.Subcommands { - if scmd.HelpName == "" { - scmd.HelpName = fmt.Sprintf("%s %s", c.HelpName, scmd.Name) - } - scmd.separator = c.separator - newCmds = append(newCmds, scmd) - } - c.Subcommands = newCmds - - if c.BashComplete == nil { - c.BashComplete = DefaultCompleteWithFlags(c) - } -} - -func (c *Command) Run(cCtx *Context, arguments ...string) (err error) { - - if !c.isRoot { - c.setup(cCtx) - } - - a := args(arguments) - set, err := c.parseFlags(&a, cCtx.shellComplete) - cCtx.flagSet = set - - if checkCompletions(cCtx) { - return nil - } - - if err != nil { - if c.OnUsageError != nil { - err = c.OnUsageError(cCtx, err, !c.isRoot) - cCtx.App.handleExitCoder(cCtx, err) - return err - } - _, _ = fmt.Fprintf(cCtx.App.Writer, "%s %s\n\n", "Incorrect Usage:", err.Error()) - if cCtx.App.Suggest { - if suggestion, err := c.suggestFlagFromError(err, ""); err == nil { - fmt.Fprintf(cCtx.App.Writer, "%s", suggestion) - } - } - if !c.HideHelp { - if c.isRoot { - _ = ShowAppHelp(cCtx) - } else { - _ = ShowCommandHelp(cCtx.parentContext, c.Name) - } - } - return err - } - - if checkHelp(cCtx) { - return helpCommand.Action(cCtx) - } - - if c.isRoot && !cCtx.App.HideVersion && checkVersion(cCtx) { - ShowVersion(cCtx) - return nil - } - - if c.After != nil && !cCtx.shellComplete { - defer func() { - afterErr := c.After(cCtx) - if afterErr != nil { - cCtx.App.handleExitCoder(cCtx, err) - if err != nil { - err = newMultiError(err, afterErr) - } else { - err = afterErr - } - } - }() - } - - cerr := cCtx.checkRequiredFlags(c.Flags) - if cerr != nil { - _ = helpCommand.Action(cCtx) - return cerr - } - - if c.Before != nil && !cCtx.shellComplete { - beforeErr := c.Before(cCtx) - if beforeErr != nil { - cCtx.App.handleExitCoder(cCtx, beforeErr) - err = beforeErr - return err - } - } - - if err = runFlagActions(cCtx, c.Flags); err != nil { - return err - } - - var cmd *Command - args := cCtx.Args() - if args.Present() { - name := args.First() - cmd = c.Command(name) - if cmd == nil { - hasDefault := cCtx.App.DefaultCommand != "" - isFlagName := checkStringSliceIncludes(name, cCtx.FlagNames()) - - var ( - isDefaultSubcommand = false - defaultHasSubcommands = false - ) - - if hasDefault { - dc := cCtx.App.Command(cCtx.App.DefaultCommand) - defaultHasSubcommands = len(dc.Subcommands) > 0 - for _, dcSub := range dc.Subcommands { - if checkStringSliceIncludes(name, dcSub.Names()) { - isDefaultSubcommand = true - break - } - } - } - - if isFlagName || (hasDefault && (defaultHasSubcommands && isDefaultSubcommand)) { - argsWithDefault := cCtx.App.argsWithDefaultCommand(args) - if !reflect.DeepEqual(args, argsWithDefault) { - cmd = cCtx.App.rootCommand.Command(argsWithDefault.First()) - } - } - } - } else if c.isRoot && cCtx.App.DefaultCommand != "" { - if dc := cCtx.App.Command(cCtx.App.DefaultCommand); dc != c { - cmd = dc - } - } - - if cmd != nil { - newcCtx := NewContext(cCtx.App, nil, cCtx) - newcCtx.Command = cmd - return cmd.Run(newcCtx, cCtx.Args().Slice()...) - } - - if c.Action == nil { - c.Action = helpCommand.Action - } - - err = c.Action(cCtx) - - cCtx.App.handleExitCoder(cCtx, err) - return err -} - -func (c *Command) newFlagSet() (*flag.FlagSet, error) { - return flagSet(c.Name, c.Flags, c.separator) -} - -func (c *Command) useShortOptionHandling() bool { - return c.UseShortOptionHandling -} - -func (c *Command) suggestFlagFromError(err error, command string) (string, error) { - flag, parseErr := flagFromError(err) - if parseErr != nil { - return "", err - } - - flags := c.Flags - hideHelp := c.HideHelp - if command != "" { - cmd := c.Command(command) - if cmd == nil { - return "", err - } - flags = cmd.Flags - hideHelp = hideHelp || cmd.HideHelp - } - - suggestion := SuggestFlag(flags, flag, hideHelp) - if len(suggestion) == 0 { - return "", err - } - - return fmt.Sprintf(SuggestDidYouMeanTemplate, suggestion) + "\n\n", nil -} - -func (c *Command) parseFlags(args Args, shellComplete bool) (*flag.FlagSet, error) { - set, err := c.newFlagSet() - if err != nil { - return nil, err - } - - if c.SkipFlagParsing { - return set, set.Parse(append([]string{"--"}, args.Tail()...)) - } - - err = parseIter(set, c, args.Tail(), shellComplete) - if err != nil { - return nil, err - } - - err = normalizeFlags(c.Flags, set) - if err != nil { - return nil, err - } - - return set, nil -} - -// Names returns the names including short names and aliases. -func (c *Command) Names() []string { - return append([]string{c.Name}, c.Aliases...) -} - -// HasName returns true if Command.Name matches given name -func (c *Command) HasName(name string) bool { - for _, n := range c.Names() { - if n == name { - return true - } - } - return false -} - -// VisibleCategories returns a slice of categories and commands that are -// Hidden=false -func (c *Command) VisibleCategories() []CommandCategory { - ret := []CommandCategory{} - for _, category := range c.categories.Categories() { - if visible := func() CommandCategory { - if len(category.VisibleCommands()) > 0 { - return category - } - return nil - }(); visible != nil { - ret = append(ret, visible) - } - } - return ret -} - -// VisibleCommands returns a slice of the Commands with Hidden=false -func (c *Command) VisibleCommands() []*Command { - var ret []*Command - for _, command := range c.Subcommands { - if !command.Hidden { - ret = append(ret, command) - } - } - return ret -} - -// VisibleFlagCategories returns a slice containing all the visible flag categories with the flags they contain -func (c *Command) VisibleFlagCategories() []VisibleFlagCategory { - if c.flagCategories == nil { - c.flagCategories = newFlagCategoriesFromFlags(c.Flags) - } - return c.flagCategories.VisibleCategories() -} - -// VisibleFlags returns a slice of the Flags with Hidden=false -func (c *Command) VisibleFlags() []Flag { - return visibleFlags(c.Flags) -} - -func (c *Command) appendFlag(fl Flag) { - if !hasFlag(c.Flags, fl) { - c.Flags = append(c.Flags, fl) - } -} - -func hasCommand(commands []*Command, command *Command) bool { - for _, existing := range commands { - if command == existing { - return true - } - } - - return false -} diff --git a/vendor/github.com/urfave/cli/v2/context.go b/vendor/github.com/urfave/cli/v2/context.go deleted file mode 100644 index a45c120..0000000 --- a/vendor/github.com/urfave/cli/v2/context.go +++ /dev/null @@ -1,272 +0,0 @@ -package cli - -import ( - "context" - "flag" - "fmt" - "strings" -) - -// Context is a type that is passed through to -// each Handler action in a cli application. Context -// can be used to retrieve context-specific args and -// parsed command-line options. -type Context struct { - context.Context - App *App - Command *Command - shellComplete bool - flagSet *flag.FlagSet - parentContext *Context -} - -// NewContext creates a new context. For use in when invoking an App or Command action. -func NewContext(app *App, set *flag.FlagSet, parentCtx *Context) *Context { - c := &Context{App: app, flagSet: set, parentContext: parentCtx} - if parentCtx != nil { - c.Context = parentCtx.Context - c.shellComplete = parentCtx.shellComplete - if parentCtx.flagSet == nil { - parentCtx.flagSet = &flag.FlagSet{} - } - } - - c.Command = &Command{} - - if c.Context == nil { - c.Context = context.Background() - } - - return c -} - -// NumFlags returns the number of flags set -func (cCtx *Context) NumFlags() int { - return cCtx.flagSet.NFlag() -} - -// Set sets a context flag to a value. -func (cCtx *Context) Set(name, value string) error { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return fs.Set(name, value) - } - - return fmt.Errorf("no such flag -%s", name) -} - -// IsSet determines if the flag was actually set -func (cCtx *Context) IsSet(name string) bool { - - if fs := cCtx.lookupFlagSet(name); fs != nil { - isSet := false - fs.Visit(func(f *flag.Flag) { - if f.Name == name { - isSet = true - } - }) - if isSet { - return true - } - - f := cCtx.lookupFlag(name) - if f == nil { - return false - } - - if f.IsSet() { - return true - } - - // now redo flagset search on aliases - aliases := f.Names() - fs.Visit(func(f *flag.Flag) { - for _, alias := range aliases { - if f.Name == alias { - isSet = true - } - } - }) - - if isSet { - return true - } - } - - return false -} - -// LocalFlagNames returns a slice of flag names used in this context. -func (cCtx *Context) LocalFlagNames() []string { - var names []string - cCtx.flagSet.Visit(makeFlagNameVisitor(&names)) - // Check the flags which have been set via env or file - if cCtx.Command != nil && cCtx.Command.Flags != nil { - for _, f := range cCtx.Command.Flags { - if f.IsSet() { - names = append(names, f.Names()...) - } - } - } - - // Sort out the duplicates since flag could be set via multiple - // paths - m := map[string]struct{}{} - var unames []string - for _, name := range names { - if _, ok := m[name]; !ok { - m[name] = struct{}{} - unames = append(unames, name) - } - } - - return unames -} - -// FlagNames returns a slice of flag names used by the this context and all of -// its parent contexts. -func (cCtx *Context) FlagNames() []string { - var names []string - for _, pCtx := range cCtx.Lineage() { - names = append(names, pCtx.LocalFlagNames()...) - } - return names -} - -// Lineage returns *this* context and all of its ancestor contexts in order from -// child to parent -func (cCtx *Context) Lineage() []*Context { - var lineage []*Context - - for cur := cCtx; cur != nil; cur = cur.parentContext { - lineage = append(lineage, cur) - } - - return lineage -} - -// Count returns the num of occurences of this flag -func (cCtx *Context) Count(name string) int { - if fs := cCtx.lookupFlagSet(name); fs != nil { - if cf, ok := fs.Lookup(name).Value.(Countable); ok { - return cf.Count() - } - } - return 0 -} - -// Value returns the value of the flag corresponding to `name` -func (cCtx *Context) Value(name string) interface{} { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return fs.Lookup(name).Value.(flag.Getter).Get() - } - return nil -} - -// Args returns the command line arguments associated with the context. -func (cCtx *Context) Args() Args { - ret := args(cCtx.flagSet.Args()) - return &ret -} - -// NArg returns the number of the command line arguments. -func (cCtx *Context) NArg() int { - return cCtx.Args().Len() -} - -func (cCtx *Context) lookupFlag(name string) Flag { - for _, c := range cCtx.Lineage() { - if c.Command == nil { - continue - } - - for _, f := range c.Command.Flags { - for _, n := range f.Names() { - if n == name { - return f - } - } - } - } - - if cCtx.App != nil { - for _, f := range cCtx.App.Flags { - for _, n := range f.Names() { - if n == name { - return f - } - } - } - } - - return nil -} - -func (cCtx *Context) lookupFlagSet(name string) *flag.FlagSet { - for _, c := range cCtx.Lineage() { - if c.flagSet == nil { - continue - } - if f := c.flagSet.Lookup(name); f != nil { - return c.flagSet - } - } - cCtx.onInvalidFlag(name) - return nil -} - -func (cCtx *Context) checkRequiredFlags(flags []Flag) requiredFlagsErr { - var missingFlags []string - for _, f := range flags { - if rf, ok := f.(RequiredFlag); ok && rf.IsRequired() { - var flagPresent bool - var flagName string - - flagNames := f.Names() - flagName = flagNames[0] - - for _, key := range flagNames { - if cCtx.IsSet(strings.TrimSpace(key)) { - flagPresent = true - } - } - - if !flagPresent && flagName != "" { - missingFlags = append(missingFlags, flagName) - } - } - } - - if len(missingFlags) != 0 { - return &errRequiredFlags{missingFlags: missingFlags} - } - - return nil -} - -func (cCtx *Context) onInvalidFlag(name string) { - for cCtx != nil { - if cCtx.App != nil && cCtx.App.InvalidFlagAccessHandler != nil { - cCtx.App.InvalidFlagAccessHandler(cCtx, name) - break - } - cCtx = cCtx.parentContext - } -} - -func makeFlagNameVisitor(names *[]string) func(*flag.Flag) { - return func(f *flag.Flag) { - nameParts := strings.Split(f.Name, ",") - name := strings.TrimSpace(nameParts[0]) - - for _, part := range nameParts { - part = strings.TrimSpace(part) - if len(part) > len(name) { - name = part - } - } - - if name != "" { - *names = append(*names, name) - } - } -} diff --git a/vendor/github.com/urfave/cli/v2/docs.go b/vendor/github.com/urfave/cli/v2/docs.go deleted file mode 100644 index 6cd0624..0000000 --- a/vendor/github.com/urfave/cli/v2/docs.go +++ /dev/null @@ -1,203 +0,0 @@ -//go:build !urfave_cli_no_docs -// +build !urfave_cli_no_docs - -package cli - -import ( - "bytes" - "fmt" - "io" - "sort" - "strings" - "text/template" - - "github.com/cpuguy83/go-md2man/v2/md2man" -) - -// ToMarkdown creates a markdown string for the `*App` -// The function errors if either parsing or writing of the string fails. -func (a *App) ToMarkdown() (string, error) { - var w bytes.Buffer - if err := a.writeDocTemplate(&w, 0); err != nil { - return "", err - } - return w.String(), nil -} - -// ToMan creates a man page string with section number for the `*App` -// The function errors if either parsing or writing of the string fails. -func (a *App) ToManWithSection(sectionNumber int) (string, error) { - var w bytes.Buffer - if err := a.writeDocTemplate(&w, sectionNumber); err != nil { - return "", err - } - man := md2man.Render(w.Bytes()) - return string(man), nil -} - -// ToMan creates a man page string for the `*App` -// The function errors if either parsing or writing of the string fails. -func (a *App) ToMan() (string, error) { - man, err := a.ToManWithSection(8) - return man, err -} - -type cliTemplate struct { - App *App - SectionNum int - Commands []string - GlobalArgs []string - SynopsisArgs []string -} - -func (a *App) writeDocTemplate(w io.Writer, sectionNum int) error { - const name = "cli" - t, err := template.New(name).Parse(MarkdownDocTemplate) - if err != nil { - return err - } - return t.ExecuteTemplate(w, name, &cliTemplate{ - App: a, - SectionNum: sectionNum, - Commands: prepareCommands(a.Commands, 0), - GlobalArgs: prepareArgsWithValues(a.VisibleFlags()), - SynopsisArgs: prepareArgsSynopsis(a.VisibleFlags()), - }) -} - -func prepareCommands(commands []*Command, level int) []string { - var coms []string - for _, command := range commands { - if command.Hidden { - continue - } - - usageText := prepareUsageText(command) - - usage := prepareUsage(command, usageText) - - prepared := fmt.Sprintf("%s %s\n\n%s%s", - strings.Repeat("#", level+2), - strings.Join(command.Names(), ", "), - usage, - usageText, - ) - - flags := prepareArgsWithValues(command.VisibleFlags()) - if len(flags) > 0 { - prepared += fmt.Sprintf("\n%s", strings.Join(flags, "\n")) - } - - coms = append(coms, prepared) - - // recursively iterate subcommands - if len(command.Subcommands) > 0 { - coms = append( - coms, - prepareCommands(command.Subcommands, level+1)..., - ) - } - } - - return coms -} - -func prepareArgsWithValues(flags []Flag) []string { - return prepareFlags(flags, ", ", "**", "**", `""`, true) -} - -func prepareArgsSynopsis(flags []Flag) []string { - return prepareFlags(flags, "|", "[", "]", "[value]", false) -} - -func prepareFlags( - flags []Flag, - sep, opener, closer, value string, - addDetails bool, -) []string { - args := []string{} - for _, f := range flags { - flag, ok := f.(DocGenerationFlag) - if !ok { - continue - } - modifiedArg := opener - - for _, s := range flag.Names() { - trimmed := strings.TrimSpace(s) - if len(modifiedArg) > len(opener) { - modifiedArg += sep - } - if len(trimmed) > 1 { - modifiedArg += fmt.Sprintf("--%s", trimmed) - } else { - modifiedArg += fmt.Sprintf("-%s", trimmed) - } - } - modifiedArg += closer - if flag.TakesValue() { - modifiedArg += fmt.Sprintf("=%s", value) - } - - if addDetails { - modifiedArg += flagDetails(flag) - } - - args = append(args, modifiedArg+"\n") - - } - sort.Strings(args) - return args -} - -// flagDetails returns a string containing the flags metadata -func flagDetails(flag DocGenerationFlag) string { - description := flag.GetUsage() - if flag.TakesValue() { - defaultText := flag.GetDefaultText() - if defaultText == "" { - defaultText = flag.GetValue() - } - if defaultText != "" { - description += " (default: " + defaultText + ")" - } - } - return ": " + description -} - -func prepareUsageText(command *Command) string { - if command.UsageText == "" { - return "" - } - - // Remove leading and trailing newlines - preparedUsageText := strings.Trim(command.UsageText, "\n") - - var usageText string - if strings.Contains(preparedUsageText, "\n") { - // Format multi-line string as a code block using the 4 space schema to allow for embedded markdown such - // that it will not break the continuous code block. - for _, ln := range strings.Split(preparedUsageText, "\n") { - usageText += fmt.Sprintf(" %s\n", ln) - } - } else { - // Style a single line as a note - usageText = fmt.Sprintf(">%s\n", preparedUsageText) - } - - return usageText -} - -func prepareUsage(command *Command, usageText string) string { - if command.Usage == "" { - return "" - } - - usage := command.Usage + "\n" - // Add a newline to the Usage IFF there is a UsageText - if usageText != "" { - usage += "\n" - } - - return usage -} diff --git a/vendor/github.com/urfave/cli/v2/errors.go b/vendor/github.com/urfave/cli/v2/errors.go deleted file mode 100644 index a818727..0000000 --- a/vendor/github.com/urfave/cli/v2/errors.go +++ /dev/null @@ -1,178 +0,0 @@ -package cli - -import ( - "fmt" - "io" - "os" - "strings" -) - -// OsExiter is the function used when the app exits. If not set defaults to os.Exit. -var OsExiter = os.Exit - -// ErrWriter is used to write errors to the user. This can be anything -// implementing the io.Writer interface and defaults to os.Stderr. -var ErrWriter io.Writer = os.Stderr - -// MultiError is an error that wraps multiple errors. -type MultiError interface { - error - Errors() []error -} - -// newMultiError creates a new MultiError. Pass in one or more errors. -func newMultiError(err ...error) MultiError { - ret := multiError(err) - return &ret -} - -type multiError []error - -// Error implements the error interface. -func (m *multiError) Error() string { - errs := make([]string, len(*m)) - for i, err := range *m { - errs[i] = err.Error() - } - - return strings.Join(errs, "\n") -} - -// Errors returns a copy of the errors slice -func (m *multiError) Errors() []error { - errs := make([]error, len(*m)) - for _, err := range *m { - errs = append(errs, err) - } - return errs -} - -type requiredFlagsErr interface { - error - getMissingFlags() []string -} - -type errRequiredFlags struct { - missingFlags []string -} - -func (e *errRequiredFlags) Error() string { - numberOfMissingFlags := len(e.missingFlags) - if numberOfMissingFlags == 1 { - return fmt.Sprintf("Required flag %q not set", e.missingFlags[0]) - } - joinedMissingFlags := strings.Join(e.missingFlags, ", ") - return fmt.Sprintf("Required flags %q not set", joinedMissingFlags) -} - -func (e *errRequiredFlags) getMissingFlags() []string { - return e.missingFlags -} - -// ErrorFormatter is the interface that will suitably format the error output -type ErrorFormatter interface { - Format(s fmt.State, verb rune) -} - -// ExitCoder is the interface checked by `App` and `Command` for a custom exit -// code -type ExitCoder interface { - error - ExitCode() int -} - -type exitError struct { - exitCode int - err error -} - -// NewExitError calls Exit to create a new ExitCoder. -// -// Deprecated: This function is a duplicate of Exit and will eventually be removed. -func NewExitError(message interface{}, exitCode int) ExitCoder { - return Exit(message, exitCode) -} - -// Exit wraps a message and exit code into an error, which by default is -// handled with a call to os.Exit during default error handling. -// -// This is the simplest way to trigger a non-zero exit code for an App without -// having to call os.Exit manually. During testing, this behavior can be avoided -// by overriding the ExitErrHandler function on an App or the package-global -// OsExiter function. -func Exit(message interface{}, exitCode int) ExitCoder { - var err error - - switch e := message.(type) { - case ErrorFormatter: - err = fmt.Errorf("%+v", message) - case error: - err = e - default: - err = fmt.Errorf("%+v", message) - } - - return &exitError{ - err: err, - exitCode: exitCode, - } -} - -func (ee *exitError) Error() string { - return ee.err.Error() -} - -func (ee *exitError) ExitCode() int { - return ee.exitCode -} - -func (ee *exitError) Unwrap() error { - return ee.err -} - -// HandleExitCoder handles errors implementing ExitCoder by printing their -// message and calling OsExiter with the given exit code. -// -// If the given error instead implements MultiError, each error will be checked -// for the ExitCoder interface, and OsExiter will be called with the last exit -// code found, or exit code 1 if no ExitCoder is found. -// -// This function is the default error-handling behavior for an App. -func HandleExitCoder(err error) { - if err == nil { - return - } - - if exitErr, ok := err.(ExitCoder); ok { - if err.Error() != "" { - if _, ok := exitErr.(ErrorFormatter); ok { - _, _ = fmt.Fprintf(ErrWriter, "%+v\n", err) - } else { - _, _ = fmt.Fprintln(ErrWriter, err) - } - } - OsExiter(exitErr.ExitCode()) - return - } - - if multiErr, ok := err.(MultiError); ok { - code := handleMultiError(multiErr) - OsExiter(code) - return - } -} - -func handleMultiError(multiErr MultiError) int { - code := 1 - for _, merr := range multiErr.Errors() { - if multiErr2, ok := merr.(MultiError); ok { - code = handleMultiError(multiErr2) - } else if merr != nil { - fmt.Fprintln(ErrWriter, merr) - if exitErr, ok := merr.(ExitCoder); ok { - code = exitErr.ExitCode() - } - } - } - return code -} diff --git a/vendor/github.com/urfave/cli/v2/fish.go b/vendor/github.com/urfave/cli/v2/fish.go deleted file mode 100644 index 909dfc5..0000000 --- a/vendor/github.com/urfave/cli/v2/fish.go +++ /dev/null @@ -1,196 +0,0 @@ -package cli - -import ( - "bytes" - "fmt" - "io" - "strings" - "text/template" -) - -// ToFishCompletion creates a fish completion string for the `*App` -// The function errors if either parsing or writing of the string fails. -func (a *App) ToFishCompletion() (string, error) { - var w bytes.Buffer - if err := a.writeFishCompletionTemplate(&w); err != nil { - return "", err - } - return w.String(), nil -} - -type fishCompletionTemplate struct { - App *App - Completions []string - AllCommands []string -} - -func (a *App) writeFishCompletionTemplate(w io.Writer) error { - const name = "cli" - t, err := template.New(name).Parse(FishCompletionTemplate) - if err != nil { - return err - } - allCommands := []string{} - - // Add global flags - completions := a.prepareFishFlags(a.VisibleFlags(), allCommands) - - // Add help flag - if !a.HideHelp { - completions = append( - completions, - a.prepareFishFlags([]Flag{HelpFlag}, allCommands)..., - ) - } - - // Add version flag - if !a.HideVersion { - completions = append( - completions, - a.prepareFishFlags([]Flag{VersionFlag}, allCommands)..., - ) - } - - // Add commands and their flags - completions = append( - completions, - a.prepareFishCommands(a.VisibleCommands(), &allCommands, []string{})..., - ) - - return t.ExecuteTemplate(w, name, &fishCompletionTemplate{ - App: a, - Completions: completions, - AllCommands: allCommands, - }) -} - -func (a *App) prepareFishCommands(commands []*Command, allCommands *[]string, previousCommands []string) []string { - completions := []string{} - for _, command := range commands { - if command.Hidden { - continue - } - - var completion strings.Builder - completion.WriteString(fmt.Sprintf( - "complete -r -c %s -n '%s' -a '%s'", - a.Name, - a.fishSubcommandHelper(previousCommands), - strings.Join(command.Names(), " "), - )) - - if command.Usage != "" { - completion.WriteString(fmt.Sprintf(" -d '%s'", - escapeSingleQuotes(command.Usage))) - } - - if !command.HideHelp { - completions = append( - completions, - a.prepareFishFlags([]Flag{HelpFlag}, command.Names())..., - ) - } - - *allCommands = append(*allCommands, command.Names()...) - completions = append(completions, completion.String()) - completions = append( - completions, - a.prepareFishFlags(command.VisibleFlags(), command.Names())..., - ) - - // recursively iterate subcommands - if len(command.Subcommands) > 0 { - completions = append( - completions, - a.prepareFishCommands( - command.Subcommands, allCommands, command.Names(), - )..., - ) - } - } - - return completions -} - -func (a *App) prepareFishFlags(flags []Flag, previousCommands []string) []string { - completions := []string{} - for _, f := range flags { - flag, ok := f.(DocGenerationFlag) - if !ok { - continue - } - - completion := &strings.Builder{} - completion.WriteString(fmt.Sprintf( - "complete -c %s -n '%s'", - a.Name, - a.fishSubcommandHelper(previousCommands), - )) - - fishAddFileFlag(f, completion) - - for idx, opt := range flag.Names() { - if idx == 0 { - completion.WriteString(fmt.Sprintf( - " -l %s", strings.TrimSpace(opt), - )) - } else { - completion.WriteString(fmt.Sprintf( - " -s %s", strings.TrimSpace(opt), - )) - - } - } - - if flag.TakesValue() { - completion.WriteString(" -r") - } - - if flag.GetUsage() != "" { - completion.WriteString(fmt.Sprintf(" -d '%s'", - escapeSingleQuotes(flag.GetUsage()))) - } - - completions = append(completions, completion.String()) - } - - return completions -} - -func fishAddFileFlag(flag Flag, completion *strings.Builder) { - switch f := flag.(type) { - case *GenericFlag: - if f.TakesFile { - return - } - case *StringFlag: - if f.TakesFile { - return - } - case *StringSliceFlag: - if f.TakesFile { - return - } - case *PathFlag: - if f.TakesFile { - return - } - } - completion.WriteString(" -f") -} - -func (a *App) fishSubcommandHelper(allCommands []string) string { - fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", a.Name) - if len(allCommands) > 0 { - fishHelper = fmt.Sprintf( - "__fish_seen_subcommand_from %s", - strings.Join(allCommands, " "), - ) - } - return fishHelper - -} - -func escapeSingleQuotes(input string) string { - return strings.Replace(input, `'`, `\'`, -1) -} diff --git a/vendor/github.com/urfave/cli/v2/flag-spec.yaml b/vendor/github.com/urfave/cli/v2/flag-spec.yaml deleted file mode 100644 index 03d82e7..0000000 --- a/vendor/github.com/urfave/cli/v2/flag-spec.yaml +++ /dev/null @@ -1,131 +0,0 @@ -# NOTE: this file is used by the tool defined in -# ./cmd/urfave-cli-genflags/main.go which uses the -# `Spec` type that maps to this file structure. -flag_types: - bool: - struct_fields: - - name: Count - type: int - pointer: true - - name: DisableDefaultText - type: bool - - name: Action - type: "func(*Context, bool) error" - float64: - struct_fields: - - name: Action - type: "func(*Context, float64) error" - Float64Slice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: Action - type: "func(*Context, []float64) error" - int: - struct_fields: - - name: Base - type: int - - name: Action - type: "func(*Context, int) error" - IntSlice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: Action - type: "func(*Context, []int) error" - int64: - struct_fields: - - name: Base - type: int - - name: Action - type: "func(*Context, int64) error" - Int64Slice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: Action - type: "func(*Context, []int64) error" - uint: - struct_fields: - - name: Base - type: int - - name: Action - type: "func(*Context, uint) error" - UintSlice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: Action - type: "func(*Context, []uint) error" - uint64: - struct_fields: - - name: Base - type: int - - name: Action - type: "func(*Context, uint64) error" - Uint64Slice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: Action - type: "func(*Context, []uint64) error" - string: - struct_fields: - - name: TakesFile - type: bool - - name: Action - type: "func(*Context, string) error" - StringSlice: - value_pointer: true - skip_interfaces: - - fmt.Stringer - struct_fields: - - name: separator - type: separatorSpec - - name: TakesFile - type: bool - - name: Action - type: "func(*Context, []string) error" - - name: KeepSpace - type: bool - time.Duration: - struct_fields: - - name: Action - type: "func(*Context, time.Duration) error" - Timestamp: - value_pointer: true - struct_fields: - - name: Layout - type: string - - name: Timezone - type: "*time.Location" - - name: Action - type: "func(*Context, *time.Time) error" - Generic: - no_destination_pointer: true - struct_fields: - - name: TakesFile - type: bool - - name: Action - type: "func(*Context, interface{}) error" - Path: - struct_fields: - - name: TakesFile - type: bool - - name: Action - type: "func(*Context, Path) error" diff --git a/vendor/github.com/urfave/cli/v2/flag.go b/vendor/github.com/urfave/cli/v2/flag.go deleted file mode 100644 index 4d04de3..0000000 --- a/vendor/github.com/urfave/cli/v2/flag.go +++ /dev/null @@ -1,419 +0,0 @@ -package cli - -import ( - "errors" - "flag" - "fmt" - "io" - "os" - "regexp" - "runtime" - "strings" - "syscall" - "time" -) - -const defaultPlaceholder = "value" - -const ( - defaultSliceFlagSeparator = "," - disableSliceFlagSeparator = false -) - -var ( - slPfx = fmt.Sprintf("sl:::%d:::", time.Now().UTC().UnixNano()) - - commaWhitespace = regexp.MustCompile("[, ]+.*") -) - -// BashCompletionFlag enables bash-completion for all commands and subcommands -var BashCompletionFlag Flag = &BoolFlag{ - Name: "generate-bash-completion", - Hidden: true, -} - -// VersionFlag prints the version for the application -var VersionFlag Flag = &BoolFlag{ - Name: "version", - Aliases: []string{"v"}, - Usage: "print the version", - DisableDefaultText: true, -} - -// HelpFlag prints the help for all commands and subcommands. -// Set to nil to disable the flag. The subcommand -// will still be added unless HideHelp or HideHelpCommand is set to true. -var HelpFlag Flag = &BoolFlag{ - Name: "help", - Aliases: []string{"h"}, - Usage: "show help", - DisableDefaultText: true, -} - -// FlagStringer converts a flag definition to a string. This is used by help -// to display a flag. -var FlagStringer FlagStringFunc = stringifyFlag - -// Serializer is used to circumvent the limitations of flag.FlagSet.Set -type Serializer interface { - Serialize() string -} - -// FlagNamePrefixer converts a full flag name and its placeholder into the help -// message flag prefix. This is used by the default FlagStringer. -var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames - -// FlagEnvHinter annotates flag help message with the environment variable -// details. This is used by the default FlagStringer. -var FlagEnvHinter FlagEnvHintFunc = withEnvHint - -// FlagFileHinter annotates flag help message with the environment variable -// details. This is used by the default FlagStringer. -var FlagFileHinter FlagFileHintFunc = withFileHint - -// FlagsByName is a slice of Flag. -type FlagsByName []Flag - -func (f FlagsByName) Len() int { - return len(f) -} - -func (f FlagsByName) Less(i, j int) bool { - if len(f[j].Names()) == 0 { - return false - } else if len(f[i].Names()) == 0 { - return true - } - return lexicographicLess(f[i].Names()[0], f[j].Names()[0]) -} - -func (f FlagsByName) Swap(i, j int) { - f[i], f[j] = f[j], f[i] -} - -// ActionableFlag is an interface that wraps Flag interface and RunAction operation. -type ActionableFlag interface { - Flag - RunAction(*Context) error -} - -// Flag is a common interface related to parsing flags in cli. -// For more advanced flag parsing techniques, it is recommended that -// this interface be implemented. -type Flag interface { - fmt.Stringer - // Apply Flag settings to the given flag set - Apply(*flag.FlagSet) error - Names() []string - IsSet() bool -} - -// RequiredFlag is an interface that allows us to mark flags as required -// it allows flags required flags to be backwards compatible with the Flag interface -type RequiredFlag interface { - Flag - - IsRequired() bool -} - -// DocGenerationFlag is an interface that allows documentation generation for the flag -type DocGenerationFlag interface { - Flag - - // TakesValue returns true if the flag takes a value, otherwise false - TakesValue() bool - - // GetUsage returns the usage string for the flag - GetUsage() string - - // GetValue returns the flags value as string representation and an empty - // string if the flag takes no value at all. - GetValue() string - - // GetDefaultText returns the default text for this flag - GetDefaultText() string - - // GetEnvVars returns the env vars for this flag - GetEnvVars() []string -} - -// DocGenerationSliceFlag extends DocGenerationFlag for slice-based flags. -type DocGenerationSliceFlag interface { - DocGenerationFlag - - // IsSliceFlag returns true for flags that can be given multiple times. - IsSliceFlag() bool -} - -// VisibleFlag is an interface that allows to check if a flag is visible -type VisibleFlag interface { - Flag - - // IsVisible returns true if the flag is not hidden, otherwise false - IsVisible() bool -} - -// CategorizableFlag is an interface that allows us to potentially -// use a flag in a categorized representation. -type CategorizableFlag interface { - VisibleFlag - - GetCategory() string -} - -// Countable is an interface to enable detection of flag values which support -// repetitive flags -type Countable interface { - Count() int -} - -func flagSet(name string, flags []Flag, spec separatorSpec) (*flag.FlagSet, error) { - set := flag.NewFlagSet(name, flag.ContinueOnError) - - for _, f := range flags { - if c, ok := f.(customizedSeparator); ok { - c.WithSeparatorSpec(spec) - } - if err := f.Apply(set); err != nil { - return nil, err - } - } - set.SetOutput(io.Discard) - return set, nil -} - -func copyFlag(name string, ff *flag.Flag, set *flag.FlagSet) { - switch ff.Value.(type) { - case Serializer: - _ = set.Set(name, ff.Value.(Serializer).Serialize()) - default: - _ = set.Set(name, ff.Value.String()) - } -} - -func normalizeFlags(flags []Flag, set *flag.FlagSet) error { - visited := make(map[string]bool) - set.Visit(func(f *flag.Flag) { - visited[f.Name] = true - }) - for _, f := range flags { - parts := f.Names() - if len(parts) == 1 { - continue - } - var ff *flag.Flag - for _, name := range parts { - name = strings.Trim(name, " ") - if visited[name] { - if ff != nil { - return errors.New("Cannot use two forms of the same flag: " + name + " " + ff.Name) - } - ff = set.Lookup(name) - } - } - if ff == nil { - continue - } - for _, name := range parts { - name = strings.Trim(name, " ") - if !visited[name] { - copyFlag(name, ff, set) - } - } - } - return nil -} - -func visibleFlags(fl []Flag) []Flag { - var visible []Flag - for _, f := range fl { - if vf, ok := f.(VisibleFlag); ok && vf.IsVisible() { - visible = append(visible, f) - } - } - return visible -} - -func prefixFor(name string) (prefix string) { - if len(name) == 1 { - prefix = "-" - } else { - prefix = "--" - } - - return -} - -// Returns the placeholder, if any, and the unquoted usage string. -func unquoteUsage(usage string) (string, string) { - for i := 0; i < len(usage); i++ { - if usage[i] == '`' { - for j := i + 1; j < len(usage); j++ { - if usage[j] == '`' { - name := usage[i+1 : j] - usage = usage[:i] + name + usage[j+1:] - return name, usage - } - } - break - } - } - return "", usage -} - -func prefixedNames(names []string, placeholder string) string { - var prefixed string - for i, name := range names { - if name == "" { - continue - } - - prefixed += prefixFor(name) + name - if placeholder != "" { - prefixed += " " + placeholder - } - if i < len(names)-1 { - prefixed += ", " - } - } - return prefixed -} - -func envFormat(envVars []string, prefix, sep, suffix string) string { - if len(envVars) > 0 { - return fmt.Sprintf(" [%s%s%s]", prefix, strings.Join(envVars, sep), suffix) - } - return "" -} - -func defaultEnvFormat(envVars []string) string { - return envFormat(envVars, "$", ", $", "") -} - -func withEnvHint(envVars []string, str string) string { - envText := "" - if runtime.GOOS != "windows" || os.Getenv("PSHOME") != "" { - envText = defaultEnvFormat(envVars) - } else { - envText = envFormat(envVars, "%", "%, %", "%") - } - return str + envText -} - -func FlagNames(name string, aliases []string) []string { - var ret []string - - for _, part := range append([]string{name}, aliases...) { - // v1 -> v2 migration warning zone: - // Strip off anything after the first found comma or space, which - // *hopefully* makes it a tiny bit more obvious that unexpected behavior is - // caused by using the v1 form of stringly typed "Name". - ret = append(ret, commaWhitespace.ReplaceAllString(part, "")) - } - - return ret -} - -func withFileHint(filePath, str string) string { - fileText := "" - if filePath != "" { - fileText = fmt.Sprintf(" [%s]", filePath) - } - return str + fileText -} - -func formatDefault(format string) string { - return " (default: " + format + ")" -} - -func stringifyFlag(f Flag) string { - // enforce DocGeneration interface on flags to avoid reflection - df, ok := f.(DocGenerationFlag) - if !ok { - return "" - } - - placeholder, usage := unquoteUsage(df.GetUsage()) - needsPlaceholder := df.TakesValue() - - if needsPlaceholder && placeholder == "" { - placeholder = defaultPlaceholder - } - - defaultValueString := "" - - // set default text for all flags except bool flags - // for bool flags display default text if DisableDefaultText is not - // set - if bf, ok := f.(*BoolFlag); !ok || !bf.DisableDefaultText { - if s := df.GetDefaultText(); s != "" { - defaultValueString = fmt.Sprintf(formatDefault("%s"), s) - } - } - - usageWithDefault := strings.TrimSpace(usage + defaultValueString) - - pn := prefixedNames(df.Names(), placeholder) - sliceFlag, ok := f.(DocGenerationSliceFlag) - if ok && sliceFlag.IsSliceFlag() { - pn = pn + " [ " + pn + " ]" - } - - return withEnvHint(df.GetEnvVars(), fmt.Sprintf("%s\t%s", pn, usageWithDefault)) -} - -func hasFlag(flags []Flag, fl Flag) bool { - for _, existing := range flags { - if fl == existing { - return true - } - } - - return false -} - -// Return the first value from a list of environment variables and files -// (which may or may not exist), a description of where the value was found, -// and a boolean which is true if a value was found. -func flagFromEnvOrFile(envVars []string, filePath string) (value string, fromWhere string, found bool) { - for _, envVar := range envVars { - envVar = strings.TrimSpace(envVar) - if value, found := syscall.Getenv(envVar); found { - return value, fmt.Sprintf("environment variable %q", envVar), true - } - } - for _, fileVar := range strings.Split(filePath, ",") { - if fileVar != "" { - if data, err := os.ReadFile(fileVar); err == nil { - return string(data), fmt.Sprintf("file %q", filePath), true - } - } - } - return "", "", false -} - -type customizedSeparator interface { - WithSeparatorSpec(separatorSpec) -} - -type separatorSpec struct { - sep string - disabled bool - customized bool -} - -func (s separatorSpec) flagSplitMultiValues(val string) []string { - var ( - disabled bool = s.disabled - sep string = s.sep - ) - if !s.customized { - disabled = disableSliceFlagSeparator - sep = defaultSliceFlagSeparator - } - if disabled { - return []string{val} - } - - return strings.Split(val, sep) -} diff --git a/vendor/github.com/urfave/cli/v2/flag_bool.go b/vendor/github.com/urfave/cli/v2/flag_bool.go deleted file mode 100644 index 369d18b..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_bool.go +++ /dev/null @@ -1,174 +0,0 @@ -package cli - -import ( - "errors" - "flag" - "fmt" - "strconv" -) - -// boolValue needs to implement the boolFlag internal interface in flag -// to be able to capture bool fields and values -// -// type boolFlag interface { -// Value -// IsBoolFlag() bool -// } -type boolValue struct { - destination *bool - count *int -} - -func newBoolValue(val bool, p *bool, count *int) *boolValue { - *p = val - return &boolValue{ - destination: p, - count: count, - } -} - -func (b *boolValue) Set(s string) error { - v, err := strconv.ParseBool(s) - if err != nil { - err = errors.New("parse error") - return err - } - *b.destination = v - if b.count != nil { - *b.count = *b.count + 1 - } - return err -} - -func (b *boolValue) Get() interface{} { return *b.destination } - -func (b *boolValue) String() string { - if b.destination != nil { - return strconv.FormatBool(*b.destination) - } - return strconv.FormatBool(false) -} - -func (b *boolValue) IsBoolFlag() bool { return true } - -func (b *boolValue) Count() int { - if b.count != nil && *b.count > 0 { - return *b.count - } - return 0 -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *BoolFlag) TakesValue() bool { - return false -} - -// GetUsage returns the usage string for the flag -func (f *BoolFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *BoolFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *BoolFlag) GetValue() string { - return "" -} - -// GetDefaultText returns the default text for this flag -func (f *BoolFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return fmt.Sprintf("%v", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *BoolFlag) GetEnvVars() []string { - return f.EnvVars -} - -// RunAction executes flag action if set -func (f *BoolFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Bool(f.Name)) - } - - return nil -} - -// Apply populates the flag given the flag set and environment -func (f *BoolFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valBool, err := strconv.ParseBool(val) - - if err != nil { - return fmt.Errorf("could not parse %q as bool value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = valBool - } else { - // empty value implies that the env is defined but set to empty string, we have to assume that this is - // what the user wants. If user doesnt want this then the env needs to be deleted or the flag removed from - // file - f.Value = false - } - f.HasBeenSet = true - } - - count := f.Count - dest := f.Destination - - if count == nil { - count = new(int) - } - - // since count will be incremented for each alias as well - // subtract number of aliases from overall count - *count -= len(f.Aliases) - - if dest == nil { - dest = new(bool) - } - - for _, name := range f.Names() { - value := newBoolValue(f.Value, dest, count) - set.Var(value, name, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *BoolFlag) Get(ctx *Context) bool { - return ctx.Bool(f.Name) -} - -// Bool looks up the value of a local BoolFlag, returns -// false if not found -func (cCtx *Context) Bool(name string) bool { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupBool(name, fs) - } - return false -} - -func lookupBool(name string, set *flag.FlagSet) bool { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseBool(f.Value.String()) - if err != nil { - return false - } - return parsed - } - return false -} diff --git a/vendor/github.com/urfave/cli/v2/flag_duration.go b/vendor/github.com/urfave/cli/v2/flag_duration.go deleted file mode 100644 index eac4cb8..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_duration.go +++ /dev/null @@ -1,104 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "time" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *DurationFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *DurationFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *DurationFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *DurationFlag) GetValue() string { - return f.Value.String() -} - -// GetDefaultText returns the default text for this flag -func (f *DurationFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.defaultValue.String() -} - -// GetEnvVars returns the env vars for this flag -func (f *DurationFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *DurationFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valDuration, err := time.ParseDuration(val) - - if err != nil { - return fmt.Errorf("could not parse %q as duration value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = valDuration - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.DurationVar(f.Destination, name, f.Value, f.Usage) - continue - } - set.Duration(name, f.Value, f.Usage) - } - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *DurationFlag) Get(ctx *Context) time.Duration { - return ctx.Duration(f.Name) -} - -// RunAction executes flag action if set -func (f *DurationFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Duration(f.Name)) - } - - return nil -} - -// Duration looks up the value of a local DurationFlag, returns -// 0 if not found -func (cCtx *Context) Duration(name string) time.Duration { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupDuration(name, fs) - } - return 0 -} - -func lookupDuration(name string, set *flag.FlagSet) time.Duration { - f := set.Lookup(name) - if f != nil { - parsed, err := time.ParseDuration(f.Value.String()) - if err != nil { - return 0 - } - return parsed - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_ext.go b/vendor/github.com/urfave/cli/v2/flag_ext.go deleted file mode 100644 index 64da59e..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_ext.go +++ /dev/null @@ -1,48 +0,0 @@ -package cli - -import "flag" - -type extFlag struct { - f *flag.Flag -} - -func (e *extFlag) Apply(fs *flag.FlagSet) error { - fs.Var(e.f.Value, e.f.Name, e.f.Usage) - return nil -} - -func (e *extFlag) Names() []string { - return []string{e.f.Name} -} - -func (e *extFlag) IsSet() bool { - return false -} - -func (e *extFlag) String() string { - return FlagStringer(e) -} - -func (e *extFlag) IsVisible() bool { - return true -} - -func (e *extFlag) TakesValue() bool { - return false -} - -func (e *extFlag) GetUsage() string { - return e.f.Usage -} - -func (e *extFlag) GetValue() string { - return e.f.Value.String() -} - -func (e *extFlag) GetDefaultText() string { - return e.f.DefValue -} - -func (e *extFlag) GetEnvVars() []string { - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_float64.go b/vendor/github.com/urfave/cli/v2/flag_float64.go deleted file mode 100644 index bce26c1..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_float64.go +++ /dev/null @@ -1,101 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "strconv" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *Float64Flag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Float64Flag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Float64Flag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Float64Flag) GetValue() string { - return fmt.Sprintf("%v", f.Value) -} - -// GetDefaultText returns the default text for this flag -func (f *Float64Flag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *Float64Flag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *Float64Flag) Apply(set *flag.FlagSet) error { - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valFloat, err := strconv.ParseFloat(val, 64) - if err != nil { - return fmt.Errorf("could not parse %q as float64 value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = valFloat - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.Float64Var(f.Destination, name, f.Value, f.Usage) - continue - } - set.Float64(name, f.Value, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *Float64Flag) Get(ctx *Context) float64 { - return ctx.Float64(f.Name) -} - -// RunAction executes flag action if set -func (f *Float64Flag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Float64(f.Name)) - } - - return nil -} - -// Float64 looks up the value of a local Float64Flag, returns -// 0 if not found -func (cCtx *Context) Float64(name string) float64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupFloat64(name, fs) - } - return 0 -} - -func lookupFloat64(name string, set *flag.FlagSet) float64 { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseFloat(f.Value.String(), 64) - if err != nil { - return 0 - } - return parsed - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_float64_slice.go b/vendor/github.com/urfave/cli/v2/flag_float64_slice.go deleted file mode 100644 index 0bc4612..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_float64_slice.go +++ /dev/null @@ -1,216 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// Float64Slice wraps []float64 to satisfy flag.Value -type Float64Slice struct { - slice []float64 - separator separatorSpec - hasBeenSet bool -} - -// NewFloat64Slice makes a *Float64Slice with default values -func NewFloat64Slice(defaults ...float64) *Float64Slice { - return &Float64Slice{slice: append([]float64{}, defaults...)} -} - -// clone allocate a copy of self object -func (f *Float64Slice) clone() *Float64Slice { - n := &Float64Slice{ - slice: make([]float64, len(f.slice)), - hasBeenSet: f.hasBeenSet, - } - copy(n.slice, f.slice) - return n -} - -func (f *Float64Slice) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Set parses the value into a float64 and appends it to the list of values -func (f *Float64Slice) Set(value string) error { - if !f.hasBeenSet { - f.slice = []float64{} - f.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &f.slice) - f.hasBeenSet = true - return nil - } - - for _, s := range f.separator.flagSplitMultiValues(value) { - tmp, err := strconv.ParseFloat(strings.TrimSpace(s), 64) - if err != nil { - return err - } - - f.slice = append(f.slice, tmp) - } - return nil -} - -// String returns a readable representation of this value (for usage defaults) -func (f *Float64Slice) String() string { - v := f.slice - if v == nil { - // treat nil the same as zero length non-nil - v = make([]float64, 0) - } - return fmt.Sprintf("%#v", v) -} - -// Serialize allows Float64Slice to fulfill Serializer -func (f *Float64Slice) Serialize() string { - jsonBytes, _ := json.Marshal(f.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of float64s set by this flag -func (f *Float64Slice) Value() []float64 { - return f.slice -} - -// Get returns the slice of float64s set by this flag -func (f *Float64Slice) Get() interface{} { - return *f -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *Float64SliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true if the flag takes a value, otherwise false -func (f *Float64SliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Float64SliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Float64SliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Float64SliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, i := range f.Value.Value() { - defaultVals = append(defaultVals, strings.TrimRight(strings.TrimRight(fmt.Sprintf("%f", i), "0"), ".")) - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *Float64SliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *Float64SliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *Float64SliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *Float64SliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]float64, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *Float64Slice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(Float64Slice) - setValue.WithSeparatorSpec(f.separator) - } - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - for _, s := range f.separator.flagSplitMultiValues(val) { - if err := setValue.Set(strings.TrimSpace(s)); err != nil { - return fmt.Errorf("could not parse %q as float64 slice value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *Float64SliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *Float64SliceFlag) Get(ctx *Context) []float64 { - return ctx.Float64Slice(f.Name) -} - -// RunAction executes flag action if set -func (f *Float64SliceFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Float64Slice(f.Name)) - } - - return nil -} - -// Float64Slice looks up the value of a local Float64SliceFlag, returns -// nil if not found -func (cCtx *Context) Float64Slice(name string) []float64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupFloat64Slice(name, fs) - } - return nil -} - -func lookupFloat64Slice(name string, set *flag.FlagSet) []float64 { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*Float64Slice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_generic.go b/vendor/github.com/urfave/cli/v2/flag_generic.go deleted file mode 100644 index 039ffdf..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_generic.go +++ /dev/null @@ -1,124 +0,0 @@ -package cli - -import ( - "flag" - "fmt" -) - -// Generic is a generic parseable type identified by a specific flag -type Generic interface { - Set(value string) error - String() string -} - -type stringGeneric struct { - value string -} - -func (s *stringGeneric) Set(value string) error { - s.value = value - return nil -} - -func (s *stringGeneric) String() string { - return s.value -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *GenericFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *GenericFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *GenericFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *GenericFlag) GetValue() string { - if f.Value != nil { - return f.Value.String() - } - return "" -} - -// GetDefaultText returns the default text for this flag -func (f *GenericFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - if f.defaultValue != nil { - return f.defaultValue.String() - } - return "" -} - -// GetEnvVars returns the env vars for this flag -func (f *GenericFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply takes the flagset and calls Set on the generic flag with the value -// provided by the user for parsing by the flag -func (f *GenericFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - if f.Value != nil { - f.defaultValue = &stringGeneric{value: f.Value.String()} - } - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - if err := f.Value.Set(val); err != nil { - return fmt.Errorf("could not parse %q from %s as value for flag %s: %s", val, source, f.Name, err) - } - - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.Var(f.Destination, name, f.Usage) - continue - } - set.Var(f.Value, name, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *GenericFlag) Get(ctx *Context) interface{} { - return ctx.Generic(f.Name) -} - -// RunAction executes flag action if set -func (f *GenericFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Generic(f.Name)) - } - - return nil -} - -// Generic looks up the value of a local GenericFlag, returns -// nil if not found -func (cCtx *Context) Generic(name string) interface{} { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupGeneric(name, fs) - } - return nil -} - -func lookupGeneric(name string, set *flag.FlagSet) interface{} { - if f := set.Lookup(name); f != nil { - return f.Value - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_int.go b/vendor/github.com/urfave/cli/v2/flag_int.go deleted file mode 100644 index d681270..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_int.go +++ /dev/null @@ -1,105 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "strconv" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *IntFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *IntFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *IntFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *IntFlag) GetValue() string { - return fmt.Sprintf("%d", f.Value) -} - -// GetDefaultText returns the default text for this flag -func (f *IntFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return fmt.Sprintf("%d", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *IntFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *IntFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valInt, err := strconv.ParseInt(val, f.Base, 64) - - if err != nil { - return fmt.Errorf("could not parse %q as int value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = int(valInt) - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.IntVar(f.Destination, name, f.Value, f.Usage) - continue - } - set.Int(name, f.Value, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *IntFlag) Get(ctx *Context) int { - return ctx.Int(f.Name) -} - -// RunAction executes flag action if set -func (f *IntFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Int(f.Name)) - } - - return nil -} - -// Int looks up the value of a local IntFlag, returns -// 0 if not found -func (cCtx *Context) Int(name string) int { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupInt(name, fs) - } - return 0 -} - -func lookupInt(name string, set *flag.FlagSet) int { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseInt(f.Value.String(), 0, 64) - if err != nil { - return 0 - } - return int(parsed) - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_int64.go b/vendor/github.com/urfave/cli/v2/flag_int64.go deleted file mode 100644 index 6f8c8d2..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_int64.go +++ /dev/null @@ -1,104 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "strconv" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *Int64Flag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Int64Flag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Int64Flag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Int64Flag) GetValue() string { - return fmt.Sprintf("%d", f.Value) -} - -// GetDefaultText returns the default text for this flag -func (f *Int64Flag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return fmt.Sprintf("%d", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *Int64Flag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *Int64Flag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valInt, err := strconv.ParseInt(val, f.Base, 64) - - if err != nil { - return fmt.Errorf("could not parse %q as int value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = valInt - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.Int64Var(f.Destination, name, f.Value, f.Usage) - continue - } - set.Int64(name, f.Value, f.Usage) - } - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *Int64Flag) Get(ctx *Context) int64 { - return ctx.Int64(f.Name) -} - -// RunAction executes flag action if set -func (f *Int64Flag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Int64(f.Name)) - } - - return nil -} - -// Int64 looks up the value of a local Int64Flag, returns -// 0 if not found -func (cCtx *Context) Int64(name string) int64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupInt64(name, fs) - } - return 0 -} - -func lookupInt64(name string, set *flag.FlagSet) int64 { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseInt(f.Value.String(), 0, 64) - if err != nil { - return 0 - } - return parsed - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_int64_slice.go b/vendor/github.com/urfave/cli/v2/flag_int64_slice.go deleted file mode 100644 index d45c2dd..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_int64_slice.go +++ /dev/null @@ -1,215 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// Int64Slice wraps []int64 to satisfy flag.Value -type Int64Slice struct { - slice []int64 - separator separatorSpec - hasBeenSet bool -} - -// NewInt64Slice makes an *Int64Slice with default values -func NewInt64Slice(defaults ...int64) *Int64Slice { - return &Int64Slice{slice: append([]int64{}, defaults...)} -} - -// clone allocate a copy of self object -func (i *Int64Slice) clone() *Int64Slice { - n := &Int64Slice{ - slice: make([]int64, len(i.slice)), - hasBeenSet: i.hasBeenSet, - } - copy(n.slice, i.slice) - return n -} - -func (i *Int64Slice) WithSeparatorSpec(spec separatorSpec) { - i.separator = spec -} - -// Set parses the value into an integer and appends it to the list of values -func (i *Int64Slice) Set(value string) error { - if !i.hasBeenSet { - i.slice = []int64{} - i.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &i.slice) - i.hasBeenSet = true - return nil - } - - for _, s := range i.separator.flagSplitMultiValues(value) { - tmp, err := strconv.ParseInt(strings.TrimSpace(s), 0, 64) - if err != nil { - return err - } - - i.slice = append(i.slice, tmp) - } - - return nil -} - -// String returns a readable representation of this value (for usage defaults) -func (i *Int64Slice) String() string { - v := i.slice - if v == nil { - // treat nil the same as zero length non-nil - v = make([]int64, 0) - } - return fmt.Sprintf("%#v", v) -} - -// Serialize allows Int64Slice to fulfill Serializer -func (i *Int64Slice) Serialize() string { - jsonBytes, _ := json.Marshal(i.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of ints set by this flag -func (i *Int64Slice) Value() []int64 { - return i.slice -} - -// Get returns the slice of ints set by this flag -func (i *Int64Slice) Get() interface{} { - return *i -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *Int64SliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *Int64SliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Int64SliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Int64SliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Int64SliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, i := range f.Value.Value() { - defaultVals = append(defaultVals, strconv.FormatInt(i, 10)) - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *Int64SliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *Int64SliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *Int64SliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *Int64SliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]int64, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *Int64Slice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(Int64Slice) - setValue.WithSeparatorSpec(f.separator) - } - - if val, source, ok := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok && val != "" { - for _, s := range f.separator.flagSplitMultiValues(val) { - if err := setValue.Set(strings.TrimSpace(s)); err != nil { - return fmt.Errorf("could not parse %q as int64 slice value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *Int64SliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *Int64SliceFlag) Get(ctx *Context) []int64 { - return ctx.Int64Slice(f.Name) -} - -// RunAction executes flag action if set -func (f *Int64SliceFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Int64Slice(f.Name)) - } - - return nil -} - -// Int64Slice looks up the value of a local Int64SliceFlag, returns -// nil if not found -func (cCtx *Context) Int64Slice(name string) []int64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupInt64Slice(name, fs) - } - return nil -} - -func lookupInt64Slice(name string, set *flag.FlagSet) []int64 { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*Int64Slice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_int_slice.go b/vendor/github.com/urfave/cli/v2/flag_int_slice.go deleted file mode 100644 index da9c09b..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_int_slice.go +++ /dev/null @@ -1,226 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// IntSlice wraps []int to satisfy flag.Value -type IntSlice struct { - slice []int - separator separatorSpec - hasBeenSet bool -} - -// NewIntSlice makes an *IntSlice with default values -func NewIntSlice(defaults ...int) *IntSlice { - return &IntSlice{slice: append([]int{}, defaults...)} -} - -// clone allocate a copy of self object -func (i *IntSlice) clone() *IntSlice { - n := &IntSlice{ - slice: make([]int, len(i.slice)), - hasBeenSet: i.hasBeenSet, - } - copy(n.slice, i.slice) - return n -} - -// TODO: Consistently have specific Set function for Int64 and Float64 ? -// SetInt directly adds an integer to the list of values -func (i *IntSlice) SetInt(value int) { - if !i.hasBeenSet { - i.slice = []int{} - i.hasBeenSet = true - } - - i.slice = append(i.slice, value) -} - -func (i *IntSlice) WithSeparatorSpec(spec separatorSpec) { - i.separator = spec -} - -// Set parses the value into an integer and appends it to the list of values -func (i *IntSlice) Set(value string) error { - if !i.hasBeenSet { - i.slice = []int{} - i.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &i.slice) - i.hasBeenSet = true - return nil - } - - for _, s := range i.separator.flagSplitMultiValues(value) { - tmp, err := strconv.ParseInt(strings.TrimSpace(s), 0, 64) - if err != nil { - return err - } - - i.slice = append(i.slice, int(tmp)) - } - - return nil -} - -// String returns a readable representation of this value (for usage defaults) -func (i *IntSlice) String() string { - v := i.slice - if v == nil { - // treat nil the same as zero length non-nil - v = make([]int, 0) - } - return fmt.Sprintf("%#v", v) -} - -// Serialize allows IntSlice to fulfill Serializer -func (i *IntSlice) Serialize() string { - jsonBytes, _ := json.Marshal(i.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of ints set by this flag -func (i *IntSlice) Value() []int { - return i.slice -} - -// Get returns the slice of ints set by this flag -func (i *IntSlice) Get() interface{} { - return *i -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *IntSliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *IntSliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *IntSliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *IntSliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *IntSliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, i := range f.Value.Value() { - defaultVals = append(defaultVals, strconv.Itoa(i)) - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *IntSliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *IntSliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *IntSliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *IntSliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]int, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *IntSlice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(IntSlice) - setValue.WithSeparatorSpec(f.separator) - } - - if val, source, ok := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok && val != "" { - for _, s := range f.separator.flagSplitMultiValues(val) { - if err := setValue.Set(strings.TrimSpace(s)); err != nil { - return fmt.Errorf("could not parse %q as int slice value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *IntSliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *IntSliceFlag) Get(ctx *Context) []int { - return ctx.IntSlice(f.Name) -} - -// RunAction executes flag action if set -func (f *IntSliceFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.IntSlice(f.Name)) - } - - return nil -} - -// IntSlice looks up the value of a local IntSliceFlag, returns -// nil if not found -func (cCtx *Context) IntSlice(name string) []int { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupIntSlice(name, fs) - } - return nil -} - -func lookupIntSlice(name string, set *flag.FlagSet) []int { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*IntSlice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_path.go b/vendor/github.com/urfave/cli/v2/flag_path.go deleted file mode 100644 index c498677..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_path.go +++ /dev/null @@ -1,97 +0,0 @@ -package cli - -import ( - "flag" - "fmt" -) - -type Path = string - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *PathFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *PathFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *PathFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *PathFlag) GetValue() string { - return f.Value -} - -// GetDefaultText returns the default text for this flag -func (f *PathFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - if f.defaultValue == "" { - return f.defaultValue - } - return fmt.Sprintf("%q", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *PathFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *PathFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, _, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - f.Value = val - f.HasBeenSet = true - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.StringVar(f.Destination, name, f.Value, f.Usage) - continue - } - set.String(name, f.Value, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *PathFlag) Get(ctx *Context) string { - return ctx.Path(f.Name) -} - -// RunAction executes flag action if set -func (f *PathFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Path(f.Name)) - } - - return nil -} - -// Path looks up the value of a local PathFlag, returns -// "" if not found -func (cCtx *Context) Path(name string) string { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupPath(name, fs) - } - - return "" -} - -func lookupPath(name string, set *flag.FlagSet) string { - if f := set.Lookup(name); f != nil { - return f.Value.String() - } - return "" -} diff --git a/vendor/github.com/urfave/cli/v2/flag_string.go b/vendor/github.com/urfave/cli/v2/flag_string.go deleted file mode 100644 index 4e55a2c..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_string.go +++ /dev/null @@ -1,94 +0,0 @@ -package cli - -import ( - "flag" - "fmt" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *StringFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *StringFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *StringFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *StringFlag) GetValue() string { - return f.Value -} - -// GetDefaultText returns the default text for this flag -func (f *StringFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - if f.defaultValue == "" { - return f.defaultValue - } - return fmt.Sprintf("%q", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *StringFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *StringFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, _, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - f.Value = val - f.HasBeenSet = true - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.StringVar(f.Destination, name, f.Value, f.Usage) - continue - } - set.String(name, f.Value, f.Usage) - } - - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *StringFlag) Get(ctx *Context) string { - return ctx.String(f.Name) -} - -// RunAction executes flag action if set -func (f *StringFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.String(f.Name)) - } - - return nil -} - -// String looks up the value of a local StringFlag, returns -// "" if not found -func (cCtx *Context) String(name string) string { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupString(name, fs) - } - return "" -} - -func lookupString(name string, set *flag.FlagSet) string { - if f := set.Lookup(name); f != nil { - return f.Value.String() - } - return "" -} diff --git a/vendor/github.com/urfave/cli/v2/flag_string_slice.go b/vendor/github.com/urfave/cli/v2/flag_string_slice.go deleted file mode 100644 index 28f4798..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_string_slice.go +++ /dev/null @@ -1,216 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// StringSlice wraps a []string to satisfy flag.Value -type StringSlice struct { - slice []string - separator separatorSpec - hasBeenSet bool - keepSpace bool -} - -// NewStringSlice creates a *StringSlice with default values -func NewStringSlice(defaults ...string) *StringSlice { - return &StringSlice{slice: append([]string{}, defaults...)} -} - -// clone allocate a copy of self object -func (s *StringSlice) clone() *StringSlice { - n := &StringSlice{ - slice: make([]string, len(s.slice)), - hasBeenSet: s.hasBeenSet, - } - copy(n.slice, s.slice) - return n -} - -// Set appends the string value to the list of values -func (s *StringSlice) Set(value string) error { - if !s.hasBeenSet { - s.slice = []string{} - s.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &s.slice) - s.hasBeenSet = true - return nil - } - - for _, t := range s.separator.flagSplitMultiValues(value) { - if !s.keepSpace { - t = strings.TrimSpace(t) - } - s.slice = append(s.slice, t) - } - - return nil -} - -func (s *StringSlice) WithSeparatorSpec(spec separatorSpec) { - s.separator = spec -} - -// String returns a readable representation of this value (for usage defaults) -func (s *StringSlice) String() string { - return fmt.Sprintf("%s", s.slice) -} - -// Serialize allows StringSlice to fulfill Serializer -func (s *StringSlice) Serialize() string { - jsonBytes, _ := json.Marshal(s.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of strings set by this flag -func (s *StringSlice) Value() []string { - return s.slice -} - -// Get returns the slice of strings set by this flag -func (s *StringSlice) Get() interface{} { - return *s -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *StringSliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *StringSliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *StringSliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *StringSliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *StringSliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, s := range f.Value.Value() { - if len(s) > 0 { - defaultVals = append(defaultVals, strconv.Quote(s)) - } - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *StringSliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *StringSliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *StringSliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *StringSliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]string, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *StringSlice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(StringSlice) - setValue.WithSeparatorSpec(f.separator) - } - - setValue.keepSpace = f.KeepSpace - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - for _, s := range f.separator.flagSplitMultiValues(val) { - if !f.KeepSpace { - s = strings.TrimSpace(s) - } - if err := setValue.Set(s); err != nil { - return fmt.Errorf("could not parse %q as string value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *StringSliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *StringSliceFlag) Get(ctx *Context) []string { - return ctx.StringSlice(f.Name) -} - -// RunAction executes flag action if set -func (f *StringSliceFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.StringSlice(f.Name)) - } - - return nil -} - -// StringSlice looks up the value of a local StringSliceFlag, returns -// nil if not found -func (cCtx *Context) StringSlice(name string) []string { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupStringSlice(name, fs) - } - return nil -} - -func lookupStringSlice(name string, set *flag.FlagSet) []string { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*StringSlice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_timestamp.go b/vendor/github.com/urfave/cli/v2/flag_timestamp.go deleted file mode 100644 index 83f750a..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_timestamp.go +++ /dev/null @@ -1,199 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "time" -) - -// Timestamp wrap to satisfy golang's flag interface. -type Timestamp struct { - timestamp *time.Time - hasBeenSet bool - layout string - location *time.Location -} - -// Timestamp constructor -func NewTimestamp(timestamp time.Time) *Timestamp { - return &Timestamp{timestamp: ×tamp} -} - -// Set the timestamp value directly -func (t *Timestamp) SetTimestamp(value time.Time) { - if !t.hasBeenSet { - t.timestamp = &value - t.hasBeenSet = true - } -} - -// Set the timestamp string layout for future parsing -func (t *Timestamp) SetLayout(layout string) { - t.layout = layout -} - -// Set perceived timezone of the to-be parsed time string -func (t *Timestamp) SetLocation(loc *time.Location) { - t.location = loc -} - -// Parses the string value to timestamp -func (t *Timestamp) Set(value string) error { - var timestamp time.Time - var err error - - if t.location != nil { - timestamp, err = time.ParseInLocation(t.layout, value, t.location) - } else { - timestamp, err = time.Parse(t.layout, value) - } - - if err != nil { - return err - } - - t.timestamp = ×tamp - t.hasBeenSet = true - return nil -} - -// String returns a readable representation of this value (for usage defaults) -func (t *Timestamp) String() string { - return fmt.Sprintf("%#v", t.timestamp) -} - -// Value returns the timestamp value stored in the flag -func (t *Timestamp) Value() *time.Time { - return t.timestamp -} - -// Get returns the flag structure -func (t *Timestamp) Get() interface{} { - return *t -} - -// clone timestamp -func (t *Timestamp) clone() *Timestamp { - tc := &Timestamp{ - timestamp: nil, - hasBeenSet: t.hasBeenSet, - layout: t.layout, - location: nil, - } - if t.timestamp != nil { - tts := *t.timestamp - tc.timestamp = &tts - } - if t.location != nil { - loc := *t.location - tc.location = &loc - } - return tc -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *TimestampFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *TimestampFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *TimestampFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *TimestampFlag) GetValue() string { - if f.Value != nil && f.Value.timestamp != nil { - return f.Value.timestamp.String() - } - return "" -} - -// GetDefaultText returns the default text for this flag -func (f *TimestampFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - if f.defaultValue != nil && f.defaultValue.timestamp != nil { - return f.defaultValue.timestamp.String() - } - - return "" -} - -// GetEnvVars returns the env vars for this flag -func (f *TimestampFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Apply populates the flag given the flag set and environment -func (f *TimestampFlag) Apply(set *flag.FlagSet) error { - if f.Layout == "" { - return fmt.Errorf("timestamp Layout is required") - } - if f.Value == nil { - f.Value = &Timestamp{} - } - f.Value.SetLayout(f.Layout) - f.Value.SetLocation(f.Timezone) - - f.defaultValue = f.Value.clone() - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if err := f.Value.Set(val); err != nil { - return fmt.Errorf("could not parse %q as timestamp value from %s for flag %s: %s", val, source, f.Name, err) - } - f.HasBeenSet = true - } - - if f.Destination != nil { - *f.Destination = *f.Value - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.Var(f.Destination, name, f.Usage) - continue - } - - set.Var(f.Value, name, f.Usage) - } - return nil -} - -// Get returns the flag’s value in the given Context. -func (f *TimestampFlag) Get(ctx *Context) *time.Time { - return ctx.Timestamp(f.Name) -} - -// RunAction executes flag action if set -func (f *TimestampFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Timestamp(f.Name)) - } - - return nil -} - -// Timestamp gets the timestamp from a flag name -func (cCtx *Context) Timestamp(name string) *time.Time { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupTimestamp(name, fs) - } - return nil -} - -// Fetches the timestamp value from the local timestampWrap -func lookupTimestamp(name string, set *flag.FlagSet) *time.Time { - f := set.Lookup(name) - if f != nil { - return (f.Value.(*Timestamp)).Value() - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_uint.go b/vendor/github.com/urfave/cli/v2/flag_uint.go deleted file mode 100644 index d11aa0a..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_uint.go +++ /dev/null @@ -1,104 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "strconv" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *UintFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *UintFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *UintFlag) GetCategory() string { - return f.Category -} - -// Apply populates the flag given the flag set and environment -func (f *UintFlag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valInt, err := strconv.ParseUint(val, f.Base, 64) - if err != nil { - return fmt.Errorf("could not parse %q as uint value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = uint(valInt) - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.UintVar(f.Destination, name, f.Value, f.Usage) - continue - } - set.Uint(name, f.Value, f.Usage) - } - - return nil -} - -// RunAction executes flag action if set -func (f *UintFlag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Uint(f.Name)) - } - - return nil -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *UintFlag) GetValue() string { - return fmt.Sprintf("%d", f.Value) -} - -// GetDefaultText returns the default text for this flag -func (f *UintFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return fmt.Sprintf("%d", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *UintFlag) GetEnvVars() []string { - return f.EnvVars -} - -// Get returns the flag’s value in the given Context. -func (f *UintFlag) Get(ctx *Context) uint { - return ctx.Uint(f.Name) -} - -// Uint looks up the value of a local UintFlag, returns -// 0 if not found -func (cCtx *Context) Uint(name string) uint { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupUint(name, fs) - } - return 0 -} - -func lookupUint(name string, set *flag.FlagSet) uint { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseUint(f.Value.String(), 0, 64) - if err != nil { - return 0 - } - return uint(parsed) - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_uint64.go b/vendor/github.com/urfave/cli/v2/flag_uint64.go deleted file mode 100644 index ea73100..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_uint64.go +++ /dev/null @@ -1,104 +0,0 @@ -package cli - -import ( - "flag" - "fmt" - "strconv" -) - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *Uint64Flag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Uint64Flag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Uint64Flag) GetCategory() string { - return f.Category -} - -// Apply populates the flag given the flag set and environment -func (f *Uint64Flag) Apply(set *flag.FlagSet) error { - // set default value so that environment wont be able to overwrite it - f.defaultValue = f.Value - - if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found { - if val != "" { - valInt, err := strconv.ParseUint(val, f.Base, 64) - if err != nil { - return fmt.Errorf("could not parse %q as uint64 value from %s for flag %s: %s", val, source, f.Name, err) - } - - f.Value = valInt - f.HasBeenSet = true - } - } - - for _, name := range f.Names() { - if f.Destination != nil { - set.Uint64Var(f.Destination, name, f.Value, f.Usage) - continue - } - set.Uint64(name, f.Value, f.Usage) - } - - return nil -} - -// RunAction executes flag action if set -func (f *Uint64Flag) RunAction(c *Context) error { - if f.Action != nil { - return f.Action(c, c.Uint64(f.Name)) - } - - return nil -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Uint64Flag) GetValue() string { - return fmt.Sprintf("%d", f.Value) -} - -// GetDefaultText returns the default text for this flag -func (f *Uint64Flag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return fmt.Sprintf("%d", f.defaultValue) -} - -// GetEnvVars returns the env vars for this flag -func (f *Uint64Flag) GetEnvVars() []string { - return f.EnvVars -} - -// Get returns the flag’s value in the given Context. -func (f *Uint64Flag) Get(ctx *Context) uint64 { - return ctx.Uint64(f.Name) -} - -// Uint64 looks up the value of a local Uint64Flag, returns -// 0 if not found -func (cCtx *Context) Uint64(name string) uint64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupUint64(name, fs) - } - return 0 -} - -func lookupUint64(name string, set *flag.FlagSet) uint64 { - f := set.Lookup(name) - if f != nil { - parsed, err := strconv.ParseUint(f.Value.String(), 0, 64) - if err != nil { - return 0 - } - return parsed - } - return 0 -} diff --git a/vendor/github.com/urfave/cli/v2/flag_uint64_slice.go b/vendor/github.com/urfave/cli/v2/flag_uint64_slice.go deleted file mode 100644 index e845dd5..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_uint64_slice.go +++ /dev/null @@ -1,210 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// Uint64Slice wraps []int64 to satisfy flag.Value -type Uint64Slice struct { - slice []uint64 - separator separatorSpec - hasBeenSet bool -} - -// NewUint64Slice makes an *Uint64Slice with default values -func NewUint64Slice(defaults ...uint64) *Uint64Slice { - return &Uint64Slice{slice: append([]uint64{}, defaults...)} -} - -// clone allocate a copy of self object -func (i *Uint64Slice) clone() *Uint64Slice { - n := &Uint64Slice{ - slice: make([]uint64, len(i.slice)), - hasBeenSet: i.hasBeenSet, - } - copy(n.slice, i.slice) - return n -} - -// Set parses the value into an integer and appends it to the list of values -func (i *Uint64Slice) Set(value string) error { - if !i.hasBeenSet { - i.slice = []uint64{} - i.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &i.slice) - i.hasBeenSet = true - return nil - } - - for _, s := range i.separator.flagSplitMultiValues(value) { - tmp, err := strconv.ParseUint(strings.TrimSpace(s), 0, 64) - if err != nil { - return err - } - - i.slice = append(i.slice, tmp) - } - - return nil -} - -func (i *Uint64Slice) WithSeparatorSpec(spec separatorSpec) { - i.separator = spec -} - -// String returns a readable representation of this value (for usage defaults) -func (i *Uint64Slice) String() string { - v := i.slice - if v == nil { - // treat nil the same as zero length non-nil - v = make([]uint64, 0) - } - str := fmt.Sprintf("%d", v) - str = strings.Replace(str, " ", ", ", -1) - str = strings.Replace(str, "[", "{", -1) - str = strings.Replace(str, "]", "}", -1) - return fmt.Sprintf("[]uint64%s", str) -} - -// Serialize allows Uint64Slice to fulfill Serializer -func (i *Uint64Slice) Serialize() string { - jsonBytes, _ := json.Marshal(i.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of ints set by this flag -func (i *Uint64Slice) Value() []uint64 { - return i.slice -} - -// Get returns the slice of ints set by this flag -func (i *Uint64Slice) Get() interface{} { - return *i -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *Uint64SliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *Uint64SliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *Uint64SliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *Uint64SliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *Uint64SliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, i := range f.Value.Value() { - defaultVals = append(defaultVals, strconv.FormatUint(i, 10)) - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *Uint64SliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *Uint64SliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *Uint64SliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *Uint64SliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]uint64, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *Uint64Slice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(Uint64Slice) - setValue.WithSeparatorSpec(f.separator) - } - - if val, source, ok := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok && val != "" { - for _, s := range f.separator.flagSplitMultiValues(val) { - if err := setValue.Set(strings.TrimSpace(s)); err != nil { - return fmt.Errorf("could not parse %q as uint64 slice value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *Uint64SliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *Uint64SliceFlag) Get(ctx *Context) []uint64 { - return ctx.Uint64Slice(f.Name) -} - -// Uint64Slice looks up the value of a local Uint64SliceFlag, returns -// nil if not found -func (cCtx *Context) Uint64Slice(name string) []uint64 { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupUint64Slice(name, fs) - } - return nil -} - -func lookupUint64Slice(name string, set *flag.FlagSet) []uint64 { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*Uint64Slice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/flag_uint_slice.go b/vendor/github.com/urfave/cli/v2/flag_uint_slice.go deleted file mode 100644 index d2aed48..0000000 --- a/vendor/github.com/urfave/cli/v2/flag_uint_slice.go +++ /dev/null @@ -1,221 +0,0 @@ -package cli - -import ( - "encoding/json" - "flag" - "fmt" - "strconv" - "strings" -) - -// UintSlice wraps []int to satisfy flag.Value -type UintSlice struct { - slice []uint - separator separatorSpec - hasBeenSet bool -} - -// NewUintSlice makes an *UintSlice with default values -func NewUintSlice(defaults ...uint) *UintSlice { - return &UintSlice{slice: append([]uint{}, defaults...)} -} - -// clone allocate a copy of self object -func (i *UintSlice) clone() *UintSlice { - n := &UintSlice{ - slice: make([]uint, len(i.slice)), - hasBeenSet: i.hasBeenSet, - } - copy(n.slice, i.slice) - return n -} - -// TODO: Consistently have specific Set function for Int64 and Float64 ? -// SetInt directly adds an integer to the list of values -func (i *UintSlice) SetUint(value uint) { - if !i.hasBeenSet { - i.slice = []uint{} - i.hasBeenSet = true - } - - i.slice = append(i.slice, value) -} - -// Set parses the value into an integer and appends it to the list of values -func (i *UintSlice) Set(value string) error { - if !i.hasBeenSet { - i.slice = []uint{} - i.hasBeenSet = true - } - - if strings.HasPrefix(value, slPfx) { - // Deserializing assumes overwrite - _ = json.Unmarshal([]byte(strings.Replace(value, slPfx, "", 1)), &i.slice) - i.hasBeenSet = true - return nil - } - - for _, s := range i.separator.flagSplitMultiValues(value) { - tmp, err := strconv.ParseUint(strings.TrimSpace(s), 0, 32) - if err != nil { - return err - } - - i.slice = append(i.slice, uint(tmp)) - } - - return nil -} - -func (i *UintSlice) WithSeparatorSpec(spec separatorSpec) { - i.separator = spec -} - -// String returns a readable representation of this value (for usage defaults) -func (i *UintSlice) String() string { - v := i.slice - if v == nil { - // treat nil the same as zero length non-nil - v = make([]uint, 0) - } - str := fmt.Sprintf("%d", v) - str = strings.Replace(str, " ", ", ", -1) - str = strings.Replace(str, "[", "{", -1) - str = strings.Replace(str, "]", "}", -1) - return fmt.Sprintf("[]uint%s", str) -} - -// Serialize allows UintSlice to fulfill Serializer -func (i *UintSlice) Serialize() string { - jsonBytes, _ := json.Marshal(i.slice) - return fmt.Sprintf("%s%s", slPfx, string(jsonBytes)) -} - -// Value returns the slice of ints set by this flag -func (i *UintSlice) Value() []uint { - return i.slice -} - -// Get returns the slice of ints set by this flag -func (i *UintSlice) Get() interface{} { - return *i -} - -// String returns a readable representation of this value -// (for usage defaults) -func (f *UintSliceFlag) String() string { - return FlagStringer(f) -} - -// TakesValue returns true of the flag takes a value, otherwise false -func (f *UintSliceFlag) TakesValue() bool { - return true -} - -// GetUsage returns the usage string for the flag -func (f *UintSliceFlag) GetUsage() string { - return f.Usage -} - -// GetCategory returns the category for the flag -func (f *UintSliceFlag) GetCategory() string { - return f.Category -} - -// GetValue returns the flags value as string representation and an empty -// string if the flag takes no value at all. -func (f *UintSliceFlag) GetValue() string { - var defaultVals []string - if f.Value != nil && len(f.Value.Value()) > 0 { - for _, i := range f.Value.Value() { - defaultVals = append(defaultVals, strconv.FormatUint(uint64(i), 10)) - } - } - return strings.Join(defaultVals, ", ") -} - -// GetDefaultText returns the default text for this flag -func (f *UintSliceFlag) GetDefaultText() string { - if f.DefaultText != "" { - return f.DefaultText - } - return f.GetValue() -} - -// GetEnvVars returns the env vars for this flag -func (f *UintSliceFlag) GetEnvVars() []string { - return f.EnvVars -} - -// IsSliceFlag implements DocGenerationSliceFlag. -func (f *UintSliceFlag) IsSliceFlag() bool { - return true -} - -// Apply populates the flag given the flag set and environment -func (f *UintSliceFlag) Apply(set *flag.FlagSet) error { - // apply any default - if f.Destination != nil && f.Value != nil { - f.Destination.slice = make([]uint, len(f.Value.slice)) - copy(f.Destination.slice, f.Value.slice) - } - - // resolve setValue (what we will assign to the set) - var setValue *UintSlice - switch { - case f.Destination != nil: - setValue = f.Destination - case f.Value != nil: - setValue = f.Value.clone() - default: - setValue = new(UintSlice) - setValue.WithSeparatorSpec(f.separator) - } - - if val, source, ok := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok && val != "" { - for _, s := range f.separator.flagSplitMultiValues(val) { - if err := setValue.Set(strings.TrimSpace(s)); err != nil { - return fmt.Errorf("could not parse %q as uint slice value from %s for flag %s: %s", val, source, f.Name, err) - } - } - - // Set this to false so that we reset the slice if we then set values from - // flags that have already been set by the environment. - setValue.hasBeenSet = false - f.HasBeenSet = true - } - - for _, name := range f.Names() { - set.Var(setValue, name, f.Usage) - } - - return nil -} - -func (f *UintSliceFlag) WithSeparatorSpec(spec separatorSpec) { - f.separator = spec -} - -// Get returns the flag’s value in the given Context. -func (f *UintSliceFlag) Get(ctx *Context) []uint { - return ctx.UintSlice(f.Name) -} - -// UintSlice looks up the value of a local UintSliceFlag, returns -// nil if not found -func (cCtx *Context) UintSlice(name string) []uint { - if fs := cCtx.lookupFlagSet(name); fs != nil { - return lookupUintSlice(name, fs) - } - return nil -} - -func lookupUintSlice(name string, set *flag.FlagSet) []uint { - f := set.Lookup(name) - if f != nil { - if slice, ok := unwrapFlagValue(f.Value).(*UintSlice); ok { - return slice.Value() - } - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/funcs.go b/vendor/github.com/urfave/cli/v2/funcs.go deleted file mode 100644 index e77b0d0..0000000 --- a/vendor/github.com/urfave/cli/v2/funcs.go +++ /dev/null @@ -1,47 +0,0 @@ -package cli - -// BashCompleteFunc is an action to execute when the shell completion flag is set -type BashCompleteFunc func(*Context) - -// BeforeFunc is an action to execute before any subcommands are run, but after -// the context is ready if a non-nil error is returned, no subcommands are run -type BeforeFunc func(*Context) error - -// AfterFunc is an action to execute after any subcommands are run, but after the -// subcommand has finished it is run even if Action() panics -type AfterFunc func(*Context) error - -// ActionFunc is the action to execute when no subcommands are specified -type ActionFunc func(*Context) error - -// CommandNotFoundFunc is executed if the proper command cannot be found -type CommandNotFoundFunc func(*Context, string) - -// OnUsageErrorFunc is executed if a usage error occurs. This is useful for displaying -// customized usage error messages. This function is able to replace the -// original error messages. If this function is not set, the "Incorrect usage" -// is displayed and the execution is interrupted. -type OnUsageErrorFunc func(cCtx *Context, err error, isSubcommand bool) error - -// InvalidFlagAccessFunc is executed when an invalid flag is accessed from the context. -type InvalidFlagAccessFunc func(*Context, string) - -// ExitErrHandlerFunc is executed if provided in order to handle exitError values -// returned by Actions and Before/After functions. -type ExitErrHandlerFunc func(cCtx *Context, err error) - -// FlagStringFunc is used by the help generation to display a flag, which is -// expected to be a single line. -type FlagStringFunc func(Flag) string - -// FlagNamePrefixFunc is used by the default FlagStringFunc to create prefix -// text for a flag's full name. -type FlagNamePrefixFunc func(fullName []string, placeholder string) string - -// FlagEnvHintFunc is used by the default FlagStringFunc to annotate flag help -// with the environment variable details. -type FlagEnvHintFunc func(envVars []string, str string) string - -// FlagFileHintFunc is used by the default FlagStringFunc to annotate flag help -// with the file path details. -type FlagFileHintFunc func(filePath, str string) string diff --git a/vendor/github.com/urfave/cli/v2/go.mod b/vendor/github.com/urfave/cli/v2/go.mod deleted file mode 100644 index 5d7fc32..0000000 --- a/vendor/github.com/urfave/cli/v2/go.mod +++ /dev/null @@ -1,12 +0,0 @@ -module github.com/urfave/cli/v2 - -go 1.18 - -require ( - github.com/BurntSushi/toml v1.3.2 - github.com/cpuguy83/go-md2man/v2 v2.0.2 - github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 - gopkg.in/yaml.v3 v3.0.1 -) - -require github.com/russross/blackfriday/v2 v2.1.0 // indirect diff --git a/vendor/github.com/urfave/cli/v2/go.sum b/vendor/github.com/urfave/cli/v2/go.sum deleted file mode 100644 index 9a1b372..0000000 --- a/vendor/github.com/urfave/cli/v2/go.sum +++ /dev/null @@ -1,12 +0,0 @@ -github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8= -github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= -github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= -github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= -github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= -github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU= -github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= -gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= -gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/vendor/github.com/urfave/cli/v2/godoc-current.txt b/vendor/github.com/urfave/cli/v2/godoc-current.txt deleted file mode 100644 index 6016bd8..0000000 --- a/vendor/github.com/urfave/cli/v2/godoc-current.txt +++ /dev/null @@ -1,2714 +0,0 @@ -package cli // import "github.com/urfave/cli/v2" - -Package cli provides a minimal framework for creating and organizing command -line Go applications. cli is designed to be easy to understand and write, -the most simple cli application can be written as follows: - - func main() { - (&cli.App{}).Run(os.Args) - } - -Of course this application does not do much, so let's make this an actual -application: - - func main() { - app := &cli.App{ - Name: "greet", - Usage: "say a greeting", - Action: func(c *cli.Context) error { - fmt.Println("Greetings") - return nil - }, - } - - app.Run(os.Args) - } - -VARIABLES - -var ( - SuggestFlag SuggestFlagFunc = suggestFlag - SuggestCommand SuggestCommandFunc = suggestCommand - SuggestDidYouMeanTemplate string = suggestDidYouMeanTemplate -) -var AppHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Version}}{{if not .HideVersion}} - -VERSION: - {{.Version}}{{end}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}} -{{- if len .Authors}} - -AUTHOR{{template "authorsTemplate" .}}{{end}}{{if .VisibleCommands}} - -COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -GLOBAL OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -GLOBAL OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}{{if .Copyright}} - -COPYRIGHT: - {{template "copyrightTemplate" .}}{{end}} -` - AppHelpTemplate is the text template for the Default help topic. cli.go - uses text/template to render templates. You can render custom help text by - setting this variable. - -var CommandHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{template "usageTemplate" .}}{{if .Category}} - -CATEGORY: - {{.Category}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -OPTIONS:{{template "visibleFlagTemplate" .}}{{end}} -` - CommandHelpTemplate is the text template for the command help topic. cli.go - uses text/template to render templates. You can render custom help text by - setting this variable. - -var ErrWriter io.Writer = os.Stderr - ErrWriter is used to write errors to the user. This can be anything - implementing the io.Writer interface and defaults to os.Stderr. - -var FishCompletionTemplate = `# {{ .App.Name }} fish shell completion - -function __fish_{{ .App.Name }}_no_subcommand --description 'Test if there has been any subcommand yet' - for i in (commandline -opc) - if contains -- $i{{ range $v := .AllCommands }} {{ $v }}{{ end }} - return 1 - end - end - return 0 -end - -{{ range $v := .Completions }}{{ $v }} -{{ end }}` -var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionNum }} - -{{end}}# NAME - -{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }} - -# SYNOPSIS - -{{ .App.Name }} -{{ if .SynopsisArgs }} -` + "```" + ` -{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + ` -{{ end }}{{ if .App.Description }} -# DESCRIPTION - -{{ .App.Description }} -{{ end }} -**Usage**: - -` + "```" + `{{ if .App.UsageText }} -{{ .App.UsageText }} -{{ else }} -{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] -{{ end }}` + "```" + ` -{{ if .GlobalArgs }} -# GLOBAL OPTIONS -{{ range $v := .GlobalArgs }} -{{ $v }}{{ end }} -{{ end }}{{ if .Commands }} -# COMMANDS -{{ range $v := .Commands }} -{{ $v }}{{ end }}{{ end }}` -var OsExiter = os.Exit - OsExiter is the function used when the app exits. If not set defaults to - os.Exit. - -var SubcommandHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}} - -COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -OPTIONS:{{template "visibleFlagTemplate" .}}{{end}} -` - SubcommandHelpTemplate is the text template for the subcommand help topic. - cli.go uses text/template to render templates. You can render custom help - text by setting this variable. - -var VersionPrinter = printVersion - VersionPrinter prints the version for the App - -var HelpPrinter helpPrinter = printHelp - HelpPrinter is a function that writes the help output. If not set - explicitly, this calls HelpPrinterCustom using only the default template - functions. - - If custom logic for printing help is required, this function can be - overridden. If the ExtraInfo field is defined on an App, this function - should not be modified, as HelpPrinterCustom will be used directly in order - to capture the extra information. - -var HelpPrinterCustom helpPrinterCustom = printHelpCustom - HelpPrinterCustom is a function that writes the help output. It is used as - the default implementation of HelpPrinter, and may be called directly if the - ExtraInfo field is set on an App. - - In the default implementation, if the customFuncs argument contains a - "wrapAt" key, which is a function which takes no arguments and returns an - int, this int value will be used to produce a "wrap" function used by the - default template to wrap long lines. - - -FUNCTIONS - -func DefaultAppComplete(cCtx *Context) - DefaultAppComplete prints the list of subcommands as the default app - completion method - -func DefaultCompleteWithFlags(cmd *Command) func(cCtx *Context) -func FlagNames(name string, aliases []string) []string -func HandleAction(action interface{}, cCtx *Context) (err error) - HandleAction attempts to figure out which Action signature was used. - If it's an ActionFunc or a func with the legacy signature for Action, - the func is run! - -func HandleExitCoder(err error) - HandleExitCoder handles errors implementing ExitCoder by printing their - message and calling OsExiter with the given exit code. - - If the given error instead implements MultiError, each error will be checked - for the ExitCoder interface, and OsExiter will be called with the last exit - code found, or exit code 1 if no ExitCoder is found. - - This function is the default error-handling behavior for an App. - -func ShowAppHelp(cCtx *Context) error - ShowAppHelp is an action that displays the help. - -func ShowAppHelpAndExit(c *Context, exitCode int) - ShowAppHelpAndExit - Prints the list of subcommands for the app and exits - with exit code. - -func ShowCommandCompletions(ctx *Context, command string) - ShowCommandCompletions prints the custom completions for a given command - -func ShowCommandHelp(ctx *Context, command string) error - ShowCommandHelp prints help for the given command - -func ShowCommandHelpAndExit(c *Context, command string, code int) - ShowCommandHelpAndExit - exits with code after showing help - -func ShowCompletions(cCtx *Context) - ShowCompletions prints the lists of commands within a given context - -func ShowSubcommandHelp(cCtx *Context) error - ShowSubcommandHelp prints help for the given subcommand - -func ShowSubcommandHelpAndExit(c *Context, exitCode int) - ShowSubcommandHelpAndExit - Prints help for the given subcommand and exits - with exit code. - -func ShowVersion(cCtx *Context) - ShowVersion prints the version number of the App - - -TYPES - -type ActionFunc func(*Context) error - ActionFunc is the action to execute when no subcommands are specified - -type ActionableFlag interface { - Flag - RunAction(*Context) error -} - ActionableFlag is an interface that wraps Flag interface and RunAction - operation. - -type AfterFunc func(*Context) error - AfterFunc is an action to execute after any subcommands are run, but after - the subcommand has finished it is run even if Action() panics - -type App struct { - // The name of the program. Defaults to path.Base(os.Args[0]) - Name string - // Full name of command for help, defaults to Name - HelpName string - // Description of the program. - Usage string - // Text to override the USAGE section of help - UsageText string - // Description of the program argument format. - ArgsUsage string - // Version of the program - Version string - // Description of the program - Description string - // DefaultCommand is the (optional) name of a command - // to run if no command names are passed as CLI arguments. - DefaultCommand string - // List of commands to execute - Commands []*Command - // List of flags to parse - Flags []Flag - // Boolean to enable bash completion commands - EnableBashCompletion bool - // Boolean to hide built-in help command and help flag - HideHelp bool - // Boolean to hide built-in help command but keep help flag. - // Ignored if HideHelp is true. - HideHelpCommand bool - // Boolean to hide built-in version flag and the VERSION section of help - HideVersion bool - - // An action to execute when the shell completion flag is set - BashComplete BashCompleteFunc - // An action to execute before any subcommands are run, but after the context is ready - // If a non-nil error is returned, no subcommands are run - Before BeforeFunc - // An action to execute after any subcommands are run, but after the subcommand has finished - // It is run even if Action() panics - After AfterFunc - // The action to execute when no subcommands are specified - Action ActionFunc - // Execute this function if the proper command cannot be found - CommandNotFound CommandNotFoundFunc - // Execute this function if a usage error occurs - OnUsageError OnUsageErrorFunc - // Execute this function when an invalid flag is accessed from the context - InvalidFlagAccessHandler InvalidFlagAccessFunc - // Compilation date - Compiled time.Time - // List of all authors who contributed - Authors []*Author - // Copyright of the binary if any - Copyright string - // Reader reader to write input to (useful for tests) - Reader io.Reader - // Writer writer to write output to - Writer io.Writer - // ErrWriter writes error output - ErrWriter io.Writer - // ExitErrHandler processes any error encountered while running an App before - // it is returned to the caller. If no function is provided, HandleExitCoder - // is used as the default behavior. - ExitErrHandler ExitErrHandlerFunc - // Other custom info - Metadata map[string]interface{} - // Carries a function which returns app specific info. - ExtraInfo func() map[string]string - // CustomAppHelpTemplate the text template for app help topic. - // cli.go uses text/template to render templates. You can - // render custom help text by setting this variable. - CustomAppHelpTemplate string - // SliceFlagSeparator is used to customize the separator for SliceFlag, the default is "," - SliceFlagSeparator string - // DisableSliceFlagSeparator is used to disable SliceFlagSeparator, the default is false - DisableSliceFlagSeparator bool - // Boolean to enable short-option handling so user can combine several - // single-character bool arguments into one - // i.e. foobar -o -v -> foobar -ov - UseShortOptionHandling bool - // Enable suggestions for commands and flags - Suggest bool - // Allows global flags set by libraries which use flag.XXXVar(...) directly - // to be parsed through this library - AllowExtFlags bool - // Treat all flags as normal arguments if true - SkipFlagParsing bool - - // Has unexported fields. -} - App is the main structure of a cli application. It is recommended that an - app be created with the cli.NewApp() function - -func NewApp() *App - NewApp creates a new cli Application with some reasonable defaults for Name, - Usage, Version and Action. - -func (a *App) Command(name string) *Command - Command returns the named command on App. Returns nil if the command does - not exist - -func (a *App) Run(arguments []string) (err error) - Run is the entry point to the cli app. Parses the arguments slice and routes - to the proper flag/args combination - -func (a *App) RunAndExitOnError() - RunAndExitOnError calls .Run() and exits non-zero if an error was returned - - Deprecated: instead you should return an error that fulfills cli.ExitCoder - to cli.App.Run. This will cause the application to exit with the given error - code in the cli.ExitCoder - -func (a *App) RunAsSubcommand(ctx *Context) (err error) - RunAsSubcommand is for legacy/compatibility purposes only. New code should - only use App.RunContext. This function is slated to be removed in v3. - -func (a *App) RunContext(ctx context.Context, arguments []string) (err error) - RunContext is like Run except it takes a Context that will be passed to - its commands and sub-commands. Through this, you can propagate timeouts and - cancellation requests - -func (a *App) Setup() - Setup runs initialization code to ensure all data structures are ready - for `Run` or inspection prior to `Run`. It is internally called by `Run`, - but will return early if setup has already happened. - -func (a *App) ToFishCompletion() (string, error) - ToFishCompletion creates a fish completion string for the `*App` The - function errors if either parsing or writing of the string fails. - -func (a *App) ToMan() (string, error) - ToMan creates a man page string for the `*App` The function errors if either - parsing or writing of the string fails. - -func (a *App) ToManWithSection(sectionNumber int) (string, error) - ToMan creates a man page string with section number for the `*App` The - function errors if either parsing or writing of the string fails. - -func (a *App) ToMarkdown() (string, error) - ToMarkdown creates a markdown string for the `*App` The function errors if - either parsing or writing of the string fails. - -func (a *App) VisibleCategories() []CommandCategory - VisibleCategories returns a slice of categories and commands that are - Hidden=false - -func (a *App) VisibleCommands() []*Command - VisibleCommands returns a slice of the Commands with Hidden=false - -func (a *App) VisibleFlagCategories() []VisibleFlagCategory - VisibleFlagCategories returns a slice containing all the categories with the - flags they contain - -func (a *App) VisibleFlags() []Flag - VisibleFlags returns a slice of the Flags with Hidden=false - -type Args interface { - // Get returns the nth argument, or else a blank string - Get(n int) string - // First returns the first argument, or else a blank string - First() string - // Tail returns the rest of the arguments (not the first one) - // or else an empty string slice - Tail() []string - // Len returns the length of the wrapped slice - Len() int - // Present checks if there are any arguments present - Present() bool - // Slice returns a copy of the internal slice - Slice() []string -} - -type Author struct { - Name string // The Authors name - Email string // The Authors email -} - Author represents someone who has contributed to a cli project. - -func (a *Author) String() string - String makes Author comply to the Stringer interface, to allow an easy print - in the templating process - -type BashCompleteFunc func(*Context) - BashCompleteFunc is an action to execute when the shell completion flag is - set - -type BeforeFunc func(*Context) error - BeforeFunc is an action to execute before any subcommands are run, but after - the context is ready if a non-nil error is returned, no subcommands are run - -type BoolFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value bool - Destination *bool - - Aliases []string - EnvVars []string - - Count *int - - DisableDefaultText bool - - Action func(*Context, bool) error - // Has unexported fields. -} - BoolFlag is a flag with type bool - -func (f *BoolFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *BoolFlag) Get(ctx *Context) bool - Get returns the flag’s value in the given Context. - -func (f *BoolFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *BoolFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *BoolFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *BoolFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *BoolFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *BoolFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *BoolFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *BoolFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *BoolFlag) Names() []string - Names returns the names of the flag - -func (f *BoolFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *BoolFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *BoolFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type CategorizableFlag interface { - VisibleFlag - - GetCategory() string -} - CategorizableFlag is an interface that allows us to potentially use a flag - in a categorized representation. - -type Command struct { - // The name of the command - Name string - // A list of aliases for the command - Aliases []string - // A short description of the usage of this command - Usage string - // Custom text to show on USAGE section of help - UsageText string - // A longer explanation of how the command works - Description string - // A short description of the arguments of this command - ArgsUsage string - // The category the command is part of - Category string - // The function to call when checking for bash command completions - BashComplete BashCompleteFunc - // An action to execute before any sub-subcommands are run, but after the context is ready - // If a non-nil error is returned, no sub-subcommands are run - Before BeforeFunc - // An action to execute after any subcommands are run, but after the subcommand has finished - // It is run even if Action() panics - After AfterFunc - // The function to call when this command is invoked - Action ActionFunc - // Execute this function if a usage error occurs. - OnUsageError OnUsageErrorFunc - // List of child commands - Subcommands []*Command - // List of flags to parse - Flags []Flag - - // Treat all flags as normal arguments if true - SkipFlagParsing bool - // Boolean to hide built-in help command and help flag - HideHelp bool - // Boolean to hide built-in help command but keep help flag - // Ignored if HideHelp is true. - HideHelpCommand bool - // Boolean to hide this command from help or completion - Hidden bool - // Boolean to enable short-option handling so user can combine several - // single-character bool arguments into one - // i.e. foobar -o -v -> foobar -ov - UseShortOptionHandling bool - - // Full name of command for help, defaults to full command name, including parent commands. - HelpName string - - // CustomHelpTemplate the text template for the command help topic. - // cli.go uses text/template to render templates. You can - // render custom help text by setting this variable. - CustomHelpTemplate string - - // Has unexported fields. -} - Command is a subcommand for a cli.App. - -func (cmd *Command) Command(name string) *Command - -func (c *Command) FullName() string - FullName returns the full name of the command. For subcommands this ensures - that parent commands are part of the command path - -func (c *Command) HasName(name string) bool - HasName returns true if Command.Name matches given name - -func (c *Command) Names() []string - Names returns the names including short names and aliases. - -func (c *Command) Run(cCtx *Context, arguments ...string) (err error) - -func (c *Command) VisibleCategories() []CommandCategory - VisibleCategories returns a slice of categories and commands that are - Hidden=false - -func (c *Command) VisibleCommands() []*Command - VisibleCommands returns a slice of the Commands with Hidden=false - -func (c *Command) VisibleFlagCategories() []VisibleFlagCategory - VisibleFlagCategories returns a slice containing all the visible flag - categories with the flags they contain - -func (c *Command) VisibleFlags() []Flag - VisibleFlags returns a slice of the Flags with Hidden=false - -type CommandCategories interface { - // AddCommand adds a command to a category, creating a new category if necessary. - AddCommand(category string, command *Command) - // Categories returns a slice of categories sorted by name - Categories() []CommandCategory -} - CommandCategories interface allows for category manipulation - -type CommandCategory interface { - // Name returns the category name string - Name() string - // VisibleCommands returns a slice of the Commands with Hidden=false - VisibleCommands() []*Command -} - CommandCategory is a category containing commands. - -type CommandNotFoundFunc func(*Context, string) - CommandNotFoundFunc is executed if the proper command cannot be found - -type Commands []*Command - -type CommandsByName []*Command - -func (c CommandsByName) Len() int - -func (c CommandsByName) Less(i, j int) bool - -func (c CommandsByName) Swap(i, j int) - -type Context struct { - context.Context - App *App - Command *Command - - // Has unexported fields. -} - Context is a type that is passed through to each Handler action in a cli - application. Context can be used to retrieve context-specific args and - parsed command-line options. - -func NewContext(app *App, set *flag.FlagSet, parentCtx *Context) *Context - NewContext creates a new context. For use in when invoking an App or Command - action. - -func (cCtx *Context) Args() Args - Args returns the command line arguments associated with the context. - -func (cCtx *Context) Bool(name string) bool - Bool looks up the value of a local BoolFlag, returns false if not found - -func (cCtx *Context) Count(name string) int - Count returns the num of occurences of this flag - -func (cCtx *Context) Duration(name string) time.Duration - Duration looks up the value of a local DurationFlag, returns 0 if not found - -func (cCtx *Context) FlagNames() []string - FlagNames returns a slice of flag names used by the this context and all of - its parent contexts. - -func (cCtx *Context) Float64(name string) float64 - Float64 looks up the value of a local Float64Flag, returns 0 if not found - -func (cCtx *Context) Float64Slice(name string) []float64 - Float64Slice looks up the value of a local Float64SliceFlag, returns nil if - not found - -func (cCtx *Context) Generic(name string) interface{} - Generic looks up the value of a local GenericFlag, returns nil if not found - -func (cCtx *Context) Int(name string) int - Int looks up the value of a local IntFlag, returns 0 if not found - -func (cCtx *Context) Int64(name string) int64 - Int64 looks up the value of a local Int64Flag, returns 0 if not found - -func (cCtx *Context) Int64Slice(name string) []int64 - Int64Slice looks up the value of a local Int64SliceFlag, returns nil if not - found - -func (cCtx *Context) IntSlice(name string) []int - IntSlice looks up the value of a local IntSliceFlag, returns nil if not - found - -func (cCtx *Context) IsSet(name string) bool - IsSet determines if the flag was actually set - -func (cCtx *Context) Lineage() []*Context - Lineage returns *this* context and all of its ancestor contexts in order - from child to parent - -func (cCtx *Context) LocalFlagNames() []string - LocalFlagNames returns a slice of flag names used in this context. - -func (cCtx *Context) NArg() int - NArg returns the number of the command line arguments. - -func (cCtx *Context) NumFlags() int - NumFlags returns the number of flags set - -func (cCtx *Context) Path(name string) string - Path looks up the value of a local PathFlag, returns "" if not found - -func (cCtx *Context) Set(name, value string) error - Set sets a context flag to a value. - -func (cCtx *Context) String(name string) string - String looks up the value of a local StringFlag, returns "" if not found - -func (cCtx *Context) StringSlice(name string) []string - StringSlice looks up the value of a local StringSliceFlag, returns nil if - not found - -func (cCtx *Context) Timestamp(name string) *time.Time - Timestamp gets the timestamp from a flag name - -func (cCtx *Context) Uint(name string) uint - Uint looks up the value of a local UintFlag, returns 0 if not found - -func (cCtx *Context) Uint64(name string) uint64 - Uint64 looks up the value of a local Uint64Flag, returns 0 if not found - -func (cCtx *Context) Uint64Slice(name string) []uint64 - Uint64Slice looks up the value of a local Uint64SliceFlag, returns nil if - not found - -func (cCtx *Context) UintSlice(name string) []uint - UintSlice looks up the value of a local UintSliceFlag, returns nil if not - found - -func (cCtx *Context) Value(name string) interface{} - Value returns the value of the flag corresponding to `name` - -type Countable interface { - Count() int -} - Countable is an interface to enable detection of flag values which support - repetitive flags - -type DocGenerationFlag interface { - Flag - - // TakesValue returns true if the flag takes a value, otherwise false - TakesValue() bool - - // GetUsage returns the usage string for the flag - GetUsage() string - - // GetValue returns the flags value as string representation and an empty - // string if the flag takes no value at all. - GetValue() string - - // GetDefaultText returns the default text for this flag - GetDefaultText() string - - // GetEnvVars returns the env vars for this flag - GetEnvVars() []string -} - DocGenerationFlag is an interface that allows documentation generation for - the flag - -type DocGenerationSliceFlag interface { - DocGenerationFlag - - // IsSliceFlag returns true for flags that can be given multiple times. - IsSliceFlag() bool -} - DocGenerationSliceFlag extends DocGenerationFlag for slice-based flags. - -type DurationFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value time.Duration - Destination *time.Duration - - Aliases []string - EnvVars []string - - Action func(*Context, time.Duration) error - // Has unexported fields. -} - DurationFlag is a flag with type time.Duration - -func (f *DurationFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *DurationFlag) Get(ctx *Context) time.Duration - Get returns the flag’s value in the given Context. - -func (f *DurationFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *DurationFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *DurationFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *DurationFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *DurationFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *DurationFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *DurationFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *DurationFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *DurationFlag) Names() []string - Names returns the names of the flag - -func (f *DurationFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *DurationFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *DurationFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type ErrorFormatter interface { - Format(s fmt.State, verb rune) -} - ErrorFormatter is the interface that will suitably format the error output - -type ExitCoder interface { - error - ExitCode() int -} - ExitCoder is the interface checked by `App` and `Command` for a custom exit - code - -func Exit(message interface{}, exitCode int) ExitCoder - Exit wraps a message and exit code into an error, which by default is - handled with a call to os.Exit during default error handling. - - This is the simplest way to trigger a non-zero exit code for an App - without having to call os.Exit manually. During testing, this behavior - can be avoided by overriding the ExitErrHandler function on an App or the - package-global OsExiter function. - -func NewExitError(message interface{}, exitCode int) ExitCoder - NewExitError calls Exit to create a new ExitCoder. - - Deprecated: This function is a duplicate of Exit and will eventually be - removed. - -type ExitErrHandlerFunc func(cCtx *Context, err error) - ExitErrHandlerFunc is executed if provided in order to handle exitError - values returned by Actions and Before/After functions. - -type Flag interface { - fmt.Stringer - // Apply Flag settings to the given flag set - Apply(*flag.FlagSet) error - Names() []string - IsSet() bool -} - Flag is a common interface related to parsing flags in cli. For more - advanced flag parsing techniques, it is recommended that this interface be - implemented. - -var BashCompletionFlag Flag = &BoolFlag{ - Name: "generate-bash-completion", - Hidden: true, -} - BashCompletionFlag enables bash-completion for all commands and subcommands - -var HelpFlag Flag = &BoolFlag{ - Name: "help", - Aliases: []string{"h"}, - Usage: "show help", - DisableDefaultText: true, -} - HelpFlag prints the help for all commands and subcommands. Set to nil to - disable the flag. The subcommand will still be added unless HideHelp or - HideHelpCommand is set to true. - -var VersionFlag Flag = &BoolFlag{ - Name: "version", - Aliases: []string{"v"}, - Usage: "print the version", - DisableDefaultText: true, -} - VersionFlag prints the version for the application - -type FlagCategories interface { - // AddFlags adds a flag to a category, creating a new category if necessary. - AddFlag(category string, fl Flag) - // VisibleCategories returns a slice of visible flag categories sorted by name - VisibleCategories() []VisibleFlagCategory -} - FlagCategories interface allows for category manipulation - -type FlagEnvHintFunc func(envVars []string, str string) string - FlagEnvHintFunc is used by the default FlagStringFunc to annotate flag help - with the environment variable details. - -var FlagEnvHinter FlagEnvHintFunc = withEnvHint - FlagEnvHinter annotates flag help message with the environment variable - details. This is used by the default FlagStringer. - -type FlagFileHintFunc func(filePath, str string) string - FlagFileHintFunc is used by the default FlagStringFunc to annotate flag help - with the file path details. - -var FlagFileHinter FlagFileHintFunc = withFileHint - FlagFileHinter annotates flag help message with the environment variable - details. This is used by the default FlagStringer. - -type FlagNamePrefixFunc func(fullName []string, placeholder string) string - FlagNamePrefixFunc is used by the default FlagStringFunc to create prefix - text for a flag's full name. - -var FlagNamePrefixer FlagNamePrefixFunc = prefixedNames - FlagNamePrefixer converts a full flag name and its placeholder into the help - message flag prefix. This is used by the default FlagStringer. - -type FlagStringFunc func(Flag) string - FlagStringFunc is used by the help generation to display a flag, which is - expected to be a single line. - -var FlagStringer FlagStringFunc = stringifyFlag - FlagStringer converts a flag definition to a string. This is used by help to - display a flag. - -type FlagsByName []Flag - FlagsByName is a slice of Flag. - -func (f FlagsByName) Len() int - -func (f FlagsByName) Less(i, j int) bool - -func (f FlagsByName) Swap(i, j int) - -type Float64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value float64 - Destination *float64 - - Aliases []string - EnvVars []string - - Action func(*Context, float64) error - // Has unexported fields. -} - Float64Flag is a flag with type float64 - -func (f *Float64Flag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Float64Flag) Get(ctx *Context) float64 - Get returns the flag’s value in the given Context. - -func (f *Float64Flag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Float64Flag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Float64Flag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Float64Flag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Float64Flag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Float64Flag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Float64Flag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Float64Flag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Float64Flag) Names() []string - Names returns the names of the flag - -func (f *Float64Flag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *Float64Flag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Float64Flag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type Float64Slice struct { - // Has unexported fields. -} - Float64Slice wraps []float64 to satisfy flag.Value - -func NewFloat64Slice(defaults ...float64) *Float64Slice - NewFloat64Slice makes a *Float64Slice with default values - -func (f *Float64Slice) Get() interface{} - Get returns the slice of float64s set by this flag - -func (f *Float64Slice) Serialize() string - Serialize allows Float64Slice to fulfill Serializer - -func (f *Float64Slice) Set(value string) error - Set parses the value into a float64 and appends it to the list of values - -func (f *Float64Slice) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Float64Slice) Value() []float64 - Value returns the slice of float64s set by this flag - -func (f *Float64Slice) WithSeparatorSpec(spec separatorSpec) - -type Float64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Float64Slice - Destination *Float64Slice - - Aliases []string - EnvVars []string - - Action func(*Context, []float64) error - // Has unexported fields. -} - Float64SliceFlag is a flag with type *Float64Slice - -func (f *Float64SliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Float64SliceFlag) Get(ctx *Context) []float64 - Get returns the flag’s value in the given Context. - -func (f *Float64SliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Float64SliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Float64SliceFlag) GetDestination() []float64 - -func (f *Float64SliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Float64SliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Float64SliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Float64SliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Float64SliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Float64SliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *Float64SliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Float64SliceFlag) Names() []string - Names returns the names of the flag - -func (f *Float64SliceFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *Float64SliceFlag) SetDestination(slice []float64) - -func (f *Float64SliceFlag) SetValue(slice []float64) - -func (f *Float64SliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Float64SliceFlag) TakesValue() bool - TakesValue returns true if the flag takes a value, otherwise false - -func (f *Float64SliceFlag) WithSeparatorSpec(spec separatorSpec) - -type Generic interface { - Set(value string) error - String() string -} - Generic is a generic parseable type identified by a specific flag - -type GenericFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value Generic - Destination Generic - - Aliases []string - EnvVars []string - - TakesFile bool - - Action func(*Context, interface{}) error - // Has unexported fields. -} - GenericFlag is a flag with type Generic - -func (f *GenericFlag) Apply(set *flag.FlagSet) error - Apply takes the flagset and calls Set on the generic flag with the value - provided by the user for parsing by the flag - -func (f *GenericFlag) Get(ctx *Context) interface{} - Get returns the flag’s value in the given Context. - -func (f *GenericFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *GenericFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *GenericFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *GenericFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *GenericFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *GenericFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *GenericFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *GenericFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *GenericFlag) Names() []string - Names returns the names of the flag - -func (f *GenericFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *GenericFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *GenericFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type Int64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value int64 - Destination *int64 - - Aliases []string - EnvVars []string - - Base int - - Action func(*Context, int64) error - // Has unexported fields. -} - Int64Flag is a flag with type int64 - -func (f *Int64Flag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Int64Flag) Get(ctx *Context) int64 - Get returns the flag’s value in the given Context. - -func (f *Int64Flag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Int64Flag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Int64Flag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Int64Flag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Int64Flag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Int64Flag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Int64Flag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Int64Flag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Int64Flag) Names() []string - Names returns the names of the flag - -func (f *Int64Flag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *Int64Flag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Int64Flag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type Int64Slice struct { - // Has unexported fields. -} - Int64Slice wraps []int64 to satisfy flag.Value - -func NewInt64Slice(defaults ...int64) *Int64Slice - NewInt64Slice makes an *Int64Slice with default values - -func (i *Int64Slice) Get() interface{} - Get returns the slice of ints set by this flag - -func (i *Int64Slice) Serialize() string - Serialize allows Int64Slice to fulfill Serializer - -func (i *Int64Slice) Set(value string) error - Set parses the value into an integer and appends it to the list of values - -func (i *Int64Slice) String() string - String returns a readable representation of this value (for usage defaults) - -func (i *Int64Slice) Value() []int64 - Value returns the slice of ints set by this flag - -func (i *Int64Slice) WithSeparatorSpec(spec separatorSpec) - -type Int64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Int64Slice - Destination *Int64Slice - - Aliases []string - EnvVars []string - - Action func(*Context, []int64) error - // Has unexported fields. -} - Int64SliceFlag is a flag with type *Int64Slice - -func (f *Int64SliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Int64SliceFlag) Get(ctx *Context) []int64 - Get returns the flag’s value in the given Context. - -func (f *Int64SliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Int64SliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Int64SliceFlag) GetDestination() []int64 - -func (f *Int64SliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Int64SliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Int64SliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Int64SliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Int64SliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Int64SliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *Int64SliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Int64SliceFlag) Names() []string - Names returns the names of the flag - -func (f *Int64SliceFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *Int64SliceFlag) SetDestination(slice []int64) - -func (f *Int64SliceFlag) SetValue(slice []int64) - -func (f *Int64SliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Int64SliceFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -func (f *Int64SliceFlag) WithSeparatorSpec(spec separatorSpec) - -type IntFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value int - Destination *int - - Aliases []string - EnvVars []string - - Base int - - Action func(*Context, int) error - // Has unexported fields. -} - IntFlag is a flag with type int - -func (f *IntFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *IntFlag) Get(ctx *Context) int - Get returns the flag’s value in the given Context. - -func (f *IntFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *IntFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *IntFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *IntFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *IntFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *IntFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *IntFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *IntFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *IntFlag) Names() []string - Names returns the names of the flag - -func (f *IntFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *IntFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *IntFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type IntSlice struct { - // Has unexported fields. -} - IntSlice wraps []int to satisfy flag.Value - -func NewIntSlice(defaults ...int) *IntSlice - NewIntSlice makes an *IntSlice with default values - -func (i *IntSlice) Get() interface{} - Get returns the slice of ints set by this flag - -func (i *IntSlice) Serialize() string - Serialize allows IntSlice to fulfill Serializer - -func (i *IntSlice) Set(value string) error - Set parses the value into an integer and appends it to the list of values - -func (i *IntSlice) SetInt(value int) - TODO: Consistently have specific Set function for Int64 and Float64 ? SetInt - directly adds an integer to the list of values - -func (i *IntSlice) String() string - String returns a readable representation of this value (for usage defaults) - -func (i *IntSlice) Value() []int - Value returns the slice of ints set by this flag - -func (i *IntSlice) WithSeparatorSpec(spec separatorSpec) - -type IntSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *IntSlice - Destination *IntSlice - - Aliases []string - EnvVars []string - - Action func(*Context, []int) error - // Has unexported fields. -} - IntSliceFlag is a flag with type *IntSlice - -func (f *IntSliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *IntSliceFlag) Get(ctx *Context) []int - Get returns the flag’s value in the given Context. - -func (f *IntSliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *IntSliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *IntSliceFlag) GetDestination() []int - -func (f *IntSliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *IntSliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *IntSliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *IntSliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *IntSliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *IntSliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *IntSliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *IntSliceFlag) Names() []string - Names returns the names of the flag - -func (f *IntSliceFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *IntSliceFlag) SetDestination(slice []int) - -func (f *IntSliceFlag) SetValue(slice []int) - -func (f *IntSliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *IntSliceFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -func (f *IntSliceFlag) WithSeparatorSpec(spec separatorSpec) - -type InvalidFlagAccessFunc func(*Context, string) - InvalidFlagAccessFunc is executed when an invalid flag is accessed from the - context. - -type MultiError interface { - error - Errors() []error -} - MultiError is an error that wraps multiple errors. - -type MultiFloat64Flag = SliceFlag[*Float64SliceFlag, []float64, float64] - MultiFloat64Flag extends Float64SliceFlag with support for using slices - directly, as Value and/or Destination. See also SliceFlag. - -type MultiInt64Flag = SliceFlag[*Int64SliceFlag, []int64, int64] - MultiInt64Flag extends Int64SliceFlag with support for using slices - directly, as Value and/or Destination. See also SliceFlag. - -type MultiIntFlag = SliceFlag[*IntSliceFlag, []int, int] - MultiIntFlag extends IntSliceFlag with support for using slices directly, - as Value and/or Destination. See also SliceFlag. - -type MultiStringFlag = SliceFlag[*StringSliceFlag, []string, string] - MultiStringFlag extends StringSliceFlag with support for using slices - directly, as Value and/or Destination. See also SliceFlag. - -type OnUsageErrorFunc func(cCtx *Context, err error, isSubcommand bool) error - OnUsageErrorFunc is executed if a usage error occurs. This is useful for - displaying customized usage error messages. This function is able to replace - the original error messages. If this function is not set, the "Incorrect - usage" is displayed and the execution is interrupted. - -type Path = string - -type PathFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value Path - Destination *Path - - Aliases []string - EnvVars []string - - TakesFile bool - - Action func(*Context, Path) error - // Has unexported fields. -} - PathFlag is a flag with type Path - -func (f *PathFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *PathFlag) Get(ctx *Context) string - Get returns the flag’s value in the given Context. - -func (f *PathFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *PathFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *PathFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *PathFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *PathFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *PathFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *PathFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *PathFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *PathFlag) Names() []string - Names returns the names of the flag - -func (f *PathFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *PathFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *PathFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type RequiredFlag interface { - Flag - - IsRequired() bool -} - RequiredFlag is an interface that allows us to mark flags as required - it allows flags required flags to be backwards compatible with the Flag - interface - -type Serializer interface { - Serialize() string -} - Serializer is used to circumvent the limitations of flag.FlagSet.Set - -type SliceFlag[T SliceFlagTarget[E], S ~[]E, E any] struct { - Target T - Value S - Destination *S -} - SliceFlag extends implementations like StringSliceFlag and IntSliceFlag - with support for using slices directly, as Value and/or Destination. - See also SliceFlagTarget, MultiStringFlag, MultiFloat64Flag, MultiInt64Flag, - MultiIntFlag. - -func (x *SliceFlag[T, S, E]) Apply(set *flag.FlagSet) error - -func (x *SliceFlag[T, S, E]) GetCategory() string - -func (x *SliceFlag[T, S, E]) GetDefaultText() string - -func (x *SliceFlag[T, S, E]) GetDestination() S - -func (x *SliceFlag[T, S, E]) GetEnvVars() []string - -func (x *SliceFlag[T, S, E]) GetUsage() string - -func (x *SliceFlag[T, S, E]) GetValue() string - -func (x *SliceFlag[T, S, E]) IsRequired() bool - -func (x *SliceFlag[T, S, E]) IsSet() bool - -func (x *SliceFlag[T, S, E]) IsVisible() bool - -func (x *SliceFlag[T, S, E]) Names() []string - -func (x *SliceFlag[T, S, E]) SetDestination(slice S) - -func (x *SliceFlag[T, S, E]) SetValue(slice S) - -func (x *SliceFlag[T, S, E]) String() string - -func (x *SliceFlag[T, S, E]) TakesValue() bool - -type SliceFlagTarget[E any] interface { - Flag - RequiredFlag - DocGenerationFlag - VisibleFlag - CategorizableFlag - - // SetValue should propagate the given slice to the target, ideally as a new value. - // Note that a nil slice should nil/clear any existing value (modelled as ~[]E). - SetValue(slice []E) - // SetDestination should propagate the given slice to the target, ideally as a new value. - // Note that a nil slice should nil/clear any existing value (modelled as ~*[]E). - SetDestination(slice []E) - // GetDestination should return the current value referenced by any destination, or nil if nil/unset. - GetDestination() []E -} - SliceFlagTarget models a target implementation for use with SliceFlag. The - three methods, SetValue, SetDestination, and GetDestination, are necessary - to propagate Value and Destination, where Value is propagated inwards - (initially), and Destination is propagated outwards (on every update). - -type StringFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value string - Destination *string - - Aliases []string - EnvVars []string - - TakesFile bool - - Action func(*Context, string) error - // Has unexported fields. -} - StringFlag is a flag with type string - -func (f *StringFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *StringFlag) Get(ctx *Context) string - Get returns the flag’s value in the given Context. - -func (f *StringFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *StringFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *StringFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *StringFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *StringFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *StringFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *StringFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *StringFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *StringFlag) Names() []string - Names returns the names of the flag - -func (f *StringFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *StringFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *StringFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type StringSlice struct { - // Has unexported fields. -} - StringSlice wraps a []string to satisfy flag.Value - -func NewStringSlice(defaults ...string) *StringSlice - NewStringSlice creates a *StringSlice with default values - -func (s *StringSlice) Get() interface{} - Get returns the slice of strings set by this flag - -func (s *StringSlice) Serialize() string - Serialize allows StringSlice to fulfill Serializer - -func (s *StringSlice) Set(value string) error - Set appends the string value to the list of values - -func (s *StringSlice) String() string - String returns a readable representation of this value (for usage defaults) - -func (s *StringSlice) Value() []string - Value returns the slice of strings set by this flag - -func (s *StringSlice) WithSeparatorSpec(spec separatorSpec) - -type StringSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *StringSlice - Destination *StringSlice - - Aliases []string - EnvVars []string - - TakesFile bool - - Action func(*Context, []string) error - - KeepSpace bool - // Has unexported fields. -} - StringSliceFlag is a flag with type *StringSlice - -func (f *StringSliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *StringSliceFlag) Get(ctx *Context) []string - Get returns the flag’s value in the given Context. - -func (f *StringSliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *StringSliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *StringSliceFlag) GetDestination() []string - -func (f *StringSliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *StringSliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *StringSliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *StringSliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *StringSliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *StringSliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *StringSliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *StringSliceFlag) Names() []string - Names returns the names of the flag - -func (f *StringSliceFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *StringSliceFlag) SetDestination(slice []string) - -func (f *StringSliceFlag) SetValue(slice []string) - -func (f *StringSliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *StringSliceFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -func (f *StringSliceFlag) WithSeparatorSpec(spec separatorSpec) - -type SuggestCommandFunc func(commands []*Command, provided string) string - -type SuggestFlagFunc func(flags []Flag, provided string, hideHelp bool) string - -type Timestamp struct { - // Has unexported fields. -} - Timestamp wrap to satisfy golang's flag interface. - -func NewTimestamp(timestamp time.Time) *Timestamp - Timestamp constructor - -func (t *Timestamp) Get() interface{} - Get returns the flag structure - -func (t *Timestamp) Set(value string) error - Parses the string value to timestamp - -func (t *Timestamp) SetLayout(layout string) - Set the timestamp string layout for future parsing - -func (t *Timestamp) SetLocation(loc *time.Location) - Set perceived timezone of the to-be parsed time string - -func (t *Timestamp) SetTimestamp(value time.Time) - Set the timestamp value directly - -func (t *Timestamp) String() string - String returns a readable representation of this value (for usage defaults) - -func (t *Timestamp) Value() *time.Time - Value returns the timestamp value stored in the flag - -type TimestampFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Timestamp - Destination *Timestamp - - Aliases []string - EnvVars []string - - Layout string - - Timezone *time.Location - - Action func(*Context, *time.Time) error - // Has unexported fields. -} - TimestampFlag is a flag with type *Timestamp - -func (f *TimestampFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *TimestampFlag) Get(ctx *Context) *time.Time - Get returns the flag’s value in the given Context. - -func (f *TimestampFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *TimestampFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *TimestampFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *TimestampFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *TimestampFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *TimestampFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *TimestampFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *TimestampFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *TimestampFlag) Names() []string - Names returns the names of the flag - -func (f *TimestampFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *TimestampFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *TimestampFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type Uint64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value uint64 - Destination *uint64 - - Aliases []string - EnvVars []string - - Base int - - Action func(*Context, uint64) error - // Has unexported fields. -} - Uint64Flag is a flag with type uint64 - -func (f *Uint64Flag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Uint64Flag) Get(ctx *Context) uint64 - Get returns the flag’s value in the given Context. - -func (f *Uint64Flag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Uint64Flag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Uint64Flag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Uint64Flag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Uint64Flag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Uint64Flag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Uint64Flag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Uint64Flag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Uint64Flag) Names() []string - Names returns the names of the flag - -func (f *Uint64Flag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *Uint64Flag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Uint64Flag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type Uint64Slice struct { - // Has unexported fields. -} - Uint64Slice wraps []int64 to satisfy flag.Value - -func NewUint64Slice(defaults ...uint64) *Uint64Slice - NewUint64Slice makes an *Uint64Slice with default values - -func (i *Uint64Slice) Get() interface{} - Get returns the slice of ints set by this flag - -func (i *Uint64Slice) Serialize() string - Serialize allows Uint64Slice to fulfill Serializer - -func (i *Uint64Slice) Set(value string) error - Set parses the value into an integer and appends it to the list of values - -func (i *Uint64Slice) String() string - String returns a readable representation of this value (for usage defaults) - -func (i *Uint64Slice) Value() []uint64 - Value returns the slice of ints set by this flag - -func (i *Uint64Slice) WithSeparatorSpec(spec separatorSpec) - -type Uint64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Uint64Slice - Destination *Uint64Slice - - Aliases []string - EnvVars []string - - Action func(*Context, []uint64) error - // Has unexported fields. -} - Uint64SliceFlag is a flag with type *Uint64Slice - -func (f *Uint64SliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *Uint64SliceFlag) Get(ctx *Context) []uint64 - Get returns the flag’s value in the given Context. - -func (f *Uint64SliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *Uint64SliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *Uint64SliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *Uint64SliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *Uint64SliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *Uint64SliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *Uint64SliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *Uint64SliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *Uint64SliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *Uint64SliceFlag) Names() []string - Names returns the names of the flag - -func (f *Uint64SliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *Uint64SliceFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -func (f *Uint64SliceFlag) WithSeparatorSpec(spec separatorSpec) - -type UintFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value uint - Destination *uint - - Aliases []string - EnvVars []string - - Base int - - Action func(*Context, uint) error - // Has unexported fields. -} - UintFlag is a flag with type uint - -func (f *UintFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *UintFlag) Get(ctx *Context) uint - Get returns the flag’s value in the given Context. - -func (f *UintFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *UintFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *UintFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *UintFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *UintFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *UintFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *UintFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *UintFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *UintFlag) Names() []string - Names returns the names of the flag - -func (f *UintFlag) RunAction(c *Context) error - RunAction executes flag action if set - -func (f *UintFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *UintFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -type UintSlice struct { - // Has unexported fields. -} - UintSlice wraps []int to satisfy flag.Value - -func NewUintSlice(defaults ...uint) *UintSlice - NewUintSlice makes an *UintSlice with default values - -func (i *UintSlice) Get() interface{} - Get returns the slice of ints set by this flag - -func (i *UintSlice) Serialize() string - Serialize allows UintSlice to fulfill Serializer - -func (i *UintSlice) Set(value string) error - Set parses the value into an integer and appends it to the list of values - -func (i *UintSlice) SetUint(value uint) - TODO: Consistently have specific Set function for Int64 and Float64 ? SetInt - directly adds an integer to the list of values - -func (i *UintSlice) String() string - String returns a readable representation of this value (for usage defaults) - -func (i *UintSlice) Value() []uint - Value returns the slice of ints set by this flag - -func (i *UintSlice) WithSeparatorSpec(spec separatorSpec) - -type UintSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *UintSlice - Destination *UintSlice - - Aliases []string - EnvVars []string - - Action func(*Context, []uint) error - // Has unexported fields. -} - UintSliceFlag is a flag with type *UintSlice - -func (f *UintSliceFlag) Apply(set *flag.FlagSet) error - Apply populates the flag given the flag set and environment - -func (f *UintSliceFlag) Get(ctx *Context) []uint - Get returns the flag’s value in the given Context. - -func (f *UintSliceFlag) GetCategory() string - GetCategory returns the category for the flag - -func (f *UintSliceFlag) GetDefaultText() string - GetDefaultText returns the default text for this flag - -func (f *UintSliceFlag) GetEnvVars() []string - GetEnvVars returns the env vars for this flag - -func (f *UintSliceFlag) GetUsage() string - GetUsage returns the usage string for the flag - -func (f *UintSliceFlag) GetValue() string - GetValue returns the flags value as string representation and an empty - string if the flag takes no value at all. - -func (f *UintSliceFlag) IsRequired() bool - IsRequired returns whether or not the flag is required - -func (f *UintSliceFlag) IsSet() bool - IsSet returns whether or not the flag has been set through env or file - -func (f *UintSliceFlag) IsSliceFlag() bool - IsSliceFlag implements DocGenerationSliceFlag. - -func (f *UintSliceFlag) IsVisible() bool - IsVisible returns true if the flag is not hidden, otherwise false - -func (f *UintSliceFlag) Names() []string - Names returns the names of the flag - -func (f *UintSliceFlag) String() string - String returns a readable representation of this value (for usage defaults) - -func (f *UintSliceFlag) TakesValue() bool - TakesValue returns true of the flag takes a value, otherwise false - -func (f *UintSliceFlag) WithSeparatorSpec(spec separatorSpec) - -type VisibleFlag interface { - Flag - - // IsVisible returns true if the flag is not hidden, otherwise false - IsVisible() bool -} - VisibleFlag is an interface that allows to check if a flag is visible - -type VisibleFlagCategory interface { - // Name returns the category name string - Name() string - // Flags returns a slice of VisibleFlag sorted by name - Flags() []VisibleFlag -} - VisibleFlagCategory is a category containing flags. - -package altsrc // import "github.com/urfave/cli/v2/altsrc" - - -FUNCTIONS - -func ApplyInputSourceValues(cCtx *cli.Context, inputSourceContext InputSourceContext, flags []cli.Flag) error - ApplyInputSourceValues iterates over all provided flags and executes - ApplyInputSourceValue on flags implementing the FlagInputSourceExtension - interface to initialize these flags to an alternate input source. - -func InitInputSource(flags []cli.Flag, createInputSource func() (InputSourceContext, error)) cli.BeforeFunc - InitInputSource is used to to setup an InputSourceContext on a cli.Command - Before method. It will create a new input source based on the func provided. - If there is no error it will then apply the new input source to any flags - that are supported by the input source - -func InitInputSourceWithContext(flags []cli.Flag, createInputSource func(cCtx *cli.Context) (InputSourceContext, error)) cli.BeforeFunc - InitInputSourceWithContext is used to to setup an InputSourceContext on - a cli.Command Before method. It will create a new input source based on - the func provided with potentially using existing cli.Context values to - initialize itself. If there is no error it will then apply the new input - source to any flags that are supported by the input source - -func NewJSONSourceFromFlagFunc(flag string) func(c *cli.Context) (InputSourceContext, error) - NewJSONSourceFromFlagFunc returns a func that takes a cli.Context and - returns an InputSourceContext suitable for retrieving config variables from - a file containing JSON data with the file name defined by the given flag. - -func NewTomlSourceFromFlagFunc(flagFileName string) func(cCtx *cli.Context) (InputSourceContext, error) - NewTomlSourceFromFlagFunc creates a new TOML InputSourceContext from a - provided flag name and source context. - -func NewYamlSourceFromFlagFunc(flagFileName string) func(cCtx *cli.Context) (InputSourceContext, error) - NewYamlSourceFromFlagFunc creates a new Yaml InputSourceContext from a - provided flag name and source context. - - -TYPES - -type BoolFlag struct { - *cli.BoolFlag - // Has unexported fields. -} - BoolFlag is the flag type that wraps cli.BoolFlag to allow for other values - to be specified - -func NewBoolFlag(fl *cli.BoolFlag) *BoolFlag - NewBoolFlag creates a new BoolFlag - -func (f *BoolFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - BoolFlag.Apply - -func (f *BoolFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Bool value to the flagSet if required - -type DurationFlag struct { - *cli.DurationFlag - // Has unexported fields. -} - DurationFlag is the flag type that wraps cli.DurationFlag to allow for other - values to be specified - -func NewDurationFlag(fl *cli.DurationFlag) *DurationFlag - NewDurationFlag creates a new DurationFlag - -func (f *DurationFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - DurationFlag.Apply - -func (f *DurationFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Duration value to the flagSet if required - -type FlagInputSourceExtension interface { - cli.Flag - ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error -} - FlagInputSourceExtension is an extension interface of cli.Flag that allows a - value to be set on the existing parsed flags. - -type Float64Flag struct { - *cli.Float64Flag - // Has unexported fields. -} - Float64Flag is the flag type that wraps cli.Float64Flag to allow for other - values to be specified - -func NewFloat64Flag(fl *cli.Float64Flag) *Float64Flag - NewFloat64Flag creates a new Float64Flag - -func (f *Float64Flag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - Float64Flag.Apply - -func (f *Float64Flag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Float64 value to the flagSet if required - -type Float64SliceFlag struct { - *cli.Float64SliceFlag - // Has unexported fields. -} - Float64SliceFlag is the flag type that wraps cli.Float64SliceFlag to allow - for other values to be specified - -func NewFloat64SliceFlag(fl *cli.Float64SliceFlag) *Float64SliceFlag - NewFloat64SliceFlag creates a new Float64SliceFlag - -func (f *Float64SliceFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - Float64SliceFlag.Apply - -func (f *Float64SliceFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Float64Slice value if required - -type GenericFlag struct { - *cli.GenericFlag - // Has unexported fields. -} - GenericFlag is the flag type that wraps cli.GenericFlag to allow for other - values to be specified - -func NewGenericFlag(fl *cli.GenericFlag) *GenericFlag - NewGenericFlag creates a new GenericFlag - -func (f *GenericFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - GenericFlag.Apply - -func (f *GenericFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a generic value to the flagSet if required - -type InputSourceContext interface { - Source() string - - Int(name string) (int, error) - Int64(name string) (int64, error) - Uint(name string) (uint, error) - Uint64(name string) (uint64, error) - Duration(name string) (time.Duration, error) - Float64(name string) (float64, error) - String(name string) (string, error) - StringSlice(name string) ([]string, error) - IntSlice(name string) ([]int, error) - Int64Slice(name string) ([]int64, error) - Float64Slice(name string) ([]float64, error) - Generic(name string) (cli.Generic, error) - Bool(name string) (bool, error) - - // Has unexported methods. -} - InputSourceContext is an interface used to allow other input sources to be - implemented as needed. - - Source returns an identifier for the input source. In case of file source it - should return path to the file. - -func NewJSONSource(data []byte) (InputSourceContext, error) - NewJSONSource returns an InputSourceContext suitable for retrieving config - variables from raw JSON data. - -func NewJSONSourceFromFile(f string) (InputSourceContext, error) - NewJSONSourceFromFile returns an InputSourceContext suitable for retrieving - config variables from a file (or url) containing JSON data. - -func NewJSONSourceFromReader(r io.Reader) (InputSourceContext, error) - NewJSONSourceFromReader returns an InputSourceContext suitable for - retrieving config variables from an io.Reader that returns JSON data. - -func NewTomlSourceFromFile(file string) (InputSourceContext, error) - NewTomlSourceFromFile creates a new TOML InputSourceContext from a filepath. - -func NewYamlSourceFromFile(file string) (InputSourceContext, error) - NewYamlSourceFromFile creates a new Yaml InputSourceContext from a filepath. - -type Int64Flag struct { - *cli.Int64Flag - // Has unexported fields. -} - Int64Flag is the flag type that wraps cli.Int64Flag to allow for other - values to be specified - -func NewInt64Flag(fl *cli.Int64Flag) *Int64Flag - NewInt64Flag creates a new Int64Flag - -func (f *Int64Flag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - Int64Flag.Apply - -func (f *Int64Flag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - -type Int64SliceFlag struct { - *cli.Int64SliceFlag - // Has unexported fields. -} - Int64SliceFlag is the flag type that wraps cli.Int64SliceFlag to allow for - other values to be specified - -func NewInt64SliceFlag(fl *cli.Int64SliceFlag) *Int64SliceFlag - NewInt64SliceFlag creates a new Int64SliceFlag - -func (f *Int64SliceFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - Int64SliceFlag.Apply - -func (f *Int64SliceFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Int64Slice value if required - -type IntFlag struct { - *cli.IntFlag - // Has unexported fields. -} - IntFlag is the flag type that wraps cli.IntFlag to allow for other values to - be specified - -func NewIntFlag(fl *cli.IntFlag) *IntFlag - NewIntFlag creates a new IntFlag - -func (f *IntFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - IntFlag.Apply - -func (f *IntFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a int value to the flagSet if required - -type IntSliceFlag struct { - *cli.IntSliceFlag - // Has unexported fields. -} - IntSliceFlag is the flag type that wraps cli.IntSliceFlag to allow for other - values to be specified - -func NewIntSliceFlag(fl *cli.IntSliceFlag) *IntSliceFlag - NewIntSliceFlag creates a new IntSliceFlag - -func (f *IntSliceFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - IntSliceFlag.Apply - -func (f *IntSliceFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a IntSlice value if required - -type MapInputSource struct { - // Has unexported fields. -} - MapInputSource implements InputSourceContext to return data from the map - that is loaded. - -func NewMapInputSource(file string, valueMap map[interface{}]interface{}) *MapInputSource - NewMapInputSource creates a new MapInputSource for implementing custom input - sources. - -func (fsm *MapInputSource) Bool(name string) (bool, error) - Bool returns an bool from the map otherwise returns false - -func (fsm *MapInputSource) Duration(name string) (time.Duration, error) - Duration returns a duration from the map if it exists otherwise returns 0 - -func (fsm *MapInputSource) Float64(name string) (float64, error) - Float64 returns an float64 from the map if it exists otherwise returns 0 - -func (fsm *MapInputSource) Float64Slice(name string) ([]float64, error) - Float64Slice returns an []float64 from the map if it exists otherwise - returns nil - -func (fsm *MapInputSource) Generic(name string) (cli.Generic, error) - Generic returns an cli.Generic from the map if it exists otherwise returns - nil - -func (fsm *MapInputSource) Int(name string) (int, error) - Int returns an int from the map if it exists otherwise returns 0 - -func (fsm *MapInputSource) Int64(name string) (int64, error) - Int64 returns an int64 from the map if it exists otherwise returns 0 - -func (fsm *MapInputSource) Int64Slice(name string) ([]int64, error) - Int64Slice returns an []int64 from the map if it exists otherwise returns - nil - -func (fsm *MapInputSource) IntSlice(name string) ([]int, error) - IntSlice returns an []int from the map if it exists otherwise returns nil - -func (fsm *MapInputSource) Source() string - Source returns the path of the source file - -func (fsm *MapInputSource) String(name string) (string, error) - String returns a string from the map if it exists otherwise returns an empty - string - -func (fsm *MapInputSource) StringSlice(name string) ([]string, error) - StringSlice returns an []string from the map if it exists otherwise returns - nil - -func (fsm *MapInputSource) Uint(name string) (uint, error) - Int64 returns an int64 from the map if it exists otherwise returns 0 - -func (fsm *MapInputSource) Uint64(name string) (uint64, error) - UInt64 returns an uint64 from the map if it exists otherwise returns 0 - -type PathFlag struct { - *cli.PathFlag - // Has unexported fields. -} - PathFlag is the flag type that wraps cli.PathFlag to allow for other values - to be specified - -func NewPathFlag(fl *cli.PathFlag) *PathFlag - NewPathFlag creates a new PathFlag - -func (f *PathFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - PathFlag.Apply - -func (f *PathFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a Path value to the flagSet if required - -type StringFlag struct { - *cli.StringFlag - // Has unexported fields. -} - StringFlag is the flag type that wraps cli.StringFlag to allow for other - values to be specified - -func NewStringFlag(fl *cli.StringFlag) *StringFlag - NewStringFlag creates a new StringFlag - -func (f *StringFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - StringFlag.Apply - -func (f *StringFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a String value to the flagSet if required - -type StringSliceFlag struct { - *cli.StringSliceFlag - // Has unexported fields. -} - StringSliceFlag is the flag type that wraps cli.StringSliceFlag to allow for - other values to be specified - -func NewStringSliceFlag(fl *cli.StringSliceFlag) *StringSliceFlag - NewStringSliceFlag creates a new StringSliceFlag - -func (f *StringSliceFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - StringSliceFlag.Apply - -func (f *StringSliceFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - ApplyInputSourceValue applies a StringSlice value to the flagSet if required - -type Uint64Flag struct { - *cli.Uint64Flag - // Has unexported fields. -} - Uint64Flag is the flag type that wraps cli.Uint64Flag to allow for other - values to be specified - -func NewUint64Flag(fl *cli.Uint64Flag) *Uint64Flag - NewUint64Flag creates a new Uint64Flag - -func (f *Uint64Flag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - Uint64Flag.Apply - -func (f *Uint64Flag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - -type UintFlag struct { - *cli.UintFlag - // Has unexported fields. -} - UintFlag is the flag type that wraps cli.UintFlag to allow for other values - to be specified - -func NewUintFlag(fl *cli.UintFlag) *UintFlag - NewUintFlag creates a new UintFlag - -func (f *UintFlag) Apply(set *flag.FlagSet) error - Apply saves the flagSet for later usage calls, then calls the wrapped - UintFlag.Apply - -func (f *UintFlag) ApplyInputSourceValue(cCtx *cli.Context, isc InputSourceContext) error - diff --git a/vendor/github.com/urfave/cli/v2/help.go b/vendor/github.com/urfave/cli/v2/help.go deleted file mode 100644 index 885d784..0000000 --- a/vendor/github.com/urfave/cli/v2/help.go +++ /dev/null @@ -1,570 +0,0 @@ -package cli - -import ( - "fmt" - "io" - "os" - "strings" - "text/tabwriter" - "text/template" - "unicode/utf8" -) - -const ( - helpName = "help" - helpAlias = "h" -) - -// this instance is to avoid recursion in the ShowCommandHelp which can -// add a help command again -var helpCommandDontUse = &Command{ - Name: helpName, - Aliases: []string{helpAlias}, - Usage: "Shows a list of commands or help for one command", - ArgsUsage: "[command]", -} - -var helpCommand = &Command{ - Name: helpName, - Aliases: []string{helpAlias}, - Usage: "Shows a list of commands or help for one command", - ArgsUsage: "[command]", - Action: func(cCtx *Context) error { - args := cCtx.Args() - argsPresent := args.First() != "" - firstArg := args.First() - - // This action can be triggered by a "default" action of a command - // or via cmd.Run when cmd == helpCmd. So we have following possibilities - // - // 1 $ app - // 2 $ app help - // 3 $ app foo - // 4 $ app help foo - // 5 $ app foo help - // 6 $ app foo -h (with no other sub-commands nor flags defined) - - // Case 4. when executing a help command set the context to parent - // to allow resolution of subsequent args. This will transform - // $ app help foo - // to - // $ app foo - // which will then be handled as case 3 - if cCtx.Command.Name == helpName || cCtx.Command.Name == helpAlias { - cCtx = cCtx.parentContext - } - - // Case 4. $ app hello foo - // foo is the command for which help needs to be shown - if argsPresent { - return ShowCommandHelp(cCtx, firstArg) - } - - // Case 1 & 2 - // Special case when running help on main app itself as opposed to individual - // commands/subcommands - if cCtx.parentContext.App == nil { - _ = ShowAppHelp(cCtx) - return nil - } - - // Case 3, 5 - if (len(cCtx.Command.Subcommands) == 1 && !cCtx.Command.HideHelp) || - (len(cCtx.Command.Subcommands) == 0 && cCtx.Command.HideHelp) { - templ := cCtx.Command.CustomHelpTemplate - if templ == "" { - templ = CommandHelpTemplate - } - HelpPrinter(cCtx.App.Writer, templ, cCtx.Command) - return nil - } - - // Case 6, handling incorporated in the callee itself - return ShowSubcommandHelp(cCtx) - }, -} - -// Prints help for the App or Command -type helpPrinter func(w io.Writer, templ string, data interface{}) - -// Prints help for the App or Command with custom template function. -type helpPrinterCustom func(w io.Writer, templ string, data interface{}, customFunc map[string]interface{}) - -// HelpPrinter is a function that writes the help output. If not set explicitly, -// this calls HelpPrinterCustom using only the default template functions. -// -// If custom logic for printing help is required, this function can be -// overridden. If the ExtraInfo field is defined on an App, this function -// should not be modified, as HelpPrinterCustom will be used directly in order -// to capture the extra information. -var HelpPrinter helpPrinter = printHelp - -// HelpPrinterCustom is a function that writes the help output. It is used as -// the default implementation of HelpPrinter, and may be called directly if -// the ExtraInfo field is set on an App. -// -// In the default implementation, if the customFuncs argument contains a -// "wrapAt" key, which is a function which takes no arguments and returns -// an int, this int value will be used to produce a "wrap" function used -// by the default template to wrap long lines. -var HelpPrinterCustom helpPrinterCustom = printHelpCustom - -// VersionPrinter prints the version for the App -var VersionPrinter = printVersion - -// ShowAppHelpAndExit - Prints the list of subcommands for the app and exits with exit code. -func ShowAppHelpAndExit(c *Context, exitCode int) { - _ = ShowAppHelp(c) - os.Exit(exitCode) -} - -// ShowAppHelp is an action that displays the help. -func ShowAppHelp(cCtx *Context) error { - tpl := cCtx.App.CustomAppHelpTemplate - if tpl == "" { - tpl = AppHelpTemplate - } - - if cCtx.App.ExtraInfo == nil { - HelpPrinter(cCtx.App.Writer, tpl, cCtx.App) - return nil - } - - customAppData := func() map[string]interface{} { - return map[string]interface{}{ - "ExtraInfo": cCtx.App.ExtraInfo, - } - } - HelpPrinterCustom(cCtx.App.Writer, tpl, cCtx.App, customAppData()) - - return nil -} - -// DefaultAppComplete prints the list of subcommands as the default app completion method -func DefaultAppComplete(cCtx *Context) { - DefaultCompleteWithFlags(nil)(cCtx) -} - -func printCommandSuggestions(commands []*Command, writer io.Writer) { - for _, command := range commands { - if command.Hidden { - continue - } - if strings.HasSuffix(os.Getenv("SHELL"), "zsh") { - for _, name := range command.Names() { - _, _ = fmt.Fprintf(writer, "%s:%s\n", name, command.Usage) - } - } else { - for _, name := range command.Names() { - _, _ = fmt.Fprintf(writer, "%s\n", name) - } - } - } -} - -func cliArgContains(flagName string) bool { - for _, name := range strings.Split(flagName, ",") { - name = strings.TrimSpace(name) - count := utf8.RuneCountInString(name) - if count > 2 { - count = 2 - } - flag := fmt.Sprintf("%s%s", strings.Repeat("-", count), name) - for _, a := range os.Args { - if a == flag { - return true - } - } - } - return false -} - -func printFlagSuggestions(lastArg string, flags []Flag, writer io.Writer) { - cur := strings.TrimPrefix(lastArg, "-") - cur = strings.TrimPrefix(cur, "-") - for _, flag := range flags { - if bflag, ok := flag.(*BoolFlag); ok && bflag.Hidden { - continue - } - for _, name := range flag.Names() { - name = strings.TrimSpace(name) - // this will get total count utf8 letters in flag name - count := utf8.RuneCountInString(name) - if count > 2 { - count = 2 // reuse this count to generate single - or -- in flag completion - } - // if flag name has more than one utf8 letter and last argument in cli has -- prefix then - // skip flag completion for short flags example -v or -x - if strings.HasPrefix(lastArg, "--") && count == 1 { - continue - } - // match if last argument matches this flag and it is not repeated - if strings.HasPrefix(name, cur) && cur != name && !cliArgContains(name) { - flagCompletion := fmt.Sprintf("%s%s", strings.Repeat("-", count), name) - _, _ = fmt.Fprintln(writer, flagCompletion) - } - } - } -} - -func DefaultCompleteWithFlags(cmd *Command) func(cCtx *Context) { - return func(cCtx *Context) { - var lastArg string - - // TODO: This shouldnt depend on os.Args rather it should - // depend on root arguments passed to App - if len(os.Args) > 2 { - lastArg = os.Args[len(os.Args)-2] - } - - if lastArg != "" { - if strings.HasPrefix(lastArg, "-") { - if cmd != nil { - printFlagSuggestions(lastArg, cmd.Flags, cCtx.App.Writer) - - return - } - - printFlagSuggestions(lastArg, cCtx.App.Flags, cCtx.App.Writer) - - return - } - } - - if cmd != nil { - printCommandSuggestions(cmd.Subcommands, cCtx.App.Writer) - return - } - - printCommandSuggestions(cCtx.Command.Subcommands, cCtx.App.Writer) - } -} - -// ShowCommandHelpAndExit - exits with code after showing help -func ShowCommandHelpAndExit(c *Context, command string, code int) { - _ = ShowCommandHelp(c, command) - os.Exit(code) -} - -// ShowCommandHelp prints help for the given command -func ShowCommandHelp(ctx *Context, command string) error { - - commands := ctx.App.Commands - if ctx.Command.Subcommands != nil { - commands = ctx.Command.Subcommands - } - for _, c := range commands { - if c.HasName(command) { - if !ctx.App.HideHelpCommand && !c.HasName(helpName) && len(c.Subcommands) != 0 && c.Command(helpName) == nil { - c.Subcommands = append(c.Subcommands, helpCommandDontUse) - } - if !ctx.App.HideHelp && HelpFlag != nil { - c.appendFlag(HelpFlag) - } - templ := c.CustomHelpTemplate - if templ == "" { - if len(c.Subcommands) == 0 { - templ = CommandHelpTemplate - } else { - templ = SubcommandHelpTemplate - } - } - - HelpPrinter(ctx.App.Writer, templ, c) - - return nil - } - } - - if ctx.App.CommandNotFound == nil { - errMsg := fmt.Sprintf("No help topic for '%v'", command) - if ctx.App.Suggest { - if suggestion := SuggestCommand(ctx.Command.Subcommands, command); suggestion != "" { - errMsg += ". " + suggestion - } - } - return Exit(errMsg, 3) - } - - ctx.App.CommandNotFound(ctx, command) - return nil -} - -// ShowSubcommandHelpAndExit - Prints help for the given subcommand and exits with exit code. -func ShowSubcommandHelpAndExit(c *Context, exitCode int) { - _ = ShowSubcommandHelp(c) - os.Exit(exitCode) -} - -// ShowSubcommandHelp prints help for the given subcommand -func ShowSubcommandHelp(cCtx *Context) error { - if cCtx == nil { - return nil - } - // use custom template when provided (fixes #1703) - templ := SubcommandHelpTemplate - if cCtx.Command != nil && cCtx.Command.CustomHelpTemplate != "" { - templ = cCtx.Command.CustomHelpTemplate - } - HelpPrinter(cCtx.App.Writer, templ, cCtx.Command) - return nil -} - -// ShowVersion prints the version number of the App -func ShowVersion(cCtx *Context) { - VersionPrinter(cCtx) -} - -func printVersion(cCtx *Context) { - _, _ = fmt.Fprintf(cCtx.App.Writer, "%v version %v\n", cCtx.App.Name, cCtx.App.Version) -} - -// ShowCompletions prints the lists of commands within a given context -func ShowCompletions(cCtx *Context) { - c := cCtx.Command - if c != nil && c.BashComplete != nil { - c.BashComplete(cCtx) - } -} - -// ShowCommandCompletions prints the custom completions for a given command -func ShowCommandCompletions(ctx *Context, command string) { - c := ctx.Command.Command(command) - if c != nil { - if c.BashComplete != nil { - c.BashComplete(ctx) - } else { - DefaultCompleteWithFlags(c)(ctx) - } - } - -} - -// printHelpCustom is the default implementation of HelpPrinterCustom. -// -// The customFuncs map will be combined with a default template.FuncMap to -// allow using arbitrary functions in template rendering. -func printHelpCustom(out io.Writer, templ string, data interface{}, customFuncs map[string]interface{}) { - - const maxLineLength = 10000 - - funcMap := template.FuncMap{ - "join": strings.Join, - "subtract": subtract, - "indent": indent, - "nindent": nindent, - "trim": strings.TrimSpace, - "wrap": func(input string, offset int) string { return wrap(input, offset, maxLineLength) }, - "offset": offset, - "offsetCommands": offsetCommands, - } - - if customFuncs["wrapAt"] != nil { - if wa, ok := customFuncs["wrapAt"]; ok { - if waf, ok := wa.(func() int); ok { - wrapAt := waf() - customFuncs["wrap"] = func(input string, offset int) string { - return wrap(input, offset, wrapAt) - } - } - } - } - - for key, value := range customFuncs { - funcMap[key] = value - } - - w := tabwriter.NewWriter(out, 1, 8, 2, ' ', 0) - t := template.Must(template.New("help").Funcs(funcMap).Parse(templ)) - t.New("helpNameTemplate").Parse(helpNameTemplate) - t.New("usageTemplate").Parse(usageTemplate) - t.New("descriptionTemplate").Parse(descriptionTemplate) - t.New("visibleCommandTemplate").Parse(visibleCommandTemplate) - t.New("copyrightTemplate").Parse(copyrightTemplate) - t.New("versionTemplate").Parse(versionTemplate) - t.New("visibleFlagCategoryTemplate").Parse(visibleFlagCategoryTemplate) - t.New("visibleFlagTemplate").Parse(visibleFlagTemplate) - t.New("visibleGlobalFlagCategoryTemplate").Parse(strings.Replace(visibleFlagCategoryTemplate, "OPTIONS", "GLOBAL OPTIONS", -1)) - t.New("authorsTemplate").Parse(authorsTemplate) - t.New("visibleCommandCategoryTemplate").Parse(visibleCommandCategoryTemplate) - - err := t.Execute(w, data) - if err != nil { - // If the writer is closed, t.Execute will fail, and there's nothing - // we can do to recover. - if os.Getenv("CLI_TEMPLATE_ERROR_DEBUG") != "" { - _, _ = fmt.Fprintf(ErrWriter, "CLI TEMPLATE ERROR: %#v\n", err) - } - return - } - _ = w.Flush() -} - -func printHelp(out io.Writer, templ string, data interface{}) { - HelpPrinterCustom(out, templ, data, nil) -} - -func checkVersion(cCtx *Context) bool { - found := false - for _, name := range VersionFlag.Names() { - if cCtx.Bool(name) { - found = true - } - } - return found -} - -func checkHelp(cCtx *Context) bool { - found := false - for _, name := range HelpFlag.Names() { - if cCtx.Bool(name) { - found = true - break - } - } - - return found -} - -func checkCommandHelp(c *Context, name string) bool { - if c.Bool("h") || c.Bool("help") { - _ = ShowCommandHelp(c, name) - return true - } - - return false -} - -func checkSubcommandHelp(cCtx *Context) bool { - if cCtx.Bool("h") || cCtx.Bool("help") { - _ = ShowSubcommandHelp(cCtx) - return true - } - - return false -} - -func checkShellCompleteFlag(a *App, arguments []string) (bool, []string) { - if !a.EnableBashCompletion { - return false, arguments - } - - pos := len(arguments) - 1 - lastArg := arguments[pos] - - if lastArg != "--generate-bash-completion" { - return false, arguments - } - - return true, arguments[:pos] -} - -func checkCompletions(cCtx *Context) bool { - if !cCtx.shellComplete { - return false - } - - if args := cCtx.Args(); args.Present() { - name := args.First() - if cmd := cCtx.Command.Command(name); cmd != nil { - // let the command handle the completion - return false - } - } - - ShowCompletions(cCtx) - return true -} - -func subtract(a, b int) int { - return a - b -} - -func indent(spaces int, v string) string { - pad := strings.Repeat(" ", spaces) - return pad + strings.Replace(v, "\n", "\n"+pad, -1) -} - -func nindent(spaces int, v string) string { - return "\n" + indent(spaces, v) -} - -func wrap(input string, offset int, wrapAt int) string { - var ss []string - - lines := strings.Split(input, "\n") - - padding := strings.Repeat(" ", offset) - - for i, line := range lines { - if line == "" { - ss = append(ss, line) - } else { - wrapped := wrapLine(line, offset, wrapAt, padding) - if i == 0 { - ss = append(ss, wrapped) - } else { - ss = append(ss, padding+wrapped) - - } - - } - } - - return strings.Join(ss, "\n") -} - -func wrapLine(input string, offset int, wrapAt int, padding string) string { - if wrapAt <= offset || len(input) <= wrapAt-offset { - return input - } - - lineWidth := wrapAt - offset - words := strings.Fields(input) - if len(words) == 0 { - return input - } - - wrapped := words[0] - spaceLeft := lineWidth - len(wrapped) - for _, word := range words[1:] { - if len(word)+1 > spaceLeft { - wrapped += "\n" + padding + word - spaceLeft = lineWidth - len(word) - } else { - wrapped += " " + word - spaceLeft -= 1 + len(word) - } - } - - return wrapped -} - -func offset(input string, fixed int) int { - return len(input) + fixed -} - -// this function tries to find the max width of the names column -// so say we have the following rows for help -// -// foo1, foo2, foo3 some string here -// bar1, b2 some other string here -// -// We want to offset the 2nd row usage by some amount so that everything -// is aligned -// -// foo1, foo2, foo3 some string here -// bar1, b2 some other string here -// -// to find that offset we find the length of all the rows and use the max -// to calculate the offset -func offsetCommands(cmds []*Command, fixed int) int { - var max int = 0 - for _, cmd := range cmds { - s := strings.Join(cmd.Names(), ", ") - if len(s) > max { - max = len(s) - } - } - return max + fixed -} diff --git a/vendor/github.com/urfave/cli/v2/mkdocs-requirements.txt b/vendor/github.com/urfave/cli/v2/mkdocs-requirements.txt deleted file mode 100644 index 482ad06..0000000 --- a/vendor/github.com/urfave/cli/v2/mkdocs-requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -mkdocs-git-revision-date-localized-plugin~=1.0 -mkdocs-material-extensions~=1.0 -mkdocs-material~=8.2 -mkdocs~=1.3 -pygments~=2.12 diff --git a/vendor/github.com/urfave/cli/v2/mkdocs.yml b/vendor/github.com/urfave/cli/v2/mkdocs.yml deleted file mode 100644 index 02657b9..0000000 --- a/vendor/github.com/urfave/cli/v2/mkdocs.yml +++ /dev/null @@ -1,107 +0,0 @@ -# NOTE: the mkdocs dependencies will need to be installed out of -# band until this whole thing gets more automated: -# -# pip install -r mkdocs-requirements.txt -# - -site_name: urfave/cli -site_url: https://cli.urfave.org/ -repo_url: https://github.com/urfave/cli -edit_uri: edit/main/docs/ -nav: - - Home: - - Welcome: index.md - - Contributing: CONTRIBUTING.md - - Code of Conduct: CODE_OF_CONDUCT.md - - Releasing: RELEASING.md - - Security: SECURITY.md - - Migrate v1 to v2: migrate-v1-to-v2.md - - v2 Manual: - - Getting Started: v2/getting-started.md - - Migrating From Older Releases: v2/migrating-from-older-releases.md - - Examples: - - Greet: v2/examples/greet.md - - Arguments: v2/examples/arguments.md - - Flags: v2/examples/flags.md - - Subcommands: v2/examples/subcommands.md - - Subcommands Categories: v2/examples/subcommands-categories.md - - Exit Codes: v2/examples/exit-codes.md - - Combining Short Options: v2/examples/combining-short-options.md - - Bash Completions: v2/examples/bash-completions.md - - Generated Help Text: v2/examples/generated-help-text.md - - Version Flag: v2/examples/version-flag.md - - Timestamp Flag: v2/examples/timestamp-flag.md - - Suggestions: v2/examples/suggestions.md - - Full API Example: v2/examples/full-api-example.md - - v1 Manual: - - Getting Started: v1/getting-started.md - - Migrating to v2: v1/migrating-to-v2.md - - Examples: - - Greet: v1/examples/greet.md - - Arguments: v1/examples/arguments.md - - Flags: v1/examples/flags.md - - Subcommands: v1/examples/subcommands.md - - Subcommands (Categories): v1/examples/subcommands-categories.md - - Exit Codes: v1/examples/exit-codes.md - - Combining Short Options: v1/examples/combining-short-options.md - - Bash Completions: v1/examples/bash-completions.md - - Generated Help Text: v1/examples/generated-help-text.md - - Version Flag: v1/examples/version-flag.md - -theme: - name: material - palette: - - media: "(prefers-color-scheme: light)" - scheme: default - toggle: - icon: material/brightness-4 - name: dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - toggle: - icon: material/brightness-7 - name: light mode - features: - - content.code.annotate - - navigation.top - - navigation.instant - - navigation.expand - - navigation.sections - - navigation.tabs - - navigation.tabs.sticky -plugins: - - git-revision-date-localized - - search - - tags -# NOTE: this is the recommended configuration from -# https://squidfunk.github.io/mkdocs-material/setup/extensions/#recommended-configuration -markdown_extensions: - - abbr - - admonition - - attr_list - - def_list - - footnotes - - meta - - md_in_html - - toc: - permalink: true - - pymdownx.arithmatex: - generic: true - - pymdownx.betterem: - smart_enable: all - - pymdownx.caret - - pymdownx.details - - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg - - pymdownx.highlight - - pymdownx.inlinehilite - - pymdownx.keys - - pymdownx.mark - - pymdownx.smartsymbols - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.tilde diff --git a/vendor/github.com/urfave/cli/v2/parse.go b/vendor/github.com/urfave/cli/v2/parse.go deleted file mode 100644 index d79f15a..0000000 --- a/vendor/github.com/urfave/cli/v2/parse.go +++ /dev/null @@ -1,102 +0,0 @@ -package cli - -import ( - "flag" - "strings" -) - -type iterativeParser interface { - newFlagSet() (*flag.FlagSet, error) - useShortOptionHandling() bool -} - -// To enable short-option handling (e.g., "-it" vs "-i -t") we have to -// iteratively catch parsing errors. This way we achieve LR parsing without -// transforming any arguments. Otherwise, there is no way we can discriminate -// combined short options from common arguments that should be left untouched. -// Pass `shellComplete` to continue parsing options on failure during shell -// completion when, the user-supplied options may be incomplete. -func parseIter(set *flag.FlagSet, ip iterativeParser, args []string, shellComplete bool) error { - for { - err := set.Parse(args) - if !ip.useShortOptionHandling() || err == nil { - if shellComplete { - return nil - } - return err - } - - trimmed, trimErr := flagFromError(err) - if trimErr != nil { - return err - } - - // regenerate the initial args with the split short opts - argsWereSplit := false - for i, arg := range args { - // skip args that are not part of the error message - if name := strings.TrimLeft(arg, "-"); name != trimmed { - continue - } - - // if we can't split, the error was accurate - shortOpts := splitShortOptions(set, arg) - if len(shortOpts) == 1 { - return err - } - - // swap current argument with the split version - // do not include args that parsed correctly so far as it would - // trigger Value.Set() on those args and would result in - // duplicates for slice type flags - args = append(shortOpts, args[i+1:]...) - argsWereSplit = true - break - } - - // This should be an impossible to reach code path, but in case the arg - // splitting failed to happen, this will prevent infinite loops - if !argsWereSplit { - return err - } - } -} - -const providedButNotDefinedErrMsg = "flag provided but not defined: -" - -// flagFromError tries to parse a provided flag from an error message. If the -// parsing fials, it returns the input error and an empty string -func flagFromError(err error) (string, error) { - errStr := err.Error() - trimmed := strings.TrimPrefix(errStr, providedButNotDefinedErrMsg) - if errStr == trimmed { - return "", err - } - return trimmed, nil -} - -func splitShortOptions(set *flag.FlagSet, arg string) []string { - shortFlagsExist := func(s string) bool { - for _, c := range s[1:] { - if f := set.Lookup(string(c)); f == nil { - return false - } - } - return true - } - - if !isSplittable(arg) || !shortFlagsExist(arg) { - return []string{arg} - } - - separated := make([]string, 0, len(arg)-1) - for _, flagChar := range arg[1:] { - separated = append(separated, "-"+string(flagChar)) - } - - return separated -} - -func isSplittable(flagArg string) bool { - return strings.HasPrefix(flagArg, "-") && !strings.HasPrefix(flagArg, "--") && len(flagArg) > 2 -} diff --git a/vendor/github.com/urfave/cli/v2/sliceflag.go b/vendor/github.com/urfave/cli/v2/sliceflag.go deleted file mode 100644 index b2ca590..0000000 --- a/vendor/github.com/urfave/cli/v2/sliceflag.go +++ /dev/null @@ -1,290 +0,0 @@ -package cli - -import ( - "flag" - "reflect" -) - -type ( - // SliceFlag extends implementations like StringSliceFlag and IntSliceFlag with support for using slices directly, - // as Value and/or Destination. - // See also SliceFlagTarget, MultiStringFlag, MultiFloat64Flag, MultiInt64Flag, MultiIntFlag. - SliceFlag[T SliceFlagTarget[E], S ~[]E, E any] struct { - Target T - Value S - Destination *S - } - - // SliceFlagTarget models a target implementation for use with SliceFlag. - // The three methods, SetValue, SetDestination, and GetDestination, are necessary to propagate Value and - // Destination, where Value is propagated inwards (initially), and Destination is propagated outwards (on every - // update). - SliceFlagTarget[E any] interface { - Flag - RequiredFlag - DocGenerationFlag - VisibleFlag - CategorizableFlag - - // SetValue should propagate the given slice to the target, ideally as a new value. - // Note that a nil slice should nil/clear any existing value (modelled as ~[]E). - SetValue(slice []E) - // SetDestination should propagate the given slice to the target, ideally as a new value. - // Note that a nil slice should nil/clear any existing value (modelled as ~*[]E). - SetDestination(slice []E) - // GetDestination should return the current value referenced by any destination, or nil if nil/unset. - GetDestination() []E - } - - // MultiStringFlag extends StringSliceFlag with support for using slices directly, as Value and/or Destination. - // See also SliceFlag. - MultiStringFlag = SliceFlag[*StringSliceFlag, []string, string] - - // MultiFloat64Flag extends Float64SliceFlag with support for using slices directly, as Value and/or Destination. - // See also SliceFlag. - MultiFloat64Flag = SliceFlag[*Float64SliceFlag, []float64, float64] - - // MultiInt64Flag extends Int64SliceFlag with support for using slices directly, as Value and/or Destination. - // See also SliceFlag. - MultiInt64Flag = SliceFlag[*Int64SliceFlag, []int64, int64] - - // MultiIntFlag extends IntSliceFlag with support for using slices directly, as Value and/or Destination. - // See also SliceFlag. - MultiIntFlag = SliceFlag[*IntSliceFlag, []int, int] - - flagValueHook struct { - value Generic - hook func() - } -) - -var ( - // compile time assertions - - _ SliceFlagTarget[string] = (*StringSliceFlag)(nil) - _ SliceFlagTarget[string] = (*SliceFlag[*StringSliceFlag, []string, string])(nil) - _ SliceFlagTarget[string] = (*MultiStringFlag)(nil) - _ SliceFlagTarget[float64] = (*MultiFloat64Flag)(nil) - _ SliceFlagTarget[int64] = (*MultiInt64Flag)(nil) - _ SliceFlagTarget[int] = (*MultiIntFlag)(nil) - - _ Generic = (*flagValueHook)(nil) - _ Serializer = (*flagValueHook)(nil) -) - -func (x *SliceFlag[T, S, E]) Apply(set *flag.FlagSet) error { - x.Target.SetValue(x.convertSlice(x.Value)) - - destination := x.Destination - if destination == nil { - x.Target.SetDestination(nil) - - return x.Target.Apply(set) - } - - x.Target.SetDestination(x.convertSlice(*destination)) - - return applyFlagValueHook(set, x.Target.Apply, func() { - *destination = x.Target.GetDestination() - }) -} - -func (x *SliceFlag[T, S, E]) convertSlice(slice S) []E { - result := make([]E, len(slice)) - copy(result, slice) - return result -} - -func (x *SliceFlag[T, S, E]) SetValue(slice S) { - x.Value = slice -} - -func (x *SliceFlag[T, S, E]) SetDestination(slice S) { - if slice != nil { - x.Destination = &slice - } else { - x.Destination = nil - } -} - -func (x *SliceFlag[T, S, E]) GetDestination() S { - if destination := x.Destination; destination != nil { - return *destination - } - return nil -} - -func (x *SliceFlag[T, S, E]) String() string { return x.Target.String() } -func (x *SliceFlag[T, S, E]) Names() []string { return x.Target.Names() } -func (x *SliceFlag[T, S, E]) IsSet() bool { return x.Target.IsSet() } -func (x *SliceFlag[T, S, E]) IsRequired() bool { return x.Target.IsRequired() } -func (x *SliceFlag[T, S, E]) TakesValue() bool { return x.Target.TakesValue() } -func (x *SliceFlag[T, S, E]) GetUsage() string { return x.Target.GetUsage() } -func (x *SliceFlag[T, S, E]) GetValue() string { return x.Target.GetValue() } -func (x *SliceFlag[T, S, E]) GetDefaultText() string { return x.Target.GetDefaultText() } -func (x *SliceFlag[T, S, E]) GetEnvVars() []string { return x.Target.GetEnvVars() } -func (x *SliceFlag[T, S, E]) IsVisible() bool { return x.Target.IsVisible() } -func (x *SliceFlag[T, S, E]) GetCategory() string { return x.Target.GetCategory() } - -func (x *flagValueHook) Set(value string) error { - if err := x.value.Set(value); err != nil { - return err - } - x.hook() - return nil -} - -func (x *flagValueHook) String() string { - // note: this is necessary due to the way Go's flag package handles defaults - isZeroValue := func(f flag.Value, v string) bool { - /* - https://cs.opensource.google/go/go/+/refs/tags/go1.18.3:src/flag/flag.go;drc=2580d0e08d5e9f979b943758d3c49877fb2324cb;l=453 - - Copyright (c) 2009 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. - */ - // Build a zero value of the flag's Value type, and see if the - // result of calling its String method equals the value passed in. - // This works unless the Value type is itself an interface type. - typ := reflect.TypeOf(f) - var z reflect.Value - if typ.Kind() == reflect.Pointer { - z = reflect.New(typ.Elem()) - } else { - z = reflect.Zero(typ) - } - return v == z.Interface().(flag.Value).String() - } - if x.value != nil { - // only return non-empty if not the same string as returned by the zero value - if s := x.value.String(); !isZeroValue(x.value, s) { - return s - } - } - return `` -} - -func (x *flagValueHook) Serialize() string { - if value, ok := x.value.(Serializer); ok { - return value.Serialize() - } - return x.String() -} - -// applyFlagValueHook wraps calls apply then wraps flags to call a hook function on update and after initial apply. -func applyFlagValueHook(set *flag.FlagSet, apply func(set *flag.FlagSet) error, hook func()) error { - if apply == nil || set == nil || hook == nil { - panic(`invalid input`) - } - var tmp flag.FlagSet - if err := apply(&tmp); err != nil { - return err - } - tmp.VisitAll(func(f *flag.Flag) { set.Var(&flagValueHook{value: f.Value, hook: hook}, f.Name, f.Usage) }) - hook() - return nil -} - -// newSliceFlagValue is for implementing SliceFlagTarget.SetValue and SliceFlagTarget.SetDestination. -// It's e.g. as part of StringSliceFlag.SetValue, using the factory NewStringSlice. -func newSliceFlagValue[R any, S ~[]E, E any](factory func(defaults ...E) *R, defaults S) *R { - if defaults == nil { - return nil - } - return factory(defaults...) -} - -// unwrapFlagValue strips any/all *flagValueHook wrappers. -func unwrapFlagValue(v flag.Value) flag.Value { - for { - h, ok := v.(*flagValueHook) - if !ok { - return v - } - v = h.value - } -} - -// NOTE: the methods below are in this file to make use of the build constraint - -func (f *Float64SliceFlag) SetValue(slice []float64) { - f.Value = newSliceFlagValue(NewFloat64Slice, slice) -} - -func (f *Float64SliceFlag) SetDestination(slice []float64) { - f.Destination = newSliceFlagValue(NewFloat64Slice, slice) -} - -func (f *Float64SliceFlag) GetDestination() []float64 { - if destination := f.Destination; destination != nil { - return destination.Value() - } - return nil -} - -func (f *Int64SliceFlag) SetValue(slice []int64) { - f.Value = newSliceFlagValue(NewInt64Slice, slice) -} - -func (f *Int64SliceFlag) SetDestination(slice []int64) { - f.Destination = newSliceFlagValue(NewInt64Slice, slice) -} - -func (f *Int64SliceFlag) GetDestination() []int64 { - if destination := f.Destination; destination != nil { - return destination.Value() - } - return nil -} - -func (f *IntSliceFlag) SetValue(slice []int) { - f.Value = newSliceFlagValue(NewIntSlice, slice) -} - -func (f *IntSliceFlag) SetDestination(slice []int) { - f.Destination = newSliceFlagValue(NewIntSlice, slice) -} - -func (f *IntSliceFlag) GetDestination() []int { - if destination := f.Destination; destination != nil { - return destination.Value() - } - return nil -} - -func (f *StringSliceFlag) SetValue(slice []string) { - f.Value = newSliceFlagValue(NewStringSlice, slice) -} - -func (f *StringSliceFlag) SetDestination(slice []string) { - f.Destination = newSliceFlagValue(NewStringSlice, slice) -} - -func (f *StringSliceFlag) GetDestination() []string { - if destination := f.Destination; destination != nil { - return destination.Value() - } - return nil -} diff --git a/vendor/github.com/urfave/cli/v2/sort.go b/vendor/github.com/urfave/cli/v2/sort.go deleted file mode 100644 index 23d1c2f..0000000 --- a/vendor/github.com/urfave/cli/v2/sort.go +++ /dev/null @@ -1,29 +0,0 @@ -package cli - -import "unicode" - -// lexicographicLess compares strings alphabetically considering case. -func lexicographicLess(i, j string) bool { - iRunes := []rune(i) - jRunes := []rune(j) - - lenShared := len(iRunes) - if lenShared > len(jRunes) { - lenShared = len(jRunes) - } - - for index := 0; index < lenShared; index++ { - ir := iRunes[index] - jr := jRunes[index] - - if lir, ljr := unicode.ToLower(ir), unicode.ToLower(jr); lir != ljr { - return lir < ljr - } - - if ir != jr { - return ir < jr - } - } - - return i < j -} diff --git a/vendor/github.com/urfave/cli/v2/suggestions.go b/vendor/github.com/urfave/cli/v2/suggestions.go deleted file mode 100644 index 87fa905..0000000 --- a/vendor/github.com/urfave/cli/v2/suggestions.go +++ /dev/null @@ -1,60 +0,0 @@ -package cli - -import ( - "fmt" - - "github.com/xrash/smetrics" -) - -func jaroWinkler(a, b string) float64 { - // magic values are from https://github.com/xrash/smetrics/blob/039620a656736e6ad994090895784a7af15e0b80/jaro-winkler.go#L8 - const ( - boostThreshold = 0.7 - prefixSize = 4 - ) - return smetrics.JaroWinkler(a, b, boostThreshold, prefixSize) -} - -func suggestFlag(flags []Flag, provided string, hideHelp bool) string { - distance := 0.0 - suggestion := "" - - for _, flag := range flags { - flagNames := flag.Names() - if !hideHelp { - flagNames = append(flagNames, HelpFlag.Names()...) - } - for _, name := range flagNames { - newDistance := jaroWinkler(name, provided) - if newDistance > distance { - distance = newDistance - suggestion = name - } - } - } - - if len(suggestion) == 1 { - suggestion = "-" + suggestion - } else if len(suggestion) > 1 { - suggestion = "--" + suggestion - } - - return suggestion -} - -// suggestCommand takes a list of commands and a provided string to suggest a -// command name -func suggestCommand(commands []*Command, provided string) (suggestion string) { - distance := 0.0 - for _, command := range commands { - for _, name := range append(command.Names(), helpName, helpAlias) { - newDistance := jaroWinkler(name, provided) - if newDistance > distance { - distance = newDistance - suggestion = name - } - } - } - - return fmt.Sprintf(SuggestDidYouMeanTemplate, suggestion) -} diff --git a/vendor/github.com/urfave/cli/v2/template.go b/vendor/github.com/urfave/cli/v2/template.go deleted file mode 100644 index da98890..0000000 --- a/vendor/github.com/urfave/cli/v2/template.go +++ /dev/null @@ -1,143 +0,0 @@ -package cli - -var helpNameTemplate = `{{$v := offset .HelpName 6}}{{wrap .HelpName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}` -var usageTemplate = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}}{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}` -var descriptionTemplate = `{{wrap .Description 3}}` -var authorsTemplate = `{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}: - {{range $index, $author := .Authors}}{{if $index}} - {{end}}{{$author}}{{end}}` -var visibleCommandTemplate = `{{ $cv := offsetCommands .VisibleCommands 5}}{{range .VisibleCommands}} - {{$s := join .Names ", "}}{{$s}}{{ $sp := subtract $cv (offset $s 3) }}{{ indent $sp ""}}{{wrap .Usage $cv}}{{end}}` -var visibleCommandCategoryTemplate = `{{range .VisibleCategories}}{{if .Name}} - {{.Name}}:{{range .VisibleCommands}} - {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{template "visibleCommandTemplate" .}}{{end}}{{end}}` -var visibleFlagCategoryTemplate = `{{range .VisibleFlagCategories}} - {{if .Name}}{{.Name}} - - {{end}}{{$flglen := len .Flags}}{{range $i, $e := .Flags}}{{if eq (subtract $flglen $i) 1}}{{$e}} -{{else}}{{$e}} - {{end}}{{end}}{{end}}` - -var visibleFlagTemplate = `{{range $i, $e := .VisibleFlags}} - {{wrap $e.String 6}}{{end}}` - -var versionTemplate = `{{if .Version}}{{if not .HideVersion}} - -VERSION: - {{.Version}}{{end}}{{end}}` - -var copyrightTemplate = `{{wrap .Copyright 3}}` - -// AppHelpTemplate is the text template for the Default help topic. -// cli.go uses text/template to render templates. You can -// render custom help text by setting this variable. -var AppHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Version}}{{if not .HideVersion}} - -VERSION: - {{.Version}}{{end}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}} -{{- if len .Authors}} - -AUTHOR{{template "authorsTemplate" .}}{{end}}{{if .VisibleCommands}} - -COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -GLOBAL OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -GLOBAL OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}{{if .Copyright}} - -COPYRIGHT: - {{template "copyrightTemplate" .}}{{end}} -` - -// CommandHelpTemplate is the text template for the command help topic. -// cli.go uses text/template to render templates. You can -// render custom help text by setting this variable. -var CommandHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{template "usageTemplate" .}}{{if .Category}} - -CATEGORY: - {{.Category}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -OPTIONS:{{template "visibleFlagTemplate" .}}{{end}} -` - -// SubcommandHelpTemplate is the text template for the subcommand help topic. -// cli.go uses text/template to render templates. You can -// render custom help text by setting this variable. -var SubcommandHelpTemplate = `NAME: - {{template "helpNameTemplate" .}} - -USAGE: - {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}} - -DESCRIPTION: - {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}} - -COMMANDS:{{template "visibleCommandCategoryTemplate" .}}{{end}}{{if .VisibleFlagCategories}} - -OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}} - -OPTIONS:{{template "visibleFlagTemplate" .}}{{end}} -` - -var MarkdownDocTemplate = `{{if gt .SectionNum 0}}% {{ .App.Name }} {{ .SectionNum }} - -{{end}}# NAME - -{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }} - -# SYNOPSIS - -{{ .App.Name }} -{{ if .SynopsisArgs }} -` + "```" + ` -{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + ` -{{ end }}{{ if .App.Description }} -# DESCRIPTION - -{{ .App.Description }} -{{ end }} -**Usage**: - -` + "```" + `{{ if .App.UsageText }} -{{ .App.UsageText }} -{{ else }} -{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] -{{ end }}` + "```" + ` -{{ if .GlobalArgs }} -# GLOBAL OPTIONS -{{ range $v := .GlobalArgs }} -{{ $v }}{{ end }} -{{ end }}{{ if .Commands }} -# COMMANDS -{{ range $v := .Commands }} -{{ $v }}{{ end }}{{ end }}` - -var FishCompletionTemplate = `# {{ .App.Name }} fish shell completion - -function __fish_{{ .App.Name }}_no_subcommand --description 'Test if there has been any subcommand yet' - for i in (commandline -opc) - if contains -- $i{{ range $v := .AllCommands }} {{ $v }}{{ end }} - return 1 - end - end - return 0 -end - -{{ range $v := .Completions }}{{ $v }} -{{ end }}` diff --git a/vendor/github.com/urfave/cli/v2/zz_generated.flags.go b/vendor/github.com/urfave/cli/v2/zz_generated.flags.go deleted file mode 100644 index 73e7714..0000000 --- a/vendor/github.com/urfave/cli/v2/zz_generated.flags.go +++ /dev/null @@ -1,848 +0,0 @@ -// WARNING: this file is generated. DO NOT EDIT - -package cli - -import "time" - -// Float64SliceFlag is a flag with type *Float64Slice -type Float64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Float64Slice - Destination *Float64Slice - - Aliases []string - EnvVars []string - - defaultValue *Float64Slice - - separator separatorSpec - - Action func(*Context, []float64) error -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Float64SliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Float64SliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Float64SliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Float64SliceFlag) IsVisible() bool { - return !f.Hidden -} - -// GenericFlag is a flag with type Generic -type GenericFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value Generic - Destination Generic - - Aliases []string - EnvVars []string - - defaultValue Generic - - TakesFile bool - - Action func(*Context, interface{}) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *GenericFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *GenericFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *GenericFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *GenericFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *GenericFlag) IsVisible() bool { - return !f.Hidden -} - -// Int64SliceFlag is a flag with type *Int64Slice -type Int64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Int64Slice - Destination *Int64Slice - - Aliases []string - EnvVars []string - - defaultValue *Int64Slice - - separator separatorSpec - - Action func(*Context, []int64) error -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Int64SliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Int64SliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Int64SliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Int64SliceFlag) IsVisible() bool { - return !f.Hidden -} - -// IntSliceFlag is a flag with type *IntSlice -type IntSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *IntSlice - Destination *IntSlice - - Aliases []string - EnvVars []string - - defaultValue *IntSlice - - separator separatorSpec - - Action func(*Context, []int) error -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *IntSliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *IntSliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *IntSliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *IntSliceFlag) IsVisible() bool { - return !f.Hidden -} - -// PathFlag is a flag with type Path -type PathFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value Path - Destination *Path - - Aliases []string - EnvVars []string - - defaultValue Path - - TakesFile bool - - Action func(*Context, Path) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *PathFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *PathFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *PathFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *PathFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *PathFlag) IsVisible() bool { - return !f.Hidden -} - -// StringSliceFlag is a flag with type *StringSlice -type StringSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *StringSlice - Destination *StringSlice - - Aliases []string - EnvVars []string - - defaultValue *StringSlice - - separator separatorSpec - - TakesFile bool - - Action func(*Context, []string) error - - KeepSpace bool -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *StringSliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *StringSliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *StringSliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *StringSliceFlag) IsVisible() bool { - return !f.Hidden -} - -// TimestampFlag is a flag with type *Timestamp -type TimestampFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Timestamp - Destination *Timestamp - - Aliases []string - EnvVars []string - - defaultValue *Timestamp - - Layout string - - Timezone *time.Location - - Action func(*Context, *time.Time) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *TimestampFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *TimestampFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *TimestampFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *TimestampFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *TimestampFlag) IsVisible() bool { - return !f.Hidden -} - -// Uint64SliceFlag is a flag with type *Uint64Slice -type Uint64SliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *Uint64Slice - Destination *Uint64Slice - - Aliases []string - EnvVars []string - - defaultValue *Uint64Slice - - separator separatorSpec - - Action func(*Context, []uint64) error -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Uint64SliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Uint64SliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Uint64SliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Uint64SliceFlag) IsVisible() bool { - return !f.Hidden -} - -// UintSliceFlag is a flag with type *UintSlice -type UintSliceFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value *UintSlice - Destination *UintSlice - - Aliases []string - EnvVars []string - - defaultValue *UintSlice - - separator separatorSpec - - Action func(*Context, []uint) error -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *UintSliceFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *UintSliceFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *UintSliceFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *UintSliceFlag) IsVisible() bool { - return !f.Hidden -} - -// BoolFlag is a flag with type bool -type BoolFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value bool - Destination *bool - - Aliases []string - EnvVars []string - - defaultValue bool - - Count *int - - DisableDefaultText bool - - Action func(*Context, bool) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *BoolFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *BoolFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *BoolFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *BoolFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *BoolFlag) IsVisible() bool { - return !f.Hidden -} - -// Float64Flag is a flag with type float64 -type Float64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value float64 - Destination *float64 - - Aliases []string - EnvVars []string - - defaultValue float64 - - Action func(*Context, float64) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *Float64Flag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Float64Flag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Float64Flag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Float64Flag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Float64Flag) IsVisible() bool { - return !f.Hidden -} - -// IntFlag is a flag with type int -type IntFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value int - Destination *int - - Aliases []string - EnvVars []string - - defaultValue int - - Base int - - Action func(*Context, int) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *IntFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *IntFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *IntFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *IntFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *IntFlag) IsVisible() bool { - return !f.Hidden -} - -// Int64Flag is a flag with type int64 -type Int64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value int64 - Destination *int64 - - Aliases []string - EnvVars []string - - defaultValue int64 - - Base int - - Action func(*Context, int64) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *Int64Flag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Int64Flag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Int64Flag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Int64Flag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Int64Flag) IsVisible() bool { - return !f.Hidden -} - -// StringFlag is a flag with type string -type StringFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value string - Destination *string - - Aliases []string - EnvVars []string - - defaultValue string - - TakesFile bool - - Action func(*Context, string) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *StringFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *StringFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *StringFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *StringFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *StringFlag) IsVisible() bool { - return !f.Hidden -} - -// DurationFlag is a flag with type time.Duration -type DurationFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value time.Duration - Destination *time.Duration - - Aliases []string - EnvVars []string - - defaultValue time.Duration - - Action func(*Context, time.Duration) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *DurationFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *DurationFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *DurationFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *DurationFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *DurationFlag) IsVisible() bool { - return !f.Hidden -} - -// UintFlag is a flag with type uint -type UintFlag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value uint - Destination *uint - - Aliases []string - EnvVars []string - - defaultValue uint - - Base int - - Action func(*Context, uint) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *UintFlag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *UintFlag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *UintFlag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *UintFlag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *UintFlag) IsVisible() bool { - return !f.Hidden -} - -// Uint64Flag is a flag with type uint64 -type Uint64Flag struct { - Name string - - Category string - DefaultText string - FilePath string - Usage string - - Required bool - Hidden bool - HasBeenSet bool - - Value uint64 - Destination *uint64 - - Aliases []string - EnvVars []string - - defaultValue uint64 - - Base int - - Action func(*Context, uint64) error -} - -// String returns a readable representation of this value (for usage defaults) -func (f *Uint64Flag) String() string { - return FlagStringer(f) -} - -// IsSet returns whether or not the flag has been set through env or file -func (f *Uint64Flag) IsSet() bool { - return f.HasBeenSet -} - -// Names returns the names of the flag -func (f *Uint64Flag) Names() []string { - return FlagNames(f.Name, f.Aliases) -} - -// IsRequired returns whether or not the flag is required -func (f *Uint64Flag) IsRequired() bool { - return f.Required -} - -// IsVisible returns true if the flag is not hidden, otherwise false -func (f *Uint64Flag) IsVisible() bool { - return !f.Hidden -} - -// vim:ro diff --git a/vendor/github.com/xrash/smetrics/.travis.yml b/vendor/github.com/xrash/smetrics/.travis.yml deleted file mode 100644 index d1cd67f..0000000 --- a/vendor/github.com/xrash/smetrics/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -language: go -go: - - 1.11 - - 1.12 - - 1.13 - - 1.14.x - - master -script: - - cd tests && make diff --git a/vendor/github.com/xrash/smetrics/LICENSE b/vendor/github.com/xrash/smetrics/LICENSE deleted file mode 100644 index 8044568..0000000 --- a/vendor/github.com/xrash/smetrics/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -Copyright (C) 2016 Felipe da Cunha Gonçalves -All Rights Reserved. - -MIT LICENSE - -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. diff --git a/vendor/github.com/xrash/smetrics/README.md b/vendor/github.com/xrash/smetrics/README.md deleted file mode 100644 index 5e0c1a4..0000000 --- a/vendor/github.com/xrash/smetrics/README.md +++ /dev/null @@ -1,49 +0,0 @@ -[![Build Status](https://travis-ci.org/xrash/smetrics.svg?branch=master)](http://travis-ci.org/xrash/smetrics) - -# smetrics - -`smetrics` is "string metrics". - -Package smetrics provides a bunch of algorithms for calculating the distance between strings. - -There are implementations for calculating the popular Levenshtein distance (aka Edit Distance or Wagner-Fischer), as well as the Jaro distance, the Jaro-Winkler distance, and more. - -# How to import - -```go -import "github.com/xrash/smetrics" -``` - -# Documentation - -Go to [https://pkg.go.dev/github.com/xrash/smetrics](https://pkg.go.dev/github.com/xrash/smetrics) for complete documentation. - -# Example - -```go -package main - -import ( - "github.com/xrash/smetrics" -) - -func main() { - smetrics.WagnerFischer("POTATO", "POTATTO", 1, 1, 2) - smetrics.WagnerFischer("MOUSE", "HOUSE", 2, 2, 4) - - smetrics.Ukkonen("POTATO", "POTATTO", 1, 1, 2) - smetrics.Ukkonen("MOUSE", "HOUSE", 2, 2, 4) - - smetrics.Jaro("AL", "AL") - smetrics.Jaro("MARTHA", "MARHTA") - - smetrics.JaroWinkler("AL", "AL", 0.7, 4) - smetrics.JaroWinkler("MARTHA", "MARHTA", 0.7, 4) - - smetrics.Soundex("Euler") - smetrics.Soundex("Ellery") - - smetrics.Hamming("aaa", "aaa") - smetrics.Hamming("aaa", "aab") -} -``` diff --git a/vendor/github.com/xrash/smetrics/doc.go b/vendor/github.com/xrash/smetrics/doc.go deleted file mode 100644 index 21bc986..0000000 --- a/vendor/github.com/xrash/smetrics/doc.go +++ /dev/null @@ -1,19 +0,0 @@ -/* -Package smetrics provides a bunch of algorithms for calculating -the distance between strings. - -There are implementations for calculating the popular Levenshtein -distance (aka Edit Distance or Wagner-Fischer), as well as the Jaro -distance, the Jaro-Winkler distance, and more. - -For the Levenshtein distance, you can use the functions WagnerFischer() -and Ukkonen(). Read the documentation on these functions. - -For the Jaro and Jaro-Winkler algorithms, check the functions -Jaro() and JaroWinkler(). Read the documentation on these functions. - -For the Soundex algorithm, check the function Soundex(). - -For the Hamming distance algorithm, check the function Hamming(). -*/ -package smetrics diff --git a/vendor/github.com/xrash/smetrics/hamming.go b/vendor/github.com/xrash/smetrics/hamming.go deleted file mode 100644 index 505d3e5..0000000 --- a/vendor/github.com/xrash/smetrics/hamming.go +++ /dev/null @@ -1,25 +0,0 @@ -package smetrics - -import ( - "fmt" -) - -// The Hamming distance is the minimum number of substitutions required to change string A into string B. Both strings must have the same size. If the strings have different sizes, the function returns an error. -func Hamming(a, b string) (int, error) { - al := len(a) - bl := len(b) - - if al != bl { - return -1, fmt.Errorf("strings are not equal (len(a)=%d, len(b)=%d)", al, bl) - } - - var difference = 0 - - for i := range a { - if a[i] != b[i] { - difference = difference + 1 - } - } - - return difference, nil -} diff --git a/vendor/github.com/xrash/smetrics/jaro-winkler.go b/vendor/github.com/xrash/smetrics/jaro-winkler.go deleted file mode 100644 index abdb288..0000000 --- a/vendor/github.com/xrash/smetrics/jaro-winkler.go +++ /dev/null @@ -1,28 +0,0 @@ -package smetrics - -import ( - "math" -) - -// The Jaro-Winkler distance. The result is 1 for equal strings, and 0 for completely different strings. It is commonly used on Record Linkage stuff, thus it tries to be accurate for common typos when writing real names such as person names and street names. -// Jaro-Winkler is a modification of the Jaro algorithm. It works by first running Jaro, then boosting the score of exact matches at the beginning of the strings. Because of that, it introduces two more parameters: the boostThreshold and the prefixSize. These are commonly set to 0.7 and 4, respectively. -func JaroWinkler(a, b string, boostThreshold float64, prefixSize int) float64 { - j := Jaro(a, b) - - if j <= boostThreshold { - return j - } - - prefixSize = int(math.Min(float64(len(a)), math.Min(float64(prefixSize), float64(len(b))))) - - var prefixMatch float64 - for i := 0; i < prefixSize; i++ { - if a[i] == b[i] { - prefixMatch++ - } else { - break - } - } - - return j + 0.1*prefixMatch*(1.0-j) -} diff --git a/vendor/github.com/xrash/smetrics/jaro.go b/vendor/github.com/xrash/smetrics/jaro.go deleted file mode 100644 index 75f924e..0000000 --- a/vendor/github.com/xrash/smetrics/jaro.go +++ /dev/null @@ -1,86 +0,0 @@ -package smetrics - -import ( - "math" -) - -// The Jaro distance. The result is 1 for equal strings, and 0 for completely different strings. -func Jaro(a, b string) float64 { - // If both strings are zero-length, they are completely equal, - // therefore return 1. - if len(a) == 0 && len(b) == 0 { - return 1 - } - - // If one string is zero-length, strings are completely different, - // therefore return 0. - if len(a) == 0 || len(b) == 0 { - return 0 - } - - // Define the necessary variables for the algorithm. - la := float64(len(a)) - lb := float64(len(b)) - matchRange := int(math.Max(0, math.Floor(math.Max(la, lb)/2.0)-1)) - matchesA := make([]bool, len(a)) - matchesB := make([]bool, len(b)) - var matches float64 = 0 - - // Step 1: Matches - // Loop through each character of the first string, - // looking for a matching character in the second string. - for i := 0; i < len(a); i++ { - start := int(math.Max(0, float64(i-matchRange))) - end := int(math.Min(lb-1, float64(i+matchRange))) - - for j := start; j <= end; j++ { - if matchesB[j] { - continue - } - - if a[i] == b[j] { - matchesA[i] = true - matchesB[j] = true - matches++ - break - } - } - } - - // If there are no matches, strings are completely different, - // therefore return 0. - if matches == 0 { - return 0 - } - - // Step 2: Transpositions - // Loop through the matches' arrays, looking for - // unaligned matches. Count the number of unaligned matches. - unaligned := 0 - j := 0 - for i := 0; i < len(a); i++ { - if !matchesA[i] { - continue - } - - for !matchesB[j] { - j++ - } - - if a[i] != b[j] { - unaligned++ - } - - j++ - } - - // The number of unaligned matches divided by two, is the number of _transpositions_. - transpositions := math.Floor(float64(unaligned / 2)) - - // Jaro distance is the average between these three numbers: - // 1. matches / length of string A - // 2. matches / length of string B - // 3. (matches - transpositions/matches) - // So, all that divided by three is the final result. - return ((matches / la) + (matches / lb) + ((matches - transpositions) / matches)) / 3.0 -} diff --git a/vendor/github.com/xrash/smetrics/soundex.go b/vendor/github.com/xrash/smetrics/soundex.go deleted file mode 100644 index a2ad034..0000000 --- a/vendor/github.com/xrash/smetrics/soundex.go +++ /dev/null @@ -1,41 +0,0 @@ -package smetrics - -import ( - "strings" -) - -// The Soundex encoding. It is a phonetic algorithm that considers how the words sound in English. Soundex maps a string to a 4-byte code consisting of the first letter of the original string and three numbers. Strings that sound similar should map to the same code. -func Soundex(s string) string { - m := map[byte]string{ - 'B': "1", 'P': "1", 'F': "1", 'V': "1", - 'C': "2", 'S': "2", 'K': "2", 'G': "2", 'J': "2", 'Q': "2", 'X': "2", 'Z': "2", - 'D': "3", 'T': "3", - 'L': "4", - 'M': "5", 'N': "5", - 'R': "6", - } - - s = strings.ToUpper(s) - - r := string(s[0]) - p := s[0] - for i := 1; i < len(s) && len(r) < 4; i++ { - c := s[i] - - if (c < 'A' || c > 'Z') || (c == p) { - continue - } - - p = c - - if n, ok := m[c]; ok { - r += n - } - } - - for i := len(r); i < 4; i++ { - r += "0" - } - - return r -} diff --git a/vendor/github.com/xrash/smetrics/ukkonen.go b/vendor/github.com/xrash/smetrics/ukkonen.go deleted file mode 100644 index 3c5579c..0000000 --- a/vendor/github.com/xrash/smetrics/ukkonen.go +++ /dev/null @@ -1,94 +0,0 @@ -package smetrics - -import ( - "math" -) - -// The Ukkonen algorithm for calculating the Levenshtein distance. The algorithm is described in http://www.cs.helsinki.fi/u/ukkonen/InfCont85.PDF, or in docs/InfCont85.PDF. It runs on O(t . min(m, n)) where t is the actual distance between strings a and b. It needs O(min(t, m, n)) space. This function might be preferred over WagnerFischer() for *very* similar strings. But test it out yourself. -// The first two parameters are the two strings to be compared. The last three parameters are the insertion cost, the deletion cost and the substitution cost. These are normally defined as 1, 1 and 2 respectively. -func Ukkonen(a, b string, icost, dcost, scost int) int { - var lowerCost int - - if icost < dcost && icost < scost { - lowerCost = icost - } else if dcost < scost { - lowerCost = dcost - } else { - lowerCost = scost - } - - infinite := math.MaxInt32 / 2 - - var r []int - var k, kprime, p, t int - var ins, del, sub int - - if len(a) > len(b) { - t = (len(a) - len(b) + 1) * lowerCost - } else { - t = (len(b) - len(a) + 1) * lowerCost - } - - for { - if (t / lowerCost) < (len(b) - len(a)) { - continue - } - - // This is the right damn thing since the original Ukkonen - // paper minimizes the expression result only, but the uncommented version - // doesn't need to deal with floats so it's faster. - // p = int(math.Floor(0.5*((float64(t)/float64(lowerCost)) - float64(len(b) - len(a))))) - p = ((t / lowerCost) - (len(b) - len(a))) / 2 - - k = -p - kprime = k - - rowlength := (len(b) - len(a)) + (2 * p) - - r = make([]int, rowlength+2) - - for i := 0; i < rowlength+2; i++ { - r[i] = infinite - } - - for i := 0; i <= len(a); i++ { - for j := 0; j <= rowlength; j++ { - if i == j+k && i == 0 { - r[j] = 0 - } else { - if j-1 < 0 { - ins = infinite - } else { - ins = r[j-1] + icost - } - - del = r[j+1] + dcost - sub = r[j] + scost - - if i-1 < 0 || i-1 >= len(a) || j+k-1 >= len(b) || j+k-1 < 0 { - sub = infinite - } else if a[i-1] == b[j+k-1] { - sub = r[j] - } - - if ins < del && ins < sub { - r[j] = ins - } else if del < sub { - r[j] = del - } else { - r[j] = sub - } - } - } - k++ - } - - if r[(len(b)-len(a))+(2*p)+kprime] <= t { - break - } else { - t *= 2 - } - } - - return r[(len(b)-len(a))+(2*p)+kprime] -} diff --git a/vendor/github.com/xrash/smetrics/wagner-fischer.go b/vendor/github.com/xrash/smetrics/wagner-fischer.go deleted file mode 100644 index 9883aea..0000000 --- a/vendor/github.com/xrash/smetrics/wagner-fischer.go +++ /dev/null @@ -1,48 +0,0 @@ -package smetrics - -// The Wagner-Fischer algorithm for calculating the Levenshtein distance. -// The first two parameters are the two strings to be compared. The last three parameters are the insertion cost, the deletion cost and the substitution cost. These are normally defined as 1, 1 and 2 respectively. -func WagnerFischer(a, b string, icost, dcost, scost int) int { - - // Allocate both rows. - row1 := make([]int, len(b)+1) - row2 := make([]int, len(b)+1) - var tmp []int - - // Initialize the first row. - for i := 1; i <= len(b); i++ { - row1[i] = i * icost - } - - // For each row... - for i := 1; i <= len(a); i++ { - row2[0] = i * dcost - - // For each column... - for j := 1; j <= len(b); j++ { - if a[i-1] == b[j-1] { - row2[j] = row1[j-1] - } else { - ins := row2[j-1] + icost - del := row1[j] + dcost - sub := row1[j-1] + scost - - if ins < del && ins < sub { - row2[j] = ins - } else if del < sub { - row2[j] = del - } else { - row2[j] = sub - } - } - } - - // Swap the rows at the end of each row. - tmp = row1 - row1 = row2 - row2 = tmp - } - - // Because we swapped the rows, the final result is in row1 instead of row2. - return row1[len(row1)-1] -} diff --git a/vendor/modules.txt b/vendor/modules.txt deleted file mode 100644 index d12247a..0000000 --- a/vendor/modules.txt +++ /dev/null @@ -1,8 +0,0 @@ -# github.com/cpuguy83/go-md2man/v2 v2.0.2 -github.com/cpuguy83/go-md2man/v2/md2man -# github.com/russross/blackfriday/v2 v2.1.0 -github.com/russross/blackfriday/v2 -# github.com/urfave/cli/v2 v2.25.7 -github.com/urfave/cli/v2 -# github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 -github.com/xrash/smetrics