Merge pull request #78 from ilmanzo/fix_help_messages

Fix help message handling

Author: ilmanzo

cmd/funkoverage.go

@@ -8,13 +8,13 @@ import (
 	"strings"
 )
 
-const versionString = "0.4.4"
+const versionString = "0.4.5"
 
 // --- CLI ---
 
 func main() {
 	if len(os.Args) < 2 {
-		fmt.Println(helpText)
+		fmt.Print(helpText)
 		os.Exit(1)
 	}
 
@@ -24,9 +24,24 @@ func main() {
 	reportCmd := flag.NewFlagSet("report", flag.ExitOnError)
 	reportFormats := reportCmd.String("formats", "html,txt,xml", "Comma-separated list: html,xml,txt (default: html,txt,xml)")
 
+	wrapCmd.Usage = func() {
+		fmt.Print(wrapHelpText)
+		wrapCmd.PrintDefaults()
+	}
+
+	unwrapCmd.Usage = func() {
+		fmt.Print(unwrapHelpText)
+		unwrapCmd.PrintDefaults()
+	}
+
+	reportCmd.Usage = func() {
+		fmt.Print(reportHelpText)
+		reportCmd.PrintDefaults()
+	}
+
 	switch os.Args[1] {
 	case "help", "--help", "-h":
-		fmt.Println(helpText)
+		fmt.Print(helpText)
 		return
 	case "version", "--version", "-v":
 		fmt.Println("funkoverage version", versionString)
@@ -114,7 +129,7 @@ func main() {
 		}
 	default:
 		fmt.Println("Unknown command:", os.Args[1])
-		fmt.Println(helpText)
+		fmt.Print(helpText)
 		os.Exit(1)
 	}
 }

cmd/templates.go

@@ -1,35 +1,59 @@
 package main
 
-import _ "embed"
+import (
+	_ "embed"
+	"fmt"
+	"strings"
+)
 
 //go:embed templates/detailed.html
 var detailedHTMLTemplateStr string
 
 //go:embed templates/aggregate.html
 var aggregateHTMLTemplate string
 
-const helpText = `Usage:
-  wrap /path/to/binary
-      Wrap the given ELF binary with the Pin coverage wrapper.
+const wrapHelpText = `Usage: funkoverage wrap /path/to/binary
+Wrap the given ELF binary with the Pin coverage wrapper.`
 
-  unwrap /path/to/binary
-      Restore the original binary previously wrapped.
+const unwrapHelpText = `Usage: funkoverage unwrap /path/to/binary
+Restore the original binary previously wrapped.`
 
-  report <inputdir|log1.txt,log2.txt> <outputdir> [--formats <formats>]
-      Generate coverage reports from log files.
-      <inputdir>         Directory containing .log files (all will be used)
-      log1.txt,log2.txt  Comma-separated list of log files
-      <outputdir>        Output directory for reports (mandatory)
-      --formats          Comma-separated list: html,xml,txt (default: html,txt,xml)
+const reportHelpText = `Usage: funkoverage report <inputdir|log1.txt,log2.txt> <outputdir> [--formats <formats>]
 
+Generate coverage reports from log files.
+  <inputdir>         Directory containing .log files (all will be used)
+  log1.txt,log2.txt  Comma-separated list of log files
+  <outputdir>        Output directory for reports (mandatory)
+  --formats          Comma-separated list: html,xml,txt (default: html,txt,xml)
+`
+
+var helpText string
+
+func init() {
+	// We use fmt.Sprintf to build the main help text from the subcommand help texts
+	// to avoid duplication. The subcommand help texts are modified slightly for
+	// proper formatting in the main help view.
+	helpText = fmt.Sprintf(`Usage:
+  %s
+  %s
+  %s
   help
       Show this help message.
-
   version
       Show program version.
 
 Environment variables:
   PIN_ROOT            Path to Intel Pin root directory (default: autodetect or required)
   PIN_TOOL_SEARCH_DIR Directory to search for FuncTracer.so (default: /usr/lib64/coverage-tools)
   LOG_DIR             Directory for coverage logs (default: /var/coverage/data)
-  SAFE_BIN_DIR        Directory to store original binaries (default: /var/coverage/bin)`
+  SAFE_BIN_DIR        Directory to store original binaries (default: /var/coverage/bin)
+`,
+		indent(strings.TrimPrefix(wrapHelpText, "Usage: funkoverage "), "  "),
+		indent(strings.TrimPrefix(unwrapHelpText, "Usage: funkoverage "), "  "),
+		indent(strings.TrimPrefix(reportHelpText, "Usage: funkoverage "), "  "))
+}
+
+// indent adds indentation to each line of a string.
+func indent(text, indentation string) string {
+	return indentation + strings.ReplaceAll(strings.TrimSpace(text), "\n", "\n"+indentation)
+}