Repository files navigation

Extracts string messages for translation from modules that useReact Intl.

This Babel plugin works with React Intl v2.x

• 3.x of this plugin works with Babel 7
• 2.x works with Babel 6
• 1.x works with Babel 5

$ npm install babel-plugin-react-intl

This Babel plugin only visits ES6 modules whichimport React Intl.

The default message descriptors for the app's default language will be extracted from:defineMessages(),<FormattedMessage>, and<FormattedHTMLMessage>; all of which are named exports of the React Intl package.

If a message descriptor has adescription, it'll be removed from the source after it's extracted to save bytes since it isn't used at runtime.

.babelrc

{"plugins": [    ["react-intl", {"messagesDir":"./build/messages/"    }]  ]}

• messagesDir: The target location where the plugin will output a.json file corresponding to each component from which React Intl messages were extracted. If not provided, the extracted message descriptors will only be accessible via Babel's API.

• enforceDescriptions: Whether message declarationsmust contain adescription to provide context to translators. Defaults to:false.

• extractSourceLocation: Whether the metadata about the location of the message in the source file should be extracted. Iftrue, thenfile,start, andend fields will exist for each extracted message descriptors. Defaults tofalse.

• moduleSourceName: The ES6 module source name of the React Intl package. Defaults to:"react-intl", but can be changed to another name/path to React Intl.

• overrideIdFn: A function with the signature(id: string, defaultMessage: string, description: string|object) => string which allows you to override the ID both in the extracted javascript and messages.

The extract message descriptors are available via themetadata property on the object returned from Babel'stransform() API:

require('@babel/core').transform('code',{plugins:['react-intl']})// => { code, map, ast, metadata['react-intl'].messages };