feat: Uppercase Twig option

BREAKING CHANGE: Uppercase Twig option to align with Twig.js documentation.

Author: mvsde

README.md

@@ -26,7 +26,7 @@ import Twig from "twig";
 import { twigDrupalString } from "twig-drupal-string";
 
 twigDrupalString({
-  twig: Twig,
+  Twig,
   files: ["strings.yaml"],
 });
 
@@ -76,7 +76,7 @@ Set the `watch` options:
 
 ```js
 twigDrupalString({
-  twig: Twig,
+  Twig,
   files: ["strings.yaml"],
   watch: true,
 });

lib/index.js

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

lib/types.d.ts

@@ -2,7 +2,7 @@ import Twig from "twig";
 
 type Options = {
 	/** Twig engine instance */
-	twig: typeof Twig;
+	Twig: typeof Twig;
 
 	/** Paths to translation string files */
 	files: string[];

test/index.test.js

@@ -1,25 +1,25 @@
 import assert from "node:assert/strict";
 import test from "node:test";
 
-import twig from "twig";
+import Twig from "twig";
 
 import { twigDrupalString } from "../lib/index.js";
 
-twigDrupalString({ twig, files: ["./test/strings.yaml"] });
+twigDrupalString({ Twig, files: ["./test/strings.yaml"] });
 
 test("basic", async (t) => {
 	const expected = `<h1>Hello world</h1>`;
 
 	await t.test("t", () => {
 		const data = `<h1>{{ 'welcome'|t }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
 
 	await t.test("trans", () => {
 		const data = `<h1>{{ 'welcome'|trans }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
@@ -30,14 +30,14 @@ test("placeholder", async (t) => {
 
 	await t.test("t", () => {
 		const data = `<h1>{{ 'greeting'|t({'@name': 'world'}) }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
 
 	await t.test("trans", () => {
 		const data = `<h1>{{ 'greeting'|trans({'@name': 'world'}) }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
@@ -48,14 +48,14 @@ test("not found", async (t) => {
 
 	await t.test("t", () => {
 		const data = `<h1>{{ 'goodbye'|t }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
 
 	await t.test("trans", () => {
 		const data = `<h1>{{ 'goodbye'|trans }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
@@ -66,14 +66,14 @@ test("no default", async (t) => {
 
 	await t.test("t", () => {
 		const data = `<h1>{{ 'see.ya'|t }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});
 
 	await t.test("trans", () => {
 		const data = `<h1>{{ 'see.ya'|trans }}</h1>`;
-		const result = twig.twig({ data }).render();
+		const result = Twig.twig({ data }).render();
 
 		assert.equal(result, expected);
 	});