commands.go

package cli

import "fmt"

func HelpCommand() Command {
	return Command{
		Name:  "help",
		Usage: Usage("Show information about a command"),
		Action: ActionFunc(func(cmd *Command) ActionRunner {
			// Do not mutate the previous path.
			path := cmd.Path()
			newPath := make([]string, len(path)-1)
			copy(newPath, path[:len(path)-1])
			path = newPath

			_ = RestStringsVar(cmd, &path, "command")

			return func(cmd *Command) error {
				cmd, err := cmd.App().Command(path...)
				if err != nil {
					return err
				}

				return cmd.App().Help(cmd, cmd.Stdout())
			}
		}),
	}
}

func CompletionCommand() Command {
	return Command{
		Name:  "completion",
		Usage: Usage("Generate completion script"),
		Action: ActionFunc(func(cmd *Command) ActionRunner {
			shell := StringArg(cmd, "shell")

			return func(cmd *Command) error {
				var generator CompletionGenerator
				switch *shell {
				case "zsh":
					generator = &ZSHCompletionGenerator{}

				default:
					return fmt.Errorf("unknown shell: '%s'", *shell)
				}

				root, err := cmd.App().RootCommand()
				if err != nil {
					return err
				}

				return generator.CompletionGenerate(root, cmd.Stdout())
			}
		}),
	}
}

func HelpCommandFlag() CommandFlag {
	return CommandFlag{
		Long:  "help",
		Short: "h",
		Usage: Usage("Show information about a command"),
		Action: ActionRunner(func(cmd *Command) error {
			return cmd.App().Help(cmd, cmd.Stdout())
		}),
	}
}

func VersionCommandFlag(version string) CommandFlag {
	return CommandFlag{
		Long:  "version",
		Short: "v",
		Usage: Usage("Print version information and quit"),
		Action: ActionRunner(func(cmd *Command) error {
			if _, err := cmd.Printf(version); err != nil {
				return err
			}

			if _, err := cmd.Printf("\n"); err != nil {
				return err
			}

			return nil
		}),
	}
}