# egg-view-nunjucks

> nunjucks view plugin for egg

Latest version **2.3.0** (published 2021-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-view-nunjucks
pnpm add egg-view-nunjucks
yarn add egg-view-nunjucks
bun add egg-view-nunjucks
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2021-01-14 |
| First published | 2016-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 1 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 90 |
| Author | TZ |
| Maintainers | atian25, dead_horse, fengmk2, popomore, eggjs-admin |
| Keywords | egg, eggPlugin, egg-plugin, egg-view, nunjucks |

## Links

- npm: https://www.npmjs.com/package/egg-view-nunjucks
- Repository: https://github.com/eggjs/egg-view-nunjucks
- Homepage: https://github.com/eggjs/egg-view-nunjucks#readme
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/egg-view-nunjucks

## Dependencies (1)

- [nunjucks](https://npm.io/package/nunjucks.md) ^3.2.2

## Recent versions

- 2.3.0 (latest) — 2021-01-14
- 2.0.0-beta.1 (beta) — 2017-02-21
- 2.2.0 — 2018-03-29
- 2.1.6 — 2018-02-24
- 2.1.5 — 2018-02-23
- 2.1.4 — 2017-09-19
- 2.1.3 — 2017-06-30
- 2.1.2 — 2017-06-01
- 2.1.1 — 2017-05-10
- 2.1.0 — 2017-04-28
- 2.0.0 — 2017-02-22
- 1.0.0 — 2017-01-16
- 0.7.0 — 2017-01-13
- 0.6.0 — 2016-11-03
- 0.5.0 — 2016-09-18
- … 5 more at https://npm.io/package/egg-view-nunjucks/versions

## 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('<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](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)

---
_Source: https://npm.io/package/egg-view-nunjucks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._