Add “doctor” chezmoi command

[kkirsche]

Add a chezmoi doctor command. Not sure the best way to test this though (unit test wise). Thoughts?

 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ go build -o cmoi                                 ✔
 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ ./cmoi doctor
Arch: amd64
OS: darwin
Configuration File: Exists (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory: Exists (-rwxr-xr-x /Users/kkirsche)
Source Directory: Exists (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Hashicorp Vault: Installed (-r-xr-xr-x /Users/kkirsche/.local/share/chezmoi)
Bitwarden: Not Found
LastPass: Not Found

[kkirsche]

This PR is related to the doctor command mentioned in #134

[kkirsche]

Oops, I had an error in the paths being printed. Fixed in d585022:

 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ ./cmoi doctor
Arch: amd64
OS: darwin
Configuration File: Exists (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory: Exists (-rwxr-xr-x /Users/kkirsche)
Source Directory: Exists (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Hashicorp Vault: Installed (-r-xr-xr-x /usr/local/bin/vault)
Bitwarden: Not Found
LastPass: Not Found

[kkirsche]

If you prefer aligned, we can use a tabwriter (https://golang.org/pkg/text/tabwriter/) to align it like so:

Arch:                    amd64
OS:                      darwin
Configuration File:      Exists      (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory:   Exists      (-rwxr-xr-x /Users/kkirsche)
Source Directory:        Exists      (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Hashicorp Vault:         Installed   (-r-xr-xr-x /usr/local/bin/vault)
Bitwarden:               Not Found
LastPass:                Not Found

[twpayne]

#138 is also relevant now :)

[kkirsche]

Output:

 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ ./cmoi doctor
Arch:                    amd64
OS:                      darwin
Configuration File:      Exists   (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory:   Exists   (-rwxr-xr-x /Users/kkirsche)
Source Directory:        Exists   (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Bitwarden:               Not Found
LastPass:                Not Found
Vault:                   Installed   (-r-xr-xr-x /usr/local/bin/vault)

[twpayne]

For the output, let's focus on the logic first and then make the UX pretty second :)

[kkirsche]

Updated output:

 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ go build -o cmoi
 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor ? $ ./cmoi doctor
Arch:                    amd64
OS:                      darwin
Configuration File:      Exists   (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory:   Exists   (-rwxr-xr-x /Users/kkirsche)
Source Directory:        Exists   (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Bitwarden:               Not Found
LastPass:                Not Found
Pass:                    Not Found
Vault:                   Installed   (-r-xr-xr-x /usr/local/bin/vault)

[twpayne]

Another thing to add: please return nil if everything is ok, and call os.Exit(1) if it is not. This will allow chezmoi doctor to be used in scripts.

[kkirsche]

What situations do you define as "not ok"?

[twpayne]

What situations do you define as "not ok"?

Good question! I would say anything that prevents chezmoi from running at all, e.g. missing source or destination directories. Missing config files is OK, and missing password manager binaries is OK.

[kkirsche]

Added exit codes 👍

[kkirsche]

Updated output:

 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor $ go build -o cmoi
 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor $ ./cmoi doctor
Arch:                    amd64
OS:                      darwin
Configuration File:      Exists      (-rw-r--r-- /Users/kkirsche/.config/chezmoi/chezmoi.yaml)
Destination Directory:   Exists      (-rwxr-xr-x /Users/kkirsche)
Source Directory:        Exists      (-rwx------ /Users/kkirsche/.local/share/chezmoi)
Bitwarden:               Not Found   (looking for: bw)
Editor:                  Installed   (-r-xr-xr-x /usr/local/bin/nvim)
LastPass:                Not Found   (looking for: lpass)
Pass:                    Not Found   (looking for: pass)
Vault:                   Installed   (-r-xr-xr-x /usr/local/bin/vault)
VCS:                     Installed   (-rwxr-xr-x /usr/local/bin/git)
 ~/git/go/src/github.com/twpayne/chezmoi >> feature/cmd_doctor $ echo $?
0

EDIT: Updated to show the editor component

Commits need squashing before merging

[twpayne]

Thanks for addressing the commands. Please can you squash the commits in to a single one with the message "Add doctor command" and I will then merge.

[kkirsche]

Well, squashing stuff broke the PR 😢