feat: safe funcs, follow go template standards and sprout conventions

.github/workflows/lint.yaml

@@ -0,0 +1,25 @@
+on: [pull_request]
+name: Linters
+permissions:
+  # Required: allow read access to the content for analysis.
+  contents: read
+  pull-requests: read
+  # Allow write access to checks to allow the action to annotate code in the PR.
+  checks: write
+jobs:
+  lint:
+    name: Golang CI Lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Install Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: stable
+    - name: Install testifylint
+      run: go install github.com/Antonboom/testifylint@v1.4.0
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@v6
+      with:
+        version: v1.60

.github/workflows/test.yaml

@@ -1,10 +1,10 @@
-on: [push, pull_request]
+on: [push]
 name: Tests
 jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.21.x, 1.22.x]
+        go-version: [1.21.x, 1.22.x, 1.23.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:

.golangci.yaml

@@ -0,0 +1,47 @@
+---
+# Thanks to @ccoVeille for the configuration template from 
+# https://github.com/ccoVeille/golangci-lint-config-examples
+linters:
+  enable:
+    - errorlint
+    - gci
+    - gocritic
+    - gofumpt
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - misspell
+    - testifylint
+    - errcheck
+    - thelper
+    - mirror
+    - usestdlibvars
+
+linters-settings:
+  gofumpt:
+    module-path: github.com/go-sprout/sprout
+  misspell:
+    ignore-words:
+      - "nto" # Used in the codebase in format "\nto" (as a newline)
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/go-sprout)
+  testifylint:
+    enable:
+      - float-compare
+      - go-require
+      - bool-compare
+      - compares
+      - empty
+      - error-is-as
+      - error-nil
+      - expected-actual
+      - len
+      - require-error
+      - suite-dont-use-pkg
+      - suite-extra-assert-call
+run:
+  timeout: 5m

alias_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 // TestWithAlias checks that aliases are correctly added to a function.
@@ -78,8 +79,8 @@ func TestRegisterAliases(t *testing.T) {
 	AssignAliases(handler)
 
 	// Check that the aliases are mapped to the same function as the original function in funcsRegistry.
-	assert.True(t, reflect.ValueOf(handler.cachedFuncsMap[originalFunc]).Pointer() == reflect.ValueOf(handler.cachedFuncsMap[alias1]).Pointer())
-	assert.True(t, reflect.ValueOf(handler.cachedFuncsMap[originalFunc]).Pointer() == reflect.ValueOf(handler.cachedFuncsMap[alias2]).Pointer())
+	assert.Equal(t, reflect.ValueOf(handler.cachedFuncsMap[originalFunc]).Pointer(), reflect.ValueOf(handler.cachedFuncsMap[alias1]).Pointer())
+	assert.Equal(t, reflect.ValueOf(handler.cachedFuncsMap[originalFunc]).Pointer(), reflect.ValueOf(handler.cachedFuncsMap[alias2]).Pointer())
 }
 
 func TestAliasesInTemplate(t *testing.T) {
@@ -97,10 +98,10 @@ func TestAliasesInTemplate(t *testing.T) {
 
 	// Create a template with the aliases.
 	tmpl, err := template.New("test").Funcs(handler.Build()).Parse(`{{originalFunc}} {{alias1}} {{alias2}}`)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 
 	var buf bytes.Buffer
 	err = tmpl.ExecuteTemplate(&buf, "test", nil)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, "cheese cheese cheese", buf.String())
 }

benchmarks/allFunctions.sprig.tmpl

@@ -29,7 +29,7 @@
 {{$v := toString .int }}{{typeOf $v}}-{{$v}}
 {{$v := toString .float }}{{typeOf $v}}-{{$v}}
 {{$v := toString .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toString .objectrray }}{{typeOf $v}}-{{$v}}
+{{$v := toString .array }}{{typeOf $v}}-{{$v}}
 {{$v := toString .time }}{{typeOf $v}}-{{$v}}
 {{$v := toString .duration }}{{typeOf $v}}-{{$v}}
 {{$v := toString .object }}{{typeOf $v}}-{{$v}}

benchmarks/allFunctions.sprout.tmpl

