add icu1 example #604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

examples/icu1/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,18 @@
+    # ICU1 plugin example
+    This example shows how to configure the ICU MessageFormat v1 storage plugin in `project.inlang/settings.json` and use ICU1 messages in `messages/{locale}.json`.
+    ## Files
+    - `project.inlang/settings.json` uses the ICU1 plugin and `plugin.inlang.icu-messageformat-1` config.
+    - `messages/en.json` and `messages/de.json` contain ICU1 `select` and `plural` messages.
+    ## Try it
+    From the repo root:
+    ```sh
+    npx @inlang/paraglide-js@latest compile --project ./examples/icu1/project.inlang --outdir ./examples/icu1/src/paraglide
+    ```
+    (Adjust the `--outdir` if you want the generated files elsewhere.)

examples/icu1/messages/de.json

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    {
+    	"mode": "{mode, select, light {Hell} dark {Dunkel} system {System} other {Unbekannt}}",
+    	"items": "{count, plural, offset:1 =0 {keine Elemente} one {# Element} other {# Elemente}}",
+    	"greeting": "Hallo {name}!"
+    }

examples/icu1/messages/en.json

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    {
+    	"mode": "{mode, select, light {Light} dark {Dark} system {System} other {Unknown}}",
+    	"items": "{count, plural, offset:1 =0 {no items} one {# item} other {# items}}",
+    	"greeting": "Hello {name}!"
+    }

examples/icu1/package.json

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    {
+    	"name": "@inlang/paraglide-js-example-icu1",
+    	"private": true,
+    	"version": "0.0.0",
+    	"type": "module",
+    	"scripts": {
+    		"build": "paraglide-js compile --project ./project.inlang --outdir ./src/paraglide",
+    		"clean": "rm -rf ./src/paraglide ./node_modules"
+    	},
+    	"devDependencies": {
+    		"@inlang/paraglide-js": "workspace:*",
+    		"@inlang/plugin-icu1": "^1.0.0",
+    		"@inlang/plugin-m-function-matcher": "^2.1.0"
+    	}
+    }

examples/icu1/project.inlang/settings.json

-Original file line number
+Diff line change
@@ -0,0 +1,12 @@
+    {
+    	"$schema": "https://inlang.com/schema/project-settings",
+    	"baseLocale": "en",
+    	"locales": ["en", "de"],
+    	"modules": [
+    		"./node_modules/@inlang/plugin-icu1/dist/index.js",
+    		"./node_modules/@inlang/plugin-m-function-matcher/dist/index.js"
+    	],
+    	"plugin.inlang.icu-messageformat-1": {
+    		"pathPattern": "./messages/{locale}.json"
+    	}
+    }

examples/vite/messages/en.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ @@
     	"unused": "This is an unused message",
     	"Unused": "This is the second unused message with a capital U to test case sensitivity",
     	"non_existent_in_de": "This is a new message",
+    	"mode": "{mode, select, light {Light} dark {Dark} system {System} other {Unknown}}",
     	"json_array": "[\"a\", \"b\", \"c\"]",
     	"json_object": "\\{\"a\": \"b\", \"c\": \"d\"\\}"
     }

pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Provide feedback