Make codespaces detection shorter

[felipecrs]

At least until we have Masterminds/sprig#258.

[twpayne]

The reason for the original code was that it makes it easier for people to add their own Codespaces specific configuration: they can include it in the existing if/else/end block. Admittedly I didn't include a comment to document this. Thoughts?

[felipecrs]

I see. I didn't think about that, probably because I can't imagine what else people would do in the chezmoi.toml.tmpl specifically for Codespaces.

[twpayne]

The main difference (as far as I can tell) is that the Codespaces dotfile setup is non-interactive so you can't use interactive template functions like promptString. Consequently my personal .chezmoi.toml.tmpl ends up looking like this:

[data]
  name = "Tom Payne"
{{- if env "CODESPACES" }}
  codespaces = true
  email = "twpayne@gmail.com"
{{- else }}
{{- $email := promptString "email" -}}
  codespaces = false
  email = "{{ $email}}"
  sshKey = "{{ $email }} SSH key"
{{- end }}

[felipecrs]

You're right. I would personally do this differently:

{{- $codespaces:= env "CODESPACES" | not | not -}}

[data]
  name = "Tom Payne"
  codespaces = {{ $codespaces }}
{{- if $codespaces }}
  email = "twpayne@gmail.com"
{{- else }}
{{- $email := promptString "email" -}}
  email = "{{ $email}}"
  sshKey = "{{ $email }} SSH key"
{{- end }}

Here I create the variable $codespaces and you create the variable $email. I know that chezmoi currently can not read the variables defined in [data] in the template time, otherwise, we could just get rid of those definitions and use {{ .codespaces }} instead.

Is this possible? If yes, I can open an issue for such a feature.

[twpayne]

You're right. I would personally do this differently:

Thanks! That's a nice improvement and I've updated my template to use it.

I know that chezmoi currently can not read the variables defined in [data] in the template time, otherwise, we could just get rid of those definitions and use {{ .codespaces }} instead.

Is this possible? If yes, I can open an issue for such a feature.

If I understand correctly, this is not possible. The [data] section is in the config file, which does not exist when the config file template is executed.

[felipecrs]

I made some changes and included an example mail address. Do you think it's a good idea?

[twpayne]

I made some changes and included an example mail address. Do you think it's a good idea?

No :) This is a template repo for people who are just getting started with chezmoi and templates, so we should make things as easy to understand as possible, even if there are some equivalent code golf ways of achieving the same effect.

[felipecrs]

I see. What's your opinion about

{{- $codespaces := env "CODESPACES" | not | not -}}

sourceDir = "{{ .chezmoi.sourceDir }}"
[data]
  codespaces = {{ $codespaces }}

Compared to the original one?

[twpayne]

I would go with one similar to what you suggested here:

{{- $codespaces:= env "CODESPACES" | not | not -}}

[data]
  name = "Your name"
  codespaces = {{ $codespaces }}
{{- if $codespaces }}{{/* Codespaces dotfiles setup is non-interactive, so set an email address */}}
  email = "your@email.com"
{{- else }}{{/* Interactive setup, so prompt for an email address */}}
  email = "{{ promptString "email" }}"
{{- end }}

Reasons:

• Demonstrates several features: detecting codespaces, setting variables everywhere, setting variables depending on codespaces.
• Makes it very clear where users should add their own variables.

[twpayne]

Thank you :)

[felipecrs]

Thank you :)

No need to thanks! :)