
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Proper JavaScript code templating with source maps support.
This module allows to generate JavaScript AST from code template and AST nodes as substitutions.
This is more proper way of code templating since it works on AST not on code string, and thus preserves locations which allow to generate source maps in future.
Install the module with: npm install estemplate
and require it:
npm i estemplate --save
var estemplate = require('estemplate');
Generates SpiderMonkey AST from given template string, optional esprima options and data.
Supported template substitution markers:
<% var localCounter = 0; %>
var x = <%= expr %> + 1;
var a = [%= elements %];
function f(%= params %) {}
var x = f(%= args %);
define(function () {%= body %});
var x = "%= 'alpha' + 'beta' %";
You can combine list substitutions with inline elements like:
var a = [0, %= numbers %, Infinity];
function f(%= params %, callback) {}
define(function () { console.time('Module'); %= body %; console.timeEnd('Module'); });
From template, you can access entire data object via it
and estemplate itself via estemplate
.
If you set options.fast
to true, then passed data will be available only via it
variable, but template function in general will be significantly faster.
Same as above but returns function that can be reused for AST generation (just save result and call with data
as argument whenever needed).
var ast = estemplate('var <%= varName %> = <%= value %> + 1;', {
varName: {type: 'Identifier', name: 'myVar'},
value: {type: 'Literal', value: 123}
});
console.log(escodegen.generate(ast));
// > var myVar = 123 + 1;
template.jst
define(function (require, exports, module) {% = body %});
index.js
var dependency1 = require('dependency1'),
dependency2 = require('dependency2');
module.exports = function () {
return dependency1() + dependency2();
};
main code
var templateCode = fs.readFileSync('template.jst', 'utf-8');
var template = estemplate.compile(templateCode, {attachComment: true});
var program = esprima.parse(fs.readFileSync('index.js', 'utf-8'), {
loc: true,
source: 'index.js'
});
var ast = template({body: program.body});
var output = escodegen.generate(ast, {
sourceMap: true,
sourceMapWithCode: true
});
console.log(output.code);
output
define(function (require, exports, module) {
var dependency1 = require('dependency1'), dependency2 = require('dependency2');
module.exports = function () {
return dependency1() + dependency2();
};
});
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Copyright (c) 2014 Ingvar Stepanyan. Licensed under the MIT license.
FAQs
Proper JavaScript code templating with source maps support.
The npm package estemplate receives a total of 5,771 weekly downloads. As such, estemplate popularity was classified as popular.
We found that estemplate 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.
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
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.