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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
---
title: regexp functions
menu:
main:
parent: functions
---
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.
## `regexp.Find`
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.
_Added in gomplate [v3.1.0](https://github.com/hairyhenderson/gomplate/releases/tag/v3.1.0)_
### Usage
```
regexp.Find expression input
```
```
input | regexp.Find expression
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression |
| `input` | _(required)_ The input to search |
### Examples
```console
$ gomplate -i '{{ regexp.Find "[a-z]{3}" "foobar"}}'
foo
```
```console
$ gomplate -i 'no {{ "will not match" | regexp.Find "[0-9]" }}numbers'
no numbers
```
## `regexp.FindAll`
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.
_Added in gomplate [v3.1.0](https://github.com/hairyhenderson/gomplate/releases/tag/v3.1.0)_
### Usage
```
regexp.FindAll expression [n] input
```
```
input | regexp.FindAll expression [n]
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression |
| `n` | _(optional)_ The number of matches to return |
| `input` | _(required)_ The input to search |
### Examples
```console
$ gomplate -i '{{ regexp.FindAll "[a-z]{3}" "foobar" | toJSON}}'
["foo", "bar"]
```
```console
$ gomplate -i '{{ "foo bar baz qux" | regexp.FindAll "[a-z]{3}" 3 | toJSON}}'
["foo", "bar", "baz"]
```
## `regexp.Match`
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.
_Added in gomplate [v1.9.0](https://github.com/hairyhenderson/gomplate/releases/tag/v1.9.0)_
### Usage
```
regexp.Match expression input
```
```
input | regexp.Match expression
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression |
| `input` | _(required)_ The input to test |
### Examples
```console
$ gomplate -i '{{ if (.Env.USER | regexp.Match `^h`) }}username ({{.Env.USER}}) starts with h!{{end}}'
username (hairyhenderson) starts with h!
```
## `regexp.QuoteMeta`
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.
_Added in gomplate [v3.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v3.7.0)_
### Usage
```
regexp.QuoteMeta input
```
```
input | regexp.QuoteMeta
```
### Arguments
| name | description |
|------|-------------|
| `input` | _(required)_ The input to escape |
### Examples
```console
$ gomplate -i '{{ `{hello}` | regexp.QuoteMeta }}'
\{hello\}
```
## `regexp.Replace`
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.
_Added in gomplate [v1.9.0](https://github.com/hairyhenderson/gomplate/releases/tag/v1.9.0)_
### Usage
```
regexp.Replace expression replacement input
```
```
input | regexp.Replace expression replacement
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression string |
| `replacement` | _(required)_ The replacement string |
| `input` | _(required)_ The input string to operate on |
### Examples
```console
$ gomplate -i '{{ regexp.Replace "(foo)bar" "$1" "foobar"}}'
foo
```
```console
$ gomplate -i '{{ regexp.Replace "(?P<first>[a-zA-Z]+) (?P<last>[a-zA-Z]+)" "${last}, ${first}" "Alan Turing"}}'
Turing, Alan
```
## `regexp.ReplaceLiteral`
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.
_Added in gomplate [v3.1.0](https://github.com/hairyhenderson/gomplate/releases/tag/v3.1.0)_
### Usage
```
regexp.ReplaceLiteral expression replacement input
```
```
input | regexp.ReplaceLiteral expression replacement
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression string |
| `replacement` | _(required)_ The replacement string |
| `input` | _(required)_ The input string to operate on |
### Examples
```console
$ gomplate -i '{{ regexp.ReplaceLiteral "(foo)bar" "$1" "foobar"}}'
$1
```
```console
$ gomplate -i '{{ `foo.bar,baz` | regexp.ReplaceLiteral `\W` `$` }}'
foo$bar$baz
```
## `regexp.Split`
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.
_Added in gomplate [v3.1.0](https://github.com/hairyhenderson/gomplate/releases/tag/v3.1.0)_
### Usage
```
regexp.Split expression [n] input
```
```
input | regexp.Split expression [n]
```
### Arguments
| name | description |
|------|-------------|
| `expression` | _(required)_ The regular expression |
| `n` | _(optional)_ The number of matches to return |
| `input` | _(required)_ The input to search |
### Examples
```console
$ gomplate -i '{{ regexp.Split `[\s,.]` "foo bar,baz.qux" | toJSON}}'
["foo","bar","baz","qux"]
```
```console
$ gomplate -i '{{ "foo bar.baz,qux" | regexp.Split `[\s,.]` 3 | toJSON}}'
["foo","bar","baz"]
```
|
