Skip to content
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

Update and consolidate i18n #3313

Merged
merged 11 commits into from
Aug 28, 2024
32 changes: 16 additions & 16 deletions package-lock.json

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

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@
"distinct-colors": "^3.0.0",
"history": "^5.3.0",
"http-status-codes": "^2.3.0",
"i18next": "^23.4.6",
"i18next": "^23.14.0",
"i18next-browser-languagedetector": "^8.0.0",
"i18next-http-backend": "^2.2.2",
"i18next-http-backend": "^2.6.0",
"js-base64": "^3.7.7",
"make-dir": "^4.0.0",
"material-react-table": "^2.9.2",
Expand All @@ -70,7 +70,7 @@
"react-beautiful-dnd": "^13.1.1",
"react-chartjs-2": "^5.2.0",
"react-dom": "^18.2.0",
"react-i18next": "^14.1.2",
"react-i18next": "^15.0.1",
"react-modal": "^3.16.1",
"react-redux": "^8.1.3",
"react-router-dom": "^6.16.0",
Expand Down
9 changes: 4 additions & 5 deletions src/i18n.ts → src/i18n/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// https://dev.to/adrai/how-to-properly-internationalize-a-react-application-using-i18next-3hdb#getting-started
import i18n from "i18next";
import LanguageDetector from "i18next-browser-languagedetector";
import Backend from "i18next-http-backend";
import Backend, { type HttpBackendOptions } from "i18next-http-backend";
import { initReactI18next } from "react-i18next";

import { getCurrentUser } from "backend/localStorage";
Expand All @@ -18,17 +18,16 @@ i18n
.use(Backend)
.use(LanguageDetector)
.use(initReactI18next)
.init(
.init<HttpBackendOptions>(
{
//debug: true, // Uncomment to troubleshoot
returnNull: false,
// detection: options,
// ignoring localStorage and cookies for the detection order lets the user change languages
// more easily (just switch in the browser and reload, instead of clearing all site data)
detection: { order: ["queryString", "path", "navigator"] },
supportedLngs: i18nLangs,
// nonExplicitSupportedLngs will (e.g.) use 'es' if the browser is 'es-MX'
nonExplicitSupportedLngs: true,
// "languageOnly" will (e.g.) only load 'es' if the browser is 'es-MX'
load: "languageOnly",
fallbackLng: i18nFallbacks,
interpolation: { escapeValue: false },
},
Expand Down
4 changes: 2 additions & 2 deletions src/tests/i18nMock.ts → src/i18n/tests/i18nMock.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/* Adapted from https://react.i18next.com/misc/testing
* (In most cases, this isn't needed.
* Instead you can use tests/reactI18nextMock.ts to mock out i18n completely.)
* Instead you can use i18n/tests/reactI18nextMock.ts to mock out i18n completely.)
* For a simple i18next wrapper, add the following to a test file:
* * import { I18nextProvider } from "react-i18next";
* * import i18n from "tests/i18nMock";
* * import i18n from "i18n/tests/i18nMock";
* Then wrap the component being rendered with <I18nextProvider i18n={i18n}> */

import i18n from "i18next";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/* Use `import "tests/reactI18nextMock.ts";` in `setupTests.js` to mock i18next globally.
* (For testing components with `Trans`, see tests/i18nMock.ts instead.)
/* Use `import "i18n/tests/reactI18nextMock.ts";` in `setupTests.js` to mock i18next globally.
* (For testing components with `Trans`, see i18n/tests/i18nMock.ts instead.)
* This import should occur before other internal imports that use `react-i18next`. */

jest.mock("react-i18next", () => ({
Expand Down
2 changes: 1 addition & 1 deletion src/setupTests.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "tests/reactI18nextMock";
import "i18n/tests/reactI18nextMock";

// Force tests to fail on console.error and console.warn
global.console.error = (message) => {
Expand Down
Loading