fix: add custom error printing for Zarf commands

[phillebaba]

Description

This change adds some custom logic for printing returned errors from Cobra commands. This will allow embedded tools like Helm to behave the same as the original tools. While the Zarf commands will print errors in the same expected error format.

Related Issue

Relates to #2567

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[netlify]

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	16aa1ff
🔍 Latest deploy log	https://app.netlify.com/sites/zarf-docs/deploys/665d7f365294f20008a98365

[phillebaba]

Here is an example of before an after an error in the Helm command.

Error: invalid argument "foo" for "-o, --output" flag: invalid format type
Usage:
  zarf tools helm repo list [flags]

Aliases:
  list, ls

Flags:
  -h, --help            help for list
  -o, --output format   prints the output in the specified format. Allowed values: table, json, yaml (default table)

Global Flags:
      --burst-limit int                 client-side default throttling limit (default 100)
      --debug                           enable verbose output
      --kube-apiserver string           the address and the port for the Kubernetes API server
      --kube-as-group stringArray       group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --kube-as-user string             username to impersonate for the operation
      --kube-ca-file string             the certificate authority file for the Kubernetes API server connection
      --kube-context string             name of the kubeconfig context to use
      --kube-insecure-skip-tls-verify   if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kube-tls-server-name string     server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used
      --kube-token string               bearer token used for authentication
      --kubeconfig string               path to the kubeconfig file
  -n, --namespace string                namespace scope for this request
      --qps float32                     queries per second used when communicating with the Kubernetes API, not including bursting
      --registry-config string          path to the registry config file (default "/home/philip/.config/helm/registry/config.json")
      --repository-cache string         path to the file containing cached repository indexes (default "/home/philip/.cache/helm/repository")
      --repository-config string        path to the file containing repository names and URLs (default "/home/philip/.config/helm/repositories.yaml")

Error: invalid argument "foo" for "-o, --output" flag: invalid format type

Error: invalid argument "foo" for "-o, --output" flag: invalid format type

Notice that before the error message was printed twice. Along with that the usage documentation is also printed for every error.

No example for Zarf command errors are given as it is currently not used.

[AustinAbro321]

This doesn't affect Zarf commands because we already either message.Fatal or return no err correct?

[phillebaba]

Yep none of the commands today return an error. Something that we want to change in the future. An issue currently is that message fatal takes both a message and an error, but only outputs the message to stderr. It is going to be a breaking change if we want to wrap everything into a single error.