Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
a tool to build emails with cool tools like mjml and different template engine lime handlebars or eta.js
Emails are hard to develop. there is some awesome libs that makes the development more easy. But each library allow us to do a single thing without focus on a full development flow. This project wants to mix up MJML, a template enigne for variables/logic and a web server.
npm i marilena
1 - create a marilena.config.js
file under root of your project:
// this is an example of config structure
module.exports = {
templateSuffix: ".html",
inputFolder: "input",
outputFolder: "output",
locales: ["en","it"],
templateOptions: {
engine: "eta",
variablesType: "json",
prepareEngine: (xxx) => {
// engine eta => xxx = eta
// engine handlebars => xxx = handlebars
// read below about this part
},
},
};
2 - create a file structures based on your config. PLease remember that each email template requires index
as name, and variables are loaded only from variables.json
project
| marilena.config.js
│ package.json
│ input
│ └──buy // email name
││││││└─── index.html // index[templateSuffix]
││││││└─── en
│││││││││││└── variables.json
││││││└─── it
│││││││││││└── variables.json
3 - fill your emails template with MJML syntax
<mjml>
<mj-body>
<mj-section>
<mj-column>
<!-- read below about template engine -->
<mj-text>hello <%= it.user %></mj-text>
</mj-column>
</mj-section>
</mj-body>
</mjml>
4 - run one of these 2 commands
# open a server on http://localhost:8080
npm run start
# build all emails based on config (template engine, output folder, and locales)
npm run build
Under the hood a default configuration will be loaded but a file marilena.config.js
allow us to set:
name | required | description | default |
---|---|---|---|
templateSuffix | X | extension of files used for email. Used for filter and can any value | .html |
inputFolder | X | folder where email are in the project | input |
outputFolder | X | folder used for generated email (when run build command) | output |
locales | X | array of languages used. If you company has only spanish email use an array of single value | ["en"] |
templateOptions | if you chose to use one of supported engines, this part id required to setup custom partial and other settings for the template engine selected. Read below for some use cases | empty |
This project can producte output html from input template. But in a real word probably we store variables in some part and render some content multiple times (example a footer). In this case templateOptions
can define:
engine
: a subset of fastify supported template engine. At this moment ["eta","handlebars"]
are supported.variablesType
: define if variables are loaded from json file or yaml file. At this moment only json
are supported.prepareEngine
: define a callback where we can setup our engine. Basically you can define all things before the render. For example: templateOptions: {
engine: "eta",
variablesType: "json",
prepareEngine: (eta) => {
// we can register partial like:
// eta is same of var eta = require("eta");
eta.templates.define("partial_1", eta.compile("this is partial 1"));
},
},
templateOptions: {
engine: "handlebars",
variablesType: "json",
prepareEngine: (h) => {
// we can register partial like:
// handlebars is same of var h = require("handlebars");
h.registerPartial("myPartial", "partial with {{ user }}");
},
},
FAQs
a tool to build emails with cool stuff like mjml and different template engine like handlebars or eta.js
The npm package marilena receives a total of 7 weekly downloads. As such, marilena popularity was classified as not popular.
We found that marilena demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.