From 593f2fdc4edb5a010e385446f36f5bdc1f6926ab Mon Sep 17 00:00:00 2001 From: qasimwarraich Date: Fri, 28 Apr 2023 13:11:56 +0200 Subject: [PATCH] Improve help text and add usage exampes Fixes #85 --- internal/livelint/check_can_access_app.go | 7 +++--- main.go | 29 ++++++++++++++++++----- 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/internal/livelint/check_can_access_app.go b/internal/livelint/check_can_access_app.go index 92d20ec..53bd2ff 100644 --- a/internal/livelint/check_can_access_app.go +++ b/internal/livelint/check_can_access_app.go @@ -87,9 +87,10 @@ func (n *Livelint) canPortForward(pod apiv1.Pod, port int32, checkFunc func(uint } }() - // wait for port forwarding to be ready - // for range readyChan { - // } + for range readyChan { + //for golangci-lint + fmt.Println("") + } n.ui.StartSpinner() diff --git a/main.go b/main.go index 053e296..be8cdaa 100644 --- a/main.go +++ b/main.go @@ -2,6 +2,7 @@ package main import ( "fmt" + "log" "os" "github.com/bespinian/livelint/internal/app" @@ -20,9 +21,11 @@ func main() { Commands: []*cli.Command{ { - Name: "check", - Aliases: []string{"c"}, - Usage: "checks a Kubernetes deployment for issues", + Name: "check", + Aliases: []string{"c"}, + Usage: "livelint check/c [--namespace/-n ] ", + UsageText: "livelint check my-deployment\nlivelint check --namespace default my-deployment", + Description: "Checks a Kubernetes deployment for issues", Flags: []cli.Flag{ &cli.StringFlag{ @@ -42,10 +45,11 @@ func main() { Action: func(c *cli.Context) error { bubbletea := livelint.NewBubbleTeaInterface(tea.NewProgram(livelint.InitialModel())) namespace := c.String("namespace") - args := c.Args().First() - fmt.Println(args) app, err := app.New(namespace, c.Args().First(), bubbletea) if err != nil { + if err := cli.ShowSubcommandHelp(c) != nil; err { + log.Println(err) + } exitWithErr(err) } @@ -64,6 +68,19 @@ func main() { return nil }, + + OnUsageError: func(c *cli.Context, err error, isSubcommand bool) error { + if isSubcommand { + if err := cli.ShowSubcommandHelp(c) != nil; err { + log.Println(err) + } + } else { + if err := cli.ShowAppHelp(c) != nil; err { + log.Println(err) + } + } + return err + }, }, }, @@ -80,6 +97,6 @@ func main() { } func exitWithErr(err error) { - _, _ = fmt.Fprintf(os.Stderr, "failed to start livelint: %s\n", err) + _, _ = fmt.Fprintf(os.Stderr, "\nfailed to start livelint: %s\n", err) os.Exit(1) }