feat: Add toYaml template function

twpayne · Nov 22, 2021 · da41e0f · da41e0f
1 parent 10dbbcd
commit da41e0f
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md
@@ -133,6 +133,7 @@ Manage your dotfiles across multiple machines, securely.
   * [`secretJSON` [*arg*...]](#secretjson-arg)
   * [`stat` *name*](#stat-name)
   * [`stdinIsATTY`](#stdinisatty)
+  * [`toYaml` *value*](#toyaml-value)
   * [`vault` *key*](#vault-key)
   * [`writeToStdout` *string*...](#writetostdout-string)
 
@@ -2593,6 +2594,18 @@ used.
 
 ---
 
+### `toYaml` *value*
+
+`toYaml` returns the YAML representation of *value*.
+
+#### `toYaml` examples
+
+```
+{{ dict "key" "value" | toYaml }}
+```
+
+---
+
 ### `vault` *key*
 
 `vault` returns structured data from [Vault](https://www.vaultproject.io/) using

diff --git a/internal/cmd/config.go b/internal/cmd/config.go
@@ -437,6 +437,7 @@ func newConfig(options ...configOption) (*Config, error) {
 		"secret":                   c.secretTemplateFunc,
 		"secretJSON":               c.secretJSONTemplateFunc,
 		"stat":                     c.statTemplateFunc,
+		"toYaml":                   c.toYamlTemplateFunc,
 		"vault":                    c.vaultTemplateFunc,
 	} {
 		c.addTemplateFunc(key, value)

diff --git a/internal/cmd/templatefuncs.go b/internal/cmd/templatefuncs.go
@@ -120,6 +120,15 @@ func (c *Config) statTemplateFunc(name string) interface{} {
 	}
 }
 
+func (c *Config) toYamlTemplateFunc(data interface{}) string {
+	yaml, err := chezmoi.FormatYAML.Marshal(data)
+	if err != nil {
+		returnTemplateError(err)
+		return ""
+	}
+	return string(yaml)
+}
+
 func returnTemplateError(err error) {
 	panic(err)
 }
diff --git a/internal/cmd/testdata/scripts/templatefuncs.txt b/internal/cmd/testdata/scripts/templatefuncs.txt
@@ -59,6 +59,10 @@ stdout arg
 # test that the output template function fails if the command fails
 ! chezmoi execute-template '{{ output "false" }}'
 
+# test toYaml
+chezmoi execute-template '{{ dict "key" "value" | toYaml }}'
+stdout '^key: value$'
+
 # test writeToStdout
 chezmoi execute-template --init '{{ writeToStdout "string" }}'
 stdout string