@tsed/engines 1.1.4 → 7.0.0-beta.5

package/readme.md

@@ -4,9 +4,9 @@
 
 <div align="center">
 
-   <h1>Ts.ED EnginesContainer</h1>
+   <h1>Ts.ED Engines</h1>
 
-[![Build & Release](https://github.com/tsedio/tsed-engines/actions/workflows/build.yml/badge.svg)](https://github.com/tsedio/tsed-engines/actions/workflows/build.yml)
+[![Build & Release](https://github.com/tsedio/tsed/actions/workflows/build.yml/badge.svg)](https://github.com/tsedio/tsed/actions/workflows/build.yml)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![backers](https://opencollective.com/tsed/tiers/badge.svg)](https://opencollective.com/tsed)
@@ -16,7 +16,7 @@
 <div align="center">
   <a href="https://tsed.io/">Website</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://tsed.io/docs/engines.html">EnginesContainer</a>
+  <a href="https://tsed.io/docs/templating.html">Templating with Ts.ED</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
   <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
@@ -25,14 +25,14 @@
 
 <hr />
 
-> Template engine consolidation library (inspired by consolidate) written in TypeScript.
+> Template engine consolidation library (inspired from consolidate) written in TypeScript.
 
 ## Feature
 
 - Support multiple engine library,
 - Extendable - You can register your own engine,
 - Configurable,
-- Agnostic from Express/Koa (but compatible with Express)
+- Agnostic from Express/Koa (but compatible with Express).
 
 ## Installation
 
@@ -42,81 +42,82 @@ npm install @tsed/engines
 
 ## Supported template engines
 
-Some package has the same key name, @tsed/engines will load them according to the order number. 
-For example with dust, @tsed/engines will try to use in this order: `dustjs-helpers` and `dustjs-linkedin`. 
+Some package has the same key name, @tsed/engines will load them according to the order number.
+For example with dust, @tsed/engines will try to use in this order: `dustjs-helpers` and `dustjs-linkedin`.
 If `dustjs-helpers` is installed, `dustjs-linkedin` will not be used by consolidate.
 
-| Name | Package Name / Order | Website / State |
----|---|---
-| [atpl](https://github.com/soywiz/atpl.js) | [`npm install atpl`](https://www.npmjs.com/package/atpl) | - |
-| [bracket](https://github.com/danlevan/bracket-template) | [`npm install bracket-template`](https://www.npmjs.com/package/bracket-template) | - |
-| [dot](https://github.com/olado/doT) | [`npm install dot`](https://www.npmjs.com/package/dot) | [(website)](http://olado.github.io/doT/) |
-| [dust](https://github.com/linkedin/dustjs) | [`npm install dustjs-helpers`](https://www.npmjs.com/package/dustjs-helpers) (2) or<br>[`npm install dustjs-linkedin`](https://www.npmjs.com/package/dustjs-linkedin) (3) | [(website)](http://linkedin.github.io/dustjs/) |
-| [ect](https://github.com/baryshev/ect) | [`npm install ect`](https://www.npmjs.com/package/ect) | [(website)](http://ectjs.com/) |
-| [ejs](https://github.com/mde/ejs) | [`npm install ejs`](https://www.npmjs.com/package/ejs) | [(website)](http://ejs.co/) |
-| [hamlet](https://github.com/gregwebs/hamlet.js) | [`npm install hamlet`](https://www.npmjs.com/package/hamlet) | - |
-| [hamljs](https://github.com/visionmedia/haml.js) | [`npm install hamljs`](https://www.npmjs.com/package/hamljs) | - |
-| [haml-coffee](https://github.com/netzpirat/haml-coffee) | [`npm install haml-coffee`](https://www.npmjs.com/package/haml-coffee) | - |
-| [handlebars](https://github.com/wycats/handlebars.js/) | [`npm install handlebars`](https://www.npmjs.com/package/handlebars) | [(website)](http://handlebarsjs.com/) |
-| [hogan](https://github.com/twitter/hogan.js) | [`npm install hogan.js`](https://www.npmjs.com/package/hogan.js) | [(website)](http://twitter.github.com/hogan.js/) |
-| [htmling](https://github.com/codemix/htmling) | [`npm install htmling`](https://www.npmjs.com/package/htmling) | - |
-| [jazz](https://github.com/shinetech/jazz) | [`npm install jazz`](https://www.npmjs.com/package/jazz) | - |
-| [just](https://github.com/baryshev/just) | [`npm install just`](https://www.npmjs.com/package/just) | - |
-| [liquor](https://github.com/chjj/liquor) | [`npm install liquor`](https://www.npmjs.com/package/liquor) | - |
-| [lodash](https://github.com/bestiejs/lodash) | [`npm install lodash`](https://www.npmjs.com/package/lodash) | [(website)](http://lodash.com/) |
-| [marko](https://github.com/marko-js/marko) | [`npm install marko`](https://www.npmjs.com/package/marko) | [(website)](http://markojs.com) |
-| [mote](https://github.com/satchmorun/mote) | [`npm install mote`](https://www.npmjs.com/package/mote) | [(website)](http://satchmorun.github.io/mote/) |
-| [mustache](https://github.com/janl/mustache.js) | [`npm install mustache`](https://www.npmjs.com/package/mustache) | - |
-| [nunjucks](https://github.com/mozilla/nunjucks) | [`npm install nunjucks`](https://www.npmjs.com/package/nunjucks) | [(website)](https://mozilla.github.io/nunjucks) |
-| [plates](https://github.com/flatiron/plates) | [`npm install plates`](https://www.npmjs.com/package/plates) | - |
-| [pug](https://github.com/pugjs/pug) | [`npm install pug`](https://www.npmjs.com/package/pug) | [(website)](http://jade-lang.com/) / **(formerly jade)** |
-| [ractive](https://github.com/ractivejs/ractive) | [`npm install ractive`](https://www.npmjs.com/package/ractive) | - |
-| [react](https://github.com/facebook/react) | [`npm install react`](https://www.npmjs.com/package/react) | - |
-| [slm](https://github.com/slm-lang/slm) | [`npm install slm`](https://www.npmjs.com/package/slm) | - |
-| [squirrelly](https://github.com/squirrellyjs/squirrelly) | [`npm install squirrelly`](https://www.npmjs.com/package/squirrelly) | [(website)](https://squirrelly.js.org) |
-| [swig](https://github.com/node-swig/swig-templates) | [`npm install swig-templates`](https://www.npmjs.com/package/swig-templates) (2) | - |
-| [teacup](https://github.com/goodeggs/teacup) | [`npm install teacup`](https://www.npmjs.com/package/teacup) | - |
-| [templayed](https://github.com/archan937/templayed.js/) | [`npm install templayed`](https://www.npmjs.com/package/templayed) | [(website)](http://archan937.github.com/templayed.js/)  |
-| [toffee](https://github.com/malgorithms/toffee) | [`npm install toffee`](https://www.npmjs.com/package/toffee) | - |
-| [twig](https://github.com/justjohn/twig.js) | [`npm install twig`](https://www.npmjs.com/package/twig) | [(wiki)](https://github.com/twigjs/twig.js/wiki/Implementation-Notes) |
-| [twing](https://github.com/NightlyCommit/twing) | [`npm install twing`](https://www.npmjs.com/package/twing) | [(website)](https://nightlycommit.github.io/twing/) |
-| [underscore](https://github.com/documentcloud/underscore) | [`npm install underscore`](https://www.npmjs.com/package/underscore) | [(website)](http://underscorejs.org/#template) |
-| [vash](https://github.com/kirbysayshi/vash) | [`npm install vash`](https://www.npmjs.com/package/vash) | - |
-| [velocityjs](https://github.com/julianshapiro/velocity) | [BETA](https://www.npmjs.com/package/velocity-animate) | [(website)](http://velocityjs.org/) |
-| [walrus](https://github.com/jeremyruppel/walrus) | [`npm install walrus`](https://www.npmjs.com/package/walrus) | [(website)](http://documentup.com/jeremyruppel/walrus/) |
-| [whiskers](https://github.com/gsf/whiskers.js) | [`npm install whiskers`](https://www.npmjs.com/package/whiskers) | - |
-| [vue](https://github.com/vuejs/vue) | `npm install vue vue-pronto` | [(website)](https://vuejs.org/)
-> __NOTE__: you must still install the engines you wish to use, add them to your package.json dependencies.
+| Name                                                      | Package Name / Order                                                                                                                                                      | Website / State                                                       |
+| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| [atpl](https://github.com/soywiz/atpl.js)                 | [`npm install atpl`](https://www.npmjs.com/package/atpl)                                                                                                                  | -                                                                     |
+| [bracket](https://github.com/danlevan/bracket-template)   | [`npm install bracket-template`](https://www.npmjs.com/package/bracket-template)                                                                                          | -                                                                     |
+| [dot](https://github.com/olado/doT)                       | [`npm install dot`](https://www.npmjs.com/package/dot)                                                                                                                    | [(website)](http://olado.github.io/doT/)                              |
+| [dust](https://github.com/linkedin/dustjs)                | [`npm install dustjs-helpers`](https://www.npmjs.com/package/dustjs-helpers) (2) or<br>[`npm install dustjs-linkedin`](https://www.npmjs.com/package/dustjs-linkedin) (3) | [(website)](http://linkedin.github.io/dustjs/)                        |
+| [ect](https://github.com/baryshev/ect)                    | [`npm install ect`](https://www.npmjs.com/package/ect)                                                                                                                    | [(website)](http://ectjs.com/)                                        |
+| [ejs](https://github.com/mde/ejs)                         | [`npm install ejs`](https://www.npmjs.com/package/ejs)                                                                                                                    | [(website)](http://ejs.co/)                                           |
+| [hamlet](https://github.com/gregwebs/hamlet.js)           | [`npm install hamlet`](https://www.npmjs.com/package/hamlet)                                                                                                              | -                                                                     |
+| [hamljs](https://github.com/visionmedia/haml.js)          | [`npm install hamljs`](https://www.npmjs.com/package/hamljs)                                                                                                              | -                                                                     |
+| [haml-coffee](https://github.com/netzpirat/haml-coffee)   | [`npm install haml-coffee`](https://www.npmjs.com/package/haml-coffee)                                                                                                    | -                                                                     |
+| [handlebars](https://github.com/wycats/handlebars.js/)    | [`npm install handlebars`](https://www.npmjs.com/package/handlebars)                                                                                                      | [(website)](http://handlebarsjs.com/)                                 |
+| [hogan](https://github.com/twitter/hogan.js)              | [`npm install hogan.js`](https://www.npmjs.com/package/hogan.js)                                                                                                          | [(website)](http://twitter.github.com/hogan.js/)                      |
+| [htmling](https://github.com/codemix/htmling)             | [`npm install htmling`](https://www.npmjs.com/package/htmling)                                                                                                            | -                                                                     |
+| [jazz](https://github.com/shinetech/jazz)                 | [`npm install jazz`](https://www.npmjs.com/package/jazz)                                                                                                                  | -                                                                     |
+| [just](https://github.com/baryshev/just)                  | [`npm install just`](https://www.npmjs.com/package/just)                                                                                                                  | -                                                                     |
+| [liquor](https://github.com/chjj/liquor)                  | [`npm install liquor`](https://www.npmjs.com/package/liquor)                                                                                                              | -                                                                     |
+| [lodash](https://github.com/bestiejs/lodash)              | [`npm install lodash`](https://www.npmjs.com/package/lodash)                                                                                                              | [(website)](http://lodash.com/)                                       |
+| [marko](https://github.com/marko-js/marko)                | [`npm install marko`](https://www.npmjs.com/package/marko)                                                                                                                | [(website)](http://markojs.com)                                       |
+| [mote](https://github.com/satchmorun/mote)                | [`npm install mote`](https://www.npmjs.com/package/mote)                                                                                                                  | [(website)](http://satchmorun.github.io/mote/)                        |
+| [mustache](https://github.com/janl/mustache.js)           | [`npm install mustache`](https://www.npmjs.com/package/mustache)                                                                                                          | -                                                                     |
+| [nunjucks](https://github.com/mozilla/nunjucks)           | [`npm install nunjucks`](https://www.npmjs.com/package/nunjucks)                                                                                                          | [(website)](https://mozilla.github.io/nunjucks)                       |
+| [plates](https://github.com/flatiron/plates)              | [`npm install plates`](https://www.npmjs.com/package/plates)                                                                                                              | -                                                                     |
+| [pug](https://github.com/pugjs/pug)                       | [`npm install pug`](https://www.npmjs.com/package/pug)                                                                                                                    | [(website)](http://jade-lang.com/) / **(formerly jade)**              |
+| [ractive](https://github.com/ractivejs/ractive)           | [`npm install ractive`](https://www.npmjs.com/package/ractive)                                                                                                            | -                                                                     |
+| [react](https://github.com/facebook/react)                | [`npm install react`](https://www.npmjs.com/package/react)                                                                                                                | -                                                                     |
+| [slm](https://github.com/slm-lang/slm)                    | [`npm install slm`](https://www.npmjs.com/package/slm)                                                                                                                    | -                                                                     |
+| [squirrelly](https://github.com/squirrellyjs/squirrelly)  | [`npm install squirrelly`](https://www.npmjs.com/package/squirrelly)                                                                                                      | [(website)](https://squirrelly.js.org)                                |
+| [swig](https://github.com/node-swig/swig-templates)       | [`npm install swig-templates`](https://www.npmjs.com/package/swig-templates) (2)                                                                                          | -                                                                     |
+| [teacup](https://github.com/goodeggs/teacup)              | [`npm install teacup`](https://www.npmjs.com/package/teacup)                                                                                                              | -                                                                     |
+| [templayed](https://github.com/archan937/templayed.js/)   | [`npm install templayed`](https://www.npmjs.com/package/templayed)                                                                                                        | [(website)](http://archan937.github.com/templayed.js/)                |
+| [toffee](https://github.com/malgorithms/toffee)           | [`npm install toffee`](https://www.npmjs.com/package/toffee)                                                                                                              | -                                                                     |
+| [twig](https://github.com/justjohn/twig.js)               | [`npm install twig`](https://www.npmjs.com/package/twig)                                                                                                                  | [(wiki)](https://github.com/twigjs/twig.js/wiki/Implementation-Notes) |
+| [twing](https://github.com/NightlyCommit/twing)           | [`npm install twing`](https://www.npmjs.com/package/twing)                                                                                                                | [(website)](https://nightlycommit.github.io/twing/)                   |
+| [underscore](https://github.com/documentcloud/underscore) | [`npm install underscore`](https://www.npmjs.com/package/underscore)                                                                                                      | [(website)](http://underscorejs.org/#template)                        |
+| [vash](https://github.com/kirbysayshi/vash)               | [`npm install vash`](https://www.npmjs.com/package/vash)                                                                                                                  | -                                                                     |
+| [velocityjs](https://github.com/julianshapiro/velocity)   | [BETA](https://www.npmjs.com/package/velocity-animate)                                                                                                                    | [(website)](http://velocityjs.org/)                                   |
+| [walrus](https://github.com/jeremyruppel/walrus)          | [`npm install walrus`](https://www.npmjs.com/package/walrus)                                                                                                              | [(website)](http://documentup.com/jeremyruppel/walrus/)               |
+| [whiskers](https://github.com/gsf/whiskers.js)            | [`npm install whiskers`](https://www.npmjs.com/package/whiskers)                                                                                                          | -                                                                     |
+| [vue](https://github.com/vuejs/vue)                       | `npm install vue vue-pronto`                                                                                                                                              | [(website)](https://vuejs.org/)                                       |
+
+> **NOTE**: you must still install the engines you wish to use, add them to your package.json dependencies.
 
 ## API
 
 You can get an engine by using `engines`:
 
 ```typescript
-import {getEngine} from '@tsed/engines';
+import {getEngine} from "@tsed/engines";
 
-getEngine('swig')
-  .renderFile({ user: 'tobi' })
+getEngine("swig")
+  .renderFile({user: "tobi"})
   .then((html) => {
     console.log(html);
-  })
+  });
 ```
 
 Or render directly a template:
 
 ```typescript
-import {getEngine} from '@tsed/engines';
+import {getEngine} from "@tsed/engines";
 
-getEngine('ejs')
-  .render('<p><%= user.name %></p>')
+getEngine("ejs")
+  .render("<p><%= user.name %></p>")
   .then((html) => {
     console.log(html);
-  })
+  });
 ```
 
 ## Caching
 
-To enable caching simply pass `{ cache: true }`. EnginesContainer _may_ use this option to cache things reading the file contents, compiled `Function`s etc. 
+To enable caching simply pass `{ cache: true }`. EnginesContainer _may_ use this option to cache things reading the file contents, compiled `Function`s etc.
 EnginesContainer which do _not_ support this may simply ignore it. All engines that consolidate.js implements I/O for will cache the file contents, ideal for production environments.
 When using @tsed/engines directly: `getEngine('swig').renderFile('views/page.html', { user: 'tobi', cache: true });`
 
@@ -127,36 +128,36 @@ Using supported Express versions: `app.locals.cache = true` or set NODE_ENV to '
 `@tsed/engines` can be used with Express as following:
 
 ```typescript
-import express from 'express';
-import {getEngine} from '@tsed/engines';
+import express from "express";
+import {getEngine} from "@tsed/engines";
 
 // assign the swig engine to .html files
-app.engine('html', getEngine('swig'));
+app.engine("html", getEngine("swig"));
 
 // set .html as the default extension
-app.set('view engine', 'html');
-app.set('views', __dirname + '/views');
+app.set("view engine", "html");
+app.set("views", __dirname + "/views");
 
 var users = [];
-users.push({ name: 'tobi' });
-users.push({ name: 'loki' });
-users.push({ name: 'jane' });
+users.push({name: "tobi"});
+users.push({name: "loki"});
+users.push({name: "jane"});
 
-app.get('/', function(req, res){
-  res.render('index', {
-    title: 'Ts.ED EnginesContainer'
+app.get("/", function (req, res) {
+  res.render("index", {
+    title: "Ts.ED EnginesContainer"
   });
 });
 
-app.get('/users', function(req, res){
-  res.render('users', {
-    title: 'Users',
+app.get("/users", function (req, res) {
+  res.render("users", {
+    title: "Users",
     users: users
   });
 });
 
 app.listen(3000);
-console.log('Express server listening on port 3000');
+console.log("Express server listening on port 3000");
 ```
 
 ## Koa
@@ -166,17 +167,17 @@ console.log('Express server listening on port 3000');
 ```typescript
 import {getEngines} from "./getEngines";
 
-var views = require('koa-views');
+var views = require("koa-views");
 
-const render = views(__dirname + '/views', {
+const render = views(__dirname + "/views", {
   engineSource: getEngines(),
   map: {
-    html: 'underscore'
+    html: "underscore"
   }
-})
+});
 
 // Must be used before any router is used
-app.use(render)
+app.use(render);
 // OR Expand by app.context
 // No order restrictions
 // app.context.render = render()
@@ -184,30 +185,30 @@ app.use(render)
 app.use(async function (ctx) {
   ctx.state = {
     session: this.session,
-    title: 'app'
+    title: "app"
   };
 
-  await ctx.render('user', {
-    user: 'John'
+  await ctx.render("user", {
+    user: "John"
   });
 });
 ```
 
 ## Template Engine Instances
 
-Template engines are exposed via the `requires` object, but they are not instantiated until you've called the `getEngine(engine).render()` method. 
+Template engines are exposed via the `requires` object, but they are not instantiated until you've called the `getEngine(engine).render()` method.
 You can instantiate them manually beforehand if you want to add filters, globals, mixins, or other engine features.
 
 ```typescript
-import {requires} from 'consolidate';
-import nunjucks from 'nunjucks';
+import {requires} from "consolidate";
+import nunjucks from "nunjucks";
 
 // add nunjucks to requires so filters can be
 // added and the same instance will be used inside the render method
-requires.set('nunjucks', nunjucks.configure());
+requires.set("nunjucks", nunjucks.configure());
 
-requires.get('nunjucks').addFilter('foo', () => {
-  return 'bar';
+requires.get("nunjucks").addFilter("foo", () => {
+  return "bar";
 });
 ```
 
@@ -256,11 +257,11 @@ export class CustomePugEngine extends PugEngine {
 
 ## Notes
 
-* If you're using Nunjucks, please take a look at the `exports.nunjucks.render` function in `packages/engines/src/components/NunjuncksEngine.ts`. You can pass your own engine/environment via `options.nunjucksEnv`, or if you want to support Express you can pass `options.settings.views`, or if you have another use case, pass `options.nunjucks` (see the code for more insight).
-* You can pass **partials** with `options.partials`
-* For using **template inheritance** with nunjucks, you can pass a loader
+- If you're using Nunjucks, please take a look at the `exports.nunjucks.render` function in `packages/engines/src/components/NunjuncksEngine.ts`. You can pass your own engine/environment via `options.nunjucksEnv`, or if you want to support Express you can pass `options.settings.views`, or if you have another use case, pass `options.nunjucks` (see the code for more insight).
+- You can pass **partials** with `options.partials`
+- For using **template inheritance** with nunjucks, you can pass a loader
   with `options.loader`.
-* `React` To render content into a html base template (eg. `index.html` of your React app), pass the path of the template with `options.base`.
+- `React` To render content into a html base template (eg. `index.html` of your React app), pass the path of the template with `options.base`.
 
 ## Contributors
 

package/tsconfig.compile.esm.json

@@ -0,0 +1,25 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "include": ["src"],
+  "exclude": [
+    "node_modules",
+    "test",
+    "lib",
+    "benchmark",
+    "coverage",
+    "spec",
+    "**/*.benchmark.ts",
+    "**/*.spec.ts",
+    "keys",
+    "jest.config.js",
+    "**/__mock__/**"
+  ]
+}