cmdopt

README

cmdopt

cmdopt 命令行选项的增强，可以轻松处理子命令。高度重用 flag 包。

opt := &cmdopt.New(...)

// 子命令 build，为一个 flag.FlagSet 实例
build := opt.New("build", "title", "usage", func(f *flag.FlagSet) DoFunc {
    v := f.Bool("v", "false", ...)

    return func(output io.Writer)error{
        if v {
            ...
        } else {
            output.Write([]byte("build"))
        }
    }
})

// 子命令 install
install := opt.New("install", "title", "usage", func(*flag.FlagSet) DoFunc {
    return func(output io.Writer)error{
        output.Write([]byte("install"))
    }
})

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。

Documentation

Overview

Package cmdopt 用于创建子命令功能的命令行

Index

• type CmdOpt
  • func New(output io.Writer, errorHandling flag.ErrorHandling, usageTemplate string, ...) *CmdOpt
  • func (opt *CmdOpt) Command(name string) (title, usage string, found bool)
  • func (opt *CmdOpt) Commands() []string
  • func (opt *CmdOpt) Exec(args []string) error
  • func (opt *CmdOpt) New(name, title, usage string, cmd CommandFunc)
  • func (opt *CmdOpt) Output() io.Writer
  • func (opt *CmdOpt) SetOutput(w io.Writer)
  • func (opt *CmdOpt) Usage() string
• type CommandFunc
  • func Help(opt *CmdOpt) CommandFunc
• type DoFunc

Types

type CmdOpt

type CmdOpt struct {
	// contains filtered or unexported fields
}

CmdOpt 带子命令的命令行操作

func New

func New(output io.Writer, errorHandling flag.ErrorHandling, usageTemplate string, cmd CommandFunc, notFound func(string) string) *CmdOpt

New 声明带有子命令的命令行处理对象

output 表示命令行信息的输出通道；

errorHandling 表示出错时的处理方式；

cmd 非子命令的参数设定，可以为空；

usageTemplate 命令行的文字说明模板，包含了以下几个占位符：

• {{flags}} 参数说明，输出时被参数替换，如果没有可以为空；
• {{commands}} 子命令说明，输出时被子命令列表替换，如果没有可以为空；

notFound 表示找不到子命令时需要返回的文字说明，若为空，则采用 usageTemplate 处理后的内容；

func (*CmdOpt) Command

func (opt *CmdOpt) Command(name string) (title, usage string, found bool)

Command 返回指定的命令的说明

func (*CmdOpt) Commands

func (opt *CmdOpt) Commands() []string

Commands 返回所有的子命令

func (*CmdOpt) Exec

func (opt *CmdOpt) Exec(args []string) error

Exec 执行命令行程序

args 参数列表，不包含应用名称，比如 os.Args[1:]。

func (*CmdOpt) New

func (opt *CmdOpt) New(name, title, usage string, cmd CommandFunc)

New 注册一条新的子命令

name 为子命令的名称，必须唯一； cmd 为该条子命令执行的函数体； usage 为该条子命令的帮助内容。可以包含 {{flags}} 占位符，表示参数信息。

func (*CmdOpt) Output

func (opt *CmdOpt) Output() io.Writer

func (*CmdOpt) SetOutput

func (opt *CmdOpt) SetOutput(w io.Writer)

SetOutput 设置输出通道

func (*CmdOpt) Usage

func (opt *CmdOpt) Usage() string

Usage 整个项目的使用说明内容

基于 New 的 usage 参数，里面的占位符会被真实的内容所覆盖。

type CommandFunc

type CommandFunc = func(*flag.FlagSet) DoFunc

CommandFunc 子命令的初始化方法

FlagSet 可用于绑定各个命令行参数； 返回值 DoFunc 表示实际执行的函数；

func Help

func Help(opt *CmdOpt) CommandFunc

Help 注册 help 子命令

type DoFunc

type DoFunc = func(io.Writer) error