A collection of helpers for handlebars (rust).
Helpers extend the template to generate or to transform content. Few helpers are included, but if you need more helpers, ask via an issue or a PR.
To use an helper:
handlebars
{{ helper_name argument}}
To chain helpers, use parenthesis:
handlebars
{{ to_upper_case (to_singular "Hello foo-bars") }}
// -> "BAR"
see Handlebars templating language
helper signature | usage sample | sample out
-- | -- | --
replace s:String from:String to:String
| replace "Hello old" "old" "new"
| "Hello new"
to_lower_case s:String
| to_lower_case "Hello foo-bars"
| "hello foo-bars"
to_upper_case s:String
| to_upper_case "Hello foo-bars"
| "HELLO FOO-BARS"
to_camel_case s:String
| to_camel_case "Hello foo-bars"
| "helloFooBars"
to_pascal_case s:String
| to_pascal_case "Hello foo-bars"
| "HelloFooBars"
to_snake_case s:String
| to_snake_case "Hello foo-bars"
| "hello_foo_bars"
to_screaming_snake_case s:String
| to_screaming_snake_case "Hello foo-bars"
| "HELLO_FOO_BARS"
to_kebab_case s:String
| to_kebab_case "Hello foo-bars"
| "hello-foo-bars"
to_train_case s:String
| to_train_case "Hello foo-bars"
| "Hello-Foo-Bars"
to_sentence_case s:String
| to_sentence_case "Hello foo-bars"
| "Hello foo" bars
to_title_case s:String
| to_title_case "Hello foo-bars"
| "Hello Foo Bars"
to_class_case s:String
| to_class_case "Hello foo-bars"
| "HelloFooBar"
to_table_case s:String
| to_table_case "Hello foo-bars"
| "hello_foo_bars"
to_plural s:String
| to_plural "Hello foo-bars"
| "bars"
to_singular s:String
| to_singular "Hello foo-bars"
| "bar"
trim s:String
| trim " foo "
| "foo"
trim_start s:String
| trim_start " foo "
| "foo "
trim_end s:String
| trim_end " foo "
| " foo"
Helper able to render body response from an http request.
helper signature | usage sample
-- | --
http_get url:String
| http_get "http://hello/..."
gitignore_io templates:String
| gitignore_io "rust,visualstudiocode"
Helper able to extract (or transform) path (defined as string).
for the same input: "/hello/bar/foo.txt"
helpername | sample output
-- | --
filename | "foo.txt"
parent | "/hello/bar"
extension | "txt"
Helper able to get environment variables.
helpername | usage
-- | --
envvar | env_var "HOME"
Specials environment variables are predefined (some of them come from std::env::consts - Rust):
variable | possible values |
---|---|
"ARCH" |
|
"DLL_EXTENSION" |
|
"DLL_PREFIX" |
|
"DLL_SUFFIX" |
|
"EXE_EXTENSION" |
|
"EXE_SUFFIX" |
|
"FAMILY" |
|
"OS" |
|
"USERNAME" | try to find the current username, in the order:
|
helpers:
json_query query:String data:Json
: Helper able to extract information from json using JMESPath syntax for query
.json_str_query query:String data:String
: Helper able to extract information from json using JMESPath syntax for query
.json_to_str data:Json
: convert a json into a string (no pretty).json_to_str data:String
: convert(parse) a string into a json.usage| output
-- | --
{{ json_query "foo" {} }}
| `
{{ jsontostr ( jsonquery "foo" {"foo":{"bar":{"baz":true}}} ) }}|
{"bar":{"baz":true}}
{{ jsontostr ( jsonquery "foo" (strtojson "{\"foo\":{\"bar\":{\"baz\":true}}}" ) ) }}|
{"bar":{"baz":true}}
{{ json_str_query "foo" "{\"foo\":{\"bar\":{\"baz\":true}}}" }}
| {"bar":{"baz":true}}
{{ json_str_query "foo.bar.baz" "{\"foo\":{\"bar\":{\"baz\":true}}}" }}
| true
Helper able to assign (to set) a variable to use later in the template.
usage| output
-- | --
{{ assign "foo" "{}" }}
| `
{{ assign "foo" "{}" }}{{ foo }}|
{}
{{ assign "foo" "hello world" }}{{ foo }}|
hello world
{{ assign "foo" {} }}{{ foo }}|
[object]
{{ assign "foo" {"bar": 33} }}{{ foo }}|
[object]`