Improve CLI output

Author: juho05

input/input.go renamed to cli/input.go

@@ -1,4 +1,4 @@
-package input
+package cli
 
 import (
 	"errors"

cli/output.go

@@ -0,0 +1,32 @@
+package cli
+
+import (
+	"errors"
+	"fmt"
+)
+
+func Info(format string, a ...any) {
+	fmt.Printf("%s\n", fmt.Sprintf(format, a...))
+}
+
+func Begin(format string, a ...any) {
+	fmt.Printf(format, a...)
+}
+
+func Finish() {
+	fmt.Print(" done.\n")
+}
+
+func Success(format string, a ...any) {
+	fmt.Printf("\x1b[32m%s\x1b[0m\n", fmt.Sprintf(format, a...))
+}
+
+func Warn(format string, a ...any) {
+	fmt.Printf("\x1b[33mWARNING: %s\x1b[0m\n", fmt.Sprintf(format, a...))
+}
+
+func Error(format string, a ...any) error {
+	message := fmt.Sprintf(format, a...)
+	fmt.Printf("\x1b[1;31mERROR: %s\x1b[0m\n", message)
+	return errors.New(message)
+}

commands/new.go

@@ -2,16 +2,14 @@ package commands
 
 import (
 	"encoding/json"
-	"errors"
-	"fmt"
 	"io"
 	"net/http"
 	"os"
 	"path/filepath"
 	"strings"
 
+	"github.com/code-game-project/codegame-cli/cli"
 	"github.com/code-game-project/codegame-cli/external"
-	"github.com/code-game-project/codegame-cli/input"
 	"github.com/ogier/pflag"
 )
 
@@ -21,19 +19,19 @@ func New() error {
 		project = strings.ToLower(pflag.Arg(1))
 	} else {
 		var err error
-		project, err = input.Select("Which type of project would you like to create?", []string{"Game Server", "Game Client"}, []string{"server", "client"})
+		project, err = cli.Select("Which type of project would you like to create?", []string{"Game Server", "Game Client"}, []string{"server", "client"})
 		if err != nil {
 			return err
 		}
 	}
 
-	projectName, err := input.Input("Project name:")
+	projectName, err := cli.Input("Project name:")
 	if err != nil {
 		return err
 	}
 
 	if _, err := os.Stat(projectName); err == nil {
-		return fmt.Errorf("Project '%s' already exists.", projectName)
+		return cli.Error("Project '%s' already exists.", projectName)
 	}
 
 	err = os.MkdirAll(projectName, 0755)
@@ -43,20 +41,28 @@ func New() error {
 
 	switch project {
 	case "server":
-		return newServer(projectName)
+		err = newServer(projectName)
 	case "client":
-		return newClient(projectName)
+		err = newClient(projectName)
 	default:
-		return fmt.Errorf("Unknown project type: %s", project)
+		err = cli.Error("Unknown project type: %s", project)
 	}
+
+	if err != nil {
+		os.RemoveAll(projectName)
+		return err
+	}
+
+	cli.Success("Successfully created project in '%s/'.", projectName)
+	return nil
 }
 
 func newServer(projectName string) error {
-	return errors.New("Not implemented.")
+	return cli.Error("Not implemented.")
 }
 
 func newClient(projectName string) error {
-	url, err := input.Input("Enter the URL of the game server:")
+	url, err := cli.Input("Enter the URL of the game server:")
 	if err != nil {
 		return err
 	}
@@ -85,7 +91,7 @@ func newClient(projectName string) error {
 		language = strings.ToLower(pflag.Arg(2))
 	} else {
 		var err error
-		language, err = input.Select("In which language do you want to write your project?", []string{"Go"}, []string{"go"})
+		language, err = cli.Select("In which language do you want to write your project?", []string{"Go"}, []string{"go"})
 		if err != nil {
 			return err
 		}
@@ -98,21 +104,19 @@ func newClient(projectName string) error {
 
 	err = external.CGGenEvents(eventsOutput, baseURL(url, ssl), cgeVersion, language)
 	if err != nil {
-		fmt.Fprintln(os.Stderr, "\x1b[31mFailed to generate event definitions:", err, "\x1b[0m")
+		cli.Error("Failed to generate event definitions: %s", err)
 	}
 
 	switch language {
 	case "go":
 		err = newClientGo(projectName, url, cgVersion)
 	default:
-		return fmt.Errorf("Unsupported language: %s", language)
+		return cli.Error("Unsupported language: %s", language)
 	}
 	if err != nil {
 		return err
 	}
 
-	fmt.Printf("\x1b[32mSuccessfully created project in '%s'.\n\x1b[0m", projectName)
-
 	return nil
 }
 
@@ -122,30 +126,30 @@ func getCodeGameInfo(baseURL string) (string, string, error) {
 		CGVersion string `json:"cg_version"`
 	}
 	res, err := http.Get(baseURL + "/info")
-	if err != nil {
-		return "", "", err
+	if err != nil || res.StatusCode != http.StatusOK {
+		return "", "", cli.Error("Couldn't access /info endpoint.")
 	}
 	defer res.Body.Close()
 
 	var data response
 	err = json.NewDecoder(res.Body).Decode(&data)
 	if err != nil {
-		return "", "", err
+		return "", "", cli.Error("Couldn't decode /info data.")
 	}
 
 	return data.Name, data.CGVersion, nil
 }
 
 func getCGEVersion(baseURL string) (string, error) {
 	res, err := http.Get(baseURL + "/events")
-	if err != nil {
-		return "", err
+	if err != nil || res.StatusCode != http.StatusOK {
+		return "", cli.Error("Couldn't access /events endpoint.")
 	}
 	defer res.Body.Close()
 
 	data, err := io.ReadAll(res.Body)
 	if err != nil {
-		return "", err
+		return "", cli.Error("Couldn't read /events file.")
 	}
 	return parseCGEVersion([]rune(string(data))), nil
 }

commands/new_go.go

@@ -9,8 +9,8 @@ import (
 
 	_ "embed"
 
+	"github.com/code-game-project/codegame-cli/cli"
 	"github.com/code-game-project/codegame-cli/external"
-	"github.com/code-game-project/codegame-cli/input"
 )
 
 //go:embed templates/main.go.tmpl
@@ -27,20 +27,28 @@ func newClientGo(projectName, serverURL, cgVersion string) error {
 		return err
 	}
 
+	cli.Begin("Cleaning up...")
 	err = external.ExecuteInDir(projectName, "go", "mod", "tidy")
 	if err != nil {
 		return err
 	}
 
-	return external.ExecuteInDir(projectName, "goimports", "-w", "main.go")
+	err = external.ExecuteInDir(projectName, "goimports", "-w", "main.go")
+	if err != nil {
+		cli.Warn("Failed to add import statements: %s", err)
+	}
+	cli.Finish()
+
+	return nil
 }
 
 func createGoTemplate(projectName, serverURL string) error {
-	module, err := input.Input("Project module path:")
+	module, err := cli.Input("Project module path:")
 	if err != nil {
 		return err
 	}
 
+	cli.Begin("Creating project template...")
 	out, err := external.ExecuteInDirHidden(projectName, "go", "mod", "init", module)
 	if err != nil {
 		fmt.Println(out)
@@ -62,12 +70,16 @@ func createGoTemplate(projectName, serverURL string) error {
 		URL string
 	}
 
-	return tmpl.Execute(file, data{
+	err = tmpl.Execute(file, data{
 		URL: serverURL,
 	})
+	cli.Finish()
+	return err
 }
 
 func installGoLibrary(projectName, cgVersion string) error {
+	cli.Begin("Fetching correct client library version...")
+
 	clientVersion := external.ClientVersionFromCGVersion("code-game-project", "go-client", cgVersion)
 
 	if clientVersion == "latest" {
@@ -88,10 +100,14 @@ func installGoLibrary(projectName, cgVersion string) error {
 		path = fmt.Sprintf("github.com/code-game-project/go-client/v%s/cg", majorVersion)
 	}
 	path += "@" + tag
+	cli.Finish()
 
+	cli.Begin("Installing dependencies...")
 	out, err := external.ExecuteInDirHidden(projectName, "go", "get", path)
 	if err != nil {
-		fmt.Println(out)
+		cli.Error(out)
+		return err
 	}
-	return err
+	cli.Finish()
+	return nil
 }

external/external.go

@@ -12,6 +12,8 @@ import (
 	"runtime"
 	"strconv"
 	"strings"
+
+	"github.com/code-game-project/codegame-cli/cli"
 )
 
 var ErrTagNotFound = errors.New("tag not found")
@@ -62,7 +64,7 @@ func GetUsername() string {
 		return strings.TrimSpace(user.Username)
 	}
 
-	fmt.Println("Make sure to replace <your-name> with your actual name.")
+	cli.Info("Make sure to replace <your-name> with your actual name.")
 	return "<your-name>"
 }
 
@@ -75,14 +77,14 @@ func OpenBrowser(url string) error {
 	case "darwin":
 		return exec.Command("open", url).Start()
 	default:
-		return fmt.Errorf("unsupported platform")
+		return fmt.Errorf("Unsupported platform.")
 	}
 }
 
 func GithubTagFromVersion(owner, repo, version string) (string, error) {
 	res, err := http.Get(fmt.Sprintf("https://api.github.com/repos/%s/%s/tags", owner, repo))
-	if err != nil {
-		return "", err
+	if err != nil || res.StatusCode != http.StatusOK {
+		return "", cli.Error("Couldn't access git tags from 'github.com/%s/%s'.", owner, repo)
 	}
 	defer res.Body.Close()
 	type response []struct {
@@ -91,7 +93,7 @@ func GithubTagFromVersion(owner, repo, version string) (string, error) {
 	var data response
 	err = json.NewDecoder(res.Body).Decode(&data)
 	if err != nil {
-		return "", err
+		return "", cli.Error("Couldn't decode git tag data.")
 	}
 
 	for _, tag := range data {
@@ -104,16 +106,16 @@ func GithubTagFromVersion(owner, repo, version string) (string, error) {
 
 func ClientVersionFromCGVersion(owner, repo, cgVersion string) string {
 	res, err := http.Get(fmt.Sprintf("https://raw.githubusercontent.com/%s/%s/main/versions.json", owner, repo))
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Couldn't fetch versions.json. Using latest client library version.\n\x1b[0m")
+	if err != nil || res.StatusCode != http.StatusOK {
+		cli.Warn("Couldn't fetch versions.json. Using latest client library version.")
 		return "latest"
 	}
 	defer res.Body.Close()
 
 	var versions map[string]string
 	err = json.NewDecoder(res.Body).Decode(&versions)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Invalid versions.json. Using latest client library version.\n\x1b[0m")
+		cli.Warn("Invalid versions.json. Using latest client library version.")
 		return "latest"
 	}
 
@@ -124,7 +126,7 @@ func ClientVersionFromCGVersion(owner, repo, cgVersion string) string {
 
 	parts := strings.Split(cgVersion, ".")
 	if len(parts) < 2 {
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Invalid versions.json. Using latest client library version.\n\x1b[0m")
+		cli.Warn("Invalid versions.json. Using latest client library version.")
 		return "latest"
 	}
 	major := parts[0]
@@ -134,28 +136,28 @@ func ClientVersionFromCGVersion(owner, repo, cgVersion string) string {
 	for v := range versions {
 		clientParts := strings.Split(v, ".")
 		if len(clientParts) < 2 {
-			fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Invalid versions.json. Using latest client library version.\n\x1b[0m")
+			cli.Warn("Invalid versions.json. Using latest client library version.")
 			return "latest"
 		}
 		clientMajor := clientParts[0]
 		if major == clientMajor {
 			minor, err := strconv.Atoi(clientParts[1])
 			if err != nil {
-				fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Invalid versions.json. Using latest client library version.\n\x1b[0m")
+				cli.Warn("Invalid versions.json. Using latest client library version.")
 				return "latest"
 			}
 			compatibleMinorVersions = append(compatibleMinorVersions, minor)
 		}
 	}
 	if len(compatibleMinorVersions) == 0 {
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: No compatible client library version found. Using latest client library version.\n\x1b[0m")
+		cli.Warn("No compatible client library version found. Using latest client library version.")
 		return "latest"
 	}
 
 	minorStr := parts[1]
 	minor, err := strconv.Atoi(minorStr)
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: Invalid versions.json. Using latest client library version.\n\x1b[0m")
+		cli.Warn("Invalid versions.json. Using latest client library version.")
 		return "latest"
 	}
 
@@ -168,7 +170,7 @@ func ClientVersionFromCGVersion(owner, repo, cgVersion string) string {
 	}
 	if closestMinor >= 0 {
 		v := fmt.Sprintf("%s.%d", major, minor)
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: No exact version match found. Using client library version %s.\n\x1b[0m", v)
+		cli.Warn("No exact version match found. Using client library version %s.", v)
 		return v
 	}
 
@@ -181,10 +183,10 @@ func ClientVersionFromCGVersion(owner, repo, cgVersion string) string {
 	}
 	if closestMinor >= 0 {
 		v := fmt.Sprintf("%s.%d", major, minor)
-		fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: No exact version match found. Using client library version %s.\n\x1b[0m", v)
+		cli.Warn("No exact version match found. Using client library version %s.")
 		return v
 	}
 
-	fmt.Fprintf(os.Stderr, "\x1b[33mWARNING: No compatible client library version found. Using latest client library version.\n\x1b[0m")
+	cli.Warn("No compatible client library version found. Using latest client library version.")
 	return "latest"
 }