npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

twig-drupal-string

v0.4.0

Published

Twig.js extension for Drupal String module filter support

Downloads

302

Readme

Twig Drupal String

Add support for the Drupal Twig t and trans filters in combination with the String module and Twig.js.

Installation

Add the package to your dependencies:

npm install --save-dev twig twig-drupal-string

Example

Crate a file called strings.yaml with the following content:

welcome:
  default: Welcome

Then create render-template.mjs:

import Twig from "twig";
import { twigDrupalString } from "twig-drupal-string";

twigDrupalString({
  Twig,
  files: ["strings.yaml"],
});

const data = `<h1>{{ 'welcome'|t }}</h1>`;
const template = Twig.twig({ data });
const output = template.render();

console.log(output);

Run the example with:

node render-template.mjs

# The output is:
# <h1>Welcome</h1>

Placeholders

The filter also supports placeholders inside the strings that will be replaced with dynamic data during template rendering.

Add the following to strings.yaml:

greeting:
  default: Hello @name

Then adjust the template inside render-template.mjs:

const data = `<h1>{{ 'greeting'|t({'@name': 'world'}) }}</h1>`;
const template = Twig.twig({ data });
const output = template.render();

// Output will be:
// <h1>Hello world</h1>

Custom filter names

By default, the filter names t and trans are supported. You can overwrite or extend these names with the filterNames option:

import Twig from "twig";
import { twigDrupalString } from "twig-drupal-string";

twigDrupalString({
  Twig,
  files: ["strings.yaml"],
  filterNames: ["t", "trans", "tc"],
});

Watch mode

For development purposes, a watch mode can be enabled that reloads the translation strings from disk if any of the referenced files change.

Set the watch options:

twigDrupalString({
  Twig,
  files: ["strings.yaml"],
  watch: true,
});

Options

The twigDrupalString method receives an options object with the following properties:

| Property | Type | Description | | ------------- | ---------- | ------------------------------------------------------ | | Twig | Twig | Twig.js engine instance | | files | string[] | Array of paths to translation string files | | filterNames | string[] | Array of filter name strings, default ["t", "trans"] | | watch | boolean | Enable or disable watch mode, default false |

Contributing

See contributing documentation for more information.

Sponsors