refactor(core): use Intl.PluralRules (#1486)

* refactor(core): i18n.loadLocaleData() is deprecated. Intl.PluralRules used instead. * refactor(core): use normalized locales in plural rules - always provide fallback to english. This is useful for cases with pseudo localization - allow to pass locales[] for all formatters, this unlocks possibility to override fallback for some locales * docs(core): add migration notes for PluralRules
lingui · Mar 9, 2023 · 3433452 · 3433452
1 parent 839f0b7
commit 3433452
Show file tree

Hide file tree

Showing 29 changed files with 339 additions and 523 deletions.
diff --git a/examples/create-react-app/src/App.test.tsx b/examples/create-react-app/src/App.test.tsx
@@ -1,42 +1,39 @@
-import React from 'react'
-import { getByText, render, act } from '@testing-library/react'
-import { i18n } from '@lingui/core'
-import { I18nProvider } from '@lingui/react'
-import { en, cs } from 'make-plural/plurals'
+import React from "react"
+import { getByText, render, act } from "@testing-library/react"
+import { i18n } from "@lingui/core"
+import { I18nProvider } from "@lingui/react"
 
-import { messages } from './locales/en/messages'
-import { messages as csMessages } from './locales/cs/messages'
-import App from './App'
+import { messages } from "./locales/en/messages"
+import { messages as csMessages } from "./locales/cs/messages"
+import App from "./App"
 
 i18n.load({
   en: messages,
-  cs: csMessages
+  cs: csMessages,
 })
-i18n.loadLocaleData({
-  en: { plurals: en },
-  cs: { plurals: cs }
-});
 
 const TestingProvider = ({ children }: any) => (
-  <I18nProvider i18n={i18n}>
-    {children}
-  </I18nProvider>
+  <I18nProvider i18n={i18n}>{children}</I18nProvider>
 )
 
-test('Test that lang is translated correctly in English' , () => {
+test("Test that lang is translated correctly in English", () => {
   act(() => {
-    i18n.activate('en')
+    i18n.activate("en")
   })
-  const { getByTestId, container } = render(<App />, { wrapper: TestingProvider });
-  expect(getByTestId('h3-title')).toBeInTheDocument()
+  const { getByTestId, container } = render(<App />, {
+    wrapper: TestingProvider,
+  })
+  expect(getByTestId("h3-title")).toBeInTheDocument()
   expect(getByText(container, "Language switcher example:")).toBeDefined()
-});
+})
 
-test('Test that lang is translated correctly in Czech', () => {
+test("Test that lang is translated correctly in Czech", () => {
   act(() => {
-    i18n.activate('cs')
+    i18n.activate("cs")
   })
-  const { getByTestId, container } = render(<App />, { wrapper: TestingProvider });
-  expect(getByTestId('h3-title')).toBeInTheDocument()
+  const { getByTestId, container } = render(<App />, {
+    wrapper: TestingProvider,
+  })
+  expect(getByTestId("h3-title")).toBeInTheDocument()
   expect(getByText(container, "Příklad přepínače jazyků:")).toBeDefined()
-});
+})
diff --git a/examples/create-react-app/src/i18n.ts b/examples/create-react-app/src/i18n.ts
@@ -1,23 +1,19 @@
-import { i18n } from "@lingui/core";
-import { en, cs } from 'make-plural/plurals'
+import { i18n } from "@lingui/core"
 
 export const locales = {
   en: "English",
   cs: "Česky",
-};
-export const defaultLocale = "en";
-
-i18n.loadLocaleData({
-  en: { plurals: en },
-  cs: { plurals: cs },
-})
+}
+export const defaultLocale = "en"
 
 /**
  * We do a dynamic import of just the catalog that we need
  * @param locale any locale string
  */
 export async function dynamicActivate(locale: string) {
-  const { messages } = await import(`@lingui/loader!./locales/${locale}/messages.po`)
+  const { messages } = await import(
+    `@lingui/loader!./locales/${locale}/messages.po`
+  )
   i18n.load(locale, messages)
   i18n.activate(locale)
 }

diff --git a/examples/js/src/ids.js b/examples/js/src/ids.js
@@ -1,9 +1,5 @@
 import { i18n } from "@lingui/core"
 import { t, plural, defineMessage } from "@lingui/macro"
