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
|
---
title: path functions
menu:
main:
parent: functions
---
gomplate's path functions are split into 2 namespaces:
- `path`, which is useful for manipulating slash-based (`/`) paths, such as in URLs
- `filepath`, which should be used for local filesystem paths, especially when Windows paths may be involved.
This page documents the `path` namespace - see also the [`filepath`](../filepath) documentation.
These functions are wrappers for Go's [`path`](https://pkg.go.dev/path/) and [`path/filepath`](https://pkg.go.dev/path/filepath/) packages.
## `path.Base`
Returns the last element of path. Trailing slashes are removed before extracting the last element. If the path is empty, Base returns `.`. If the path consists entirely of slashes, Base returns `/`.
A wrapper for Go's [`path.Base`](https://pkg.go.dev/path/#Base) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Base path
```
```
path | path.Base
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i '{{ path.Base "/tmp/foo" }}'
foo
```
## `path.Clean`
Clean returns the shortest path name equivalent to path by purely lexical processing.
A wrapper for Go's [`path.Clean`](https://pkg.go.dev/path/#Clean) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Clean path
```
```
path | path.Clean
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i '{{ path.Clean "/tmp//foo/../" }}'
/tmp
```
## `path.Dir`
Returns all but the last element of path, typically the path's directory.
A wrapper for Go's [`path.Dir`](https://pkg.go.dev/path/#Dir) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Dir path
```
```
path | path.Dir
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i '{{ path.Dir "/tmp/foo" }}'
/tmp
```
## `path.Ext`
Returns the file name extension used by path.
A wrapper for Go's [`path.Ext`](https://pkg.go.dev/path/#Ext) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Ext path
```
```
path | path.Ext
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i '{{ path.Ext "/tmp/foo.csv" }}'
.csv
```
## `path.IsAbs`
Reports whether the path is absolute.
A wrapper for Go's [`path.IsAbs`](https://pkg.go.dev/path/#IsAbs) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.IsAbs path
```
```
path | path.IsAbs
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i 'the path is {{ if (path.IsAbs "/tmp/foo.csv") }}absolute{{else}}relative{{end}}'
the path is absolute
$ gomplate -i 'the path is {{ if (path.IsAbs "../foo.csv") }}absolute{{else}}relative{{end}}'
the path is relative
```
## `path.Join`
Joins any number of path elements into a single path, adding a separating slash if necessary.
A wrapper for Go's [`path.Join`](https://pkg.go.dev/path/#Join) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Join elem...
```
### Arguments
| name | description |
|------|-------------|
| `elem...` | _(required)_ The path elements to join (0 or more) |
### Examples
```console
$ gomplate -i '{{ path.Join "/tmp" "foo" "bar" }}'
/tmp/foo/bar
```
## `path.Match`
Reports whether name matches the shell file name pattern.
A wrapper for Go's [`path.Match`](https://pkg.go.dev/path/#Match) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Match pattern path
```
### Arguments
| name | description |
|------|-------------|
| `pattern` | _(required)_ The pattern to match on |
| `path` | _(required)_ The path to match |
### Examples
```console
$ gomplate -i '{{ path.Match "*.csv" "foo.csv" }}'
true
```
## `path.Split`
Splits path immediately following the final slash, separating it into a directory and file name component.
The function returns an array with two values, the first being the directory, and the second the file.
A wrapper for Go's [`path.Split`](https://pkg.go.dev/path/#Split) function.
_Added in gomplate [v2.7.0](https://github.com/hairyhenderson/gomplate/releases/tag/v2.7.0)_
### Usage
```
path.Split path
```
```
path | path.Split
```
### Arguments
| name | description |
|------|-------------|
| `path` | _(required)_ The input path |
### Examples
```console
$ gomplate -i '{{ $p := path.Split "/tmp/foo" }}{{ $dir := index $p 0 }}{{ $file := index $p 1 }}dir is {{$dir}}, file is {{$file}}'
dir is /tmp/, file is foo
```
|
