Add "replace" function and documentation #140
Conversation
|
Hi @jen20 - thanks for the PR! This is awesome - I was thinking just the other day that I needed a Looks like the CI build is failing - should be pretty simple to fix, it seems you just need to run |
stringfunc.go
Outdated
| // StringFunc - string manipulation function wrappers | ||
| type StringFunc struct {} | ||
|
|
||
| func (t StringFunc) Replace(s, old, new string) string { |
There was a problem hiding this comment.
If necessary, a gomplate function named
replaceNcould be introduced callingstrings.Replacedirectly.
To avoid the future name-shuffling (because I think exposing the full strings.Replace is inevitable) I think I'd prefer to name this function replaceAll.
And as an aside, can you lower-case the r just so that this isn't public API right away? I feel a bit boxed in with all the exported funcs I've written to date, and I'd like to stop that and make new ones non-exported for now.
There was a problem hiding this comment.
Can you move the s arg to the end of the signature? Like this:
func (t StringFunc) replaceAll(old, new, s string) string {Then it can be used to also support pipelines:
Like this:
{{ replaceAll "a" "o" "banana" }}
or this:
{{ "banana" | replaceAll "a" "o" }}A number of other gomplate built-in funcs support this usage, so it'd fit in nicely.
There was a problem hiding this comment.
I think all of this has been addressed with the latest push - I'll wait to watch CI complete now I'm not in a plane ;-)
stringfunc_test.go
Outdated
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestReplace(t *testing.T) { |
There was a problem hiding this comment.
Should be renamed to TestReplaceAll
This commit adds a `replaceAll` function which takes three arguments - an original string, the substring to replace, and the string with which to replace it. This is of particular use when generating node names from IP addresses where the node name may not contain "." characters.
|
The last one should now be addressed. Do you have a particular schedule you are following for release builds? |
|
Thanks again, @jen20! I don't have a particular schedule - I should be able to get 1.7.0 out within the next day or so. |
|
Great - thanks for merging! |
well, better late than never 😬... 1.7.0 is out now! |
This pull request adds a
replacefunction which takes three arguments - an original string, the substring to replace, and the string with which to replace it. This is of particular use when generating node names from IP addresses where the node name may not contain "." characters.The
strings.Replacefunction in the Go standard library seems like it would be better namedstrings.ReplaceN, so we wrap it to replace all occurences of the string. If necessary, a gomplate function namedreplaceNcould be introduced callingstrings.Replacedirectly.