{"id":13487509,"url":"https://github.com/eggjs/egg-view-nunjucks","last_synced_at":"2025-04-03T03:10:57.483Z","repository":{"id":54982620,"uuid":"63524550","full_name":"eggjs/egg-view-nunjucks","owner":"eggjs","description":"nunjucks view plugin for egg","archived":false,"fork":false,"pushed_at":"2021-01-15T07:35:43.000Z","size":73,"stargazers_count":89,"open_issues_count":0,"forks_count":9,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-10-29T21:05:55.455Z","etag":null,"topics":["egg","egg-plugin","egg-view","nunjucks"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eggjs.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-17T09:38:25.000Z","updated_at":"2024-09-10T14:58:53.000Z","dependencies_parsed_at":"2022-08-14T08:10:16.730Z","dependency_job_id":null,"html_url":"https://github.com/eggjs/egg-view-nunjucks","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fegg-view-nunjucks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fegg-view-nunjucks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fegg-view-nunjucks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eggjs%2Fegg-view-nunjucks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eggjs","download_url":"https://codeload.github.com/eggjs/egg-view-nunjucks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246759485,"owners_count":20829106,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["egg","egg-plugin","egg-view","nunjucks"],"created_at":"2024-07-31T18:01:00.162Z","updated_at":"2025-04-03T03:10:57.460Z","avatar_url":"https://github.com/eggjs.png","language":"JavaScript","funding_links":[],"categories":["仓库"],"sub_categories":["插件"],"readme":"# egg-view-nunjucks\n\n[![NPM version][npm-image]][npm-url]\n[![build status][travis-image]][travis-url]\n[![Test coverage][codecov-image]][codecov-url]\n[![David deps][david-image]][david-url]\n[![Known Vulnerabilities][snyk-image]][snyk-url]\n[![npm download][download-image]][download-url]\n\n[npm-image]: https://img.shields.io/npm/v/egg-view-nunjucks.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/egg-view-nunjucks\n[travis-image]: https://img.shields.io/travis/eggjs/egg-view-nunjucks.svg?style=flat-square\n[travis-url]: https://travis-ci.org/eggjs/egg-view-nunjucks\n[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-view-nunjucks.svg?style=flat-square\n[codecov-url]: https://codecov.io/github/eggjs/egg-view-nunjucks?branch=master\n[david-image]: https://img.shields.io/david/eggjs/egg-view-nunjucks.svg?style=flat-square\n[david-url]: https://david-dm.org/eggjs/egg-view-nunjucks\n[snyk-image]: https://snyk.io/test/npm/egg-view-nunjucks/badge.svg?style=flat-square\n[snyk-url]: https://snyk.io/test/npm/egg-view-nunjucks\n[download-image]: https://img.shields.io/npm/dm/egg-view-nunjucks.svg?style=flat-square\n[download-url]: https://npmjs.org/package/egg-view-nunjucks\n\n[nunjucks](http://mozilla.github.io/nunjucks/) view plugin for egg.\n\n## Install\n\n```bash\n$ npm i egg-view-nunjucks --save\n```\n\n## Usage\n\n```js\n// {app_root}/config/plugin.js\nexports.nunjucks = {\n  enable: true,\n  package: 'egg-view-nunjucks',\n};\n```\n\nSet mapping in config\n\n```js\n// {app_root}/config/config.default.js\nexports.view = {\n  defaultViewEngine: 'nunjucks',\n  mapping: {\n    '.nj': 'nunjucks',\n  },\n};\n```\n\nRender in controller\n\n```js\n// {app_root}/app/controller/test.js\nclass TestController extends Controller {\n  async list() {\n    const ctx = this.ctx;\n    // ctx.body = await ctx.renderString('{{ name }}', { name: 'local' });\n    // not need to assign `ctx.render` to `ctx.body`\n    // https://github.com/mozilla/nunjucks/blob/6f3e4a36a71cfd59ddc8c1fc5dcd77b8c24d83f3/nunjucks/src/environment.js#L318\n    await ctx.render('test.nj', { name: 'view test' }, {\n      path: '***'\n    });\n  }\n}\n```\n\n## Feature\n\n### Filter\n\n- `escape` filter is replaced by `helper.escape` which is provided by `egg-security` for better performance\n- Add your filters to `app/extend/filter.js`, then they will be injected automatically to nunjucks\n\n```js\n// {app_root}/app/extend/filter.js\nexports.hello = name =\u003e `hi, ${name}`;\n\n// so you could use it at template\n// {app_root}/app/controller/test.js\nclass TestController extends Controller {\n  async list() {\n    const ctx = this.ctx;\n    ctx.body = await ctx.renderString('{{ name | hello }}', { name: 'egg' }, {\n      path: '***'\n    });\n  };\n}\n```\n\n### Tag\n\nyou can extend custom tag like this:\n\n```js\n// {app_root}/app.js\nconst markdown = require('nunjucks-markdown');\nconst marked = require('marked');\n\nmodule.exports = app =\u003e {\n  markdown.register(app.nunjucks, marked);\n};\n```\n\n### Security\n\nsee [egg-security](https://github.com/eggjs/egg-security)\n\n- auto inject `_csrf` attr to form field\n- auto inject `nonce` attr to script tag\n\n### Helper / Locals\n\n- you can use `helper/ctx/request` in template, such as `helper.shtml('\u003cdiv\u003e\u003c/div\u003e')`\n- nunjucks build-in filters is injected to helper, such as `helper.upper('test')`\n- `helper.shtml/surl/sjs/escape` is auto wrapped with `safe`\n\n### More\n\n- `app.nunjucks` - nunjucks environment\n- `app.nunjucks.cleanCache(fullPath/tplName)` to easy clean cache, can use with custom [egg-watcher](https://github.com/eggjs/egg-watcher)\n\n## Configuration\n\nsee [config/config.default.js](config/config.default.js) for more detail.\n\n## Questions \u0026 Suggestions\n\nPlease open an issue [here](https://github.com/eggjs/egg/issues).\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggjs%2Fegg-view-nunjucks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feggjs%2Fegg-view-nunjucks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feggjs%2Fegg-view-nunjucks/lists"}