@@ -13,44 +13,40 @@
 {{md5sum ""}}
 {{md5sum "a"}}
 {{md5sum "hello world"}}
-{{$v := toBool .string }}{{kindOf $v}}-{{$v}}
+{{$v := toBool .intString }}{{kindOf $v}}-{{$v}}
 {{$v := toBool .int }}{{kindOf $v}}-{{$v}}
 {{$v := toBool .float }}{{kindOf $v}}-{{$v}}
 {{$v := toBool .bool }}{{kindOf $v}}-{{$v}}
-{{$v := toBool .objectrray }}{{kindOf $v}}-{{$v}}
-{{$v := toInt .string }}{{kindOf $v}}-{{$v}}
+{{$v := toInt .intString }}{{kindOf $v}}-{{$v}}
 {{$v := toInt .float }}{{kindOf $v}}-{{$v}}
 {{$v := toInt .bool }}{{kindOf $v}}-{{$v}}
-{{$v := toInt64 .string }}{{typeOf $v}}-{{$v}}
+{{$v := toInt64 .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .float }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .int }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toUint .string }}{{kindOf $v}}-{{$v}}
+{{$v := toUint .intString }}{{kindOf $v}}-{{$v}}
 {{$v := toUint .float }}{{kindOf $v}}-{{$v}}
 {{$v := toUint .int }}{{kindOf $v}}-{{$v}}
 {{$v := toUint .bool }}{{kindOf $v}}-{{$v}}
-{{$v := toUint64 .string }}{{typeOf $v}}-{{$v}}
+{{$v := toUint64 .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toUint64 .float }}{{typeOf $v}}-{{$v}}
 {{$v := toUint64 .int }}{{typeOf $v}}-{{$v}}
 {{$v := toUint64 .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toFloat64 .string }}{{typeOf $v}}-{{$v}}
+{{$v := toFloat64 .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .float }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .int }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .string }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .float }}{{typeOf $v}}-{{$v}}
+{{$v := toOctal .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toOctal .int }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .bool }}{{typeOf $v}}-{{$v}}
 {{$v := toString .string }}{{typeOf $v}}-{{$v}}
 {{$v := toString .int }}{{typeOf $v}}-{{$v}}
 {{$v := toString .float }}{{typeOf $v}}-{{$v}}
 {{$v := toString .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toString .objectrray }}{{typeOf $v}}-{{$v}}
+{{$v := toString .array }}{{typeOf $v}}-{{$v}}
 {{$v := toString .time }}{{typeOf $v}}-{{$v}}
 {{$v := toString .duration }}{{typeOf $v}}-{{$v}}
 {{$v := toString .object }}{{typeOf $v}}-{{$v}}
-{{$v := toDate "2006-01-02" (.time | toString) }}{{typeOf $v}}-{{$v}}
-{{$v := toDuration .time }}{{typeOf $v}}-{{$v}}
+{{$v := .time | toString | splitList " " | initial | join " " | toDate "2006-01-02 15:04:05.999999999 -0700 MST" }}{{typeOf $v}}-{{$v}}
 {{$v := toDuration .int }}{{typeOf $v}}-{{$v}}
 {{$v := toDuration .float }}{{typeOf $v}}-{{$v}}
 {{$v := toDuration .duration }}{{typeOf $v}}-{{$v}}
@@ -59,13 +55,12 @@
 {{ "Hello World" | base64Encode }}
 {{ "=" | base64Encode }}
 {{ "" | base64Decode }}
-{{ "SGVsbG8gV29ybGQ" | base64Decode }}
+{{ "SGVsbG8gV29ybGQ=" | base64Decode }}
 {{ "" | base32Encode }}
 {{ "Hello World" | base32Encode }}
 {{ "" | base32Decode }}
 {{ "JBSWY3DPEBLW64TMMQ======" | base32Decode }}
-{{ "JBSWY3DPEBLW64TMMQ" | base32Decode }}
-{{ "" | fromJson }}
+{{ "" | safeFromJson }}
 {{ .json | fromJson }}
 {{ (.json | fromJson).foo }}
 {{ "" | toJson }}
