koa-twig
The usual way yo use a template engine with Koa is by using koa-views.
I had an issue using it with Twig. I couldn't include or extend templates as described in this issue.
So I created this little lib.
Installation
yarn add -E koa-twig
# OR
npm i --exact koa-twigConfig
-
viewsstring|required : the views folder path -
extensionstring : the files extension you want to use, by default, it'stwig -
errorsobject|boolean : this optinal parameter allows you to customize the error handling. By default you can create404.twig,500.twig, everySTATUS_CODE.twig. You can disable this behaviour by passingfalseto this option. -
dataobject : data you want to share accross all views -
functionsobject : functions you want to use accross all views -
filtersobject : filters you want to use accross all views
Example
Under the hood, this module is using the twig module. You can find an example inside the demo folder of the repo.
const Koa = require("koa");
const koaTwig = require("koa-twig");
const app = new Koa();
app.use(
koaTwig({
views: `${__dirname}/views`,
extension: "html",
errors: { 404: "not-found" }, // A 404 status code will render the file named `not-found`
data: { NODE_ENV: process.env.NODE_ENV }, // Data shared accross all views
})
);
app.use(async (ctx) => {
switch (ctx.path) {
case "/":
await ctx.render("home");
break;
case "/profile":
await ctx.render("profile", {
user: { firstName: "jean", lastName: "smaug" },
});
break;
}
});
app.listen(8080);Errors informations
If you define a 500.twig (or any other STATUS_CODE.twig file) you'll be able to get error informations : name, message, stack.
app.use(async (ctx) => {
throw new Error("Smaug");
});<html>
...
<body>
<span>{{ error.name }}</span>
<span>{{ error.message }}</span>
<span>{{ error.stack }}</span>
</body>
</html>