Skip to content

Commit 7a02863

Browse files
committed
up: update some docs and update some helper funcs
1 parent 7fe4634 commit 7a02863

File tree

6 files changed

+20
-5
lines changed

6 files changed

+20
-5
lines changed

events/events.go

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ const (
55
OnAppInitBefore = "app.init.before"
66
// OnAppInitAfter On app inited
77
OnAppInitAfter = "app.init.after"
8+
// OnAppInit event
9+
// Deprecated: please use OnAppInitAfter
10+
OnAppInit = OnAppInitAfter
811
// OnAppStop = "app.stopped"
912

1013
OnAppBindOptsBefore = "app.bind.opts.before"

helper/clog.go

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package helper

helper/help_vars.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const HelpVarFormat = "{$%s}"
2020
type HelpVars struct {
2121
VarOpen, VarClose string
2222

23-
// Vars you can add some vars map for render help info
23+
// Vars you can add some vars map for render help info. TODO rename replaces/pairs
2424
Vars map[string]string
2525
}
2626

resource/Changelog-TODO.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,18 @@
22

33
## TODO
44

5-
- hook on set flag value
5+
- [ ] hook on set flag value
66
- [x] option support multi shorts names
77
- [ ] cmd support flag option category
88
- [ ] app support command category by `c.Category`
99
- [ ] print parent's options on subcommand help panel
1010
- [ ] prompt completion by readline
11-
- [ ] keyboard and cursor control
11+
- [ ] keyboard and cursor control on terminal
12+
- [ ] refactor gflag.Flags, remove dep the `flag.FlagSet`
13+
- [ ] collect option/argument value by interactive `Option.Question`
14+
- [ ] support all command docs to markdown
1215

13-
refers:
16+
readline refers:
1417

1518
- https://github.com/chzyer/readline/tree/master/example
1619
- https://github.com/abiosoft/ishell/blob/master/completer.go
@@ -19,7 +22,6 @@ refers:
1922

2023
**new**
2124

22-
- [ ] support all command docs to markdown
2325
- [x] add some special flag type vars
2426
- [x] support hidden command on render help by `c.Hidden=true`
2527

resource/dev.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Dev
2+
3+
4+
## Tests
5+
6+
```shell
7+
go test -v -test.run ^TestCommand_Run_X ./
8+
```

show/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ contains `section, panel, padding, helpPanel, table, tree, title, list, multiLis
1818

1919
- https://github.com/InVisionApp/tabular
2020
- https://github.com/gosuri/uitable
21+
- https://github.com/tomlazar/table

0 commit comments

Comments
 (0)