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
|
ns: filepath
preamble: |
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 `filepath` namespace - see also the [`path`](../path) documentation.
These functions are wrappers for Go's [`path/filepath`](https://pkg.go.dev/path/filepath/) package.
funcs:
- name: filepath.Base
released: v2.7.0
description: |
Returns the last element of path. Trailing path separators are removed before extracting the last element. If the path is empty, Base returns `.`. If the path consists entirely of separators, Base returns a single separator.
A wrapper for Go's [`filepath.Base`](https://pkg.go.dev/path/filepath/#Base) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.Base "/tmp/foo" }}'
foo
- name: filepath.Clean
released: v2.7.0
description: |
Clean returns the shortest path name equivalent to path by purely lexical processing.
A wrapper for Go's [`filepath.Clean`](https://pkg.go.dev/path/filepath/#Clean) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.Clean "/tmp//foo/../" }}'
/tmp
- name: filepath.Dir
released: v2.7.0
description: |
Returns all but the last element of path, typically the path's directory.
A wrapper for Go's [`filepath.Dir`](https://pkg.go.dev/path/filepath/#Dir) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.Dir "/tmp/foo" }}'
/tmp
- name: filepath.Ext
released: v2.7.0
description: |
Returns the file name extension used by path.
A wrapper for Go's [`filepath.Ext`](https://pkg.go.dev/path/filepath/#Ext) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.Ext "/tmp/foo.csv" }}'
.csv
- name: filepath.FromSlash
released: v2.7.0
description: |
Returns the result of replacing each slash (`/`) character in the path with the platform's separator character.
A wrapper for Go's [`filepath.FromSlash`](https://pkg.go.dev/path/filepath/#FromSlash) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.FromSlash "/foo/bar" }}'
/foo/bar
C:\> gomplate.exe -i '{{ filepath.FromSlash "/foo/bar" }}'
C:\foo\bar
- name: filepath.IsAbs
released: v2.7.0
description: |
Reports whether the path is absolute.
A wrapper for Go's [`filepath.IsAbs`](https://pkg.go.dev/path/filepath/#IsAbs) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i 'the path is {{ if (filepath.IsAbs "/tmp/foo.csv") }}absolute{{else}}relative{{end}}'
the path is absolute
$ gomplate -i 'the path is {{ if (filepath.IsAbs "../foo.csv") }}absolute{{else}}relative{{end}}'
the path is relative
- name: filepath.Join
released: v2.7.0
description: |
Joins any number of path elements into a single path, adding a separator if necessary.
A wrapper for Go's [`filepath.Join`](https://pkg.go.dev/path/filepath/#Join) function.
arguments:
- name: elem...
required: true
description: The path elements to join (0 or more)
examples:
- |
$ gomplate -i '{{ filepath.Join "/tmp" "foo" "bar" }}'
/tmp/foo/bar
C:\> gomplate.exe -i '{{ filepath.Join "C:\tmp" "foo" "bar" }}'
C:\tmp\foo\bar
- name: filepath.Match
released: v2.7.0
description: |
Reports whether name matches the shell file name pattern.
A wrapper for Go's [`filepath.Match`](https://pkg.go.dev/path/filepath/#Match) function.
arguments:
- name: pattern
required: true
description: The pattern to match on
- name: path
required: true
description: The path to match
examples:
- |
$ gomplate -i '{{ filepath.Match "*.csv" "foo.csv" }}'
true
- name: filepath.Rel
released: v2.7.0
description: |
Returns a relative path that is lexically equivalent to targetpath when joined to basepath with an intervening separator.
A wrapper for Go's [`filepath.Rel`](https://pkg.go.dev/path/filepath/#Rel) function.
arguments:
- name: basepath
required: true
description: The base path
- name: targetpath
required: true
description: The target path
examples:
- |
$ gomplate -i '{{ filepath.Rel "/a" "/a/b/c" }}'
b/c
- name: filepath.Split
released: v2.7.0
description: |
Splits path immediately following the final path separator, 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 [`filepath.Split`](https://pkg.go.dev/path/filepath/#Split) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ $p := filepath.Split "/tmp/foo" }}{{ $dir := index $p 0 }}{{ $file := index $p 1 }}dir is {{$dir}}, file is {{$file}}'
dir is /tmp/, file is foo
C:\> gomplate.exe -i '{{ $p := filepath.Split `C:\tmp\foo` }}{{ $dir := index $p 0 }}{{ $file := index $p 1 }}dir is {{$dir}}, file is {{$file}}'
dir is C:\tmp\, file is foo
- name: filepath.ToSlash
released: v2.7.0
description: |
Returns the result of replacing each separator character in path with a slash (`/`) character.
A wrapper for Go's [`filepath.ToSlash`](https://pkg.go.dev/path/filepath/#ToSlash) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
$ gomplate -i '{{ filepath.ToSlash "/foo/bar" }}'
/foo/bar
C:\> gomplate.exe -i '{{ filepath.ToSlash `foo\bar\baz` }}'
foo/bar/baz
- name: filepath.VolumeName
released: v2.7.0
description: |
Returns the leading volume name. Given `C:\foo\bar` it returns `C:` on Windows. Given a UNC like `\\host\share\foo` it returns `\\host\share`. On other platforms it returns an empty string.
A wrapper for Go's [`filepath.VolumeName`](https://pkg.go.dev/path/filepath/#VolumeName) function.
pipeline: true
arguments:
- name: path
required: true
description: The input path
examples:
- |
C:\> gomplate.exe -i 'volume is {{ filepath.VolumeName "C:/foo/bar" }}'
volume is C:
$ gomplate -i 'volume is {{ filepath.VolumeName "/foo/bar" }}'
volume is
|
