Skip to content

Commit 3a36294

Browse files
committed
- [*] standardize the sub-func naming convention
1 parent b3f447d commit 3a36294

7 files changed

Lines changed: 25 additions & 20 deletions

File tree

cli-ext.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ var root = &cli.Command{
105105
// func {{.Name}}CLI(ctx *cli.Context) error {
106106
// rootArgv = ctx.RootArgv().(*rootT)
107107
// argv := ctx.Argv().(*{{.Name}}T)
108-
// clis.Setup(progname, rootArgv.Verbose.Value())
108+
// clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
109109
// clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
110110
// {{range $.Options}}Opts.{{.Name}}, {{end}}Opts.Verbose =
111111
// {{range $.Options}}rootArgv.{{.Name}}, {{end}}rootArgv.Verbose.Value()

cli-std.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ var root = &cli.Command{
103103
// func {{.Name}}CLI(ctx *cli.Context) error {
104104
// rootArgv = ctx.RootArgv().(*rootT)
105105
// argv := ctx.Argv().(*{{.Name}}T)
106-
// clis.Setup(progname, rootArgv.Verbose.Value())
106+
// clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
107107
// clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
108108
// {{range $.Options}}Opts.{{.Name}}, {{end}}Opts.Verbose =
109109
// {{range $.Options}}rootArgv.{{.Name}}, {{end}}rootArgv.Verbose.Value()

cmd_get.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import (
2222
func getCLI(ctx *cli.Context) error {
2323
rootArgv = ctx.RootArgv().(*rootT)
2424
argv := ctx.Argv().(*getT)
25-
clis.Setup(progname, rootArgv.Verbose.Value())
26-
clis.Verbose(2, "[get]:\n %+v\n %+v\n %v\n", rootArgv, argv, ctx.Args())
25+
clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
26+
clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
2727
Opts.Self, Opts.Host, Opts.Port, Opts.Daemonize, Opts.Verbose =
2828
rootArgv.Self, rootArgv.Host, rootArgv.Port, rootArgv.Daemonize, rootArgv.Verbose.Value()
2929

cmd_put.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import (
2222
func putCLI(ctx *cli.Context) error {
2323
rootArgv = ctx.RootArgv().(*rootT)
2424
argv := ctx.Argv().(*putT)
25-
clis.Setup(progname, rootArgv.Verbose.Value())
26-
clis.Verbose(2, "[put]:\n %+v\n %+v\n %v\n", rootArgv, argv, ctx.Args())
25+
clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
26+
clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
2727
Opts.Self, Opts.Host, Opts.Port, Opts.Daemonize, Opts.Verbose =
2828
rootArgv.Self, rootArgv.Host, rootArgv.Port, rootArgv.Daemonize, rootArgv.Verbose.Value()
2929

wireframe_cli.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Command:
6767

6868
- Name: get
6969
Desc: Get from the service
70-
Text: 'Usage:\n wireframe get -o /tmp/f some more args'
70+
Text: 'Usage:\n wireframe get -o /tmp/f mandatory some more args'
7171
NumArg: cli.AtLeast(1)
7272
#NumOption: cli.AtLeast(1)
7373

wireframe_cliDef.go

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
////////////////////////////////////////////////////////////////////////////
22
// Program: wireframe
33
// Purpose: wire framing
4-
// Authors: Myself <me@mine.org> (c) 2018, All rights reserved
4+
// Authors: Myself <me@mine.org> (c) 2019, All rights reserved
55
////////////////////////////////////////////////////////////////////////////
66

77
package main
@@ -23,7 +23,7 @@ import (
2323

2424
type rootT struct {
2525
cli.Helper
26-
Self *rootT `cli:"c,config" usage:"config file\n" json:"-" parser:"jsonfile" dft:"wireframe_cfg.json"`
26+
Self *rootT `cli:"c,config" usage:"config file\n" json:"-" parser:"jsoncfg" dft:"wireframe_cfg.json"`
2727
Host string `cli:"H,host" usage:"host addr" dft:"$HOST"`
2828
Port int `cli:"p,port" usage:"listening port\n"`
2929
Demo string `cli:"long" usage:"Now can use the \\n to arrange parameters in groups\n\t\t\tJust like what is showing here, even with extreme long usage text that can spread across multiple lines\n" dft:"$Demo"`
@@ -32,8 +32,9 @@ type rootT struct {
3232
}
3333

3434
var root = &cli.Command{
35-
Name: "wireframe",
36-
Desc: "wire framing\nVersion " + version + " built on " + date,
35+
Name: "wireframe",
36+
Desc: "wire framing\nVersion " + version + " built on " + date +
37+
"\nCopyright (C) 2019, Myself <me@mine.org>",
3738
Text: "Tool to showcase wire-framing command line app fast prototype",
3839
Global: true,
3940
Argv: func() interface{} { t := new(rootT); t.Self = t; return t },
@@ -63,7 +64,7 @@ var root = &cli.Command{
6364
// var (
6465
// progname = "wireframe"
6566
// version = "0.1.0"
66-
// date = "2018-09-18"
67+
// date = "2019-09-12"
6768

6869
// rootArgv *rootT
6970
// // Opts store all the configurable options
@@ -82,6 +83,7 @@ var root = &cli.Command{
8283
// cli.Tree(putDef),
8384
// cli.Tree(getDef)).Run(os.Args[1:]); err != nil {
8485
// fmt.Fprintln(os.Stderr, err)
86+
// os.Exit(1)
8587
// }
8688
// fmt.Println("")
8789
// }
@@ -106,18 +108,19 @@ var root = &cli.Command{
106108
// func putCLI(ctx *cli.Context) error {
107109
// rootArgv = ctx.RootArgv().(*rootT)
108110
// argv := ctx.Argv().(*putT)
109-
// clis.Setup(progname, rootArgv.Verbose.Value())
111+
// clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
110112
// clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
111113
// Opts.Self, Opts.Host, Opts.Port, Opts.Demo, Opts.Daemonize, Opts.Verbose, Opts.Verbose =
112114
// rootArgv.Self, rootArgv.Host, rootArgv.Port, rootArgv.Demo, rootArgv.Daemonize, rootArgv.Verbose, rootArgv.Verbose.Value()
115+
// // argv.Filei,
113116
// //return nil
114117
// return DoPut()
115118
// }
116119
//
117-
// DoPut implements the business logic of command `put`
120+
// DoPut implements the business logic of command `put`
118121
// func DoPut() error {
119122
// fmt.Fprintf(os.Stderr, "%s v%s. put - Upload into service\n", progname, version)
120-
// fmt.Fprintln(os.Stderr, "Copyright (C) 2018, Myself <me@mine.org>\n")
123+
// // fmt.Fprintf(os.Stderr, "Copyright (C) 2019, Myself <me@mine.org>\n\n")
121124
// return nil
122125
// }
123126

@@ -141,18 +144,19 @@ var putDef = &cli.Command{
141144
// func getCLI(ctx *cli.Context) error {
142145
// rootArgv = ctx.RootArgv().(*rootT)
143146
// argv := ctx.Argv().(*getT)
144-
// clis.Setup(progname, rootArgv.Verbose.Value())
147+
// clis.Setup(fmt.Sprintf("%s::%s", progname, ctx.Path()), rootArgv.Verbose.Value())
145148
// clis.Verbose(2, "<%s> -\n %+v\n %+v\n %v\n", ctx.Path(), rootArgv, argv, ctx.Args())
146149
// Opts.Self, Opts.Host, Opts.Port, Opts.Demo, Opts.Daemonize, Opts.Verbose, Opts.Verbose =
147150
// rootArgv.Self, rootArgv.Host, rootArgv.Port, rootArgv.Demo, rootArgv.Daemonize, rootArgv.Verbose, rootArgv.Verbose.Value()
151+
// // argv.Filei, argv.Fileo,
148152
// //return nil
149153
// return DoGet()
150154
// }
151155
//
152-
// DoGet implements the business logic of command `get`
156+
// DoGet implements the business logic of command `get`
153157
// func DoGet() error {
154158
// fmt.Fprintf(os.Stderr, "%s v%s. get - Get from the service\n", progname, version)
155-
// fmt.Fprintln(os.Stderr, "Copyright (C) 2018, Myself <me@mine.org>\n")
159+
// // fmt.Fprintf(os.Stderr, "Copyright (C) 2019, Myself <me@mine.org>\n\n")
156160
// return nil
157161
// }
158162

@@ -164,7 +168,7 @@ type getT struct {
164168
var getDef = &cli.Command{
165169
Name: "get",
166170
Desc: "Get from the service",
167-
Text: "Usage:\n wireframe get -o /tmp/f some more args",
171+
Text: "Usage:\n wireframe get -o /tmp/f mandatory some more args",
168172
Argv: func() interface{} { return new(getT) },
169173
Fn: getCLI,
170174

wireframe_cliGen.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
easygen -tf cli-ext wireframe_cli | gofmt > wireframe_cliDef.go
1+
set -x
2+
easygen cli-ext wireframe_cli | gofmt > wireframe_cliDef.go

0 commit comments

Comments
 (0)