sprig

Sprig provides tons of utilitary functions to be used inside templates.

abbrev

Truncate a string with ellipses (...)

Parameters:

max length
the string

abbrev 5 "hello world"

The above returns he..., since it counts the width of the ellipses against the maximum length.

abbrevboth

Abbreviate both sides:

abbrevboth 5 10 "1234 5678 9123"

the above produces ...5678...

It takes:

left offset
max length
the string

add

Sum numbers with add. Accepts two or more inputs.

add 1 2 3

add1

To increment by 1, use add1

add1f

To increment a float by 1, use add1f

addf

Sum floats with addf. Accepts two or more inputs.

addf 1.0 2.1 3.4

adler32sum

Computes adler32 checksum

ago

The ago function returns duration from time.Now in seconds resolution.

ago .CreatedAt"

returns in time.Duration String() format

2h34m7s

all

all returns true if empty(x) is false for all values x in the list. If the list is empty, return true.

any

any returns true if empty(x) is false for any x in the list. If the list is empty, return false.

append

Append a new item to an existing list, creating a new list.

$new = append $myList 6

The above would set $new to [1 2 3 4 5 6]. $myList would remain unaltered.

append panics if there is a problem while mustAppend returns an error to the template engine if there is a problem.

atoi

atoi: Convert a string to an integer.

Only atoi requires that the input be a specific type. The others will attempt to convert from any type to the destination type. For example, int64 can convert floats to ints, and it can also convert strings to ints.

b32dec

Sprig has the following encoding and decoding functions:

b32enc/b32dec: Encode or decode with Base32

b32enc

Sprig has the following encoding and decoding functions:

b32enc/b32dec: Encode or decode with Base32

b64dec

Sprig has the following encoding and decoding functions:

b64enc/b64dec: Encode or decode with Base64

b64enc

Sprig has the following encoding and decoding functions:

b64enc/b64dec: Encode or decode with Base64

base

Return the last element of a path.

base "foo/bar/baz"

The above prints "baz"

bcrypt

bcrypt returns the bcrypt hash of a password using bcrypt library with the DefaultCost.

biggest

No documentation for this function

buildCustomCert

The buildCustomCert function allows customizing the certificate.

It takes the following string parameters:

A base64 encoded PEM format certificate
A base64 encoded PEM format private key

It returns a certificate object with the following attributes:

Cert: A PEM-encoded certificate
Key: A PEM-encoded private key

Example:

$ca := buildCustomCert "base64-encoded-ca-crt" "base64-encoded-ca-key"

Note that the returned object can be passed to the genSignedCert function to sign a certificate using this CA.

camelcase

Convert string from snake_case to CamelCase

camelcase "http_server"

This above will produce HttpServer.

cat

The cat function concatenates multiple strings together into one, separating them with spaces:

cat "hello" "beautiful" "world"

The above produces hello beautiful world

ceil

Returns the greatest float value greater than or equal to input value

ceil 123.001 will return 124.0

chunk

To split a list into chunks of given size, use chunk size list. This is useful for pagination.

chunk 3 (list 1 2 3 4 5 6 7 8)

This produces list of lists [ [ 1 2 3 ] [ 4 5 6 ] [ 7 8 ] ].

clean

Clean up a path.

clean "foo/bar/../baz"

The above resolves the .. and returns foo/baz

coalesce

The coalesce function takes a list of values and returns the first non-empty one.

coalesce 0 1 2

The above returns 1.

This function is useful for scanning through multiple variables or values:

coalesce .name .parent.name "Matt"

The above will first check to see if .name is empty. If it is not, it will return that value. If it is empty, coalesce will evaluate .parent.name for emptiness. Finally, if both .name and .parent.name are empty, it will return Matt.

compact

Accepts a list and removes entries with empty values.

$list := list 1 "a" "foo" ""
$copy := compact $list

compact will return a new list with the empty (i.e., "") item removed.

compact panics if there is a problem and mustCompact returns an error to the template engine if there is a problem.

concat

Concatenate arbitrary number of lists into one.

concat $myList ( list 6 7 ) ( list 8 )

The above would produce [1 2 3 4 5 6 7 8]. $myList would remain unaltered.

contains

Test to see if one string is contained inside of another:

contains "cat" "catch"

The above returns true because catch contains cat.

date

The date function formats a date.

Format the date to YEAR-MONTH-DAY:

now | date "2006-01-02"

Date formatting in Go is a little bit different.

In short, take this as the base date:

Mon Jan 2 15:04:05 MST 2006

Write it in the format you want. Above, 2006-01-02 is the same date, but in the format we want.

