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](https://github.com/queckezz/koa-views/issues/99). So I created this little lib.
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.
yarn add -E koa-twig
# OR
npm i --exact koa-twig
views string|required : the views folder pathextension string : the files extension you want to use, by default, it's twigerrors object|boolean : this optinal parameter allows you to customize the error handling. By default you can create 404.twig, 500.twig, every STATUS_CODE.twig. You can disable this behaviour by passing false to this option.data object : data you want to share accross all viewsfunctions object : functions you want to use accross all viewsfilters object : filters you want to use accross all viewsUnder 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);
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>
FAQs
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](https://github.com/queckezz/koa-views/issues/99). So I created this little lib.
The npm package koa-twig receives a total of 16 weekly downloads. As such, koa-twig popularity was classified as not popular.
We found that koa-twig demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.