babel-plugin-transform-jsx-i18n

Localize JSX as is, with very little extra markup.

The translator is inspired by Genshi, Kajiki, and Tonnikala, which are XML based templating languages in Python. The latter 2 compile a template to a Python program, and while Kajiki writes source text, Tonnikala writes code as Abstract Syntax Trees. This seemed like a good fit in the Babel and React ecosystem, where AST parsing and rewriting is the norm.

React

In

var simple = <p>Hello, World!</p>;

var formatted = <div i18nMsg="name">
  Text content should be <strong>translated</strong>, { name }.
  <img src="/img/hello.jpg" alt="Text props should be translated" />
</div>;

var untranslated = <div lang="en">
  Text, elements, and attributes in an element with <code>lang</code> attribute
  shall be untouched.
  <img src="/img/hello.jpg" alt="Hello, World!" />
</div>;

Out

"use strict";

var _jsxI18nMessage = require("jsx-i18n-message");

var simple = React.createElement(
  "p",
  null,
  gettext("Hello, World!")
);

var formatted = React.createElement(
  _jsxI18nMessage.Message,
  {
    format: " " + gettext("Text content should be [1:translated], {name}. [2:]") + " ",
    component: React.createElement("div", null),
    expressions: {
      name: name
    }
  },
  React.createElement("strong", null),
  React.createElement("img", { src: "/img/hello.jpg", alt: gettext("Text props should be translated")
  })
);

var untranslated = React.createElement(
  "div",
  { lang: "en" },
  "Text, elements, and attributes in an element with ",
  React.createElement(
    "code",
    null,
    "lang"
  ),
  " attribute shall be untouched.",
  React.createElement("img", { src: "/img/hello.jpg", alt: "Hello, World!" })
);

Usage

Via .babelrc

.babelrc

Without options:

{
  "plugins": ["transform-jsx-i18n"]
}

With options:

{
  "plugins": [
    ["transform-jsx-i18n", {
      "translator": "myTranslatorFun"
    }]
  ]
}

Options

translator

string, defaults to gettext.

Replace the function used when translating messages.

messageFormatTranslator

Optional string, defaults to undefined.

Replace the function used when translating i18nMsg tagged messages. Defaults to translator, if left undefined.

normalizeWhitespace

boolean, defaults to true.

If true, replace sequences of white space characters with a single space.

Status

Early alpha, working features are

• Simple translations.
• Text attribute translations.
• Complex translations with parameters and/or markup.

TODO

• Tests!
• Message extractor – initially target gettext catalogs.
• Automatically inject Message, if needed.
• Message and other runtime parts should perhaps have their own package.
• Improve Message format parser and add escaping support. Currently it is impossible to output translated text with parameters/markup that would contain escaped placeholders as text.
• Add an attribute that overrides message id.
• Add message domain attribute.

Contributors

• Ilja Everilä