dateInZone

Same as date, but with a timezone.

dateInZone "2006-01-02" (now) "UTC"

dateModify

The dateModify takes a modification and a date and returns the timestamp.

Subtract an hour and thirty minutes from the current time:

now | date_modify "-1.5h"

If the modification format is wrong dateModify will return the date unmodified. mustDateModify will return an error otherwise.

date_in_zone

Same as date, but with a timezone.

dateInZone "2006-01-02" (now) "UTC"

date_modify

The dateModify takes a modification and a date and returns the timestamp.

Subtract an hour and thirty minutes from the current time:

now | date_modify "-1.5h"

If the modification format is wrong dateModify will return the date unmodified. mustDateModify will return an error otherwise.

decryptAES

The decryptAES function receives a base64 string encoded by the AES-256 CBC algorithm and returns the decoded text.

"30tEfhuJSVRhpG97XCuWgz2okj7L8vQ1s6V9zVUPeDQ=" | decryptAES "secretkey"

deepCopy

The deepCopy and mustDeepCopy functions takes a value and makes a deep copy of the value. This includes dicts and other structures. deepCopy panics when there is a problem while mustDeepCopy returns an error to the template system when there is an error.

dict "a" 1 "b" 2 | deepCopy

deepEqual

deepEqual returns true if two values are "deeply equal"

Works for non-primitive types as well (compared to the built-in eq).

deepEqual (list 1 2 3) (list 1 2 3)

The above will return true

default

To set a simple default value, use default:

default "foo" .Bar

In the above, if .Bar evaluates to a non-empty value, it will be used. But if it is empty, foo will be returned instead.

The definition of "empty" depends on type:

Numeric: 0
String: ""
Lists: []
Dicts: {}
Boolean: false
And always nil (aka null)

For structs, there is no definition of empty, so a struct will never return the default.

derivePassword

The derivePassword function can be used to derive a specific password based on some shared "master password" constraints. The algorithm for this is well specified.

derivePassword 1 "long" "password" "user" "example.com"

Note that it is considered insecure to store the parts directly in the template.

dict

Creating dictionaries is done by calling the dict function and passing it a list of pairs.

The following creates a dictionary with three items:

$myDict := dict "name1" "value1" "name2" "value2" "name3" "value 3"

dig

The dig function traverses a nested set of dicts, selecting keys from a list of values. It returns a default value if any of the keys are not found at the associated dict.

dig "user" "role" "humanName" "guest" $dict

Given a dict structured like

{
  user: {
    role: {
      humanName: "curator"
    }
  }
}

the above would return "curator". If the dict lacked even a user field, the result would be "guest".

Dig can be very useful in cases where you'd like to avoid guard clauses, especially since Go's template package's and doesn't shortcut. For instance and a.maybeNil a.maybeNil.iNeedThis will always evaluate a.maybeNil.iNeedThis, and panic if a lacks a maybeNil field.)

dig accepts its dict argument last in order to support pipelining. For instance:

merge a b c | dig "one" "two" "three" "<missing>"

## dir

 Compute dirname of a path. It uses internal `path` library, expecting forward slashes.

Example : 

    # Assuming node path is pydiods1/folder/filename.txt
    {{.Node.Path | dir}}
    => "pydiods1/folder"

## div

 Perform integer division with `div`

## divf

 Floats division

## duration

 Formats a given amount of seconds as a `time.Duration`.

This returns 1m35s

duration "95"


## durationRound

 Rounds a given duration to the most significant unit. Strings and `time.Duration`
gets parsed as a duration, while a `time.Time` is calculated as the duration since.

This return 2h

durationRound "2h10m5s"


This returns 3mo

durationRound "2400h10m5s"



## empty

 The `empty` function returns `true` if the given value is considered empty, and
`false` otherwise. The empty values are listed in the `default` section.

empty .Foo


Note that in Go template conditionals, emptiness is calculated for you. Thus,
you rarely need `if empty .Foo`. Instead, just use `if .Foo`.


## encryptAES

 The `encryptAES` function encrypts text with AES-256 CBC and returns a base64 encoded string.

encryptAES "secretkey" "plaintext"


## ext

 Return the file extension.

ext "foo.bar"


The above returns `.bar`.

## fail

 Unconditionally returns an empty `string` and an `error` with the specified
text. This is useful in scenarios where other conditionals have determined that
template rendering should fail.

fail "Please accept the end user license agreement"



## first

 To get the head item on a list, use `first`.

`first $myList` returns `1`

`first` panics if there is a problem while `mustFirst` returns an error to the
template engine if there is a problem.

