mrml-cli

Crates.iomrml-cli
lib.rsmrml-cli
version1.6.1
sourcesrc
created_at2020-10-11 10:45:32.301485
updated_at2024-07-03 18:29:36.244841
descriptionCLI for the Rust implementation of MJML renderer
homepage
repository
max_upload_size
id298307
size76,940
Jérémie Drouet (jdrouet)

documentation

README

MRML

Crates.io Crates.io

Build Status codecov

Average time to resolve an issue Percentage of issues still open 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 --locked 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

Why?

  • A Node.js server rendering an MJML template takes around 20 MB of RAM at startup and 130 MB under stress test. In Rust, less than 1.7 MB at startup and a bit less that 3 MB under stress test. The Rust version can also handle twice as many requests per second. You can perform the benchmarks by running bash script/run-bench.sh.
  • The JavaScript implementation cannot be run in the browser; the Rust one (and WebAssembly one) can be.

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

You want to sponsor us?

Buy Me A Coffee

Thanks to zachzurn.

Commit count: 0

cargo fmt