diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index c62ab30a..4f3aff9b 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -34,9 +34,6 @@ jobs: sudo apt-get update sudo apt-get install -y ripgrep bubblewrap socat - - name: Compile translations - run: bun run i18n:compile - - name: Lint run: bun run lint diff --git a/.github/workflows/release-npm.yaml b/.github/workflows/release-npm.yaml index a036ef0b..0cab49c2 100644 --- a/.github/workflows/release-npm.yaml +++ b/.github/workflows/release-npm.yaml @@ -53,9 +53,6 @@ jobs: - name: Install dependencies run: bun install - - name: Compile translations - run: bun run i18n:compile - - name: Lint run: bun run lint diff --git a/packages/webui/src/paraglide/README.md b/packages/webui/src/paraglide/README.md index c9706762..9e6ff79e 100644 --- a/packages/webui/src/paraglide/README.md +++ b/packages/webui/src/paraglide/README.md @@ -4,7 +4,6 @@ Compiled from: `/Users/yiling/Projects/shumai/packages/webui/project.inlang` - ## What is this folder? This folder contains compiled [Paraglide JS](https://github.com/opral/paraglide-js) output. Paraglide JS compiles your translation messages into tree-shakeable JavaScript functions. @@ -12,15 +11,18 @@ This folder contains compiled [Paraglide JS](https://github.com/opral/paraglide- ## At a glance Purpose: + - This folder stores compiled i18n message functions. - Source translations live outside this folder in your inlang project. Safe to import: + - `messages.js` — all message functions - `runtime.js` — locale utilities - `server.js` — server-side middleware Do not edit: + - All files in this folder are auto-generated. - Changes will be overwritten on next compilation. @@ -37,27 +39,27 @@ paraglide/ ## Usage ```js -import * as m from "./paraglide/messages.js"; +import * as m from './paraglide/messages.js' // Messages are functions that return localized strings -m.hello_world(); // "Hello, World!" (in current locale) -m.greeting({ name: "Sam" }); // "Hello, Sam!" +m.hello_world() // "Hello, World!" (in current locale) +m.greeting({ name: 'Sam' }) // "Hello, Sam!" // Override locale per-call -m.hello_world({}, { locale: "de" }); // "Hallo, Welt!" -m.greeting({ name: "Sam" }, { locale: "de" }); // "Hallo, Sam!" +m.hello_world({}, { locale: 'de' }) // "Hallo, Welt!" +m.greeting({ name: 'Sam' }, { locale: 'de' }) // "Hallo, Sam!" ``` ## Runtime API ```js -import { getLocale, getTextDirection, setLocale, locales, baseLocale } from "./paraglide/runtime.js"; +import { getLocale, getTextDirection, setLocale, locales, baseLocale } from './paraglide/runtime.js' -getLocale(); // Current locale, e.g., "en" -getTextDirection(); // "ltr" | "rtl" for current locale -setLocale("de"); // Set locale -locales; // Available locales, e.g., ["en", "de", "fr"] -baseLocale; // Default locale, e.g., "en" +getLocale() // Current locale, e.g., "en" +getTextDirection() // "ltr" | "rtl" for current locale +setLocale('de') // Set locale +locales // Available locales, e.g., ["en", "de", "fr"] +baseLocale // Default locale, e.g., "en" ``` ## Strategy @@ -73,10 +75,10 @@ Strategies can be combined. The order defines precedence: ```js await compile({ - project: "./project.inlang", - outdir: "./src/paraglide", - strategy: ["url", "cookie", "baseLocale"], -}); + project: './project.inlang', + outdir: './src/paraglide', + strategy: ['url', 'cookie', 'baseLocale'], +}) ``` See the [strategy documentation](https://paraglidejs.com/strategy) for details. @@ -86,6 +88,7 @@ See the [strategy documentation](https://paraglidejs.com/strategy) for details. Messages can contain markup tags for bold, links, and other inline elements. Translators control where tags appear; developers control how they render. Important: + - Tag names are app-defined. There is no built-in list of HTML tags. - `{#b}...{/b}` does not automatically render as `...`. - Renderers/snippets are looked up by the same tag name used in the message. @@ -111,13 +114,13 @@ This is the default inlang message syntax. Paraglide's message format is plugin- Calling the message function still returns **plain text** (markup stripped): ```js -m.cta({ relationship: "noopener" }); // "Read the docs" +m.cta({ relationship: 'noopener' }) // "Read the docs" ``` To render markup, use the framework adapter or the low-level `parts()` API: ```js -const parts = m.cta.parts({ relationship: "noopener" }); +const parts = m.cta.parts({ relationship: 'noopener' }) // [ // { type: "markup-start", name: "link", options: { to: "/docs", rel: "noopener" }, attributes: { track: true } }, // { type: "text", value: "Read the docs" }, @@ -133,11 +136,11 @@ Framework adapters provide a `` component that accepts markup - `@inlang/paraglide-js-solid` ```jsx -import { ParaglideMessage } from "@inlang/paraglide-js-react"; // or -vue, -svelte, -solid +import { ParaglideMessage } from '@inlang/paraglide-js-react' // or -vue, -svelte, -solid - {children}, icon: () =>