feat: Configurable filter names

Author: mvsde

README.md

@@ -68,6 +68,21 @@ const output = template.render();
 // <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:
+
+```js
+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.
@@ -86,11 +101,12 @@ twigDrupalString({
 
 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    |
-| `watch`  | `boolean`  | Enable or disable watch mode, default `false` |
+| 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
 

lib/index.js

@@ -5,7 +5,12 @@ import YAML from "yaml";
 /**
  * @param {import("./types.d.ts").Options} options
  */
-export function twigDrupalString({ Twig, files, watch = false }) {
+export function twigDrupalString({
+	Twig,
+	files,
+	filterNames = ["t", "trans"],
+	watch = false,
+}) {
 	let translations = getTranslations(files);
 
 	/** @type {Set<string>} */
@@ -69,8 +74,9 @@ export function twigDrupalString({ Twig, files, watch = false }) {
 		return string;
 	};
 
-	Twig.extendFilter("t", trans);
-	Twig.extendFilter("trans", trans);
+	for (const filterName of filterNames) {
+		Twig.extendFilter(filterName, trans);
+	}
 }
 
 /**

lib/types.d.ts

@@ -1,13 +1,28 @@
 import Twig from "twig";
 
 type Options = {
-	/** Twig engine instance */
+	/**
+	 * Twig engine instance
+	 */
 	Twig: typeof Twig;
 
-	/** Paths to translation string files */
+	/**
+	 * Paths to translation string files
+	 */
 	files: string[];
 
-	/** Enable watch mode (disabled by default) */
+	/**
+	 * Adjust the filter names
+	 *
+	 * Default: `["t", "trans"]`
+	 */
+	filterNames?: string[];
+
+	/**
+	 * Enable watch mode
+	 *
+	 * Default: `false`
+	 */
 	watch?: boolean;
 };
 

test/filter-name.test.js

@@ -28,4 +28,18 @@ suite("filter name", () => {
 
 		assert.equal(result, expected);
 	});
+
+	test("custom: tc", () => {
+		const Twig = createTwigInstance();
+		twigDrupalString({
+			Twig,
+			files: ["./test/strings.yaml"],
+			filterNames: ["tc"],
+		});
+
+		const data = `<h1>{{ 'welcome'|tc }}</h1>`;
+		const result = Twig.twig({ data }).render();
+
+		assert.equal(result, expected);
+	});
 });