migrate tea to urfave v3 (#760)

I tested this somewhat, but I haven't been using the cli before so I'm not sure if there are changes - there shouldn't be though. Reviewed-on: https://gitea.com/gitea/tea/pulls/760 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: TheFox0x7 <thefox0x7@gmail.com> Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2025-09-03 02:18:30 +02:00 · 2025-06-10 05:19:59 +00:00
parent 5420af1dfa
commit 0e54bae0c4
91 changed files with 686 additions and 608 deletions
--- a/cmd/cmd.go
+++ b/cmd/cmd.go
@ -0,0 +1,133 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+// Tea is command line tool for Gitea.
+package cmd // import "code.gitea.io/tea"
+
+import (
+	"fmt"
+	"runtime"
+	"strings"
+
+	"github.com/urfave/cli/v3"
+)
+
+// Version holds the current tea version
+var Version = "development"
+
+// Tags holds the build tags used
+var Tags = ""
+
+// SDK holds the sdk version from go.mod
+var SDK = ""
+
+// App creates and returns a tea Command with all subcommands set
+// it was separated from main so docs can be generated for it
+func App() *cli.Command {
+	// make parsing tea --version easier, by printing /just/ the version string
+	cli.VersionPrinter = func(c *cli.Command) { fmt.Fprintln(c.Writer, c.Version) }
+
+	return &cli.Command{
+		Name:               "tea",
+		Usage:              "command line tool to interact with Gitea",
+		Description:        appDescription,
+		CustomHelpTemplate: helpTemplate,
+		Version:            formatVersion(),
+		Commands: []*cli.Command{
+			&CmdLogin,
+			&CmdLogout,
+			&CmdAutocomplete,
+			&CmdWhoami,
+
+			&CmdIssues,
+			&CmdPulls,
+			&CmdLabels,
+			&CmdMilestones,
+			&CmdReleases,
+			&CmdTrackedTimes,
+			&CmdOrgs,
+			&CmdRepos,
+			&CmdBranches,
+			&CmdAddComment,
+
+			&CmdOpen,
+			&CmdNotifications,
+			&CmdRepoClone,
+
+			&CmdAdmin,
+		},
+		EnableShellCompletion: true,
+	}
+}
+
+func formatVersion() string {
+	version := fmt.Sprintf("Version: %s\tgolang: %s",
+		bold(Version),
+		strings.ReplaceAll(runtime.Version(), "go", ""))
+
+	if len(Tags) != 0 {
+		version += fmt.Sprintf("\tbuilt with: %s", strings.Replace(Tags, " ", ", ", -1))
+	}
+
+	if len(SDK) != 0 {
+		version += fmt.Sprintf("\tgo-sdk: %s", SDK)
+	}
+
+	return version
+}
+
+var appDescription = `tea is a productivity helper for Gitea. It can be used to manage most entities on
+one or multiple Gitea instances & provides local helpers like 'tea pr checkout'.
+
+tea tries to make use of context provided by the repository in $PWD if available.
+tea works best in a upstream/fork workflow, when the local main branch tracks the
+upstream repo. tea assumes that local git state is published on the remote before
+doing operations with tea.    Configuration is persisted in $XDG_CONFIG_HOME/tea.
+`
+
+var helpTemplate = bold(`
+   {{.Name}}{{if .Usage}} - {{.Usage}}{{end}}`) + `
+   {{if .Version}}{{if not .HideVersion}}version {{.Version}}{{end}}{{end}}
+
+ USAGE
+   {{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}}{{if .Commands}} command [subcommand] [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}}
+
+ DESCRIPTION
+   {{.Description | nindent 3 | trim}}{{end}}{{if .VisibleCommands}}
+
+ COMMANDS{{range .VisibleCategories}}{{if .Name}}
+   {{.Name}}:{{range .VisibleCommands}}
+     {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{range .VisibleCommands}}
+   {{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{end}}{{end}}{{end}}{{if .VisibleFlags}}
+
+ OPTIONS
+   {{range $index, $option := .VisibleFlags}}{{if $index}}
+   {{end}}{{$option}}{{end}}{{end}}
+
+ EXAMPLES
+   tea login add                       # add a login once to get started
+
+   tea pulls                           # list open pulls for the repo in $PWD
+   tea pulls --repo $HOME/foo          # list open pulls for the repo in $HOME/foo
+   tea pulls --remote upstream         # list open pulls for the repo pointed at by
+                                       # your local "upstream" git remote
+   # list open pulls for any gitea repo at the given login instance
+   tea pulls --repo gitea/tea --login gitea.com
+
+   tea milestone issues 0.7.0          # view open issues for milestone '0.7.0'
+   tea issue 189                       # view contents of issue 189
+   tea open 189                        # open web ui for issue 189
+   tea open milestones                 # open web ui for milestones
+
+   # send gitea desktop notifications every 5 minutes (bash + libnotify)
+   while :; do tea notifications --mine -o simple | xargs -i notify-send {}; sleep 300; done
+
+ ABOUT
+   Written & maintained by The Gitea Authors.
+   If you find a bug or want to contribute, we'll welcome you at https://gitea.com/gitea/tea.
+   More info about Gitea itself on https://about.gitea.com.
+`
+
+func bold(t string) string {
+	return fmt.Sprintf("\033[1m%s\033[0m", t)
+}