chezmoi doctor - .chezmoiexternals/chezmoi.toml.tmpl detected as "suspicious-entries"

[xfzv]

I'm managing chezmoi binary as an external with ~/dotfiles/.chezmoiexternals/chezmoi.toml.tmpl:

{{ if eq .distro "gentoo" }}
[".local/bin/chezmoi"]
type = "file"
executable = true
url = "https://github.com/twpayne/chezmoi/releases/download/{{ (gitHubLatestRelease "twpayne/chezmoi").TagName }}/chezmoi-linux-amd64"
refreshPeriod = "168h"
{{ end }}

which works just fine. However, I noticed that chezmoi doctor prints the following warning:

% chezmoi doctor
RESULT    CHECK                       MESSAGE
[...]
ok        source-dir                  ~/dotfiles is a git working tree (clean)
warning   suspicious-entries          ~/dotfiles/.chezmoiexternals/chezmoi.toml.tmpl
[...]

I guess the warning is because the filename contains chezmoi, considering it disappears if I rename chezmoi.toml.tmpl to something else, e.g. binary.toml.tmpl.

Just curious if this could be improved.

[halostatue]

It probably could — but it would be subtle to do so. I’m looking at the implementation of the suspicious entries check and the problem is not that it contains chezmoi, it’s that it looks like a known bad target chezmoi.toml (the .tmpl is stripped when checking this). Files in a .chezmoiexternals directory aren't written to disk the same way, but handling this specific case might be complicated (I haven't checked this part, but if the file is also tagged as an external config file, it might not be that hard, either).

Renaming the file to chezmoi-binary.toml.tmpl (or chezmoi-itself.toml.tmpl) should also remove the warning and maintain the clarity that you would like.

[xfzv]

Thanks for the reply and the explanation.

I don't really mind the warning, I only run chezmoi doctor occasionally to check if everything is fine.

I'm simply going to rename the file as you suggest.