From 6edce3f6ff8e392d53cc117b7761b94fe0922f67 Mon Sep 17 00:00:00 2001
From: Eric Cornelissen <ericornelissen@gmail.com>
Date: Sat, 9 Mar 2024 12:48:05 +0100
Subject: [PATCH] Improve error messaging

Update the CLI with better error messaging based on two principles:
- Try to help the user fix the error (achieved e.g. by suggesting to use
  an explicit target when the current working directory can't be
  determined).
- Including the full error which the user can use to debug or in bug
  reports.

Signed-off-by: Eric Cornelissen <ericornelissen@gmail.com>
---
 cmd/ades/main.go | 5 +++--
 test/stdin.txtar | 2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/cmd/ades/main.go b/cmd/ades/main.go
index 3265d74..956aabd 100644
--- a/cmd/ades/main.go
+++ b/cmd/ades/main.go
@@ -96,7 +96,7 @@ func run() int {
 	if len(targets) == 0 {
 		wd, err := os.Getwd()
 		if err != nil {
-			fmt.Printf("Unexpected error getting working directory: %s", err)
+			fmt.Printf("Could not get working directory, use explicit target instead (error: %s)\n", err)
 			return exitError
 		}
 
@@ -149,12 +149,13 @@ func run() int {
 func runOnStdin() (map[string]map[string][]ades.Violation, bool) {
 	data, err := io.ReadAll(os.Stdin)
 	if err != nil {
+		fmt.Printf("Could not read from stdin (error: %s)\n", err)
 		return nil, false
 	}
 
 	violations := make(map[string][]ades.Violation)
 	if workflowViolations, err := tryWorkflow(data); err != nil {
-		fmt.Println("Could not parse input, is it YAML?")
+		fmt.Printf("Could not parse input (error: %s)\n", err)
 		return nil, false
 	} else if len(workflowViolations) != 0 {
 		violations["stdin"] = workflowViolations
diff --git a/test/stdin.txtar b/test/stdin.txtar
index f7ba1d7..cdf3e1a 100644
--- a/test/stdin.txtar
+++ b/test/stdin.txtar
@@ -25,7 +25,7 @@ stdin .github/workflows/unsafe.yml
 # Not yaml
 stdin not-yaml.txt
 ! exec ades -
-stdout 'Could not parse input, is it YAML?'
+stdout 'Could not parse input'
 ! stdout 'Ok'
 ! stderr .