Flag: Negatable

package main

import (
	"context"
	"os"

	"github.com/hedzr/cmdr/v2"
	"github.com/hedzr/cmdr/v2/cli"
	"github.com/hedzr/cmdr/v2/examples/common"
	"github.com/hedzr/cmdr/v2/examples/devmode"
	// logz "github.com/hedzr/logg/slog"
)

const (
	appName = "negatable"
	desc    = `a sample to demo negatable flag.`
	version = cmdr.Version
	author  = ``
)

func main() {
	app := cmdr.Create(appName, version, author, desc).
		With(func(app cli.App) { logz.Debug("in dev mode?", "mode", devmode.InDevelopmentMode()) }).
		WithBuilders(common.AddNegatableFlag).
		WithAdders().
		// override the onAction defined in common.AddNegatableFlag()
		OnAction(func(ctx context.Context, cmd cli.Cmd, args []string) (err error) {
			// logz.PrintlnContext(ctx, cmd.Set().Dump())

			// v := cmd.Store().MustBool("warning")
			// w := cmd.Store().MustBool("no-warning")
			// println("warning flag: ", v)
			// println("no-warning flag: ", w)

			// wf := cmd.FlagBy("warning")
			// if wf != nil && wf.LeadingPlusSign() {
			// 	println("warning flag with leading plus sign: +w FOUND.")
			// }
			// return

			println("Dumping Store ----------\n", cmdr.Set().Dump())

			cmd.App().DoBuiltinAction(ctx, cli.ActionDefault)

			cs := cmd.Store()

			v := cs.MustBool("warning")
			w := cs.MustBool("no-warning")
			println("warning toggle group: ", cs.MustString("warning"))
			println("  warning flag: ", v)
			println("  no-warning flag: ", w)

			wf := cmd.FlagBy("warning")
			if wf != nil && wf.LeadingPlusSign() {
				println()
				println("NOTABLE: a flag with leading plus sign: +w FOUND.")
			} else {
				logz.WarnContext(ctx, "cannot found flag 'warning'")
			}

			sw1 := cs.MustBool("warnings.unused-variable")
			sw2 := cs.MustBool("warnings.unused-parameter")
			sw3 := cs.MustBool("warnings.unused-function")
			sw4 := cs.MustBool("warnings.unused-but-set-variable")
			sw5 := cs.MustBool("warnings.unused-private-field")
			sw6 := cs.MustBool("warnings.unused-label")
			fmt.Printf(`

--warnings, -W:
    > TG: %q
    > TG.selected: %q
	unused-variable:		%v, (no-): %v
	unused-parameter:		%v, (no-): %v
	unused-function:		%v, (no-): %v
	unused-but-set-variable:	%v, (no-): %v
	unused-private-field:		%v, (no-): %v
	unused-label:			%v, (no-): %v
	selected items:			%v
`,
				cs.MustString("warnings"),
				cs.MustStringSlice("warnings.selected"),
				sw1, cs.MustBool("warnings.no-unused-variable"),
				sw2, cs.MustBool("warnings.no-unused-parameter"),
				sw3, cs.MustBool("warnings.no-unused-function"),
				sw4, cs.MustBool("warnings.no-unused-but-set-variable"),
				sw5, cs.MustBool("warnings.no-unused-private-field"),
				sw6, cs.MustBool("warnings.no-unused-label"),
				cs.MustStringSlice("warnings.selected"),
			)

			return
		}).
		Build()

	ctx := context.Background()
	if err := app.Run(ctx); err != nil {
		logz.ErrorContext(ctx, "Application Error:", "err", err) // stacktrace if in debug mode/build
		os.Exit(app.SuggestRetCode())
	} else if rc := app.SuggestRetCode(); rc != 0 {
		os.Exit(rc)
	}
}

package examples

import (
	"context"

	"github.com/hedzr/cmdr/v2/cli"
)

func AddNegatableFlag(parent cli.CommandBuilder)           { AddNegatableFlagImpl(parent) }
func AddNegatableFlagWithoutCmd(parent cli.CommandBuilder) { AddNegatableFlagImpl(parent, true) }

func AddNegatableFlagImpl(parent cli.CommandBuilder, dontHandlingParentCmd ...bool) { //nolint:revive
	parent.Flg("warning", "w").
		Description("negatable flag: <code>--no-warning</code> is available", "").
		Group("Negatable").
		LeadingPlusSign(true).
		Negatable(true).
		Default(false).
		Build()

	parent.Flg("warnings", "W").
		Description("gcc-style negatable flag: <code>-Wunused-variable</code> and -Wno-unused-variable", "").
		Group("Negatable").
		Negatable(true, "unused-variable", "unused-parameter", "unused-function", "unused-but-set-variable", "unused-private-field", "unused-label").
		Default(false).
		Build()

	var noHpc bool
	for _, p := range dontHandlingParentCmd {
		if p {
			noHpc = true
		}
	}
	if !noHpc {
		// give root command an action to handle it
		action := func(ctx context.Context, cmd cli.Cmd, args []string) (err error) {
			println("Dumping Store\n", cmd.App().Store().Dump())

			cs := cmd.Store()

			v := cs.MustBool("warning")
			w := cs.MustBool("no-warning")
			println("warning flag: ", v)
			println("no-warning flag: ", w)
			wf := cmd.FlagBy("warning")
			if wf != nil && wf.LeadingPlusSign() {
				println("warning flag with leading plus sign: +w FOUND.")
			}

			sw1 := cs.MustBool("warnings.unused-variable")
			sw2 := cs.MustBool("warnings.unused-parameter")
			sw3 := cs.MustBool("warnings.unused-function")
			sw4 := cs.MustBool("warnings.unused-but-set-variable")
			sw5 := cs.MustBool("warnings.unused-private-field")
			sw6 := cs.MustBool("warnings.unused-label")
			fmt.Printf(`

--warnings, -W:
	unused-variable:			%v, (no-): %v
	unused-parameter:			%v, (no-): %v
	unused-function:			%v, (no-): %v
	unused-but-set-variable:	%v, (no-): %v
	unused-private-field:		%v, (no-): %v
	unused-label:				%v, (no-): %v
	selected items:				%v
`,
				sw1, cs.MustBool("warnings.no-unused-variable"),
				sw2, cs.MustBool("warnings.no-unused-parameter"),
				sw3, cs.MustBool("warnings.no-unused-function"),
				sw4, cs.MustBool("warnings.no-unused-but-set-variable"),
				sw5, cs.MustBool("warnings.no-unused-private-field"),
				sw6, cs.MustBool("warnings.no-unused-label"),
				cs.MustStringSlice("warnings.selected"),
			)
			return
		}

		parent.OnAction(action)
	}

	parent.Examples(`Try to use negatable flag,

	  $ $APP --no-warning
	    <code>cmd.Store().MustBool("no-warning")</code> will be 'true'.
	  $ $APP --warning
	    <code>cmd.Store().MustBool("warning")</code> will be 'true'.
	`)
}