egg-view-static

A simple egg view plugin, allow you to render static html from app/public.

Install

1$ npm i egg-view-static --save

Usage

1// {app_root}/config/plugin.js
2exports.viewStatic = {
3  enable: true,
4  package: 'egg-view-static',
5};

Set mapping in config

1// {app_root}/config/config.default.js
2exports.view = {
3  defaultViewEngine: 'static',
4  mapping: {
5    '.html': 'static',
6  },
7};

Render in controller

1// {app_root}/app/controller/home.js
2class HomeController extends Controller {
3  async index() {
4    // app/static/index.html
5    await this.ctx.render('index.html');
6  }
7}

Use replaceFn to custom render with locals, see test/fixtures/apps/locals/config/config.default.js for more detail.

1// {app_root}/config/config.default.js
2config.viewStatic = {
3  replaceFn(tpl, locals) {
4    return tpl.toString().replace(/(\\)?{{ *(\w+) *}}/g, (block, skip, key) => {
5      if (skip) {
6        return block.substring(skip.length);
7      }
8      return locals.hasOwnProperty(key) ? locals[key] : block;
9    });
10  },
11};
12
13// {app_root}/app/controller/home.js
14class HomeController extends Controller {
15  async index() {
16    // app/static/index.html
17    await this.ctx.render('index.html', { name: 'egg' });
18  }
19}

Configuration

1// {app_root}/config/config.default.js
2exports.viewStatic = {
3  // cache: true,
4  // replaceFn: (tpl, locals, options) => tpl,
5};

• {Boolean} cache - whether cache file, default to true except local mode. It will share cache with egg-static LRU cache.
• {Function} replaceFn - custom render replacement, args = (tpl, locals, options)

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

Example

Questions & Suggestions

Please open an issue here.

License

MIT