Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eggjs/egg-view-nunjucks
nunjucks view plugin for egg
https://github.com/eggjs/egg-view-nunjucks
egg egg-plugin egg-view nunjucks
Last synced: 2 months ago
JSON representation
nunjucks view plugin for egg
- Host: GitHub
- URL: https://github.com/eggjs/egg-view-nunjucks
- Owner: eggjs
- License: mit
- Created: 2016-07-17T09:38:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-01-15T07:35:43.000Z (almost 4 years ago)
- Last Synced: 2024-04-14T00:59:05.701Z (8 months ago)
- Topics: egg, egg-plugin, egg-view, nunjucks
- Language: JavaScript
- Size: 71.3 KB
- Stars: 91
- Watchers: 11
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egg - egg-view-nunjucks - Nunjucks view plugin for egg   (仓库 / 插件)
README
# 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](http://mozilla.github.io/nunjucks/) view plugin for egg.
## Install
```bash
$ npm i egg-view-nunjucks --save
```
## Usage
```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
```js
// {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
```js
// {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:
```js
// {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](https://github.com/eggjs/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('
')`
- 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](https://github.com/eggjs/egg-watcher)
## Configuration
see [config/config.default.js](config/config.default.js) for more detail.
## Questions & Suggestions
Please open an issue [here](https://github.com/eggjs/egg/issues).
## License
[MIT](LICENSE)