# @basalt/twig-renderer

> Render templates using Twig PHP, via this Node JS renderer.

Latest version **3.2.9** (published 2025-12-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @basalt/twig-renderer
pnpm add @basalt/twig-renderer
yarn add @basalt/twig-renderer
bun add @basalt/twig-renderer
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.2.9 |
| Published | 2025-12-11 |
| First published | 2018-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Maintainers | evanlovely, jfrenette |
| Keywords | twig |

## Links

- npm: https://www.npmjs.com/package/@basalt/twig-renderer
- Repository: https://github.com/basaltinc/twig-renderer
- Homepage: https://github.com/basaltinc/twig-renderer#readme
- Issues: https://github.com/basaltinc/twig-renderer/issues
- npm.io page: https://npm.io/package/@basalt/twig-renderer

## Dependencies (8)

- [ajv](https://npm.io/package/ajv.md) ^v6.12.6
- [execa](https://npm.io/package/execa.md) ^2.1.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [get-port](https://npm.io/package/get-port.md) ^5.1.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.26.10
- [sleep-promise](https://npm.io/package/sleep-promise.md) ^8.0.1
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.26.9

## Recent versions

- 3.2.9 (latest) — 2025-12-11
- 3.2.9--canary.157.4f8183e.0 (canary) — 2025-12-10
- 3.2.8 — 2025-12-02
- 3.2.8--canary.5244d04.0 — 2025-12-01
- 3.2.7 — 2025-04-28
- 3.2.6 — 2025-04-28
- 3.2.6--canary.147.a2d44ed.0 — 2025-04-28
- 3.2.6--canary.b9fc8f2.0 — 2025-04-28
- 3.2.5 — 2025-04-28
- 3.2.5--canary.145.fc78359.0 — 2025-04-28
- 3.2.4 — 2024-11-15
- 3.2.4--canary.141.642c3d0.0 — 2024-11-15
- 3.2.3 — 2024-11-15
- 3.2.3--canary.142.71bcc68.0 — 2024-11-15
- 3.2.2 — 2024-01-10
- … 51 more at https://npm.io/package/@basalt/twig-renderer/versions

## README

# Twig Renderer

[![Greenkeeper badge](https://badges.greenkeeper.io/basaltinc/twig-renderer.svg)](https://greenkeeper.io/)

> Render templates using Twig PHP, via this Node JS renderer.

*Special thanks to [Salem Ghoweri](https://twitter.com/salem_ghoweri) for collaboration on this project!*

## How to Use

```bash
npm install --save @basalt/twig-renderer
```

```php
const TwigRenderer = require('@basalt/twig-renderer');

const config = { 
  // see `./config.schema.js` for details
};

const twigRenderer = new TwigRenderer(config);

twigRenderer.render('@components/card.twig', { title: 'hi' }).then(results => {
  if (results.ok) {
    console.log(results.html);
  } else {
    console.log(results.message);
  }
});
```

Looking in tests folder can help.

## How to Develop

```bash
npm install
composer install
npm run setup
```

---
_Source: https://npm.io/package/@basalt/twig-renderer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._