@@ -251,11 +246,11 @@
 {{- $d := dict "a" 1 "b" 2 | deepCopy }}{{ keys $d | sortAlpha | join "," }}
 {{- $one := dict "foo" (dict "bar" "baz") "qux" true -}}{{ deepCopy $one }}
 {{ regexFind "a(b+)" "aaabbb" }}
-{{ regexFind "a(b+" "aaabbb" }}
+{{ safeRegexFind "a(b+" "aaabbb" }}
 {{ regexFindAll "a(b+)" "aaabbb" -1 }}
 {{ regexFindAll "a{2}" "aaaabbb" -1 }}
 {{ regexFindAll "a{2}" "none" -1 }}
-{{ regexFindAll "a(b+" "aaabbb" -1 }}
+{{ safeRegexFindAll "a(b+" "aaabbb" -1 }}
 {{ regexMatch "^[a-zA-Z]+$" "Hello" }}
 {{ regexMatch "^[a-zA-Z]+$" "Hello123" }}
 {{ regexMatch "^[a-zA-Z]+$" "123" }}
@@ -323,11 +318,10 @@
 {{ slice .array 1 }}
 {{ slice .array 1 3 }}
 {{ slice .array 0 1 }}
-{{ .map | has "foo" }}
-{{ .map | has "a" }}
-{{ .map | has 1 }}
-{{ .map | has .nil }}
-{{ .map | has "nope" }}
+{{ .map | safeHas "foo" }}
+{{ .map | safeHas "a" }}
+{{ .map | safeHas 1 }}
+{{ .map | safeHas .nil }}
 {{ without .array "a" }}
 {{ rest .array }}
 {{ initial .array }}
@@ -649,7 +643,7 @@
 {{ dateInZone "02 Jan 06 15:04 -0700" .data272 "UTC" }}
 {{ dateInZone "02 Jan 06 15:04 -0700" .data273 "UTC" }}
 {{ dateInZone "02 Jan 06 15:04 -0700" .data274 "UTC" }}
-{{ dateInZone "02 Jan 06 15:04 -0700" .data275 "invalid" }}
+{{ safeDateInZone "02 Jan 06 15:04 -0700" .data275 "invalid" }}
 {{ .duration | duration }}
 {{ .time | dateAgo | substr 0 5 }}
 {{ now | date "02 Jan 06 15:04 -0700" }}
@@ -659,7 +653,7 @@
 {{ .time | dateModify "-1h" | date "02 Jan 06 15:04 -0700" }}
 {{ .time | dateModify "10m" | date "02 Jan 06 15:04 -0700" }}
 {{ .time | dateModify "-10s" | date "02 Jan 06 15:04 -0700" }}
-{{ .time | dateModify "zz" | date "02 Jan 06 15:04 -0700" }}
+{{ .time | safeDateModify "zz" | date "02 Jan 06 15:04 -0700" }}
 {{ .duration | durationRound }}
 {{ .time | htmlDate }}
 {{ htmlDateInZone .time "UTC" }}

benchmarks/allFunctionsAsSprig.sprout.tmpl

@@ -10,41 +10,40 @@
 {{adler32sum ""}}
 {{adler32sum "a"}}
 {{adler32sum "hello world"}}
-{{$v := toInt .string }}{{kindOf $v}}-{{$v}}
+{{$v := toInt .intString }}{{kindOf $v}}-{{$v}}
 {{$v := toInt .float }}{{kindOf $v}}-{{$v}}
 {{$v := toInt .bool }}{{kindOf $v}}-{{$v}}
-{{$v := toInt64 .string }}{{typeOf $v}}-{{$v}}
+{{$v := toInt64 .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .float }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .int }}{{typeOf $v}}-{{$v}}
 {{$v := toInt64 .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toFloat64 .string }}{{typeOf $v}}-{{$v}}
+{{$v := toFloat64 .intString }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .float }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .int }}{{typeOf $v}}-{{$v}}
 {{$v := toFloat64 .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .string }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .float }}{{typeOf $v}}-{{$v}}
+{{$v := toOctal .intString }}{{typeOf $v}}-{{$v}}
+{{$v := safeToOctal .float }}{{typeOf $v}}-{{$v}}
 {{$v := toOctal .int }}{{typeOf $v}}-{{$v}}
