1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
ns: regexp
preamble: |
These functions allow user you to search and modify text with regular expressions.
The syntax of the regular expressions accepted is [Go's `regexp` syntax](https://pkg.go.dev/regexp/syntax/#hdr-Syntax),
and is the same general syntax used by Perl, Python, and other languages.
funcs:
- name: regexp.Find
released: v3.1.0
description: |
Returns a string holding the text of the leftmost match in `input`
of the regular expression `expression`.
This function provides the same behaviour as Go's
[`regexp.FindString`](https://pkg.go.dev/regexp/#Regexp.FindString) function.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression
- name: input
required: true
description: The input to search
examples:
- |
$ gomplate -i '{{ regexp.Find "[a-z]{3}" "foobar"}}'
foo
- |
$ gomplate -i 'no {{ "will not match" | regexp.Find "[0-9]" }}numbers'
no numbers
- name: regexp.FindAll
released: v3.1.0
description: |
Returns a list of all successive matches of the regular expression.
This can be called with 2 or 3 arguments. When called with 2 arguments, the
`n` argument (number of matches) will be set to `-1`, causing all matches
to be returned.
This function provides the same behaviour as Go's
[`regexp.FindAllString`](https://pkg.go.dev/regexp#Regexp.FindAllString) function.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression
- name: n
required: false
description: The number of matches to return
- name: input
required: true
description: The input to search
examples:
- |
$ gomplate -i '{{ regexp.FindAll "[a-z]{3}" "foobar" | toJSON}}'
["foo", "bar"]
- |
$ gomplate -i '{{ "foo bar baz qux" | regexp.FindAll "[a-z]{3}" 3 | toJSON}}'
["foo", "bar", "baz"]
- name: regexp.Match
released: v1.9.0
description: |
Returns `true` if a given regular expression matches a given input.
This returns a boolean which can be used in an `if` condition, for example.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression
- name: input
required: true
description: The input to test
examples:
- |
$ gomplate -i '{{ if (.Env.USER | regexp.Match `^h`) }}username ({{.Env.USER}}) starts with h!{{end}}'
username (hairyhenderson) starts with h!
- name: regexp.QuoteMeta
released: v3.7.0
description: |
Escapes all regular expression metacharacters in the input. The returned string is a regular expression matching the literal text.
This function provides the same behaviour as Go's
[`regexp.QuoteMeta`](https://pkg.go.dev/regexp#QuoteMeta) function.
pipeline: true
arguments:
- name: input
required: true
description: The input to escape
examples:
- |
$ gomplate -i '{{ `{hello}` | regexp.QuoteMeta }}'
\{hello\}
- name: regexp.Replace
released: v1.9.0
description: |
Replaces matches of a regular expression with the replacement string.
The replacement is substituted after expanding variables beginning with `$`.
This function provides the same behaviour as Go's
[`regexp.ReplaceAllString`](https://pkg.go.dev/regexp/#Regexp.ReplaceAllString) function.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression string
- name: replacement
required: true
description: The replacement string
- name: input
required: true
description: The input string to operate on
examples:
- |
$ gomplate -i '{{ regexp.Replace "(foo)bar" "$1" "foobar"}}'
foo
- |
$ gomplate -i '{{ regexp.Replace "(?P<first>[a-zA-Z]+) (?P<last>[a-zA-Z]+)" "${last}, ${first}" "Alan Turing"}}'
Turing, Alan
- name: regexp.ReplaceLiteral
released: v3.1.0
description: |
Replaces matches of a regular expression with the replacement string.
The replacement is substituted directly, without expanding variables
beginning with `$`.
This function provides the same behaviour as Go's
[`regexp.ReplaceAllLiteralString`](https://pkg.go.dev/regexp/#Regexp.ReplaceAllLiteralString) function.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression string
- name: replacement
required: true
description: The replacement string
- name: input
required: true
description: The input string to operate on
examples:
- |
$ gomplate -i '{{ regexp.ReplaceLiteral "(foo)bar" "$1" "foobar"}}'
$1
- |
$ gomplate -i '{{ `foo.bar,baz` | regexp.ReplaceLiteral `\W` `$` }}'
foo$bar$baz
- name: regexp.Split
released: v3.1.0
description: |
Splits `input` into sub-strings, separated by the expression.
This can be called with 2 or 3 arguments. When called with 2 arguments, the
`n` argument (number of matches) will be set to `-1`, causing all sub-strings
to be returned.
This is equivalent to [`strings.SplitN`](../strings/#stringssplitn),
except that regular expressions are supported.
This function provides the same behaviour as Go's
[`regexp.Split`](https://pkg.go.dev/regexp/#Regexp.Split) function.
pipeline: true
arguments:
- name: expression
required: true
description: The regular expression
- name: n
required: false
description: The number of matches to return
- name: input
required: true
description: The input to search
examples:
- |
$ gomplate -i '{{ regexp.Split `[\s,.]` "foo bar,baz.qux" | toJSON}}'
["foo","bar","baz","qux"]
- |
$ gomplate -i '{{ "foo bar.baz,qux" | regexp.Split `[\s,.]` 3 | toJSON}}'
["foo","bar","baz"]
|
