nunjucks view plugin for egg
npm install egg-view-nunjucks[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-view-nunjucks.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-view-nunjucks
[travis-image]: https://img.shields.io/travis/eggjs/egg-view-nunjucks.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-view-nunjucks
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-view-nunjucks.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-view-nunjucks?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-view-nunjucks.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-view-nunjucks
[snyk-image]: https://snyk.io/test/npm/egg-view-nunjucks/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-view-nunjucks
[download-image]: https://img.shields.io/npm/dm/egg-view-nunjucks.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-view-nunjucks
nunjucks view plugin for egg.
``bash`
$ npm i egg-view-nunjucks --save
`js`
// {app_root}/config/plugin.js
exports.nunjucks = {
enable: true,
package: 'egg-view-nunjucks',
};
Set mapping in config
`js`
// {app_root}/config/config.default.js
exports.view = {
defaultViewEngine: 'nunjucks',
mapping: {
'.nj': 'nunjucks',
},
};
Render in controller
`jsctx.render
// {app_root}/app/controller/test.js
class TestController extends Controller {
async list() {
const ctx = this.ctx;
// ctx.body = await ctx.renderString('{{ name }}', { name: 'local' });
// not need to assign to ctx.body`
// https://github.com/mozilla/nunjucks/blob/6f3e4a36a71cfd59ddc8c1fc5dcd77b8c24d83f3/nunjucks/src/environment.js#L318
await ctx.render('test.nj', { name: 'view test' }, {
path: '*'
});
}
}
- escape filter is replaced by helper.escape which is provided by egg-security for better performanceapp/extend/filter.js
- Add your filters to , then they will be injected automatically to nunjucks
`jshi, ${name}
// {app_root}/app/extend/filter.js
exports.hello = name => ;
// so you could use it at template
// {app_root}/app/controller/test.js
class TestController extends Controller {
async list() {
const ctx = this.ctx;
ctx.body = await ctx.renderString('{{ name | hello }}', { name: 'egg' }, {
path: '*'
});
};
}
`
you can extend custom tag like this:
`js
// {app_root}/app.js
const markdown = require('nunjucks-markdown');
const marked = require('marked');
module.exports = app => {
markdown.register(app.nunjucks, marked);
};
`
see egg-security
- auto inject _csrf attr to form fieldnonce
- auto inject attr to script tag
- you can use helper/ctx/request in template, such as helper.shtml('
- nunjucks build-in filters is injected to helper, such as helper.upper('test')
- helper.shtml/surl/sjs/escape is auto wrapped with safe$3
-
app.nunjucks - nunjucks environment
- app.nunjucks.cleanCache(fullPath/tplName)` to easy clean cache, can use with custom egg-watchersee config/config.default.js for more detail.
Please open an issue here.