From a75e4796680ecf33b74db60b6b780d6e7e6cc0f3 Mon Sep 17 00:00:00 2001 From: Jeff Carr Date: Sun, 26 Oct 2025 10:06:13 -0500 Subject: new argv (much better than before) --- argv.custom.go | 40 ---------------------------- argv.go | 18 +++++++++++++ argv.struct.go | 18 ------------- argv.template.go | 81 -------------------------------------------------------- complete.go | 50 ++++++++++++++++++++++++++++++++++ doStrict.go | 6 ++--- exit.go | 9 +++---- main.go | 4 +-- structs.go | 2 -- 9 files changed, 77 insertions(+), 151 deletions(-) delete mode 100644 argv.custom.go create mode 100644 argv.go delete mode 100644 argv.struct.go delete mode 100644 argv.template.go create mode 100644 complete.go diff --git a/argv.custom.go b/argv.custom.go deleted file mode 100644 index f41830a..0000000 --- a/argv.custom.go +++ /dev/null @@ -1,40 +0,0 @@ -package main - -import ( - "os" - - "go.wit.com/lib/protobuf/argvpb" -) - -// sent via -ldflags -var VERSION string -var BUILDTIME string - -// used for shell auto completion -var APPNAME string = "go-mod-clean" - -func (a args) Description() string { - return ` -go-mod-clean will try to verify your go.* files are using the newest package versions - -* Recreate go.* with 'go mod init' and 'go mod tidy' -* Set your required go in go.mod (default is go1.21 -* Check that the most recent master branch versions are used -* Try to trim go.sum of non-existent entries -` -} - -/* - handles shell autocomplete -*/ - -// sends the strings to bash or zsh that will be your options -func (a args) SendCompletionStrings(pb *argvpb.Argv) { - if pb.GetCmd() == "" { - base := []string{"strict", "--restore", "purge", "lax", "--version"} - pb.SendStrings(base) - } else { - pb.SubCommand(pb.Goargs...) - } - os.Exit(0) -} diff --git a/argv.go b/argv.go new file mode 100644 index 0000000..9e0db4b --- /dev/null +++ b/argv.go @@ -0,0 +1,18 @@ +package main + +var argv args + +type args struct { + Trim bool `arg:"--trim" default:"true" help:"trim entries from go.sum"` + Verbose bool `arg:"--verbose" help:"show more"` + Restore bool `arg:"--restore" help:"only restore from go/pkg/mod/"` + Force bool `arg:"--force" help:"remove things and redo them no matter what"` + Purge *EmptyCmd `arg:"subcommand:purge" help:"purge all git notes. (this is where the autogenerated files are stored)"` + Smart *EmptyCmd `arg:"subcommand:lax" help:"try something but never do os.Exit(-1)"` + Strict *EmptyCmd `arg:"subcommand:strict" help:"never make go.* files unless everything is perfect"` + Bash bool `arg:"--bash" help:"generate bash completion"` + BashAuto []string `arg:"--auto-complete" help:"todo: move this to go-arg"` +} + +type EmptyCmd struct { +} diff --git a/argv.struct.go b/argv.struct.go deleted file mode 100644 index 9e0db4b..0000000 --- a/argv.struct.go +++ /dev/null @@ -1,18 +0,0 @@ -package main - -var argv args - -type args struct { - Trim bool `arg:"--trim" default:"true" help:"trim entries from go.sum"` - Verbose bool `arg:"--verbose" help:"show more"` - Restore bool `arg:"--restore" help:"only restore from go/pkg/mod/"` - Force bool `arg:"--force" help:"remove things and redo them no matter what"` - Purge *EmptyCmd `arg:"subcommand:purge" help:"purge all git notes. (this is where the autogenerated files are stored)"` - Smart *EmptyCmd `arg:"subcommand:lax" help:"try something but never do os.Exit(-1)"` - Strict *EmptyCmd `arg:"subcommand:strict" help:"never make go.* files unless everything is perfect"` - Bash bool `arg:"--bash" help:"generate bash completion"` - BashAuto []string `arg:"--auto-complete" help:"todo: move this to go-arg"` -} - -type EmptyCmd struct { -} diff --git a/argv.template.go b/argv.template.go deleted file mode 100644 index 6948afe..0000000 --- a/argv.template.go +++ /dev/null @@ -1,81 +0,0 @@ -package main - -// these are stubbed in functions needed -// just copy this file from another working app for now -// you shouldn't need to change anything here -// TODO: clean this up in argv - -import ( - "os" - - "go.wit.com/dev/alexflint/arg" - "go.wit.com/gui" - "go.wit.com/lib/env" - "go.wit.com/lib/fhelp" - "go.wit.com/log" -) - -func (args) InitArgv() (string, string, string) { - return APPNAME, BUILDTIME, VERSION -} - -// this function will send the current argv PB to go-args for parsing -func (args) ParseFlags(flags []string) error { - var err error - if me.pp == nil { - // log.Info("Parse Flags GOT flags:", flags) - me.pp, err = arg.ParseFlags(flags, &argv) - // panic("got to the app's ParseFlags()") - } else { - panic("me.pp was not nil") - } - return err -} - -// add this funcgion: this will print the help -func (args) WriteHelpForSubcommand(cmd string) error { - me.pp.WriteHelpForSubcommand(os.Stderr, cmd) - return nil -} - -// this will print the help for the subcmd -func (args) WriteHelpForAutocomplete(part string, subcmd ...string) error { - return me.pp.WriteHelpForAutocomplete(os.Stderr, os.Stdout, part, subcmd...) -} - -func (args) WriteHelpForAutocompleteDebug(part string, subcmd ...string) error { - f, _ := os.OpenFile("/tmp/argv.junk", os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) - return me.pp.WriteHelpForAutocomplete(f, os.Stdout, part, subcmd...) -} - -// add this funcgion: this will print the help -func (args) WriteHelp() error { - me.pp.WriteHelp(os.Stderr) - return nil -} - -func (args) InitGui() error { - // panic("got here") - arg.Register(&gui.ArgvGui) - // me.gui = gui.PreInit() - me.myGui = fhelp.Gui() - return nil -} - -func (args) Exit() { - gui.UnloadToolkits() - if env.Verbose() { - log.Info("argv.Exit() called", APPNAME+".Exit()") - } - // remove this from the template for your app (or make one for youself if you need it) - // forgeExit() // custom forge shutdown function -} - -func (args) Help() string { - return "got app help" -} - -func (args) MustParse() error { - me.pp = arg.MustParse(&argv) - return nil -} diff --git a/complete.go b/complete.go new file mode 100644 index 0000000..07147d2 --- /dev/null +++ b/complete.go @@ -0,0 +1,50 @@ +package main + +import ( + "fmt" + "strings" + + "go.wit.com/dev/alexflint/arg" + "go.wit.com/lib/protobuf/argvpb" +) + +// sent via -ldflags +var VERSION string +var BUILDTIME string + +// used for shell auto completion +var APPNAME string = "go-mod-clean" + +func (a args) Description() string { + return ` +go-mod-clean will try to verify your go.* files are using the newest package versions + +* Recreate go.* with 'go mod init' and 'go mod tidy' +* Set your required go in go.mod (default is go1.21 +* Check that the most recent master branch versions are used +* Try to trim go.sum of non-existent entries +` +} + +func (args) MustParse() error { + me.pp = arg.MustParse(&argv) + return nil +} + +// sends the strings to bash or zsh that will be your options +func (a args) DoAutoComplete() error { + if argvpb.PB.GetCmd() == "" { + matches := []string{"strict", "--restore", "purge", "lax", "--version"} + fmt.Fprintf(argvpb.Stdout, " %s", strings.Join(matches, " ")) + return nil + } + var err error + if me.pp == nil { + me.pp, err = arg.ParseFlagsArgv(&argv) + if err != nil { + return err + } + } + err = me.pp.WriteHelpForAutocomplete(argvpb.PB.Partial, argvpb.PB.Real...) + return err +} diff --git a/doStrict.go b/doStrict.go index c36278a..0df6ce7 100644 --- a/doStrict.go +++ b/doStrict.go @@ -32,10 +32,10 @@ func doStrict(repo *gitpb.Repo) error { if repo.GetMasterBranchName() != repo.GetCurrentBranchName() { log.Info("") - log.Info("You are not operating on your git master branch.") - log.Info("Publishing go.mod & go.sum files must come from from git version tag on the master branch") + log.Info("ERR: You are not operating on your git master branch.") + log.Info("ERR: Publishing go.mod & go.sum files must come from from git version tag on the master branch") log.Info("") - return errors.New(repo.GetGoPath() + " not in the git master branch") + return errors.New("not on the git master branch") } // not sure if this really needs to be run a second time. probably not, but whatever. who cares diff --git a/exit.go b/exit.go index 4e87fd2..b091f20 100644 --- a/exit.go +++ b/exit.go @@ -2,8 +2,8 @@ package main import ( "fmt" - "path/filepath" + "go.wit.com/lib/protobuf/argvpb" "go.wit.com/lib/protobuf/gitpb" "go.wit.com/log" ) @@ -11,7 +11,7 @@ import ( func okExit(check *gitpb.Repo, msg string) { log.Info("exit() go-mod-clean on", check.Namespace, "ok") log.DaemonMode(true) - me.argv.GoodExit(msg) + argvpb.GoodExit(msg) } func badExit(check *gitpb.Repo, err error) { @@ -22,7 +22,6 @@ func badExit(check *gitpb.Repo, err error) { eraseGoMod(check) } } - fullpath := filepath.Join(check.FullPath) - s := fmt.Sprintf("failed in %s", fullpath) - me.argv.BadExit(s, err) + s := fmt.Sprintf("failed in %s", check.FullPath) + argvpb.BadExit(s, err) } diff --git a/main.go b/main.go index e0f7373..e94f7dc 100644 --- a/main.go +++ b/main.go @@ -15,7 +15,7 @@ var configSave bool func main() { me = new(mainType) - me.argv = argvpb.Autocomplete(&argv) // adds shell auto complete to go-args + argvpb.Init(&argv, APPNAME, BUILDTIME, VERSION) // adds shell auto-complete me.forge, _ = forgepb.Init() // figure out what directory we are running in @@ -34,7 +34,7 @@ func main() { badExit(nil, nil) } log.Info("todo: check return values here in go-mod-clean") - me.argv.GoodExit("may have worked somewhat") // exits back to the shell via argv (with timing) + argvpb.GoodExit("may have worked somewhat") // exits back to the shell via argv (with timing) } // deletes all the git notes diff --git a/structs.go b/structs.go index c767cbb..d10069b 100644 --- a/structs.go +++ b/structs.go @@ -6,7 +6,6 @@ package main import ( "go.wit.com/dev/alexflint/arg" "go.wit.com/lib/fhelp" - "go.wit.com/lib/protobuf/argvpb" "go.wit.com/lib/protobuf/forgepb" ) @@ -14,7 +13,6 @@ var me *mainType // this app's variables type mainType struct { - argv *argvpb.Argv // more experiments for bash handling pp *arg.Parser // for parsing the command line args. Yay to alexf lint! myGui *fhelp.GuiPrep // for initializing the GUI toolkits forge *forgepb.Forge -- cgit v1.2.3