From b1d83fe294e3082e4def167e7b891b9c5c81a80c Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Fri, 3 Sep 2021 11:33:33 -0400 Subject: [PATCH 1/4] codespace flag, deprecate argument --- cmd/ghcs/logs.go | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/cmd/ghcs/logs.go b/cmd/ghcs/logs.go index 49acb3449..fd92ff739 100644 --- a/cmd/ghcs/logs.go +++ b/cmd/ghcs/logs.go @@ -13,21 +13,27 @@ import ( ) func newLogsCmd() *cobra.Command { - var tail bool + var ( + codespace string + tail bool + ) + + log := output.NewLogger(os.Stdout, os.Stderr, false) logsCmd := &cobra.Command{ - Use: "logs []", + Use: "logs", Short: "Access codespace logs", Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - var codespaceName string if len(args) > 0 { - codespaceName = args[0] + log.Println(" argument is deprecated. Use --codespace instead.") + codespace = args[0] } - return logs(context.Background(), tail, codespaceName) + return logs(context.Background(), log, codespace, tail) }, } + logsCmd.Flags().StringVarP(&codespace, "codespace", "c", "", "Name of the codespace") logsCmd.Flags().BoolVarP(&tail, "tail", "t", false, "Tail the logs") return logsCmd @@ -37,13 +43,12 @@ func init() { rootCmd.AddCommand(newLogsCmd()) } -func logs(ctx context.Context, tail bool, codespaceName string) error { +func logs(ctx context.Context, log *output.Logger, codespaceName string, tail bool) error { // Ensure all child tasks (port forwarding, remote exec) terminate before return. ctx, cancel := context.WithCancel(ctx) defer cancel() apiClient := api.New(os.Getenv("GITHUB_TOKEN")) - log := output.NewLogger(os.Stdout, os.Stderr, false) user, err := apiClient.GetUser(ctx) if err != nil { From 9193b03b696eb0f91eb0f7d1273b3aed38f514f5 Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Fri, 3 Sep 2021 12:40:01 -0400 Subject: [PATCH 2/4] introduce follow, deprecate tail --- cmd/ghcs/logs.go | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/cmd/ghcs/logs.go b/cmd/ghcs/logs.go index fd92ff739..69ec12c42 100644 --- a/cmd/ghcs/logs.go +++ b/cmd/ghcs/logs.go @@ -16,6 +16,7 @@ func newLogsCmd() *cobra.Command { var ( codespace string tail bool + follow bool ) log := output.NewLogger(os.Stdout, os.Stderr, false) @@ -29,12 +30,17 @@ func newLogsCmd() *cobra.Command { log.Println(" argument is deprecated. Use --codespace instead.") codespace = args[0] } - return logs(context.Background(), log, codespace, tail) + if tail { + log.Println("--tail flag is deprecated. Use --follow instead.") + follow = true + } + return logs(context.Background(), log, codespace, follow) }, } logsCmd.Flags().StringVarP(&codespace, "codespace", "c", "", "Name of the codespace") - logsCmd.Flags().BoolVarP(&tail, "tail", "t", false, "Tail the logs") + logsCmd.Flags().BoolVarP(&tail, "tail", "t", false, "Tail the logs (deprecated, use --follow)") + logsCmd.Flags().BoolVarP(&follow, "follow", "f", false, "Tail and follow the logs") return logsCmd } From b79ea871fd38c1ba4d6b3f8a995a1754a72eb651 Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Fri, 3 Sep 2021 16:04:00 -0400 Subject: [PATCH 3/4] rename arg --- cmd/ghcs/logs.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/ghcs/logs.go b/cmd/ghcs/logs.go index 69ec12c42..8a83b252a 100644 --- a/cmd/ghcs/logs.go +++ b/cmd/ghcs/logs.go @@ -49,7 +49,7 @@ func init() { rootCmd.AddCommand(newLogsCmd()) } -func logs(ctx context.Context, log *output.Logger, codespaceName string, tail bool) error { +func logs(ctx context.Context, log *output.Logger, codespaceName string, follow bool) error { // Ensure all child tasks (port forwarding, remote exec) terminate before return. ctx, cancel := context.WithCancel(ctx) defer cancel() @@ -82,7 +82,7 @@ func logs(ctx context.Context, log *output.Logger, codespaceName string, tail bo } cmdType := "cat" - if tail { + if follow { cmdType = "tail -f" } From c86cd34f5ef9680de672d388b8d9a1dc2c4e35b3 Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Wed, 8 Sep 2021 13:38:27 -0400 Subject: [PATCH 4/4] switch to Errorln --- cmd/ghcs/logs.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/ghcs/logs.go b/cmd/ghcs/logs.go index 49369d1c0..15929c9bb 100644 --- a/cmd/ghcs/logs.go +++ b/cmd/ghcs/logs.go @@ -29,11 +29,11 @@ func newLogsCmd() *cobra.Command { Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { if len(args) > 0 { - log.Println(" argument is deprecated. Use --codespace instead.") + log.Errorln(" argument is deprecated. Use --codespace instead.") codespace = args[0] } if tail { - log.Println("--tail flag is deprecated. Use --follow instead.") + log.Errorln("--tail flag is deprecated. Use --follow instead.") follow = true } return logs(context.Background(), log, codespace, follow)