pug-runtime

The runtime components for the pug templating language

MIT 12 个版本
pug
安装
npm install pug-runtime
yarn add pug-runtime
pnpm add pug-runtime
bun add pug-runtime
README

pug-runtime

The runtime components for the pug templating language

Build Status Dependencies Status DevDependencies Status NPM version

Installation

npm install pug-runtime

Usage

You can call runtime methods directly using runtime.method. This is particularly useful when compiling to deal with things that are already known at compile time.

var runtime = require('pug-runtime');

assert(runtime.attr('foo', 'bar', true, true) === ' foo="bar"');

You can also build a string with a given list of functions available as pug_method by calling build(arrayOfMethods). This is useful for inlining runtime functions within the compiled templates.

var build = require('pug-runtime/build');
var src = build(['attr']);

var attr = Function('', src + ';return pug_attr;')();
assert(attr('foo', 'bar', true, true) === ' foo="bar"');

When testing code compiled for the browser in Node.js, it is necessary to make the runtime available. To do so, one can use require('pug-runtime/wrap'):

var pug = require('pug');
var wrap = require('pug-runtime/wrap');

var pugSrc = 'p= content';
// By default compileClient automatically embeds the needed runtime functions,
// rendering this module useless.
var compiledCode = pug.compileClient(pugSrc, {
  externalRuntime: true
});
//=> 'function template (locals) { ... pug.escape() ... }'

var templateFunc = wrap(compiledCode);
templateFunc({content: 'Hey!'});
//=> '<p>Hey!</p>'

// Change template function name to 'heyTemplate'
compiledCode = pug.compileClient(pugSrc, {
  externalRuntime: true,
  name: 'heyTemplate'
});
//=> 'function heyTemplate (locals) { ... }'

templateFunc = wrap(compiledCode, 'heyTemplate');
templateFunc({content: 'Hey!'});
//=> '<p>Hey!</p>'

License

MIT

版本列表
3.0.1 2021-02-28
3.0.1-canary-10 2021-02-28
3.0.0 2020-05-25
3.0.0-canary-2 2020-05-25
3.0.0-canary-1 2020-05-24
2.0.5 2019-06-18
2.0.4 2018-03-06
2.0.3 2017-01-24
2.0.2 2016-07-26
2.0.1 2016-04-18
2.0.0 2015-12-23
0.0.0 2015-12-12