-import { en, cs } from "make-plural/plurals"
-
-i18n.loadLocaleData("en", { plurals: en })
-i18n.loadLocaleData("cs", { plurals: cs })
 
 i18n.load({
   en: require("./locale/en/messages").messages,

diff --git a/examples/js/src/messages.js b/examples/js/src/messages.js
@@ -1,9 +1,5 @@
 import { i18n } from "@lingui/core"
 import { t, plural, defineMessage } from "@lingui/macro"
-import { en, cs } from "make-plural/plurals"
-
-i18n.loadLocaleData("en", { plurals: en })
-i18n.loadLocaleData("cs", { plurals: cs })
 
 i18n.load({
   en: require("./locale/en/messages").messages,

diff --git a/examples/next-js/lingui-example/i18n.ts b/examples/next-js/lingui-example/i18n.ts
@@ -1,8 +1,4 @@
 import { i18n } from "@lingui/core"
-import { en, cs } from "make-plural/plurals"
-
-i18n.loadLocaleData("en", { plurals: en })
-i18n.loadLocaleData("cs", { plurals: cs })
 
 /**
  * Load messages for requested locale and activate it.

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -56,7 +56,6 @@
     "@lingui/core": "4.0.0-next.0",
     "@messageformat/parser": "^5.0.0",
     "babel-plugin-macros": "^3.0.1",
-    "bcp-47": "^1.0.7",
     "chalk": "^4.1.0",
     "chokidar": "3.5.1",
     "cli-table": "0.3.6",
@@ -65,7 +64,6 @@
     "date-fns": "^2.16.1",
     "glob": "^7.1.4",
     "inquirer": "^7.3.3",
-    "make-plural": "^6.2.2",
     "micromatch": "4.0.2",
     "mkdirp": "^1.0.4",
     "node-gettext": "^3.0.0",

diff --git a/packages/cli/src/api/locales.test.ts b/packages/cli/src/api/locales.test.ts
diff --git a/packages/cli/src/api/locales.ts b/packages/cli/src/api/locales.ts
diff --git a/packages/cli/src/lingui-compile.ts b/packages/cli/src/lingui-compile.ts
@@ -2,7 +2,6 @@ import chalk from "chalk"
 import chokidar from "chokidar"
 import fs from "fs"
 import { program } from "commander"
-import * as plurals from "make-plural"
 
 import { getConfig, LinguiConfigNormalized } from "@lingui/conf"
 
@@ -33,18 +32,6 @@ export function command(
   console.log("Compiling message catalogs…")
 
   for (const locale of config.locales) {
-    const [language] = locale.split(/[_-]/)
-    // todo: this validation should be in @lingui/conf
-    // todo: validate locales according bcp47, instead of plurals
-    if (locale !== config.pseudoLocale && !(plurals as any)[language]) {
-      console.error(
-        chalk.red(
-          `Error: Invalid locale ${chalk.bold(locale)} (missing plural rules)!`
-        )
-      )
-      console.error()
-    }
-
     for (const catalog of catalogs) {
       const missingMessages: TranslationMissingEvent[] = []
 

diff --git a/packages/cli/src/test/__snapshots__/compile.test.ts.snap b/packages/cli/src/test/__snapshots__/compile.test.ts.snap
@@ -1,10 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`CLI Command: Compile Locales Validation Should throw error for invalid locale 1`] = `
-Error: Invalid locale abra (missing plural rules)!
-
-`;
-
 exports[`CLI Command: Compile allowEmpty = false Should show error and stop compilation of catalog if message doesnt have a translation (no template) 1`] = `
 Error: Failed to compile catalog for locale pl!
 Missing 1 translation(s)

diff --git a/packages/cli/src/test/compile.test.ts b/packages/cli/src/test/compile.test.ts
@@ -9,58 +9,6 @@ describe("CLI Command: Compile", () => {
     // todo
   })
 
-  describe("Locales Validation", () => {
-    // todo: should be moved to @lingui/conf
-    it("Should throw error for invalid locale", () => {
-      const config = makeConfig({
-        locales: ["abra"],
-        rootDir: "/test",
-        catalogs: [
-          {
-            path: "<rootDir>/{locale}",
-            include: ["<rootDir>"],
-            exclude: [],
-          },
-        ],
-      })
-
-      mockFs()
-
-      mockConsole((console) => {
-        const result = command(config, {})
-        mockFs.restore()
-        const log = getConsoleMockCalls(console.error)
-        expect(log).toMatchSnapshot()
-
-        expect(result).toBeTruthy()
-      })
-    })
-
-    it("Should not throw error for pseudolocale", () => {
-      const config = makeConfig({
-        locales: ["abracadabra"],
-        rootDir: "/test",
-        pseudoLocale: "abracadabra",
-        catalogs: [
-          {
-            path: "<rootDir>/{locale}",
-            include: ["<rootDir>"],
-            exclude: [],
-          },
-        ],
-      })
-
-      mockFs()
-
-      mockConsole((console) => {
-        const result = command(config, {})
-        mockFs.restore()
-        expect(console.error).not.toBeCalled()
-        expect(result).toBeTruthy()
-      })
-    })
-  })
-
   describe("allowEmpty = false", () => {
     const config = makeConfig({
       locales: ["en", "pl"],

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -60,8 +60,7 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@messageformat/parser": "^5.0.0",
-    "make-plural": "^6.2.2"
+    "@messageformat/parser": "^5.0.0"
   },
   "devDependencies": {
     "@lingui/jest-mocks": "*"

diff --git a/packages/core/src/compile/compileMessage.test.ts b/packages/core/src/compile/compileMessage.test.ts
@@ -2,25 +2,11 @@ import { compileMessage as compile } from "./compileMessage"
 import { mockEnv, mockConsole } from "@lingui/jest-mocks"
 import { interpolate } from "../context"
 import { Locale, Locales } from "../i18n"
-import { PluralCategory } from "make-plural"
 
 describe("compile", () => {
-  const englishPlurals = {
-    plurals(value: number, ordinal: boolean) {
-      if (ordinal) {
-        return (
-          ({ "1": "one", "2": "two", "3": "few" }[value] as PluralCategory) ||
-          "other"
-        )
-      } else {
-        return value === 1 ? "one" : "other"
-      }
-    },
-  }
-
   const prepare = (translation: string, locale?: Locale, locales?: Locales) => {
     const tokens = compile(translation)
-    return interpolate(tokens, locale || "en", locales, englishPlurals)
+    return interpolate(tokens, locale || "en", locales)
   }
 
   it("should handle an error if message has syntax errors", () => {
@@ -62,9 +48,7 @@ describe("compile", () => {
 
   it("should compile message with variable", () => {
     const cache = compile("Hey {name}!")
-    expect(interpolate(cache, "en", [], {})({ name: "Joe" })).toEqual(
-      "Hey Joe!"
-    )
+    expect(interpolate(cache, "en", [])({ name: "Joe" })).toEqual("Hey Joe!")
   })
 
   it("should not interpolate escaped placeholder", () => {
@@ -96,6 +80,32 @@ describe("compile", () => {
     expect(cache({ value: 2 })).toEqual("2nd Book")
   })
 
+  it("should support nested choice components", () => {
+    const cache = prepare(
+      `{
+      gender, select, 
+      male {{numOfGuests, plural, one {He invites one guest} other {He invites # guests}}} 
+      female {{numOfGuests, plural, one {She invites one guest} other {She invites # guests}}} 
+      other {They is {gender}}}`
+    )
+
+    expect(cache({ numOfGuests: 1, gender: "male" })).toEqual(
+      "He invites one guest"
+    )
+    expect(cache({ numOfGuests: 3, gender: "male" })).toEqual(
+      "He invites 3 guests"
+    )
+    expect(cache({ numOfGuests: 1, gender: "female" })).toEqual(
+      "She invites one guest"
+    )
+    expect(cache({ numOfGuests: 3, gender: "female" })).toEqual(
+      "She invites 3 guests"
+    )
+    expect(cache({ numOfGuests: 3, gender: "unknown" })).toEqual(
+      "They is unknown"
+    )
+  })
+
   it("should compile select", () => {
     const cache = prepare("{value, select, female {She} other {They}}")
     expect(cache({ value: "female" })).toEqual("She")
@@ -137,7 +147,7 @@ describe("compile", () => {
             style: "currency",
             currency: "EUR",
             minimumFractionDigits: 2,
-          } as Intl.NumberFormatOptions,
+          } satisfies Intl.NumberFormatOptions,
         }
         const currency = prepare("{value, number, currency}", locale, locales)
         expect(currency({ value: 0.1 }, formats)).toEqual(expectedCurrency1)