UX improvements for the 'jf setup' & 'jf project init' commands (#274)

Author: eyalbe4

general/envsetup/envsetup.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
+	"github.com/pkg/browser"
 	"net/http"
 	"net/url"
 	"strings"
@@ -18,8 +19,6 @@ import (
 	ioUtils "github.com/jfrog/jfrog-client-go/utils/io"
 	"github.com/jfrog/jfrog-client-go/utils/io/httputils"
 	"github.com/jfrog/jfrog-client-go/utils/log"
-
-	"github.com/pkg/browser"
 )
 
 const (
@@ -51,8 +50,10 @@ func NewEnvSetupCommand(url string) *EnvSetupCommand {
 }
 
 func (ftc *EnvSetupCommand) Run() (err error) {
+	fmt.Println("Thank you for installing JFrog CLI!")
+	ftc.progress.SetHeadlineMsg("To complete your JFrog environment setup, please fill out the details in your browser")
+	time.Sleep(5 * time.Second)
 	browser.OpenURL(ftc.registrationURL + "?id=" + ftc.id.String())
-	ftc.progress.SetHeadlineMsg("Thank you for installing JFrog CLI! To complete your JFrog environment setup, please fill out the details in your browser")
 	server, err := ftc.getNewServerDetails()
 	if err != nil {
 		return
@@ -61,12 +62,16 @@ func (ftc *EnvSetupCommand) Run() (err error) {
 	if err != nil {
 		return err
 	}
-	fmt.Println("Your new JFrog environment is ready!")
-	fmt.Println("	1. CD into your code project directory")
-	fmt.Println("	2. Run \"jf project init\"")
-	fmt.Println("	3. Read more about how to get started at - ")
-	fmt.Println("\t" + coreutils.GettingStartedGuideUrl)
-	return nil
+	message :=
+		coreutils.PrintBold("Your new JFrog environment is ready!") +
+			"\n" +
+			"1. CD into your code project directory\n" +
+			"2. Run \"jf project init\"\n" +
+			"3. Read more about how to get started at -\n" +
+			coreutils.PrintLink(coreutils.GettingStartedGuideUrl)
+
+	err = coreutils.PrintTable("", "", message)
+	return
 }
 
 func (ftc *EnvSetupCommand) CommandName() string {

general/project/projectinit.go

@@ -6,7 +6,6 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/gookit/color"
 	artifactoryCommandsUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
 	artifactoryUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
@@ -71,20 +70,26 @@ func (pic *ProjectInitCommand) Run() (err error) {
 	}
 
 	message :=
-		bold("You're all set!") +
+		coreutils.PrintBold("This project is initialized!\n") +
+			coreutils.PrintBold("The project config is stored inside the .jfrog directory.") +
 			"\n\n" +
-			bold("The project config is stored inside the .jfrog directory.") +
-			"\n\n" +
-			title("Audit your code project for security vulnerabilities by running") +
+			coreutils.PrintTitle("Audit your code project for security vulnerabilities by running") +
 			"\n" +
 			"jf audit\n\n" +
-			title("Scan any software package on this machine for security vulnerabilities by running") +
+			coreutils.PrintTitle("or if you're using VS Code, IntelliJ IDEA, WebStorm, PyCharm, Android Studio or GoLand") +
+			"\n" +
+			"Open the IDE\n" +
+			"Install the JFrog extension or plugin\n" +
+			"View the JFrog panel\n" +
+			"\n" +
+			coreutils.PrintTitle("Scan any software package on this machine for security vulnerabilities by running") +
 			"\n" +
 			"jf scan path/to/dir/or/package\n\n" +
+
 			pic.createBuildMessage(technologiesMap) +
-			title("Read more using this link:") +
+			coreutils.PrintTitle("Read more using this link:") +
 			"\n" +
-			link(coreutils.GettingStartedGuideUrl)
+			coreutils.PrintLink(coreutils.GettingStartedGuideUrl)
 	fmt.Println()
 	err = coreutils.PrintTable("", "", message)
 	fmt.Println()
@@ -111,51 +116,24 @@ func (pic *ProjectInitCommand) createBuildMessage(technologiesMap map[coreutils.
 			case coreutils.Pypi:
 				message +=
 					"jf pip install\n" +
-						"jf rt u path/to/package/file default-pypi-local" + comment(" # Publish your pip package") +
+						"jf rt u path/to/package/file default-pypi-local" +
+						coreutils.PrintComment(" # Publish your pip package") +
 						"\n"
 			}
 		}
 	}
 	if message != "" {
-		message = title("Build the code & deploy the packages by running") +
+		message = coreutils.PrintTitle("Build the code & deploy the packages by running") +
 			"\n" +
 			message +
 			"\n" +
-			title("Publish the build-info to Artifactory") +
+			coreutils.PrintTitle("Publish the build-info to Artifactory") +
 			"\n" +
 			"jf rt bp\n\n"
 	}
 	return message
 }
 
-// Print the test to the console in green color.
-func title(str string) string {
-	return colorStr(str, color.Green)
-}
-
-// Print the test to the console in cyan color.
-func link(str string) string {
-	return colorStr(str, color.Cyan)
-}
-
-// Print the test to the console with bold style.
-func bold(str string) string {
-	return colorStr(str, color.Bold)
-}
-
-// Print the test to the console in gray color.
-func comment(str string) string {
-	return colorStr(str, color.Gray)
-}
-
-// Print the test to the console with the specified color.
-func colorStr(str string, c color.Color) string {
-	if coreutils.IsTerminal() {
-		return c.Render(str)
-	}
-	return str
-}
-
 type BuildConfigFile struct {
 	Version    int    `yaml:"version,omitempty"`
 	ConfigType string `yaml:"type,omitempty"`

utils/coreutils/cmdutils.go

@@ -4,6 +4,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/gookit/color"
 	"github.com/mattn/go-shellwords"
 
 	"github.com/jfrog/jfrog-client-go/utils/errorutils"
@@ -198,3 +199,31 @@ func ParseArgs(args []string) ([]string, error) {
 func isQuote(s string) bool {
 	return len(s) > 0 && ((s[0] == '"' && s[len(s)-1] == '"') || (s[0] == '\'' && s[len(s)-1] == '\''))
 }
+
+// Print the test to the console in green color.
+func PrintTitle(str string) string {
+	return colorStr(str, color.Green)
+}
+
+// Print the test to the console in cyan color.
+func PrintLink(str string) string {
+	return colorStr(str, color.Cyan)
+}
+
+// Print the test to the console with bold style.
+func PrintBold(str string) string {
+	return colorStr(str, color.Bold)
+}
+
+// Print the test to the console in gray color.
+func PrintComment(str string) string {
+	return colorStr(str, color.Gray)
+}
+
+// Print the test to the console with the specified color.
+func colorStr(str string, c color.Color) string {
+	if IsTerminal() {
+		return c.Render(str)
+	}
+	return str
+}