Allow --format=json as an alias of --format={{json .}}

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

templates/templates.go

@@ -61,6 +61,11 @@ var HeaderFunctions = template.FuncMap{
 	},
 }
 
+// aliases for convenience
+var aliases = map[string]string{
+	"json": "{{json .}}",
+}
+
 // Parse creates a new anonymous template with the basic functions
 // and parses the given format.
 func Parse(format string) (*template.Template, error) {
@@ -76,6 +81,9 @@ func New(tag string) *template.Template {
 // NewParse creates a new tagged template with the basic functions
 // and parses the given format.
 func NewParse(tag, format string) (*template.Template, error) {
+	if alias, ok := aliases[format]; ok {
+		format = alias
+	}
 	return New(tag).Parse(format)
 }
 

templates/templates_test.go

@@ -39,6 +39,26 @@ func TestNewParse(t *testing.T) {
 	assert.Check(t, is.Equal(want, b.String()))
 }
 
+func TestParseJSON(t *testing.T) {
+	f := func(t testing.TB, format string) {
+		tm, err := Parse(format)
+		assert.NilError(t, err)
+		var b bytes.Buffer
+		m := map[string]int{
+			"foo": 42,
+		}
+		assert.NilError(t, tm.Execute(&b, m))
+		want := `{"foo":42}`
+		assert.Check(t, is.Equal(want, b.String()))
+	}
+	t.Run("CanonicalForm", func(t *testing.T) {
+		f(t, "{{json .}}")
+	})
+	t.Run("ConvenienceForm", func(t *testing.T) {
+		f(t, "json")
+	})
+}
+
 func TestParseTruncateFunction(t *testing.T) {
 	source := "tupx5xzf6hvsrhnruz5cr8gwp"