Add custom help message and upgrade notification (#809)

* Add custom help message and upgrade notification * Updated wording * changing colors/adding » * lipgloss border --------- Co-authored-by: Andriy Knysh <[email protected]>
cloudposse · Dec 5, 2024 · 31d7c5e · 31d7c5e
1 parent 382de94
commit 31d7c5e
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 8 deletions.
diff --git a/cmd/cmd_utils.go b/cmd/cmd_utils.go
@@ -8,6 +8,7 @@ import (
 	"path"
 	"strings"
 
+	"github.com/charmbracelet/lipgloss"
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
@@ -16,6 +17,7 @@ import (
 	cfg "github.com/cloudposse/atmos/pkg/config"
 	"github.com/cloudposse/atmos/pkg/schema"
 	u "github.com/cloudposse/atmos/pkg/utils"
+	"github.com/cloudposse/atmos/pkg/version"
 )
 
 // ValidateConfig holds configuration options for Atmos validation.
@@ -429,17 +431,50 @@ func printMessageForMissingAtmosConfig(cliConfig schema.CliConfiguration) {
 
 // printMessageToUpgradeToAtmosLatestRelease prints info on how to upgrade Atmos to the latest version
 func printMessageToUpgradeToAtmosLatestRelease(latestVersion string) {
-	c1 := color.New(color.FgCyan)
-	c2 := color.New(color.FgGreen)
+	// Define colors
+	c1 := lipgloss.NewStyle().Foreground(lipgloss.Color("8"))
+	c2 := lipgloss.NewStyle().Foreground(lipgloss.Color("10"))
+	c3 := lipgloss.NewStyle().Foreground(lipgloss.Color("14"))
+
+	// Define content
+	message := lipgloss.NewStyle().
+		Render(fmt.Sprintf("Update available! %s » %s",
+			c1.Render(version.Version),
+			c2.Render(latestVersion)))
+
+	links := []string{lipgloss.NewStyle().Render(fmt.Sprintf("Atmos Releases: %s", c3.Render("https://github.com/cloudposse/atmos/releases"))),
+		lipgloss.NewStyle().Render(fmt.Sprintf("Install Atmos: %s", c3.Render("https://atmos.tools/install"))),
+	}
+
+	messageLines := append([]string{message}, links...)
+	messageContent := strings.Join(messageLines, "\n")
 
-	u.PrintMessageInColor(fmt.Sprintf("\nYour version of Atmos is out of date. The latest version is %s\n\n", latestVersion), c1)
-	u.PrintMessage("To upgrade Atmos, refer to the following links and documents:\n")
+	// Define box
+	boxStyle := lipgloss.NewStyle().
+		Border(lipgloss.RoundedBorder()).
+		BorderForeground(lipgloss.Color("10")).
+		Padding(0, 1).
+		Align(lipgloss.Center)
 
-	u.PrintMessageInColor("Atmos Releases:\n", c2)
-	u.PrintMessage("https://github.com/cloudposse/atmos/releases\n")
+	// Render the box
+	box := boxStyle.Render(messageContent)
 
-	u.PrintMessageInColor("Install Atmos:\n", c2)
-	u.PrintMessage("https://atmos.tools/install\n")
+	// Print the box
+	fmt.Println(box)
+}
+
+// customHelpMessageToUpgradeToAtmosLatestRelease adds Atmos version info at the end of each help commnad
+func customHelpMessageToUpgradeToAtmosLatestRelease(cmd *cobra.Command, args []string) {
+	originalHelpFunc(cmd, args)
+	// Check for the latest Atmos release on GitHub
+	latestReleaseTag, err := u.GetLatestGitHubRepoRelease("cloudposse", "atmos")
+	if err == nil && latestReleaseTag != "" {
+		latestRelease := strings.TrimPrefix(latestReleaseTag, "v")
+		currentRelease := strings.TrimPrefix(version.Version, "v")
+		if latestRelease != currentRelease {
+			printMessageToUpgradeToAtmosLatestRelease(latestRelease)
+		}
+	}
 }
 
 // Check Atmos is version command

diff --git a/cmd/root.go b/cmd/root.go
@@ -18,6 +18,9 @@ import (
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
 
+// originalHelpFunc holds Cobra's original help function to avoid recursion.
+var originalHelpFunc func(*cobra.Command, []string)
+
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
 	Use:   "atmos",
@@ -69,6 +72,14 @@ func Execute() error {
 		Flags:    cc.Bold,
 	})
 
+	// Save the original help function to prevent infinite recursion when overriding it.
+	// This allows us to call the original help functionality within our custom help function.
+	originalHelpFunc = RootCmd.HelpFunc()
+
+	// Override the help function with a custom one that adds an upgrade message after displaying help.
+	// This custom help function will call the original help function and then display the bordered message.
+	RootCmd.SetHelpFunc(customHelpMessageToUpgradeToAtmosLatestRelease)
+
 	// Check if the `help` flag is passed and print a styled Atmos logo to the terminal before printing the help
 	err := RootCmd.ParseFlags(os.Args)
 	if err != nil && errors.Is(err, pflag.ErrHelp) {