## float64

 `float64`: Convert to a `float64`.

## floor

 Returns the greatest float value less than or equal to input value

`floor 123.9999` will return `123.0`

## fromJson

 `fromJson` decodes a JSON document into a structure. If the input cannot be decoded as JSON the function will return an empty string.
`mustFromJson` will return an error in case the JSON is invalid.

fromJson "{\"foo\": 55}"



## genCA

 The `genCA` function generates a new, self-signed x509 certificate authority using a
2048-bit RSA private key.

It takes the following parameters:

- Subject's common name (cn)
- Cert validity duration in days

It returns an object with the following attributes:

- `Cert`: A PEM-encoded certificate
- `Key`: A PEM-encoded private key

Example:

$ca := genCA "foo-ca" 365


Note that the returned object can be passed to the `genSignedCert` function
to sign a certificate using this CA.


## genCAWithKey

 The `genCAWithKey` function generates a new, self-signed x509 certificate authority using a
given private key.

It takes the following parameters:

- Subject's common name (cn)
- Cert validity duration in days
- Private key (PEM-encoded); DSA keys are not supported

It returns an object with the following attributes:

- `Cert`: A PEM-encoded certificate
- `Key`: A PEM-encoded private key

Example:

$ca := genCAWithKey "foo-ca" 365 (genPrivateKey "rsa")


Note that the returned object can be passed to the `genSignedCert` function
to sign a certificate using this CA.


## genPrivateKey


The `genPrivateKey` function generates a new private key encoded into a PEM
block.

It takes one of the values for its first param:

- `ecdsa`: Generate an elliptic curve DSA key (P256)
- `dsa`: Generate a DSA key (L2048N256)
- `rsa`: Generate an RSA 4096 key

## genSelfSignedCert

 The `genSelfSignedCert` function generates a new, self-signed x509 certificate using a
2048-bit RSA private key.

It takes the following parameters:

- Subject's common name (cn)
- Optional list of IPs; may be nil
- Optional list of alternate DNS names; may be nil
- Cert validity duration in days

It returns an object with the following attributes:

- `Cert`: A PEM-encoded certificate
- `Key`: A PEM-encoded private key

Example:

$cert := genSelfSignedCert "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365



## genSelfSignedCertWithKey

 The `genSelfSignedCertWithKey` function generates a new, self-signed x509 certificate using a
given private key.

It takes the following parameters:

- Subject's common name (cn)
- Optional list of IPs; may be nil
- Optional list of alternate DNS names; may be nil
- Cert validity duration in days
- Private key (PEM-encoded); DSA keys are not supported

It returns an object with the following attributes:

- `Cert`: A PEM-encoded certificate
- `Key`: A PEM-encoded private key

Example:

$cert := genSelfSignedCertWithKey "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365 (genPrivateKey "ecdsa")


## genSignedCert

 The `genSignedCert` function generates a new, x509 certificate signed by the
specified CA, using a 2048-bit RSA private key.

It takes the following parameters:

- Subject's common name (cn)
- Optional list of IPs; may be nil
- Optional list of alternate DNS names; may be nil
- Cert validity duration in days
- CA (see `genCA`)

Example:

$ca := genCA "foo-ca" 365 $cert := genSignedCert "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365 $ca



## genSignedCertWithKey

 The `genSignedCertWithKey` function generates a new, x509 certificate signed by the
specified CA, using a given private key.

It takes the following parameters:

- Subject's common name (cn)
- Optional list of IPs; may be nil
- Optional list of alternate DNS names; may be nil
- Cert validity duration in days
- CA (see `genCA`)
- Private key (PEM-encoded); DSA keys are not supported

Example:

$ca := genCA "foo-ca" 365 $cert := genSignedCert "foo.com" (list "10.0.0.1" "10.0.0.2") (list "bar.com" "bat.com") 365 $ca (genPrivateKey "ed25519")



## get

 `get` finds a key inside a map[string]interface{}, similar to `index` core function. Only works for this type, not map[string]string.

Given a map and a key, get the value from the map.

get $myDict "key1"


The above returns `"value1"`

Note that if the key is not found, this operation will simply return `""`. No error
will be generated.

## getHostByName

 The `getHostByName` receives a domain name and returns the ip address.

getHostByName "www.google.com" would return the corresponding ip address of www.google.com


## has

 Test to see if a list has a particular element.

has 4 $myList


The above would return `true`, while `has "hello" $myList` would return false.

`has` panics if there is a problem while `mustHas` returns an error to the
template engine if there is a problem.

