Cómo configurar la internacionalización en React de principio a fin

¡Esta publicación lo react-intlayudará a pasar de la create-react-appconfiguración del marco a una aplicación web completa y traducida!

Compré el código mientras escribía esta publicación, por lo que podrá ver mi historial de confirmaciones para ver fácilmente cómo evolucionó mi código de principio a fin.

¿Qué es la internacionalización?

Dado que decidió hacer clic en el enlace a esta publicación, es probable que al menos tenga alguna idea de lo que es la internacionalización (i18n). Tomado directamente del sitio web de W3:

"La internacionalización es el diseño y desarrollo de un producto, aplicación o contenido de documento que permite una fácil localización para audiencias objetivo que varían en cultura, región o idioma".

Como desarrollador, desea que su contenido sea fácilmente legible y utilizable por todo tipo de personas en todo el mundo. Creo que todos están de acuerdo con eso. Pero sé lo que estás pensando:

“¡Desarrollar una aplicación web para personas de mi propia cultura / región / idioma ya es bastante difícil! ¡No tengo tiempo ni esfuerzo para i18n! "

Ya veo la jerga. Con suerte, esta publicación lo ayudará a darse cuenta de que configurar i18n para su proyecto no es tan difícil ni requiere tanto tiempo como parece.

Lo que reacciona-intl hace y no hace

Si es nuevo en i18n, es posible que tenga algunas ideas sobre lo que cree que una biblioteca como react-intldebería y no debería poder hacer.

Lo hace:

  • Ayudarle a agregar todo su contenido disperso, para que pueda traducirlo fácilmente más tarde
  • Le ayuda a lidiar con la traducción de texto además de fechas, números, etc.
  • Proporcione una forma sencilla de importar traducciones a su aplicación

No es asi:

  • Traduce tu contenido para ti
  • Decirle cómo averiguar qué configuración regional quiere el usuario.
  • Solucione ese error no relacionado con el que ha estado lidiando durante las últimas horas (qué fastidio, ¿verdad?)

Ok, ¡vayamos directo a eso!

Configurar el proyecto de ejemplo

$ npx create-react-app i18n-example

Voy a agregar el enrutador de reacción para mostrar cómo react-intlfunciona con varias páginas.

$ cd i18n-example && npm install react-router-dom

Mi aplicación de ejemplo tendrá tres componentes de React: una página principal, una subpágina y un componente que se importa a la subpágina. Consulte la estructura de archivos y las páginas a continuación:

/src /components Weather.js /pages Home.js Day.js

El estado del proyecto hasta este punto se puede encontrar aquí.

Configurar react-intl

Ahora empieza la diversión. ¡Lo instalaremos react-intly nos pondremos manos a la obra!

$ npm install react-intl

El objetivo principal detrás react-intles permitir la compatibilidad con i18n mientras se minimiza el impacto en su flujo de codificación normal. Ciertamente, tiene contenido en muchos lugares de su aplicación web. Tiene texto, números y fechas en párrafos, tablas y encabezados.

¿Qué harías si tuvieras que construir una biblioteca i18n? Bueno, tienes estos fragmentos de contenido en toda tu aplicación web. Y desea que todo se traduzca fácilmente. Si fueras a entregar tu contenido a un traductor, no le darías tu código y le dirías "buena suerte, ponte a trabajar".

Querrá encontrar una manera de poner todo su contenido en un archivo y luego darles ese archivo. Lo traducirían a otro idioma, digamos de inglés a español, y te darían un archivo con todo el contenido en español.

Vale genial. Así que lo hizo, pero ahora tiene que tomar el contenido en español en ese archivo y volver a distribuirlo en su ubicación original. ¿Cómo harías eso programáticamente? Quizás asignaría identificadores a cada fragmento de contenido, para no perder la pista de la ubicación original de cada fragmento de contenido.

¡Y eso es todo!

