egg-view-nunjucks

2018-11-10 admin

egg-view-nunjucks是什么

什么是egg-view-nunjucks,nunjucks view plugin for egg

egg-view-nunjucks使用教程帮助文档

egg-view-nunjucks

NPM version build status Test coverage David deps Known Vulnerabilities npm download

nunjucks view plugin for egg.

Install

$ npm i egg-view-nunjucks --save

Usage

// {app_root}/config/plugin.js
exports.nunjucks = {
  enable: true,
  package: 'egg-view-nunjucks',
};

Set mapping in config

// {app_root}/config/config.default.js
exports.view = {
  defaultViewEngine: 'nunjucks',
  mapping: {
    '.nj': 'nunjucks',
  },
};

Render in controller

// {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 `ctx.render` to `ctx.body`
    await ctx.render('test.nj', { name: 'view test' });
  }
}

Feature

Filter

  • escape filter is replaced by helper.escape which is provided by egg-security for better performance
  • Add your filters to app/extend/filter.js, then they will be injected automatically to nunjucks
// {app_root}/app/extend/filter.js
exports.hello = name => `hi, ${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' });
  };
}

Tag

you can extend custom tag like this:

// {app_root}/app.js
const markdown = require('nunjucks-markdown');
const marked = require('marked');

module.exports = app => {
  markdown.register(app.nunjucks, marked);
};

Security

see egg-security

  • auto inject _csrf attr to form field
  • auto inject nonce attr to script tag

Helper / Locals

  • you can use helper/ctx/request in template, such as helper.shtml('<div></div>')
  • nunjucks build-in filters is injected to helper, such as helper.upper('test')
  • helper.shtml/surl/sjs/escape is auto wrapped with safe

More

  • app.nunjucks - nunjucks environment
  • app.nunjucks.cleanCache(fullPath/tplName) to easy clean cache, can use with custom egg-watcher

Configuration

see config/config.default.js for more detail.

Questions & Suggestions

Please open an issue here.

License

MIT

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-45041.html

文章标题:egg-view-nunjucks

回到顶部