Any tips for chezmoi on VS Code?

[felipecrs]

I have one:

https://marketplace.visualstudio.com/items?itemName=Tim-Koehler.helm-intellisense

Then:

// .vscode/settings.json
{
  "files.associations": {
    ".chezmoi*.yaml": "helm"
  }
}

Result:

zsVRFuvDxt.mp4

Refs chezmoi/dotfiles#8

[felipecrs]

For scripts, I have been doing things like:

# {{ if .is_wsl }}
# The boot.command in /etc/wsl.conf is only for Windows 11, so this workaround is needed
if service docker status 2>&1 | grep -q "is not running"; then
  wsl.exe -d "${WSL_DISTRO_NAME}" -u root -e /usr/sbin/service docker start >/dev/null 2>&1
fi
# {{ end }}

To prevent my ShellCheck and other shell extensions to freak out. The pitfall is that the # sign remains in the code after rendering the template. @twpayne do you know if there is anything that can be written to the template to wipe out the leadings # from the final script?

[felipecrs]

This is amazing!

[twpayne]

Doesn't the carriage return \r just return the cursor to the start of the line, causing whatever comes after the \r to overwrite whatever was previously displayed on the time when the template results are printed? i.e. I don't think this overwrites the comments in the template result, it just makes them not visible when you look at the template output in a terminal, for example:

$ chezmoi execute-template '{{ printf "abcde\r123" }}'
123%
$ chezmoi execute-template '{{ printf "abcde\r123" }}' | xxd
00000000: 6162 6364 650d 3132 33                   abcde.123

Maybe this is what you want...

[bradenhilton]

@twpayne It would seem that you are correct. I could have sworn I got it to work on the template result at one point but I went through a lot of iterations in a short amount of time, either that or it was just general Windows strangeness. How frustrating!

[bradenhilton]

An imperfect solution would be to add support for directive comments which are evaluated before the template is parsed. Maybe chezmoi:delims *left* *right* could be used to set https://pkg.go.dev/text/template#Template.Delims, so one could use chezmoi:delims "#{{" "}}" or chezmoi:delims "//{{" "}}". Or the typical replacers replace/regexReplaceAll could be used e.g. chezmoi:replace "# {{" "{{" . Seems like it could be a lot of work just to remove some empty comments in the template result though, assuming it's even possible. The directives would have to be at the top of the file and be consumed so they don't appear in the result to preserve things like shebangs.

It just occurred to me that mandating directives be placed at the top of the file could result in ShellCheck complaining that the shebang is not the first line of the file. Perhaps the directives should be placed at the bottom of the file instead?

[twpayne]

As an alternative, exposing template data as environment variables (work in progress in #2418) would avoid the need to use templates for your scripts, assuming your scripting language is capable of reading environment variables. I'm thinking something along the lines of:

Config file:

[env]
    IS_WSL = "true" # set $IS_WSL=true in scripts

Script (does not need to be a template, now syntactically valid and so can be checked with ShellCheck):

if "${IS_WSL}" == "true"; then
  # The boot.command in /etc/wsl.conf is only for Windows 11, so this workaround is needed
  if service docker status 2>&1 | grep -q "is not running"; then
    wsl.exe -d "${WSL_DISTRO_NAME}" -u root -e /usr/sbin/service docker start >/dev/null 2>&1
  fi
fi

Note that templates are still needed for config files that are not scripts.

[shadycuz]

@felipecrs bro, about twice a week, I stumble upon a git issue where you created or commented in it. We like use the same tech stack for sure.