-{{$v := toOctal .bool }}{{typeOf $v}}-{{$v}}
+{{$v := safeToOctal .bool }}{{typeOf $v}}-{{$v}}
 {{$v := toString .string }}{{typeOf $v}}-{{$v}}
 {{$v := toString .int }}{{typeOf $v}}-{{$v}}
 {{$v := toString .float }}{{typeOf $v}}-{{$v}}
 {{$v := toString .bool }}{{typeOf $v}}-{{$v}}
-{{$v := toString .objectrray }}{{typeOf $v}}-{{$v}}
+{{$v := toString .array }}{{typeOf $v}}-{{$v}}
 {{$v := toString .time }}{{typeOf $v}}-{{$v}}
 {{$v := toString .duration }}{{typeOf $v}}-{{$v}}
 {{$v := toString .object }}{{typeOf $v}}-{{$v}}
-{{$v := toDate "2006-01-02" (.time | toString) }}{{typeOf $v}}-{{$v}}
+{{$v := .time | toString | splitList " " | initial | join " " | toDate "2006-01-02 15:04:05.999999999 -0700 MST" }}{{typeOf $v}}-{{$v}}
 {{ "" | base64Encode }}
 {{ "Hello World" | base64Encode }}
 {{ "=" | base64Encode }}
 {{ "" | base64Decode }}
-{{ "SGVsbG8gV29ybGQ" | base64Decode }}
+{{ "SGVsbG8gV29ybGQ=" | base64Decode }}
 {{ "" | base32Encode }}
 {{ "Hello World" | base32Encode }}
 {{ "" | base32Decode }}
 {{ "JBSWY3DPEBLW64TMMQ======" | base32Decode }}
-{{ "JBSWY3DPEBLW64TMMQ" | base32Decode }}
-{{ "" | fromJson }}
+{{ "" | safeFromJson }}
 {{ .json | fromJson }}
 {{ (.json | fromJson).foo }}
 {{ "" | toJson }}
@@ -292,11 +291,11 @@
 {{ slice .array 1 }}
 {{ slice .array 1 3 }}
 {{ slice .array 0 1 }}
-{{ .map | has "foo" }}
-{{ .map | has "a" }}
-{{ .map | has 1 }}
-{{ .map | has .nil }}
-{{ .map | has "nope" }}
+{{ .map | safeHas "foo" }}
+{{ .map | safeHas "a" }}
+{{ .map | safeHas 1 }}
+{{ .map | safeHas .nil }}
+{{ .map | safeHas "nope" }}
 {{ without .array "a" }}
 {{ rest .array }}
 {{ initial .array }}
@@ -591,7 +590,7 @@
 {{ dateInZone "02 Jan 06 15:04 -0700" .data272 "UTC" }}
 {{ dateInZone "02 Jan 06 15:04 -0700" .data273 "UTC" }}
 {{ dateInZone "02 Jan 06 15:04 -0700" .data274 "UTC" }}
-{{ dateInZone "02 Jan 06 15:04 -0700" .data275 "invalid" }}
+{{ safeDateInZone "02 Jan 06 15:04 -0700" .data275 "invalid" }}
 {{ .duration | duration }}
 {{ .time | dateAgo | substr 0 5 }}
 {{ now | date "02 Jan 06 15:04 -0700" }}
@@ -601,7 +600,7 @@
 {{ .time | dateModify "-1h" | date "02 Jan 06 15:04 -0700" }}
 {{ .time | dateModify "10m" | date "02 Jan 06 15:04 -0700" }}
 {{ .time | dateModify "-10s" | date "02 Jan 06 15:04 -0700" }}
-{{ .time | dateModify "zz" | date "02 Jan 06 15:04 -0700" }}
+{{ .time | safeDateModify "zz" | date "02 Jan 06 15:04 -0700" }}
 {{ .duration | durationRound }}
 {{ .time | htmlDate }}
 {{ htmlDateInZone .time "UTC" }}

benchmarks/comparaison_test.go

