ying
v2.2.0
Published
Another simple Node.js template engine
Downloads
58
Readme
ying
Another simple Node.js template engine.
Warning
Node.js only, not for browsers. This library usesnew Function(which useseval) to compile template code. You should sanitize the data when dealing with user input.
Installation
npm i yingUsage
Compile a template
Use ying(templateStr) to compile a template string into a JavaScript function:
import ying from 'ying';
const templateFunc = ying('<template string>');Get a property value with {{prop}}
{{prop}}automatically encodes the property value into valid HTML.
import ying from 'ying';
const func = ying('<p>{{name}}</p>');
console.log(func({ name: 'hi >>>' }));Output:
<p>hi >>></p>Nested properties are also supported.
import ying from 'ying';
const func = ying('<p>{{client.os.name}}</p>');
console.log(
func({
client: {
os: {
name: 'linux',
},
},
}),
);Output:
<p>linux</p>Embed a JavaScript Expression with {{= expr}}
import ying from 'ying';
const func = ying('{{= "Current date: " + new Date() }}');
console.log(func());Output:
Current date: Sun Feb 07 2016 10:12:49 GMT+0800 (CST)Use a predefined variable named d to get the data passed to template.
import ying from 'ying';
var func = ying('{{= d.name || "<None>"}}');
console.log(func({ name: 'hi >>>' }));
console.log(func());Output:
hi >>>
<None>To escape text for HTML inside expressions, use another predefined function _e(str):
import ying from 'ying';
var func = ying('{{= _e(d.name || "<None>")}}');
console.log(func({ name: 'hi >>>' }));
console.log(func());Output:
hi >>>
<None>Embed a JavaScript Function with {{# body}}
Example, populate an HTML list using for loops:
import ying from 'ying';
// Here we use ES6 template literals which supports multi-line strings.
const func = ying(`<ul>{{#
if (!d.users) {
return "<li>No users available</li>"
}
let result = "";
for(var user of d.users) {
result += "<li>" + _e(user) + "</li>";
}
return result;
}}</ul>`);
console.log(func({ users: ['hi', '<ABC>', '123'] }));Output:
<ul><li>hi</li><li><ABC></li><li>123</li></ul>Direct code injection with {{~ code}}
Example, if-else code blocks:
import ying from 'ying';
const func = ying(`
{{~ if(d.os == 'ios') { }}
<p>You are using iOS</p>
{{~ } else if(d.os == 'android') { }}
<p>You are using Android</p>
{{~ } else { }}
<p>Unknown OS</p>
{{~ } }}
`);
console.log(func({ os: 'ios' }));
console.log(func({ os: 'android' }));
console.log(func({ os: 'wp' }));Output:
<p>You are using iOS</p>
<p>You are using Android</p>
<p>Unknown OS</p>TypeScript generics support
You can customize the parameter type of a template function in TypeScript, example:
import ying from './main.js';
// Page template.
interface PageTemplateData {
title: string;
contentHTML: string;
}
const pageTemplate = ying<PageTemplateData>(
'<html><head><title>{{title}}</title><body>{{=d.contentHTML}}</body></html>',
);
// Content template.
interface ContentTemplateData {
name: string;
description: string;
}
const contentTemplate = ying<ContentTemplateData>('<h1>{{name}}</h1><p>{{description}}</p>');
const contentHTML = contentTemplate({ name: 'hi', description: 'there>>' });
const pageHTML = pageTemplate({ title: '<My website>', contentHTML });
console.log(pageHTML);Output:
<html><head><title><My website></title><body><h1>hi</h1><p>there>></p></body></html>