Deprecate most of "templatelib" in favor of Sprig #23
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,13 @@ | ||
| package templatelib | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "reflect" | ||
| "strings" | ||
| "text/template" | ||
|
|
||
| "github.com/Masterminds/sprig/v3" | ||
| ) | ||
|
|
||
| func swapStringsFuncBoolArgsOrder(a func(string, string) bool) func(string, string) bool { | ||
|
|
@@ -68,55 +69,33 @@ func stringsModifierActionFactory(a func(string, string) string) func([]string, | |
| } | ||
| } | ||
|
|
||
| func FuncMap() template.FuncMap { | ||
| funcMap := sprig.TxtFuncMap() | ||
|
|
||
| // https://github.com/Masterminds/sprig/pull/276 | ||
| funcMap["ternary"] = func(vt interface{}, vf interface{}, v interface{}) interface{} { | ||
| if truth, ok := template.IsTrue(v); !ok { | ||
| panic(fmt.Sprintf(`template.IsTrue(%+v) says things are NOT OK`, v)) | ||
| } else if truth { | ||
| return vt | ||
| } | ||
| return vf | ||
| } | ||
|
|
||
| // Everybody: {{- join ", " .Names -}} | ||
| // Concat: {{- join "/" "https://github.com" "jsmith" "some-repo" -}} | ||
| funcMap["join"] = stringsActionFactory("join", true, strings.Join) | ||
| // (this differs slightly from the Sprig "join" in that it accepts either a list of strings or multiple arguments - Sprig instead has an explicit "list" function which can create a list of strings *from* a list of arguments so that multiple-signature usability like this is not necessary) | ||
|
There was a problem hiding this comment. I guess in looking at https://masterminds.github.io/sprig/string_slice.html, the key here will be to verify that we can start porting to the |
||
|
|
||
| // JSON data dump: {{ json . }} | ||
| // (especially nice for taking data and piping it to "jq") | ||
| // (ie "some-tool inspect --format '{{ json . }}' some-things | jq .") | ||
| funcMap["json"] = funcMap["toJson"] | ||
|
|
||
| // {{- getenv "PATH" -}} | ||
| // {{- getenv "HOME" "no HOME set" -}} | ||
| // {{- getenv "HOME" "is set" "is NOT set (or is empty)" -}} | ||
| funcMap["getenv"] = thingsActionFactory("getenv", true, func(args []interface{}, arg interface{}) interface{} { | ||
| var ( | ||
| val = os.Getenv(arg.(string)) | ||
| setVal interface{} = val | ||
|
|
@@ -134,5 +113,13 @@ var FuncMap = template.FuncMap{ | |
| } else { | ||
| return unsetVal | ||
| } | ||
| }) | ||
|
|
||
| // {{- $mungedUrl := $url | replace "git://" "https://" | trimSuffixes ".git" -}} | ||
| // turns: git://github.com/jsmith/some-repo.git | ||
| // into: https://github.com/jsmith/some-repo | ||
| funcMap["trimPrefixes"] = stringsActionFactory("trimPrefixes", false, stringsModifierActionFactory(strings.TrimPrefix)) | ||
| funcMap["trimSuffixes"] = stringsActionFactory("trimSuffixes", false, stringsModifierActionFactory(strings.TrimSuffix)) | ||
|
There was a problem hiding this comment. These support a list of prefixes/suffixes, but I'm reasonably certain we've never actually used that functionality, so all our uses should be able to port to There was a problem hiding this comment. Just confirmed, |
||
|
|
||
| return funcMap | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I could get fancy with github.com/imdario/mergo to avoid changing the signature of
templatelib.FuncMap, but I'm not aware of any actual users of it, so I'm not sure it's worth going to the trouble? 😇(I'd love to convert our uses of functions like
trimSuffixes,trimPrefixes,join, andgetenvto be compatible with their Sprig counterparts so we could deprecate/remove our custom versions too, which shouldn't be too much work.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://pkg.go.dev/github.com/docker-library/[email protected]/pkg/templatelib?tab=importedby
https://pkg.go.dev/github.com/docker-library/[email protected]/pkg/templatelib?tab=importedby
👀