command: implement help builder
Signed-off-by: Ophestra <cat@gensokyo.uk>
This commit is contained in:
parent
7bd48d3489
commit
0584d64047
@ -1,7 +1,10 @@
|
|||||||
// Package command implements generic nested command parsing.
|
// Package command implements generic nested command parsing.
|
||||||
package command
|
package command
|
||||||
|
|
||||||
import "flag"
|
import (
|
||||||
|
"flag"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
// HandlerFunc is called when matching a directly handled subcommand tree.
|
// HandlerFunc is called when matching a directly handled subcommand tree.
|
||||||
@ -13,7 +16,7 @@ type (
|
|||||||
// FlagDefiner is a deferred flag definer value, usually encapsulating the default value.
|
// FlagDefiner is a deferred flag definer value, usually encapsulating the default value.
|
||||||
FlagDefiner interface {
|
FlagDefiner interface {
|
||||||
// Define defines the flag in set.
|
// Define defines the flag in set.
|
||||||
Define(set *flag.FlagSet, p any, name, usage string)
|
Define(b *strings.Builder, set *flag.FlagSet, p any, name, usage string)
|
||||||
}
|
}
|
||||||
|
|
||||||
Command interface {
|
Command interface {
|
||||||
|
48
command/help.go
Normal file
48
command/help.go
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
package command
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"text/tabwriter"
|
||||||
|
)
|
||||||
|
|
||||||
|
var ErrHelp = errors.New("help requested")
|
||||||
|
|
||||||
|
type helpBuilder struct {
|
||||||
|
n *node
|
||||||
|
prefix []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *helpBuilder) writeHelp(w io.Writer) error {
|
||||||
|
if _, err := fmt.Fprintf(w,
|
||||||
|
"\nUsage:\t%s%s COMMAND [OPTIONS]\n\nCommands:\n",
|
||||||
|
strings.Join(h.prefix, " "), &h.n.su); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
tw := tabwriter.NewWriter(w, 0, 1, 4, ' ', 0)
|
||||||
|
if err := h.writeCommands(h.n.child, tw); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := tw.Flush(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := w.Write([]byte{'\n'})
|
||||||
|
if err == nil {
|
||||||
|
err = ErrHelp
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *helpBuilder) writeCommands(n *node, w io.Writer) error {
|
||||||
|
if n == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if _, err := fmt.Fprintf(w, "\t%s\t%s\n", n.name, n.usage); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return h.writeCommands(n.next, w)
|
||||||
|
}
|
@ -3,6 +3,7 @@ package command
|
|||||||
import (
|
import (
|
||||||
"flag"
|
"flag"
|
||||||
"io"
|
"io"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
type node struct {
|
type node struct {
|
||||||
@ -11,8 +12,10 @@ type node struct {
|
|||||||
|
|
||||||
out io.Writer
|
out io.Writer
|
||||||
logf LogFunc
|
logf LogFunc
|
||||||
|
help *helpBuilder
|
||||||
|
|
||||||
f HandlerFunc
|
f HandlerFunc
|
||||||
|
su strings.Builder
|
||||||
set *flag.FlagSet
|
set *flag.FlagSet
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user