2.3.0 • Published 5 years ago

egg-view-nunjucks v2.3.0

Weekly downloads
5,020
License
MIT
Repository
github
Last release
5 years ago

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`
    // https://github.com/mozilla/nunjucks/blob/6f3e4a36a71cfd59ddc8c1fc5dcd77b8c24d83f3/nunjucks/src/environment.js#L318
    await ctx.render('test.nj', { name: 'view test' }, {
      path: '***'
    });
  }
}

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' }, {
      path: '***'
    });
  };
}

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

egg-crc-frameworksparrow-bird-serverumo-bakery@infinitebrahmanuniverse/nolb-egg-vts-ma-core-monoeziahz-frameworks-core-mono@everything-registry/sub-chunk-1559walle.jswenshuai-serverwyf-eggjs-demosparrow-servervesstudy-gaiajs-adminsugar-coatumo-mockyouzanyun-egg-frameworkxprofiler-console-support-low-node@easy-team/res@fzo/fzo-server@l1go/analytics@l1go/bpmn-engine@l1go/console-core@l1go/console-dashboard@l1go/orm-export@l1go/system-permission@lianpf/apr@egglib/statics@egglib/statics-vite@egglib/statics-vuecli@egglib/statics-webpack@eggx/framework@knx/core-framework@jianghujs/jianghu@kecoyo/egg-frameworkmukitmicro-service-basicssandbox-mvprojer-eggjsneus-serverppeggsofa-node-demogovcloud-ciiceworks-serverllb-clild-egg-frame@ubancloud/core@ubancloud/core-lite@xprofiler/console@zctya/web-egg-vite-vue3@zcorky/reina@zhaofeng-shu33/iceworks-serveraliyun-eggcft-jv-framework-democnpmcoreava-eggbeggdumplingsegg-lt-frameworkegg-lt-framework-adminegg-mongo-frameworkegg-proxy-viewegg-rbtbaseegg-react-webpack-asset-boilerplateegg-react-webpack-boilerplateegg-react-webpack-html-boilerplateegg-react-webpack-mpa-boilerplateegg-react-webpack-spa-boilerplateegg-react-asset-boilerplateegg-react-html-boilerplateegg-sparkegg-jianghuegg-atlas-frameworkegg-bagegg-blueprinteruit-frameworkeruit-adminegg-cakejsegg-cookedegg-viteegg-vite-pluginegg-vite-vue-pluginegg-vue-asset-boilerplateegg-vue-frameworkegg-vue-framework-plusegg-vue-html-boilerplateegg-view-memoryfsfli-boilerplate-egg-tsfishx-gui-servergaia-admin@smadey/egg-vite-plugin
2.3.0

5 years ago

2.2.0

7 years ago

2.1.6

7 years ago

2.1.5

7 years ago

2.1.4

8 years ago

2.1.3

8 years ago

2.1.2

8 years ago

2.1.1

8 years ago

2.1.0

8 years ago

2.0.0

8 years ago

2.0.0-beta.1

8 years ago

1.0.0

9 years ago

0.7.0

9 years ago

0.6.0

9 years ago

0.5.0

9 years ago

0.4.0

9 years ago

0.3.0

9 years ago

0.2.0

9 years ago

0.1.0

9 years ago

0.0.1

9 years ago