feat: Initial release

Co-authored-by: Judith Plath <jujuzitroni@gmail.com>

Author: mvsde

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,yaml,yml}]
+indent_style = space

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+index.cjs

.npmrc

@@ -0,0 +1,2 @@
+message="chore(release): %s"
+sign-git-tag=true

.nvmrc

@@ -0,0 +1 @@
+21

.prettierignore

@@ -0,0 +1 @@
+package-lock.json

CHANGELOG.md

@@ -0,0 +1,53 @@
+# Contributing
+
+## Getting started
+
+Optionally choose the correct Node.js version with [nvm](https://nvm.sh/) installed:
+
+```sh
+nvm use
+```
+
+Install dependencies with:
+
+```sh
+npm install
+```
+
+All commits must follow the [Conventional Commits](https://www.conventionalcommits.org/) specification, so an automatic changelog can be generated.
+
+## Run linter
+
+```sh
+npm run lint
+```
+
+## Run test
+
+The tests are written with the [Node.js test runner](https://nodejs.org/api/test.html).
+
+```sh
+npm run test
+```
+
+## Format code
+
+```sh
+npm run format
+```
+
+## Create release
+
+Bump the package version and generate a changelog:
+
+```sh
+npm version …
+```
+
+See [npm version docs](https://docs.npmjs.com/cli/v10/commands/npm-version) for all available arguments.
+
+Publish the new version with:
+
+```sh
+npm publish
+```

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+MIT license
+
+Copyright © 2024 Fynn Becker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE

@@ -0,0 +1,93 @@
+# Twig Drupal String
+
+Add support for the Drupal [Twig `t` and `trans` filters](https://symfony.com/doc/current/translation.html#translation-filters) in combination with the [String module](https://www.drupal.org/project/string) and [Twig.js](https://github.com/twigjs/twig.js/).
+
+## Installation
+
+Add the package to your dependencies:
+
+```sh
+npm install --save-dev twig twig-drupal-string
+```
+
+## Example
+
+Crate a file called `strings.yaml` with the following content:
+
+```yaml
+welcome:
+  default: Hello world
+```
+
+Then create `render-template.mjs`:
+
+```js
+import Twig from "twig";
+import { twigDrupalString } from "twig-drupal-string";
+
+twigDrupalString({
+  twig: 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:
+
+```sh
+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`:
+
+```yaml
+greeting:
+  default: Hello @name
+```
+
+Then adjust the template inside `render-template.mjs`:
+
+```js
+const data = `<h1>{{ 'greeting'|t({'@name': 'world'}) }}</h1>`;
+const template = Twig.twig({ data });
+const output = template.render();
+
+// Output will be:
+// <h1>Hello world</h1>
+```
+
+## 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:
+
+```js
+twigDrupalString({
+  twig: Twig,
+  files: ["strings.yaml"],
+  watch: true,
+});
+```
+
+## Contributing
+
+See [contributing documentation](CONTRIBUTING.md) for more information.
+
+## Sponsored by
+
+<a href="https://factorial.io/">
+  <img src="https://logo.factorial.io/color.svg" width="40" height="56" alt="Factorial">
+</a>

README.md

@@ -0,0 +1,21 @@
+import js from "@eslint/js";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import globals from "globals";
+
+export default [
+	js.configs.recommended,
+	{
+		languageOptions: {
+			globals: {
+				...globals.node,
+			},
+		},
+		plugins: {
+			"simple-import-sort": simpleImportSort,
+		},
+		rules: {
+			"simple-import-sort/imports": "error",
+			"simple-import-sort/exports": "error",
+		},
+	},
+];