Skip to content

Commit

Permalink
update all assert/debug info headers
Browse files Browse the repository at this point in the history
  • Loading branch information
@hedzr
hedzr committed Oct 9, 2024
1 parent 813485a commit 1f551d6
Show file tree
Hide file tree
Showing 12 changed files with 71 additions and 71 deletions.
4 changes: 2 additions & 2 deletions cli/atoa/stringtoany.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ func (s *toS) parseImpl(str string, rt reflect.Type, meme any) (v any, err error
if rt.Kind() == reflect.Pointer {
rt = rt.Elem() //nolint:revive
rv := reflect.New(rt)
logz.Info("rv", "rv", ref.Valfmt(&rv))
logz.Debug("[cmdr] toS.parseImpl - rv", "rv", ref.Valfmt(&rv))
err = rv.Interface().(encoding.TextUnmarshaler).UnmarshalText([]byte(str))
if err == nil {
v = rv.Interface()
Expand Down Expand Up @@ -201,7 +201,7 @@ func (s *toS) parseArray(preferKind reflect.Kind, typArray reflect.Type, str str
var pos, position int
position, v, err = s.stepComplexObject(preferKind, typArray, runes, pos, meme)
if position == pos || position < len(runes) {
logz.Warn("the given string is empty or has too much data?", "str", str, "posAfterParsed", position)
logz.Warn("[cmdr] the given string is empty or has too much data?", "str", str, "posAfterParsed", position)
}
return
}
Expand Down
44 changes: 22 additions & 22 deletions cli/command.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ func (c *Command) getDeferAction(cmd *Command, args []string) func(errInvoked er
}

if !ecp.IsEmpty() {
logz.Fatal("Error(s) occurred when running post-actions:", "error", ecp.Error())
logz.Fatal("[cmdr] Error(s) occurred when running post-actions:", "error", ecp.Error())
}
}
}
Expand All @@ -263,7 +263,7 @@ func (c *Command) getDeferAction(cmd *Command, args []string) func(errInvoked er
// ecp.Attach(c.postInvoke(cmd, args, errInvoked))
// }
// if !ecp.IsEmpty() {
// logz.Fatalf("Error(s) occurred when running post-actions: %v", ecp)
// logz.Fatalf("[cmdr] Error(s) occurred when running post-actions: %v", ecp)
// }
// return
// }
Expand Down Expand Up @@ -346,7 +346,7 @@ func (c *Command) ensureXrefFlags() { //nolint:revive
ff.ensureXref()
if ff.headLike {
if ff.owner.headLikeFlag != nil && ff.owner.headLikeFlag != ff {
logz.Warn("too much head-like flags", "last-head-like-flag", ff.owner.headLikeFlag, "this-one", ff)
logz.Warn("[cmdr] too much head-like flags", "last-head-like-flag", ff.owner.headLikeFlag, "this-one", ff)
}
ff.owner.headLikeFlag = ff
}
Expand All @@ -362,7 +362,7 @@ func (c *Command) ensureXrefFlags() { //nolint:revive
ff.ensureXref()
if ff.headLike {
if ff.owner.headLikeFlag != nil && ff.owner.headLikeFlag != ff {
logz.Warn("too much head-like flags", "last-head-like-flag", ff.owner.headLikeFlag, "this-one", ff)
logz.Warn("[cmdr] too much head-like flags", "last-head-like-flag", ff.owner.headLikeFlag, "this-one", ff)
}
ff.owner.headLikeFlag = ff
}
Expand Down Expand Up @@ -507,7 +507,7 @@ func (c *Command) MatchFlag(vp *FlagValuePkg) (ff *Flag, err error) { //nolint:r
if num, err = strconv.ParseInt(vp.Remains, 0, 64); err == nil {
vp.Matched, vp.Remains, ff = vp.Remains, "", c.headLikeFlag
ff.defaultValue, vp.ValueOK = int(num), true // store the parsed value
logz.Verbose("headLike flag matched", "flg", ff, "num", num)
logz.Verbose("[cmdr] headLike flag matched", "flg", ff, "num", num)
}
}
} else {
Expand Down Expand Up @@ -771,7 +771,7 @@ func (c *Command) fromString(text string, meme any) (value any) { //nolint:reviv
var err error
value, err = atoa.Parse(text, meme)
if err != nil {
logz.ErrorContext(context.TODO(), "cannot parse text to value", "err", err, "text", text, "target-value-meme", meme)
logz.ErrorContext(context.TODO(), "[cmdr] cannot parse text to value", "err", err, "text", text, "target-value-meme", meme)
}
return
}
Expand All @@ -798,68 +798,68 @@ func (c *Command) invokeExternalEditor(vp *FlagValuePkg, ff *Flag) *Flag {
}
}

logz.Debug("external editor", "ex-editor", ff.externalEditor)
logz.Debug("[cmdr] external editor", "ex-editor", ff.externalEditor)
if cmd := os.Getenv(ff.externalEditor); cmd != "" {
file := tool.TempFileName("message*.tmp", "message001.tmp", c.App().Name())
cmdS := tool.SplitCommandString(cmd)
cmdS = append(cmdS, file)
defer func(dst string) {
if err := dir.DeleteFile(dst); err != nil {
logz.Error("cannot delete temporary file for flag", "flag", ff)
logz.Error("[cmdr] cannot delete temporary file for flag", "flag", ff)
}
}(file)

logz.Debug("invoke external editor", "ex-editor", ff.externalEditor, "cmd", cmdS)
logz.Debug("[cmdr] invoke external editor", "ex-editor", ff.externalEditor, "cmd", cmdS)
if is.DebuggerAttached() {
vp.ValueOK, vp.Value = true, "<<stdoutTextForDebugging>>"
logz.Warn("use debug text", "flag", ff, "text", vp.Value)
logz.Warn("[cmdr] use debug text", "flag", ff, "text", vp.Value)
return ff
}

if err := exec.CallSliceQuiet([]string{"which", cmdS[0]}, func(retCode int, stdoutText string) {
if retCode == 0 {
cmdS[0] = strings.TrimSpace(strings.TrimSuffix(stdoutText, "\n"))
logz.Debug("got external editor real-path", "cmd", cmdS)
logz.Debug("[cmdr] got external editor real-path", "cmd", cmdS)
}
}); err != nil {
logz.Error("cannot invoke which Command", "flag", ff, "cmd", cmdS)
logz.Error("[cmdr] cannot invoke which Command", "flag", ff, "cmd", cmdS)
return nil
}

var content []byte
var err error
content, err = tool.LaunchEditorWithGetter(cmdS[0], func() string { return cmdS[1] }, false)
if err != nil {
logz.Error("Error on launching cmd", "err", err, "cmd", cmdS)
logz.Error("[cmdr] Error on launching cmd", "err", err, "cmd", cmdS)
return nil
}

// content, err = tool.LaunchEditorWith(cmdS[0], cmdS[1])
// if err != nil {
// logz.Error("Error on launching cmd", "err", err, "cmd", cmdS)
// logz.Error("[cmdr] Error on launching cmd", "err", err, "cmd", cmdS)
// return nil
// }
//
// content, err = tool.LaunchEditor(cmdS[0])
// if err != nil {
// logz.Error("Error on launching cmd", "err", err, "cmd", cmdS)
// logz.Error("[cmdr] Error on launching cmd", "err", err, "cmd", cmdS)
// return nil
// }

// f, err = os.Open(file)
// if err != nil {
// logz.Error("cannot open temporary file for reading content", "file", file, "flag", ff, "cmd", cmdS)
// logz.Error("[cmdr] cannot open temporary file for reading content", "file", file, "flag", ff, "cmd", cmdS)
// return nil
// }
// defer f.Close()
// vp.ValueOK, vp.Value = true, dir.MustReadAll(f)

vp.ValueOK, vp.Value = true, string(content)
ff.defaultValue = string(content)
// logz.Debug("invoked external editor", "ex-editor", ff.externalEditor, "text", string(content))
// logz.Debug("[cmdr] invoked external editor", "ex-editor", ff.externalEditor, "text", string(content))
return ff
}
logz.Warn("Unknown External Editor for flag.", "ex-editor", ff.externalEditor, "flag", ff)
logz.Warn("[cmdr] Unknown External Editor for flag.", "ex-editor", ff.externalEditor, "flag", ff)
return nil
}

Expand Down Expand Up @@ -1250,7 +1250,7 @@ func (c *Command) walkImpl(hist map[*Command]bool, cmd *Command, level int, cb W
hist[cc] = true
c.walkImpl(hist, cc, level+1, cb)
} else {
logz.Warn("loop ref found", "dad", cmd, "cc", cc)
logz.Warn("[cmdr] loop ref found", "dad", cmd, "cc", cc)
}
}
}
Expand Down Expand Up @@ -1280,7 +1280,7 @@ func (c *Command) walkGroupedImpl(hist map[*Command]bool, dad, grandpa *Command,
// cb(cc,nil, i, 0, level)
c.walkGroupedImpl(hist, cc, dad, i, level+1, cb)
} else {
logz.Warn("loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
logz.Warn("[cmdr] loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
}
}
}
Expand All @@ -1292,7 +1292,7 @@ func (c *Command) walkGroupedImpl(hist map[*Command]bool, dad, grandpa *Command,
// // cb(cc,nil, i, 0, level)
// c.walkGrouped(hist, cc, dad, level+1, cb)
// } else {
// logz.Warn("loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
// logz.Warn("[cmdr] loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
// }
// }
// }
Expand Down Expand Up @@ -1334,7 +1334,7 @@ func (c *Command) walkEx(hist map[*Command]bool, dad, grandpa *Command, level, c
// cb(cc,nil, i, 0, level)
c.walkEx(hist, cc, dad, level+1, i, cb)
} else {
logz.Warn("loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
logz.Warn("[cmdr] loop ref found", "dad", dad, "grandpa", grandpa, "cc", cc)
}
}
}
Expand Down
6 changes: 3 additions & 3 deletions cli/examples/more.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -463,12 +463,12 @@ func mxTest(cmd *cli.Command, args []string) (err error) {
z := cmd.Set().MustString("app.test.deep.branch.1")
fmt.Printf("*** Got app.test.deep.branch.1: %s\n", z)
if z != "test" {
logz.Fatal("err, expect 'test', but got z", "z", z)
logz.Fatal("[cmdr] err, expect 'test', but got z", "z", z)
}

cmd.Set().Remove("app.test.deep.branch.1")
if cmd.Set().Has("app.test.deep.branch.1") {
logz.Fatal("FAILED, expect key not found, but found a value associated with: ", "value", cmd.Set().MustR("app.test.deep.branch.1"))
logz.Fatal("[cmdr] FAILED, expect key not found, but found a value associated with: ", "value", cmd.Set().MustR("app.test.deep.branch.1"))
}
fmt.Printf("*** Got app.test.deep.branch.1 (after deleted): %s\n", cmd.Set().MustString("app.test.deep.branch.1"))

Expand Down Expand Up @@ -498,7 +498,7 @@ func mxTest(cmd *cli.Command, args []string) (err error) {
var data []byte
data, err = dir.ReadAll(os.Stdin)
if err != nil {
logz.Error("error:", "err", err)
logz.Error("[cmdr] error:", "err", err)
return
}
fmt.Println("> The input contents are:")
Expand Down
12 changes: 6 additions & 6 deletions cli/worker/exec.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func (w *workerS) exec(ctx *parseCtx) (err error) {
}()

if !forceDefaultAction && lastCmd.HasOnAction() {
logz.Verbose("invoke action of cmd, with args", "cmd", lastCmd, "args", ctx.positionalArgs)
logz.Verbose("[cmdr] invoke action of cmd, with args", "cmd", lastCmd, "args", ctx.positionalArgs)
err = lastCmd.Invoke(ctx.positionalArgs)
if !w.errIsSignalFallback(err) {
return
Expand All @@ -53,7 +53,7 @@ func (w *workerS) exec(ctx *parseCtx) (err error) {
handled, err1 := w.handleActions(ctx)
// for k, action := range w.actions {
// if k&w.actionsMatched != 0 {
// logz.Verbose("Invoking worker.actionsMatched", "hit-action", k, "actions", w.Actions())
// logz.Verbose("[cmdr] Invoking worker.actionsMatched", "hit-action", k, "actions", w.Actions())
// err, handled = action(ctx, lastCmd), true
// break
// }
Expand All @@ -73,7 +73,7 @@ func (w *workerS) exec(ctx *parseCtx) (err error) {
return
}

logz.Verbose("no onAction associate to cmd", "cmd", lastCmd)
logz.Verbose("[cmdr] no onAction associate to cmd", "cmd", lastCmd)
err = w.onPrintHelpScreen(ctx, lastCmd)
return
}
Expand All @@ -82,7 +82,7 @@ func (w *workerS) handleActions(ctx *parseCtx) (handled bool, err error) {
lastCmd := ctx.LastCmd()
for k, action := range w.actions {
if k&w.actionsMatched != 0 {
logz.Verbose("Invoking worker.actionsMatched", "hit-action", k, "actions", w.Actions())
logz.Verbose("[cmdr] Invoking worker.actionsMatched", "hit-action", k, "actions", w.Actions())
err, handled = action(ctx, lastCmd), true
break
}
Expand Down Expand Up @@ -154,13 +154,13 @@ func (w *workerS) onSingleHyphenMatched(ctx *parseCtx) (err error) { //nolint:un
}

func (w *workerS) onUnknownCommandMatched(ctx *parseCtx) (err error) {
logz.Warn("UNKNOWN <mark>Command</mark> FOUND", "arg", ctx.arg)
logz.Warn("[cmdr] UNKNOWN <mark>Command</mark> FOUND", "arg", ctx.arg)
err = cli.ErrUnmatchedCommand.FormatWith(ctx.arg, ctx.LastCmd())
return
}

func (w *workerS) onUnknownFlagMatched(ctx *parseCtx) (err error) {
logz.Warn("UNKNOWN <mark>Flag</mark> FOUND", "arg", ctx.arg)
logz.Warn("[cmdr] UNKNOWN <mark>Flag</mark> FOUND", "arg", ctx.arg)
err = cli.ErrUnmatchedFlag.FormatWith(ctx.arg, ctx.LastCmd())
return
}
Expand Down
14 changes: 7 additions & 7 deletions cli/worker/parse.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func (w *workerS) parse(ctx *parseCtx) (err error) { //nolint:revive
}
}()

logz.Verbose("parsing command line args ...", "args", w.args)
logz.Verbose("[cmdr] parsing command line args ...", "args", w.args)

loopArgs:
for ctx.i = 1; ctx.i < len(w.args); ctx.i++ {
Expand All @@ -38,11 +38,11 @@ loopArgs:

if atomic.LoadInt32(&ctx.passThruMatched) > 0 || errorsv3.Is(err, cli.ErrShouldStop) || w.errIsUnmatchedArg(err) {
ctx.positionalArgs = append(ctx.positionalArgs, w.args[ctx.i])
logz.Verbose("positional args added", "i", ctx.i, "args", ctx.positionalArgs)
logz.Verbose("[cmdr] positional args added", "i", ctx.i, "args", ctx.positionalArgs)
continue
}

logz.Verbose("parsing command-line args", "i", ctx.i, "arg", w.args[ctx.i])
logz.Verbose("[cmdr] parsing command-line args", "i", ctx.i, "arg", w.args[ctx.i])

ctx.arg, ctx.short, ctx.pos = w.args[ctx.i], false, 0
switch c1 := ctx.arg[0]; c1 {
Expand All @@ -65,7 +65,7 @@ loopArgs:
}
// single '+': as a positional arg
ctx.positionalArgs = append(ctx.positionalArgs, ctx.arg)
logz.Verbose("positional args added", "i", ctx.i, "args", ctx.positionalArgs)
logz.Verbose("[cmdr] positional args added", "i", ctx.i, "args", ctx.positionalArgs)
continue

case '-', '~':
Expand Down Expand Up @@ -109,7 +109,7 @@ loopArgs:
default:
if ctx.NoCandidateChildCommands() {
ctx.positionalArgs = append(ctx.positionalArgs, ctx.arg)
logz.Verbose("positional args added", "i", ctx.i, "args", ctx.positionalArgs)
logz.Verbose("[cmdr] positional args added", "i", ctx.i, "args", ctx.positionalArgs)
continue
}
if err = w.matchCommand(ctx); !w.errIsSignalOrNil(err) {
Expand All @@ -129,7 +129,7 @@ func (w *workerS) matchCommand(ctx *parseCtx) (err error) {
if err == nil {
ctx.lastCommand, err = len(ctx.matchedCommands)-1, nil
}
logz.Verbose("command matched", "short", short, "cmd", ctx.LastCmd(), "handled", handled)
logz.Verbose("[cmdr] command matched", "short", short, "cmd", ctx.LastCmd(), "handled", handled)
}
return
}
Expand All @@ -144,7 +144,7 @@ compactFlags:
if vp.Matched != "" && ff != nil && w.errIsSignalOrNil(err1) {
ms, handled := ctx.addFlag(ff), false
handled, err1 = ff.TryOnMatched(0, ms)
logz.Verbose("flag matched", "short", vp.Short, "flg", ff, "val-pkg-val", ff.DefaultValue(), "handled", handled)
logz.Verbose("[cmdr] flag matched", "short", vp.Short, "flg", ff, "val-pkg-val", ff.DefaultValue(), "handled", handled)

ctx.i += vp.AteArgs
vp.AteArgs = 0
Expand Down
18 changes: 9 additions & 9 deletions cli/worker/pre.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func (w *workerS) preProcess() (err error) {
w.postEnvLoad()

if is.VerboseBuild() || is.DebugBuild() { // `-tags delve` or `-tags verbose` used in building?
logz.Verbose("Dumping Store ...")
logz.Verbose("[cmdr] Dumping Store ...")
logz.Verbose(w.Store().Dump())
}
return
Expand All @@ -55,12 +55,12 @@ func (w *workerS) preEnvSet() {
_ = os.Setenv("APP_VER", w.Version())
_ = os.Setenv("APP_VERSION", w.Version())

logz.Verbose("appName", "appName", w.Name(), "appVer", w.Version())
logz.Verbose("[cmdr] preEnvSet()", "appName", w.Name(), "appVer", w.Version())

xdgPrefer := true
if w.Store().Has("app.force-xdg-dir-prefer") {
xdgPrefer = w.Store().MustBool("app.force-xdg-dir-prefer", false)
logz.Verbose("reset force-xdg-dir-prefer from store value", "app.force-xdg-dir-prefer", xdgPrefer)
logz.Verbose("[cmdr] reset force-xdg-dir-prefer from store value", "app.force-xdg-dir-prefer", xdgPrefer)
}

home := tool.HomeDir()
Expand Down Expand Up @@ -102,14 +102,14 @@ func (w *workerS) preEnvSet() {
}

func (w *workerS) postEnvLoad() {
// logz.Info("env", "FORCE_DEFAULT_ACTION", os.Getenv("FORCE_DEFAULT_ACTION"))
// logz.Info("[cmdr] postEnvLoad()", "FORCE_DEFAULT_ACTION", os.Getenv("FORCE_DEFAULT_ACTION"))
if w.Store().Has("app.force-default-action") {
w.ForceDefaultAction = w.Store().MustBool("app.force-default-action", false)
logz.Verbose("reset forceDefaultAction from store value", "ForceDefaultAction", w.ForceDefaultAction)
logz.Verbose("[cmdr] postEnvLoad() - reset forceDefaultAction from store value", "ForceDefaultAction", w.ForceDefaultAction)
}
if tool.ToBool(os.Getenv("FORCE_DEFAULT_ACTION"), false) {
w.ForceDefaultAction = true
logz.Info("set ForceDefaultAction true", "ForceDefaultAction", w.ForceDefaultAction)
logz.Info("[cmdr] postEnvLoad() - set ForceDefaultAction true", "ForceDefaultAction", w.ForceDefaultAction)
}
}

Expand All @@ -118,7 +118,7 @@ func (w *workerS) linkCommands(root *cli.RootCommand) (err error) {
root.EnsureTree(root.App(), root) // link the added builtin commands too
if err = w.xrefCommands(root); err == nil {
if err = w.commandsToStore(root); err == nil {
logz.Verbose("*RootCommand linked itself")
logz.Verbose("[cmdr] linkCommands() - *RootCommand linked itself")
}
}
}
Expand Down Expand Up @@ -183,7 +183,7 @@ func (w *workerS) loadLoaders() (err error) {
appName := w.Name()
jsonLoader := &jsonLoaderS{}
jsonLoader.filename = path.Join(appDir, "."+appName+".json")
logz.Debug("use internal tiny json loader", "filename", jsonLoader.filename)
logz.Debug("[cmdr] use internal tiny json loader", "filename", jsonLoader.filename)
w.Config.Loaders = append(w.Config.Loaders, jsonLoader)
return
}
Expand All @@ -210,7 +210,7 @@ func (w *workerS) precheckLoaders() {
}
}
if !found {
logz.Warn("Config file has been ignored", "config-file", w.configFile)
logz.Warn("[cmdr] Config file has been ignored", "config-file", w.configFile)
}
}
}
Expand Down
Loading

0 comments on commit 1f551d6

Please sign in to comment.