El primer paso es envolver su aplicación en el er> component:

Now, you need to identify the content for react-intl that will eventually be translated. On the home page of my app, I have the following paragraph:

It is a beautiful day outside.

I need to tell react-intl that this is content that I want to translate and give it an id, so that it can keep track of this content and its original location:

By default, the text will be outputted in a an> , so we will need to wrap this in the original

I will now do this for all the content in my web app.

The state of the project up until now can be found here.

Adding babel-plugin-react-intl

Now that we have everything set up, you might be wondering how we can easily aggregate all of that content into one file. However, for debugging purposes, it could be helpful to have individual JSON files for each React component. Guess what, there’s a babel plugin for that!

$ npm install babel-plugin-react-intl

This plugin will make a copy of your src directory, but instead of having your React component files, it will have json files with the message content and id. One for each component file in your src directory. It will do this when you run npm run build .

Now we need to eject from create-react-app, so that we can add our new plugin into our babel configuration. Make sure to commit any changes and then execute:

$ npm run eject

Now, we will need to add a .babelrc file in our project root with the following contents:

{ "presets":["react-app"], "plugins": [ ["react-intl", { "messagesDir": "./public/messages/" }] ] }

Now that babel can use our fancy new plugin that we just added, we can move onto our next step: generating those JSON files.

$ npm run build

Once you run this, you should notice that you have a public/messages/src directory that appears to be a clone of your original src directory, except all your component files are actually JSON files.

/messages /src /components Weather.json /pages Home.json Day.json

Now, let’s see the contents of one of them, Home.json:

[ { "id": "Home.header", "defaultMessage": "Hello, world!" }, { "id": "Home.dayMessage", "defaultMessage": "It's a beautiful day outside." }, { "id": "Home.dayLink", "defaultMessage": "Click here to find out why!" } ]

The state of the project up until now can be found here.

Combining the JSON files

It did just what we thought it would. It can be helpful to have our content organized in this structure, but ultimately we will want it to be in one file, and we need it to include any translations that we will make.

Now we need to make a script that does this for us. Thankfully, the folks at react-intl gave us a good starting point with this script.

import * as fs from "fs"; import { sync as globSync } from "glob"; import { sync as mkdirpSync } from "mkdirp"; import last from "lodash/last"; const MESSAGES_PATTERN = "./public/messages/**/*.json"; const LANG_DIR = "./public/locales/"; const LANG_PATTERN = "./public/locales/*.json"; // Try to delete current json files from public/locales try { fs.unlinkSync("./public/locales/data.json"); } catch (error) { console.log(error); } // Merge translated json files (es.json, fr.json, etc) into one object // so that they can be merged with the eggregated "en" object below const mergedTranslations = globSync(LANG_PATTERN) .map(filename => { const locale = last(filename.split("/")).split(".json")[0]; return { [locale]: JSON.parse(fs.readFileSync(filename, "utf8")) }; }) .reduce((acc, localeObj) => { return { ...acc, ...localeObj }; }, {}); // Aggregates the default messages that were extracted from the example app's // React components via the React Intl Babel plugin. An error will be thrown if // there are messages in different components that use the same `id`. The result // is a flat collection of `id: message` pairs for the app's default locale. const defaultMessages = globSync(MESSAGES_PATTERN) .map(filename => fs.readFileSync(filename, "utf8")) .map(file => JSON.parse(file)) .reduce((collection, descriptors) => { descriptors.forEach(({ id, defaultMessage }) => { if (collection.hasOwnProperty(id)) { throw new Error(`Duplicate message id: ${id}`); } collection[id] = defaultMessage; }); return collection; }, {}); // Create a new directory that we want to write the aggregate messages to mkdirpSync(LANG_DIR); // Merge aggregated default messages with the translated json files and // write the messages to this directory fs.writeFileSync( `${LANG_DIR}data.json`, JSON.stringify({ en: defaultMessages, ...mergedTranslations }, null, 2) );

