Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soranoba/bbmustache
Binary pattern match Based Mustache template engine for Erlang/OTP.
https://github.com/soranoba/bbmustache
erlang mustache template-engine
Last synced: 7 days ago
JSON representation
Binary pattern match Based Mustache template engine for Erlang/OTP.
- Host: GitHub
- URL: https://github.com/soranoba/bbmustache
- Owner: soranoba
- License: mit
- Created: 2015-02-17T15:26:13.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-29T04:48:37.000Z (8 months ago)
- Last Synced: 2025-01-12T04:33:36.190Z (14 days ago)
- Topics: erlang, mustache, template-engine
- Language: Erlang
- Homepage:
- Size: 5.71 MB
- Stars: 183
- Watchers: 13
- Forks: 51
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Erlang - Binary pattern match Based Mustache template engine for Erlang/OTP. (Templating)
- fucking-awesome-elixir - bbmustache - Binary pattern match Based Mustache template engine for Erlang/OTP. (Templating)
- awesome-elixir - bbmustache - Binary pattern match Based Mustache template engine for Erlang/OTP. (Templating)
README
bbmustache
===========
[](https://circleci.com/gh/soranoba/bbmustache/tree/master)
[](https://hex.pm/packages/bbmustache)
Binary pattern match Based Mustache template engine for Erlang/OTP.
## Overview
- Binary pattern match based mustache template engine for Erlang/OTP.
- It means do not use regular expressions.
- Support maps and associative arrays.
- Officially support is OTP24 or later.
### What is Mustache ?
A logic-less templates.
- [{{mustache}}](http://mustache.github.io/)
## Usage
### Quick start
```bash
$ git clone https://github.com/soranoba/bbmustache.git
$ cd bbmustache
$ make start
Erlang/OTP 17 [erts-6.3] [source-f9282c6] [64-bit] [smp:4:4] [async-threads:10] [hipe] [kernel-poll:true]
Eshell V6.3 (abort with ^G)
1> bbmustache:render(<<"{{name}}">>, #{"name" => "hoge"}).
<<"hoge">>
2> bbmustache:render(<<"{{name}}">>, [{"name", "hoge"}]).
<<"hoge">>
```
### Use as a library
Add the following settings.
```erlang
%% rebar (rebar.config)
{deps,
[
{bbmustache, ".*", {git, "https://github.com/soranoba/bbmustache.git", {branch, "master"}}}
]}.
%% rebar3 (rebar.config)
{deps, [bbmustache]}.
```
### How to use simple Mustache
Map
```erlang
1> bbmustache:render(<<"{{name}}">>, #{"name" => "hoge"}).
<<"hoge">>
2> Template1 = bbmustache:parse_binary(<<"{{name}}">>).
...
3> bbmustache:compile(Template1, #{"name" => "hoge"}).
<<"hoge">>
4> Template2 = bbmustache:parse_file(<<"./hoge.mustache">>).
...
5> bbmustache:compile(Template2, #{"name" => "hoge"}).
<<"hoge">>
```
Associative array
```erlang
1> bbmustache:render(<<"{{name}}">>, [{"name", "hoge"}]).
<<"hoge">>
2> Template1 = bbmustache:parse_binary(<<"{{name}}">>).
...
3> bbmustache:compile(Template1, [{"name", "hoge"}]).
<<"hoge">>
4> Template2 = bbmustache:parse_file(<<"./hoge.mustache">>).
...
5> bbmustache:compile(Template2, [{"name", "hoge"}]).
<<"hoge">>
```
### Use as a command-line tool
```bash
make escriptize
echo '{"name", "hoge"}.' > vars.config
echo '{{name}}' > template.mustache
./bbmustache -d vars.config template.mustache
hoge
```
Data files (-d) support a single assoc list, a single map, and [consult](https://erlang.org/doc/man/file.html#consult-1) format.
Note: the behind term has a high priority in all cases. it is a result of supporting to allow for embedding relative file paths as in [config](http://erlang.org/doc/man/config.html).
### More information
- For the alias of mustache, Please refer to [ManPage](http://mustache.github.io/mustache.5.html) and [Specification](https://github.com/mustache/spec)
- For the options of this library, please see [doc](doc)
- For the functions supported by this library, please see [here](benchmarks/README.md)
## FAQ
### Avoid http escaping
```erlang
%% Please use `{{{tag}}}`
1> bbmustache:render(<<"
{{{title}}}
">>, #{"title" => "I like Erlang & mustache"}).
<<"I like Erlang & mustache
">>
%% If you should not want to use `{{{tag}}}`, escape_fun can be use.
1> bbmustache:render(<<"
{{title}}
">>, #{"title" => "I like Erlang & mustache"}, [{escape_fun, fun(X) -> X end}]).
<<"I like Erlang & mustache
">>
```
### Already used `{` and `}` for other uses (like escript)
```erlang
1> io:format(bbmustache:render(<<"
1> {{=<< >>=}}
1> {deps, [
1> <<#deps>>
1> {<>, \"<>\"}<<^last?>>,<>
1> <>
1> ]}.
1> ">>, #{"deps" => [
1> #{"name" => "bbmustache", "version" => "1.6.0"},
1> #{"name" => "jsone", "version" => "1.4.6", "last?" => true}
1> ]})).
{deps, [
{bbmustache, "1.6.0"},
{jsone, "1.4.6"}
]}.
ok
```
### Want to use something other than string for key
```erlang
1> bbmustache:render(<<"
{{{title}}}
">>, #{title => "I like Erlang & mustache"}, [{key_type, atom}]).
<<"I like Erlang & mustache
">>
2> bbmustache:render(<<"
{{{title}}}
">>, #{<<"title">> => "I like Erlang & mustache"}, [{key_type, binary}]).
<<"I like Erlang & mustache
">>
```
### Want to provide a custom serializer for Erlang Terms
```erlang
1> bbmustache:render(<<"
{{title}}
">>, #{title => "I like Erlang & mustache"}, [{key_type, atom}, {value_serializer, fun(X) -> X end}]).
<<"I like Erlang & mustache
">>
2> bbmustache:render(<<"
{{{title}}}
">>, #{<<"title">> => "I like Erlang & mustache"}, [{key_type, binary}, {value_serializer, fun(X) -> <<"replaced">> end}]).
<<"replaced
">>
3> bbmustache:render(<<"
{{{title}}}
">>, #{<<"title">> => #{<<"nested">> => <<"value">>}}, [{key_type, binary}, {value_serializer, fun(X) -> jsone:encode(X) end}]).
<<"{\"nested\": \"value\"}
">>
4> bbmustache:render(<<"
{{title}}
">>, #{<<"title">> => #{<<"nested">> => <<"value">>}}, [{key_type, binary}, {value_serializer, fun(X) -> jsone:encode(X) end}]).
<<"{"nested":"value"}
">>
```
## Attention
- Lambda expression is included wasted processing.
- Because it is optimized to `parse_binary/1` + `compile/2`.
## Comparison with other libraries
[Benchmarks and check the reference implementation](benchmarks/README.md)
## Contribute
Pull request is welcome =D
## License
[MIT License](LICENSE)