forked from uyuni-project/uyuni
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
…7296) * Initial implementation * Update docs * Test global binding * Cleanup * Update translations to new format * Upgrade more translations * Update more translations * Add tests, clean up * Deprecate test-utils t() * Update licenses * Cleanup * Update commentary * Fix pagination translation * Refactor preferred locale * Cleanup * Add changes * Cleanup
- Loading branch information
Showing
55 changed files
with
663 additions
and
260 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| import * as React from "react"; | ||
|
|
||
| import ReactDOM from "react-dom"; | ||
|
|
||
| type Props = { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| import ReactDOMServer from "react-dom/server"; | ||
|
|
||
| import { t } from "./index"; | ||
|
|
||
| describe("new t()", () => { | ||
| test("passthrough", () => { | ||
| expect(t("foo")).toEqual("foo"); | ||
| expect(t("undefined")).toEqual("undefined"); | ||
| expect(t("")).toEqual(""); | ||
| // In case someone acidentally passes an `any` typed variable with a non-string value, try and recover | ||
| expect(t(undefined as any)).toEqual(""); | ||
| expect(t(null as any)).toEqual(""); | ||
| }); | ||
|
|
||
| test("named placeholders", () => { | ||
| expect(t("foo {insert} bar", { insert: "something" })).toEqual("foo something bar"); | ||
| expect(t("foo {insert} bar", { insert: undefined })).toEqual("foo bar"); | ||
| }); | ||
|
|
||
| test("tags", () => { | ||
| const input = "foo <link>bar</link>"; | ||
| const inputArgs = { | ||
| link: (str) => <a href="/">{str}</a>, | ||
| }; | ||
| const expected = 'foo <a href="/">bar</a>'; | ||
|
|
||
| expect(ReactDOMServer.renderToStaticMarkup(<>{t(input, inputArgs)}</>)).toEqual(expected); | ||
| }); | ||
|
|
||
| test("tags with named placeholders", () => { | ||
| const input = "foo <link>{insert}</link> bar"; | ||
| const inputArgs = { | ||
| insert: "something", | ||
| link: (str) => <a href="/">{str}</a>, | ||
| }; | ||
| const expected = 'foo <a href="/">something</a> bar'; | ||
|
|
||
| expect(ReactDOMServer.renderToStaticMarkup(<>{t(input, inputArgs)}</>)).toEqual(expected); | ||
| }); | ||
|
|
||
| // This behavior allows existing `handleResponseError` implementations to pass `{ arg: undefined }` even when there is no arg | ||
| test("extra args are ignored", () => { | ||
| const input = "foo bar"; | ||
| const inputArgs = { tea: "cup", and: undefined }; | ||
| const expected = "foo bar"; | ||
|
|
||
| expect(t(input, inputArgs)).toEqual(expected); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import { createIntl, createIntlCache } from "@formatjs/intl"; | ||
| import Gettext from "node-gettext"; | ||
|
|
||
| import { jsFormatPreferredLocale } from "core/user-preferences"; | ||
|
|
||
| import type { Values } from "./inferValues"; | ||
|
|
||
| const gt = new Gettext(); | ||
| const domain = "messages"; | ||
| const poData = getPoAsJson(window.preferredLocale); | ||
| gt.addTranslations("", domain, poData); | ||
|
|
||
| /** | ||
| * Get the translation data. If the file is not found e.g. because the language is not (yet) supported | ||
| * return an empty string and use the default translation en_US | ||
| */ | ||
| function getPoAsJson(locale?: string) { | ||
| if (!locale) { | ||
| return ""; | ||
| } | ||
| try { | ||
| return require(`../../../../po/${locale}.po`); | ||
| } catch (_) { | ||
| return ""; | ||
| } | ||
| } | ||
|
|
||
| // We proxy every translation request directly to gettext so we can use the po files as-is without any transformations | ||
| const alwaysExists = { configurable: true, enumerable: true }; | ||
| const messages = new Proxy( | ||
| {}, | ||
| { | ||
| get(_, key) { | ||
| return gt.gettext(key); | ||
| }, | ||
| getOwnPropertyDescriptor() { | ||
| return alwaysExists; | ||
| }, | ||
| } | ||
| ); | ||
|
|
||
| const cache = createIntlCache(); | ||
| const intl = createIntl( | ||
| { | ||
| locale: jsFormatPreferredLocale, | ||
| messages, | ||
| }, | ||
| cache | ||
| ); | ||
|
|
||
| // This is exported for tests, everywhere else feel free to use the global reference | ||
| export const t = <Message extends string>( | ||
| // This is always the default string in English, even if the page is in another locale | ||
| defaultMessage: Message, | ||
| /** | ||
| * An object providing values to placeholders, e.g. for `"example {foo}"`, providing `{ foo: "text" }` would return `"example text"`. | ||
| * | ||
| * DOM nodes, React components, etc can also be used, e.g. `"example <bold>text</bold>"` and `{ bold: str => <b>{str}</b> }` would give `"example <b>text</b>"`. | ||
| */ | ||
| // We could optionally ` | Record<string, any>` here if we wanted to be more lax about values in some contexts while keeping autocomplete | ||
| values?: Values<Message> | ||
| ) => { | ||
| // react-intl is unhappy when an emtpy string is used as an id | ||
| if (!defaultMessage) { | ||
| return ""; | ||
| } | ||
|
|
||
| return intl.formatMessage( | ||
| { | ||
| id: defaultMessage, | ||
| defaultMessage: defaultMessage, | ||
| }, | ||
| values | ||
| ); | ||
| }; | ||
|
|
||
| export type tType = typeof t; | ||
|
|
||
| window.t = t; | ||
|
|
||
| // If we need to, we have the option to export stuff such as formatNumber etc here in the future | ||
|
|
||
| export default {}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| /** | ||
| * Infer possible placeholder and tag values for a given translatable string, e.g. for `"example {foo}"`, infer | ||
| * `PartialRecord<"foo", any>`. | ||
| * See https://stackoverflow.com/a/71906104/1470607 | ||
| * | ||
| * If we ever find a case where this breaks, drop it and replace it with a simple `Record<string, any>`, however | ||
| * currently it makes autocomplete work nicely | ||
| */ | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| type PlaceholderKeys<T extends string, KS extends string = never> = T extends `${infer F}{${infer K}}${infer R}` | ||
| ? PlaceholderKeys<R, K | KS> | ||
| : KS; | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| type TagKeys<T extends string, KS extends string = never> = T extends `${infer F}</${infer K}>${infer R}` | ||
| ? TagKeys<R, K | KS> | ||
| : KS; | ||
| type PossibleKeysOf<T extends string> = PlaceholderKeys<T> | TagKeys<T>; | ||
| type PartialRecord<K extends keyof any, T> = { | ||
| [P in K]?: T; | ||
| }; | ||
| export type Values<T extends string> = PartialRecord<PossibleKeysOf<T>, any>; |
Oops, something went wrong.