Merge pull request #2 from dAppCore/dev

Enhance CLI functionality with JSON output and improved help commands

Author: Snider

cmd/core/config/cmd.go

@@ -6,6 +6,8 @@ import (
 )
 
 // AddConfigCommands registers the 'config' command group and all subcommands.
+//
+//	config.AddConfigCommands(rootCmd)
 func AddConfigCommands(root *cli.Command) {
 	configCmd := cli.NewGroup("config", "Manage configuration", "")
 	root.AddCommand(configCmd)
@@ -17,9 +19,9 @@ func AddConfigCommands(root *cli.Command) {
 }
 
 func loadConfig() (*config.Config, error) {
-	cfg, err := config.New()
+	configuration, err := config.New()
 	if err != nil {
 		return nil, cli.Wrap(err, "failed to load config")
 	}
-	return cfg, nil
+	return configuration, nil
 }

cmd/core/config/cmd_get.go

@@ -1,26 +1,24 @@
 package config
 
 import (
-	"fmt"
-
 	"forge.lthn.ai/core/cli/pkg/cli"
 )
 
 func addGetCommand(parent *cli.Command) {
 	cmd := cli.NewCommand("get", "Get a configuration value", "", func(cmd *cli.Command, args []string) error {
 		key := args[0]
 
-		cfg, err := loadConfig()
+		configuration, err := loadConfig()
 		if err != nil {
 			return err
 		}
 
 		var value any
-		if err := cfg.Get(key, &value); err != nil {
+		if err := configuration.Get(key, &value); err != nil {
 			return cli.Err("key not found: %s", key)
 		}
 
-		fmt.Println(value)
+		cli.Println("%v", value)
 		return nil
 	})
 

cmd/core/config/cmd_list.go

@@ -1,7 +1,6 @@
 package config
 
 import (
-	"fmt"
 	"maps"
 
 	"forge.lthn.ai/core/cli/pkg/cli"
@@ -10,23 +9,23 @@ import (
 
 func addListCommand(parent *cli.Command) {
 	cmd := cli.NewCommand("list", "List all configuration values", "", func(cmd *cli.Command, args []string) error {
-		cfg, err := loadConfig()
+		configuration, err := loadConfig()
 		if err != nil {
 			return err
 		}
 
-		all := maps.Collect(cfg.All())
+		all := maps.Collect(configuration.All())
 		if len(all) == 0 {
 			cli.Dim("No configuration values set")
 			return nil
 		}
 
-		out, err := yaml.Marshal(all)
+		output, err := yaml.Marshal(all)
 		if err != nil {
 			return cli.Wrap(err, "failed to format config")
 		}
 
-		fmt.Print(string(out))
+		cli.Print("%s", string(output))
 		return nil
 	})
 

cmd/core/config/cmd_path.go

@@ -1,19 +1,17 @@
 package config
 
 import (
-	"fmt"
-
 	"forge.lthn.ai/core/cli/pkg/cli"
 )
 
 func addPathCommand(parent *cli.Command) {
 	cmd := cli.NewCommand("path", "Show the configuration file path", "", func(cmd *cli.Command, args []string) error {
-		cfg, err := loadConfig()
+		configuration, err := loadConfig()
 		if err != nil {
 			return err
 		}
 
-		fmt.Println(cfg.Path())
+		cli.Println("%s", configuration.Path())
 		return nil
 	})
 

cmd/core/config/cmd_set.go

@@ -9,12 +9,12 @@ func addSetCommand(parent *cli.Command) {
 		key := args[0]
 		value := args[1]
 
-		cfg, err := loadConfig()
+		configuration, err := loadConfig()
 		if err != nil {
 			return err
 		}
 
-		if err := cfg.Set(key, value); err != nil {
+		if err := configuration.Set(key, value); err != nil {
 			return cli.Wrap(err, "failed to set config value")
 		}
 

cmd/core/doctor/cmd_checks.go

@@ -2,8 +2,8 @@ package doctor
 
 import (
 	"os/exec"
-	"strings"
 
+	"dappco.re/go/core"
 	"forge.lthn.ai/core/go-i18n"
 )
 
@@ -26,6 +26,13 @@ func requiredChecks() []check {
 			args:        []string{"--version"},
 			versionFlag: "--version",
 		},
+		{
+			name:        i18n.T("cmd.doctor.check.go.name"),
+			description: i18n.T("cmd.doctor.check.go.description"),
+			command:     "go",
+			args:        []string{"version"},
+			versionFlag: "version",
+		},
 		{
 			name:        i18n.T("cmd.doctor.check.gh.name"),
 			description: i18n.T("cmd.doctor.check.gh.description"),
@@ -84,18 +91,20 @@ func optionalChecks() []check {
 	}
 }
 
-// runCheck executes a tool check and returns success status and version info
-func runCheck(c check) (bool, string) {
-	cmd := exec.Command(c.command, c.args...)
-	output, err := cmd.CombinedOutput()
+// runCheck executes a tool check and returns success status and version info.
+//
+//	ok, version := runCheck(check{command: "git", args: []string{"--version"}})
+func runCheck(toolCheck check) (bool, string) {
+	proc := exec.Command(toolCheck.command, toolCheck.args...)
+	output, err := proc.CombinedOutput()
 	if err != nil {
 		return false, ""
 	}
 
-	// Extract first line as version
-	lines := strings.Split(strings.TrimSpace(string(output)), "\n")
+	// Extract first line as version info.
+	lines := core.Split(core.Trim(string(output)), "\n")
 	if len(lines) > 0 {
-		return true, strings.TrimSpace(lines[0])
+		return true, core.Trim(lines[0])
 	}
 	return true, ""
 }

cmd/core/doctor/cmd_checks_test.go

@@ -0,0 +1,22 @@
+package doctor
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRequiredChecksIncludesGo(t *testing.T) {
+	checks := requiredChecks()
+
+	var found bool
+	for _, c := range checks {
+		if c.command == "go" {
+			found = true
+			assert.Equal(t, "version", c.versionFlag)
+			break
+		}
+	}
+
+	assert.True(t, found, "required checks should include the Go compiler")
+}

cmd/core/doctor/cmd_commands.go

@@ -16,6 +16,8 @@ import (
 )
 
 // AddDoctorCommands registers the 'doctor' command and all subcommands.
+//
+//	doctor.AddDoctorCommands(rootCmd)
 func AddDoctorCommands(root *cobra.Command) {
 	doctorCmd.Short = i18n.T("cmd.doctor.short")
 	doctorCmd.Long = i18n.T("cmd.doctor.long")

cmd/core/doctor/cmd_doctor.go

@@ -2,9 +2,6 @@
 package doctor
 
 import (
-	"errors"
-	"fmt"
-
 	"forge.lthn.ai/core/cli/pkg/cli"
 	"forge.lthn.ai/core/go-i18n"
 	"github.com/spf13/cobra"
@@ -32,89 +29,89 @@ func init() {
 }
 
 func runDoctor(verbose bool) error {
-	fmt.Println(i18n.T("common.progress.checking", map[string]any{"Item": "development environment"}))
-	fmt.Println()
+	cli.Println("%s", i18n.T("common.progress.checking", map[string]any{"Item": "development environment"}))
+	cli.Blank()
 
 	var passed, failed, optional int
 
 	// Check required tools
-	fmt.Println(i18n.T("cmd.doctor.required"))
-	for _, c := range requiredChecks() {
-		ok, version := runCheck(c)
+	cli.Println("%s", i18n.T("cmd.doctor.required"))
+	for _, toolCheck := range requiredChecks() {
+		ok, version := runCheck(toolCheck)
 		if ok {
 			if verbose {
-				fmt.Println(formatCheckResult(true, c.name, version))
+				cli.Println("%s", formatCheckResult(true, toolCheck.name, version))
 			} else {
-				fmt.Println(formatCheckResult(true, c.name, ""))
+				cli.Println("%s", formatCheckResult(true, toolCheck.name, ""))
 			}
 			passed++
 		} else {
-			fmt.Printf("  %s %s - %s\n", errorStyle.Render(cli.Glyph(":cross:")), c.name, c.description)
+			cli.Println("  %s %s - %s", errorStyle.Render(cli.Glyph(":cross:")), toolCheck.name, toolCheck.description)
 			failed++
 		}
 	}
 
 	// Check optional tools
-	fmt.Printf("\n%s\n", i18n.T("cmd.doctor.optional"))
-	for _, c := range optionalChecks() {
-		ok, version := runCheck(c)
+	cli.Println("\n%s", i18n.T("cmd.doctor.optional"))
+	for _, toolCheck := range optionalChecks() {
+		ok, version := runCheck(toolCheck)
 		if ok {
 			if verbose {
-				fmt.Println(formatCheckResult(true, c.name, version))
+				cli.Println("%s", formatCheckResult(true, toolCheck.name, version))
 			} else {
-				fmt.Println(formatCheckResult(true, c.name, ""))
+				cli.Println("%s", formatCheckResult(true, toolCheck.name, ""))
 			}
 			passed++
 		} else {
-			fmt.Printf("  %s %s - %s\n", dimStyle.Render(cli.Glyph(":skip:")), c.name, dimStyle.Render(c.description))
+			cli.Println("  %s %s - %s", dimStyle.Render(cli.Glyph(":skip:")), toolCheck.name, dimStyle.Render(toolCheck.description))
 			optional++
 		}
 	}
 
 	// Check GitHub access
-	fmt.Printf("\n%s\n", i18n.T("cmd.doctor.github"))
+	cli.Println("\n%s", i18n.T("cmd.doctor.github"))
 	if checkGitHubSSH() {
-		fmt.Println(formatCheckResult(true, i18n.T("cmd.doctor.ssh_found"), ""))
+		cli.Println("%s", formatCheckResult(true, i18n.T("cmd.doctor.ssh_found"), ""))
 	} else {
-		fmt.Printf("  %s %s\n", errorStyle.Render(cli.Glyph(":cross:")), i18n.T("cmd.doctor.ssh_missing"))
+		cli.Println("  %s %s", errorStyle.Render(cli.Glyph(":cross:")), i18n.T("cmd.doctor.ssh_missing"))
 		failed++
 	}
 
 	if checkGitHubCLI() {
-		fmt.Println(formatCheckResult(true, i18n.T("cmd.doctor.cli_auth"), ""))
+		cli.Println("%s", formatCheckResult(true, i18n.T("cmd.doctor.cli_auth"), ""))
 	} else {
-		fmt.Printf("  %s %s\n", errorStyle.Render(cli.Glyph(":cross:")), i18n.T("cmd.doctor.cli_auth_missing"))
+		cli.Println("  %s %s", errorStyle.Render(cli.Glyph(":cross:")), i18n.T("cmd.doctor.cli_auth_missing"))
 		failed++
 	}
 
 	// Check workspace
-	fmt.Printf("\n%s\n", i18n.T("cmd.doctor.workspace"))
+	cli.Println("\n%s", i18n.T("cmd.doctor.workspace"))
 	checkWorkspace()
 
 	// Summary
-	fmt.Println()
+	cli.Blank()
 	if failed > 0 {
 		cli.Error(i18n.T("cmd.doctor.issues", map[string]any{"Count": failed}))
-		fmt.Printf("\n%s\n", i18n.T("cmd.doctor.install_missing"))
+		cli.Println("\n%s", i18n.T("cmd.doctor.install_missing"))
 		printInstallInstructions()
-		return errors.New(i18n.T("cmd.doctor.issues_error", map[string]any{"Count": failed}))
+		return cli.Err("%s", i18n.T("cmd.doctor.issues_error", map[string]any{"Count": failed}))
 	}
 
 	cli.Success(i18n.T("cmd.doctor.ready"))
 	return nil
 }
 
 func formatCheckResult(ok bool, name, detail string) string {
-	check := cli.Check(name)
+	checkBuilder := cli.Check(name)
 	if ok {
-		check.Pass()
+		checkBuilder.Pass()
 	} else {
-		check.Fail()
+		checkBuilder.Fail()
 	}
 	if detail != "" {
-		check.Message(detail)
+		checkBuilder.Message(detail)
 	} else {
-		check.Message("")
+		checkBuilder.Message("")
 	}
-	return check.String()
+	return checkBuilder.String()
 }