chore: update some comments and add some debug logs

app.go

@@ -75,12 +75,13 @@ func New(fns ...func(app *App)) *App {
 // NewApp create new app instance.
 //
 // Usage:
-// 	NewApp()
-// 	// Or with a config func
-// 	NewApp(func(a *App) {
-// 		// do something before init ....
-// 		a.Hooks[gcli.EvtInit] = func () {}
-// 	})
+//
+//	NewApp()
+//	// Or with a config func
+//	NewApp(func(a *App) {
+//		// do something before init ....
+//		a.Hooks[gcli.EvtInit] = func () {}
+//	})
 func NewApp(fns ...func(app *App)) *App {
 	app := &App{
 		Name: "GCliApp",
@@ -431,11 +432,12 @@ func (app *App) RunLine(argsLine string) int {
 // Run running application
 //
 // Usage:
+//
 //	// run with os.Args
 //	app.Run(nil)
 //	app.Run(os.Args[1:])
 //	// custom args
-//	app.Run([]string{"cmd", ...})
+//	app.Run([]string{"cmd", "--name", "inhere"})
 func (app *App) Run(args []string) (code int) {
 	// ensure application initialized
 	app.initialize()
@@ -473,6 +475,7 @@ func (app *App) Run(args []string) (code int) {
 // RunCmd running an top command with custom args
 //
 // Usage:
+//
 //	app.Exec("top")
 //	app.Exec("top", []string{"-a", "val0", "arg0"})
 //	// can add sub command on args
@@ -487,11 +490,7 @@ func (app *App) doRunCmd(name string, args []string) (code int) {
 
 	Debugf("will run app command '%s' with args: %v", name, args)
 
-	// parse command options
-	// args, err = cmd.parseOptions(args)
-
 	// do execute command
-	// if err := cmd.innerExecute(args, true); err != nil {
 	if err := cmd.innerDispatch(args); err != nil {
 		code = ERR
 		app.Fire(EvtAppRunError, err)
@@ -539,6 +538,7 @@ func (app *App) exitOnEnd(code int) int {
 // - command path in the app. 'top sub'
 //
 // Usage:
+//
 //	app.Exec("top")
 //	app.Exec("top:sub")
 //	app.Exec("top sub")

cmd.go

@@ -120,10 +120,11 @@ type Command struct {
 
 // NewCommand create a new command instance.
 // Usage:
-// 	cmd := NewCommand("my-cmd", "description")
+//
+//	cmd := NewCommand("my-cmd", "description")
 //	// OR with an config func
-// 	cmd := NewCommand("my-cmd", "description", func(c *Command) { ... })
-// 	app.Add(cmd) // OR cmd.AttachTo(app)
+//	cmd := NewCommand("my-cmd", "description", func(c *Command) { ... })
+//	app.Add(cmd) // OR cmd.AttachTo(app)
 func NewCommand(name, desc string, fn ...func(c *Command)) *Command {
 	c := &Command{
 		Name: name,
@@ -249,7 +250,7 @@ func (c *Command) initialize() {
 
 	// check command name
 	cName := c.goodName()
-	Debugf("initialize the command '%s'", cName)
+	Debugf("initialize the command '%s': init flags, run config func", cName)
 
 	c.initialized = true
 	c.pathNames = append(c.pathNames, cName)
@@ -350,6 +351,7 @@ func (c *Command) Next() {
 // MustRun Alone the current command, will panic on error
 //
 // Usage:
+//
 //	// run with os.Args
 //	cmd.MustRun(nil)
 //	cmd.MustRun(os.Args[1:])
@@ -364,6 +366,7 @@ func (c *Command) MustRun(args []string) {
 // Run standalone running the command
 //
 // Usage:
+//
 //	// run with os.Args
 //	cmd.Run(nil)
 //	cmd.Run(os.Args[1:])
@@ -408,8 +411,6 @@ func (c *Command) Run(args []string) (err error) {
 
 // dispatch execute the command
 func (c *Command) innerDispatch(args []string) (err error) {
-	Debugf("cmd: %s - begin parse options by args: %v", c.Name, args)
-
 	// parse command flags
 	args, err = c.parseOptions(args)
 	if err != nil {

gflag.go

@@ -165,9 +165,10 @@ func (fs *Flags) WithConfigFn(fns ...func(cfg *FlagsConfig)) *Flags {
 // Run flags parse and handle help render
 //
 // Usage:
-// 	gf := gcli.NewFlags()
-//  ...
-// 	gf.Run(os.Args)
+//
+//		gf := gcli.NewFlags()
+//	 ...
+//		gf.Run(os.Args)
 func (fs *Flags) Run(args []string) {
 	if args == nil {
 		args = os.Args
@@ -202,11 +203,12 @@ func (fs *Flags) Run(args []string) {
 // Parse given arguments
 //
 // Usage:
-// 	gf := gcli.NewFlags()
-// 	gf.BoolOpt(&debug, "debug", "", defDebug, "open debug mode")
-// 	gf.UintOpt(&port, "port", "p", 18081, "the http server port")
 //
-// 	err := gf.Parse(os.Args[1:])
+//	gf := gcli.NewFlags()
+//	gf.BoolOpt(&debug, "debug", "", defDebug, "open debug mode")
+//	gf.UintOpt(&port, "port", "p", 18081, "the http server port")
+//
+//	err := gf.Parse(os.Args[1:])
 func (fs *Flags) Parse(args []string) (err error) {
 	defer func() {
 		if err := recover(); err != nil {
@@ -224,6 +226,7 @@ func (fs *Flags) Parse(args []string) (err error) {
 
 	if len(fs.shorts) > 0 && len(args) > 0 {
 		args = cflag.ReplaceShorts(args, fs.shorts)
+		Debugf("replace shortcuts. now, args: %v", args)
 	}
 
 	// do parsing
@@ -591,8 +594,9 @@ func (fs *Flags) Var(p flag.Value, meta *FlagMeta) { fs.varOpt(p, meta) }
 // VarOpt binding a custom var option
 //
 // Usage:
-//		var names gcli.Strings
-// 		cmd.VarOpt(&names, "tables", "t", "description ...")
+//
+//	var names gcli.Strings
+//	cmd.VarOpt(&names, "tables", "t", "description ...")
 func (fs *Flags) VarOpt(p flag.Value, name, shorts, desc string) {
 	fs.varOpt(p, newFlagMeta(name, desc, nil, shorts))
 }