## hasKey

 The `hasKey` function returns `true` if the given dict contains the given key.

hasKey $myDict "name1"


If the key is not found, this returns `false`.

## hasPrefix

 The `hasPrefix` and `hasSuffix` functions test whether a string has a given
prefix or suffix:

hasPrefix "cat" "catch"


The above returns `true` because `catch` has the prefix `cat`.

## hasSuffix

 The `hasPrefix` and `hasSuffix` functions test whether a string has a given
prefix or suffix:

hasPrefix "cat" "catch"


The above returns `true` because `catch` has the prefix `cat`.

## hello

 No documentation for this function

## htmlDate

 The `htmlDate` function formats a date for inserting into an HTML date picker
input field.

now | htmlDate


## htmlDateInZone

 Same as htmlDate, but with a timezone.

htmlDateInZone (now) "UTC"



## htpasswd

 The `htpasswd` function takes a `username` and `password` and generates a `bcrypt` hash of the password. The result can be used for basic authentication on an [Apache HTTP Server](https://httpd.apache.org/docs/2.4/misc/password_encryptions.html#basic).

htpasswd "myUser" "myPassword"


Note that it is insecure to store the password directly in the template.


## indent

 The `indent` function indents every line in a given string to the specified
indent width. This is useful when aligning multi-line strings:

indent 4 $lots_of_text


The above will indent every line of text by 4 space characters.

## initial

 This compliments `last` by returning all _but_ the last element.
`initial $myList` returns `[1 2 3 4]`.

`initial` panics if there is a problem while `mustInitial` returns an error to the
template engine if there is a problem.

## initials

 Given multiple words, take the first letter of each word and combine.

initials "First Try"


The above returns `FT`

## int

 `int`: Convert to an `int` at the system's width.

## int64

 int64`: Convert to an `int64`.

## isAbs

 To check whether a file path is absolute, use `isAbs`.

## join

 Join a list of strings into a single string, with the given separator.

list "hello" "world" | join "_"


The above will produce `hello_world`

`join` will try to convert non-strings to a string value:

list 1 2 3 | join "+"


The above will produce `1+2+3`

## kebabcase

 Convert string from camelCase to kebab-case.

kebabcase "FirstName"


This above will produce `first-name`.

## keys

 The `keys` function will return a `list` of all of the keys in one or more `dict`
types. Since a dictionary is _unordered_, the keys will not be in a predictable order.
They can be sorted with `sortAlpha`.

keys $myDict | sortAlpha


When supplying multiple dictionaries, the keys will be concatenated. Use the `uniq`
function along with `sortAlpha` to get a unqiue, sorted list of keys.

keys $myDict $myOtherDict | uniq | sortAlpha

kindIs

There are two Kind functions: kindOf returns the kind of an object.

kindOf "hello"

The above would return string. For simple tests (like in if blocks), the isKind function will let you verify that a value is a particular kind:

kindIs "int" 123

The above will return true

kindOf

There are two Kind functions: kindOf returns the kind of an object.

kindOf "hello"

The above would return string. For simple tests (like in if blocks), the isKind function will let you verify that a value is a particular kind:

kindIs "int" 123

The above will return true

last

To get the last item on a list, use last:

last $myList returns 5. This is roughly analogous to reversing a list and then calling first.

list

No documentation for this function

lower

Convert the entire string to lowercase:

lower "HELLO"

The above returns hello

max

Return the largest of a series of integers:

This will return 3:

max 1 2 3

maxf

Floats version of max

merge

Merge two or more dictionaries into one, giving precedence to the dest dictionary:

$newdict := merge $dest $source1 $source2

This is a deep merge operation but not a deep copy operation. Nested objects that are merged are the same instance on both dicts. If you want a deep copy along with the merge than use the deepCopy function along with merging. For example,

deepCopy $source | merge $dest

mustMerge will return an error in case of unsuccessful merge.

mergeOverwrite

Merge two or more dictionaries into one, giving precedence from right to left, effectively overwriting values in the dest dictionary:

Given:

dst:
  default: default
  overwrite: me
  key: true

src:
  overwrite: overwritten
  key: false

will result in:

newdict:
  default: default
  overwrite: overwritten
  key: false

$newdict := mergeOverwrite $dest $source1 $source2

deepCopy $source | mergeOverwrite $dest

mustMergeOverwrite will return an error in case of unsuccessful merge.

min

Return the smallest of a series of integers.

min 1 2 3 will return 1

minf

Floats version of min

mod

Modulo with mod

mul

Multiply with mul. Accepts two or more inputs.

mul 1 2 3