Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
By Philipp Burckhardt - Oct 17, 2024
Renderly - A minimal template engine based on ES6 template strings
A minimal template engine for Node based on ES6 string templates.
It handles variable interpolation, supports rendering partials and it gracefully handles presentation logic(ifs, fors etc) within the template.
Usage
First install:
npm i renderly
Programatic usage
The API is minimal by design and consists of a single function: createRenderer(options) .
It takes in a set of options and returns a render function.
Options:
globals- A javascript object whose keys are available in any rendered template without them needing to be passed to the views.
const { createRenderer } = require("../index");
// calling createRenderer returns a render function
const render = createRenderer({
globals: {
link: function(post) {
return `posts/${post.id}`;
},
siteTitle: 'Test'
}
});
const tplData = {
name: "John",
// This is a computed property
get lang() {
return `${this.name} speaks French!`;
}
// You can pass functions. Basically whatever you want
currencyFormatter: function() { .... }
};
// A `render` function is automatically added to the template data
console.log(render("./templates/test.tpl", tplData));
See also the examples folder.
How the templates look like
In file test.tsg:
<html>
${render('templates/head.tsg', {name})}
<body>
<div>
Hi ${name}. ${ name === 'test' ? 'This is a test name': 'This is a real a
name'} Language info: ${lang}
</div>
<a href="${link({id: 1})}">Test link</a>
</body>
</html>
In file head.tsg:
<head>
<title>Main page</title>
${render('templates/meta.tsg', {name})}
</head>
In file meta.tsg:
<meta name="content" value="${name}" />
Every template has access to a render function that it can use to pull in additional templates.
Additionally, if options were passed all of the globals specified
are passed along to the templates.
Inside the templates you can use standard ES6 template string interpolations to display variables and basically use just about any javascript function.
FAQs
A minimal template engine for Node based on ES6 string templates.
The npm package renderly receives a total of 2 weekly downloads. As such, renderly popularity was classified as not popular.
We found that renderly demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Package last updated on 29 Jan 2020
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.
Related posts
Product
Enhancing Open-Source Compliance: Introducing Socket’s Advanced License Analysis
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
By Christopher Bailey - Oct 17, 2024
Product
Introducing Socket Optimize
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
By John-David Dalton - Oct 16, 2024