react-intl.macro

> Extract react-intl messages with babel-plugin-macros.

[![Travis][build-badge]][build]
[![Codecov Status][codecov-badge]][codecov]
[![npm package][npm-badge]][npm]
[![npm downloads][npm-downloads]][npm]

[![prettier][prettier-badge]][prettier]
[![license][license-badge]][license]

Installation

``sh
$ yarn add react-intl.macro
`

_Note: You'll need to install and configure babel-plugin-macros if you haven't already._

> React-intl@2 should be installed in your project.

Example

evenchange4/react-intl.macro-example (with react-script@2.x) [DEMO]

Usage

$3

`diff
// Component.js
-import { defineMessages } from 'react-intl';
+import { defineMessages } from 'react-intl.macro';

const messages = defineMessages({
'Component.greet': {
id: 'Component.greet',
defaultMessage: 'Hello, {name}!',
description: 'Greeting to welcome the user to the app',
},
});
`

`diff
// Component.js
import * as React from 'react';
-import { injectIntl, defineMessages, FormattedMessage, FormattedHTMLMessage } from 'react-intl';
+import { injectIntl } from 'react-intl';
+import { defineMessages, FormattedMessage, FormattedHTMLMessage } from 'react-intl.macro';

const messages = defineMessages({
'Component.greet': {
id: 'defineMessages.greet',
defaultMessage: 'Hello, {name}!',
description: 'Greeting to welcome the user to the app',
},
});

class Foo extends React.Component {
render() {
return (

id="Foo.hello1"
defaultMessage='Hello, {name}!'
description='Greeting to welcome the user to the app'
/>
id="Foo.hello2"
defaultMessage='Hello, {name}!'
description='Greeting to welcome the user to the app'
/>

);
}
}

const Component = () => (
id="FormattedHTMLMessage.hello"
defaultMessage='

'
description='Greeting to welcome the user to the app'
/>
)
`

$3

#### Create React App

`diff
// package.json
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
+ "extract": "MESSAGE_DIR='./.messages' react-scripts build"
},
`

#### Next.js

`diff
"scripts": {
"dev": "next",
"build": "next build",
+ "extract": "MESSAGE_DIR='./.messages' next build"
},
`

API

- MESSAGE_DIR: string: The directory of output json files.

Config

Use cosmiconfig to set the babel-plugin-macros configuration: https://github.com/kentcdodds/babel-plugin-macros/blob/master/other/docs/user.md#config-experimental

$3

default: true

`js
// babel-plugin-macros.config.js
module.exports = {
'react-intl': {
verbose: false,
},
};
`

Alternative

- https://github.com/yahoo/babel-plugin-react-intl
- https://github.com/evenchange4/react-intl-cra

Development

$3

- node >= 12.7.0
- yarn >= 1.17.3

`sh
$ yarn install --pure-lockfile
`

Test

`sh
$ yarn run format
$ yarn run eslint
$ yarn run flow
$ yarn run test:watch
$ yarn run build
`

Publish

`bash
$ npm version patch
$ npm run changelog
git commit & push
``

---

CONTRIBUTING

- ⇄ Pull requests and ★ Stars are always welcome.
- For bugs and feature requests, please create an issue.
- Pull requests must be accompanied by passing automated tests.

CHANGELOG

LICENSE

MIT: http://michaelhsu.mit-license.org

[build-badge]: https://img.shields.io/travis/evenchange4/react-intl.macro/master.svg?style=flat-square
[build]: https://travis-ci.org/evenchange4/react-intl.macro
[npm-badge]: https://img.shields.io/npm/v/react-intl.macro.svg?style=flat-square
[npm]: https://www.npmjs.org/package/react-intl.macro
[codecov-badge]: https://img.shields.io/codecov/c/github/evenchange4/react-intl.macro.svg?style=flat-square
[codecov]: https://codecov.io/github/evenchange4/react-intl.macro?branch=master
[npm-downloads]: https://img.shields.io/npm/dt/react-intl.macro.svg?style=flat-square
[license-badge]: https://img.shields.io/npm/l/react-intl.macro.svg?style=flat-square
[license]: http://michaelhsu.mit-license.org/
[prettier-badge]: https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square
[prettier]: https://github.com/prettier/prettier