We will need to modify it a little bit because, as it stands, that script will generate a fake translation. We don’t want this because it is not practical.

We are better than that! We want it to read a real translation!

The script we will use to do this is below:

We will need to save this file in our scripts directory and then edit package.json so that it actually runs the script.

Before we do that, we will need to do a couple things, so that our ESNext code can be understood. First we will need to add babel-cli to make sure that the script gets transpiled.

$ npm install --save-dev babel-cli

Next, we need to add the env preset to our .babelrc so that it looks like this:

{ "presets":["react-app", "env"], "plugins": [ ["react-intl", { "messagesDir": "./public/messages/" }] ] }

Lastly, we need to edit our package.json so that it runs our script:

{... "scripts": { "build:langs": "NODE_ENV='production' babel-node scripts/mergeMessages.js", "build": "npm run build:langs && node scripts/build.js", ... }, ... }

Note that we are running the mergeMessages script before npm run build . This is because we want to generate our final data.json file in the /public directory before our build script copies it over to /build .

Alright, now when we run npm run build we should see build/locales/data.json which combines all of our JSON files into one.

The state of the project up until now can be found here.

Time to start translating

Now that we have made a script that will aggregate our default messages and our translations into one file, let’s make some translations! For this example, we will translate to Spanish. Our script that we just created will read all *.json files from /public/locales so we will need to name our new translation file /public/locales/es.json and add the content below:

{ "Weather.message": "¡Porque es soleado!", "Day.homeLink": "Regresar a inicio", "Home.header": "¡Hola Mundo!", "Home.dayMessage": "Es un hermoso día afuera.", "Home.dayLink": "¡Haz clic aquí para averiguar por qué!" }

Now when we run npm run build, our mergeMessages script will create a data.json file in /public/locales , and then it will be copied over to /build/locales. Our final data.json file will look like this:

{ "en": { "Weather.message": "Because it is sunny!", "Day.homeLink": "Go back home", "Home.header": "Hello, world!", "Home.dayMessage": "It's a beautiful day outside.", "Home.dayLink": "Click here to find out why!" }, "es": { "Weather.message": "¡Porque es soleado!", "Day.homeLink": "Regresar a inicio", "Home.header": "¡Hola Mundo!", "Home.dayMessage": "Es un hermoso día afuera.", "Home.dayLink": "¡Haz clic aquí para averiguar por qué!" } }

We’re almost there! The last step is to dynamically load the Spanish version of the text if the user’s browser settings are Spanish. We need to edit index.js to read the browser language settings and then give that information along with the correct translations to /> and ultimately our app.

Our final index.js looks like this:

import React from "react"; import ReactDOM from "react-dom"; import "./index.css"; import App from "./App"; import registerServiceWorker from "./registerServiceWorker"; import { BrowserRouter } from "react-router-dom"; import { IntlProvider, addLocaleData } from "react-intl"; import en from "react-intl/locale-data/en"; import es from "react-intl/locale-data/es"; import localeData from "./../build/locales/data.json"; addLocaleData([...en, ...es]); // Define user's language. Different browsers have the user locale defined // on different fields on the `navigator` object, so we make sure to account // for these different by checking all of them const language = (navigator.languages && navigator.languages[0]) || navigator.language || navigator.userLanguage; // Split locales with a region code const languageWithoutRegionCode = language.toLowerCase().split(/[_-]+/)[0]; // Try full locale, try locale without region code, fallback to 'en' const messages = localeData[languageWithoutRegionCode] || localeData[language] || localeData.en; ReactDOM.render( , document.getElementById("root") ); registerServiceWorker();

(Heavily copied code from Preethi Kasireddy’s gist here)

One other small thing we need to do is edit our webpack configs to allow imports outside of src and node_modules .

Now, if we change our browser settings to Spanish, we should see our content translated into Spanish!

The final state of the project can be found here.