#cli #email #mjml

app mrml-cli

CLI for the Rust implementation of MJML renderer

11 releases (7 stable)

1.3.2 May 27, 2021
1.3.1 May 15, 2021
1.2.0 Apr 21, 2021
0.4.0 Jan 31, 2021
0.3.3 Oct 14, 2020

#30 in Email

Download history 24/week @ 2021-04-02 3/week @ 2021-04-09 46/week @ 2021-04-16 7/week @ 2021-04-23 9/week @ 2021-04-30 22/week @ 2021-05-07 41/week @ 2021-05-14 10/week @ 2021-05-21 11/week @ 2021-05-28 2/week @ 2021-06-04 12/week @ 2021-06-11 1/week @ 2021-06-18 13/week @ 2021-07-16

59 downloads per month

Custom license

12KB
225 lines

MRML

Crates.io Crates.io

Build Status codecov

Maintainability

Introduction

This project is a reimplementation of the nice MJML markup language in Rust.

How to use it in the cli

# installing mrml-cli
cargo install mrml-cli
# using it 
mrml-cli path/to/template.mjml validate
mrml-cli path/to/template.mjml render
mrml-cli path/to/template.mjml format-json --pretty
mrml-cli path/to/template.json format-mjml --pretty
# getting some help
mrml-cli --help

How to use it in my code

Update your cargo.toml.

[dependencies]
mrml = "1.2"
serde = { version = "1.0", features = ["derive"] }

Create your main.rs

use mrml;

fn main() {
    let root = mrml::parse("<mjml><mj-body></mj-body></mjml>").expect("parse template");
    let opts = mrml::prelude::render::Options::default();
    match root.render(&opts) {
        Ok(content) => println!("{}", content),
        Err(_) => println!("couldn't render mjml template"),
    };
}

Why?

  • A Node server rendering a mjml template takes around 20Mo of RAM at startup and 130Mo under stress test. In Rust, less than 1.7Mo at startup and a bit less that 3Mo under stress test. The Rust version can also handle 2 times more requests per seconds. You can run the bench by doing bash script/run-bench.sh.
  • The JS implementation cannot be run in the browser. In Rust (and Wasm), you can.

You want to contribute?

Feel free to read our contributing section and the code of conduct.

Performance

With the same linux amd64 machine, to render the amario template

  • Node: 606.59ms
  • Rust: 3.48ms

To reproduce those results, you can follow the configuration in the gitlab-ci.yml or look on codebench.cloud

Missing implementations

  • mj-style[inline]: not yet implemented. It requires parsing the generated html to apply the inline styles afterward (that's how it's done in mjml) which would kill the performances. Applying it at render time would improve the performance but it would still require to parse the css.
  • mj-include: not yet implemented. It requires to handle loading remote templates when using mrml in a wasm (browser or server side) format, which implies being able to load from a different location (file://, https://, relative, etc).

Who is using MRML?

If you are using MRML and want to be added to this list, don't hesitate to create an issue or open a pull request.

What is using MRML?

mjml_nif - Elixir library

If you are using MRML and want to be added to this list, don't hesitate to create an issue or open a pull request.

You want to sponsor us?

Buy Me A Coffee

Thanks to zachzurn.

Dependencies

~5.5MB
~120K SLoC