@@ -37,6 +37,7 @@ import (
 
 var data = map[string]any{
 	"string":      "example string value",
+	"intString":   "1",
 	"url":         "https://example.com",
 	"arrayCommas": "a,b,c",
 	"int":         123,
@@ -92,7 +93,7 @@ func BenchmarkComparison(b *testing.B) {
 func BenchmarkAllSprout(b *testing.B) {
 	runtime.GOMAXPROCS(1)
 
-	b.Run("SproutWiothNewFeatures", func(b *testing.B) {
+	b.Run("SproutWithNewFeatures", func(b *testing.B) {
 		for i := 0; i < b.N; i++ {
 			sproutBench("allFunctions.sprout.tmpl")
 		}
@@ -126,6 +127,7 @@ func sprigBench() {
 func sproutBench(templatePath string) {
 	fnHandler := sprout.New(
 		sprout.WithLogger(slog.New(&noopHandler{})),
+		sprout.WithSafeFuncs(true),
 	)
 
 	_ = fnHandler.AddRegistries(

benchmarks/compare.tmpl

@@ -41,7 +41,7 @@ this is because the output of the function is fixed in Sprout due to bugs not fi
 [CODE_000041]    {{$v := toString .int }}{{typeOf $v}}-{{$v}}
 [CODE_000042]    {{$v := toString .float }}{{typeOf $v}}-{{$v}}
 [CODE_000043]    {{$v := toString .bool }}{{typeOf $v}}-{{$v}}
-[CODE_000044]    {{$v := toString .objectrray }}{{typeOf $v}}-{{$v}}
+[CODE_000044]    {{$v := toString .array }}{{typeOf $v}}-{{$v}}
 [CODE_000045]    {{$v := toString .time }}{{typeOf $v}}-{{$v}}
 [CODE_000046]    {{$v := toString .duration }}{{typeOf $v}}-{{$v}}
 [CODE_000047]    {{$v := toString .object }}{{typeOf $v}}-{{$v}}
@@ -335,7 +335,7 @@ this is because the output of the function is fixed in Sprout due to bugs not fi
 [CODE_000335]    {{ .array | mustHas "foo" }}
 [CODE_000336]    {{ .array | mustHas "a" }}
 [CODE_000337]    {{ .array | mustHas 1 }}
-[CODE_000338]    {{ .array | mustHas .Nil }}
+[CODE_000338]    {{ .array | mustHas .nil }}
 [CODE_000339]    {{ .array | mustHas "nope" }}
 [CODE_000340]    {{ .array | mustHas 1 }}
 [CODE_000341]    {{ mustWithout .array "a" }}
@@ -609,12 +609,11 @@ this is because the output of the function is fixed in Sprout due to bugs not fi
 [CODE_000609]    {{ .time | dateModify "-1h" | date "02 Jan 06 15:04 -0700" }}
 [CODE_000610]    {{ .time | dateModify "10m" | date "02 Jan 06 15:04 -0700" }}
 [CODE_000611]    {{ .time | dateModify "-10s" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000612]    {{ .time | dateModify "zz" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000613]    {{ .duration | duration | durationRound }}
-[CODE_000614]    {{ .time | htmlDate }}
-[CODE_000615]    {{ htmlDateInZone .time "UTC" }}
-[CODE_000616]    {{ .time | mustDateModify "1h" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000617]    {{ .time | mustDateModify "+1h" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000618]    {{ .time | mustDateModify "-1h" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000619]    {{ .time | mustDateModify "10m" | date "02 Jan 06 15:04 -0700" }}
-[CODE_000620]    {{ .time | mustDateModify "-10s" | date "02 Jan 06 15:04 -0700" }}
+[CODE_000612]    {{ .duration | duration | durationRound }}
+[CODE_000613]    {{ .time | htmlDate }}
+[CODE_000614]    {{ htmlDateInZone .time "UTC" }}
+[CODE_000615]    {{ .time | mustDateModify "1h" | date "02 Jan 06 15:04 -0700" }}
+[CODE_000616]    {{ .time | mustDateModify "+1h" | date "02 Jan 06 15:04 -0700" }}
+[CODE_000617]    {{ .time | mustDateModify "-1h" | date "02 Jan 06 15:04 -0700" }}
+[CODE_000618]    {{ .time | mustDateModify "10m" | date "02 Jan 06 15:04 -0700" }}
+[CODE_000619]    {{ .time | mustDateModify "-10s" | date "02 Jan 06 15:04 -0700" }}