npm package: @neverbland/react-intl.macro
Description: Run react-intl at build-time with babel-plugin-macros.
Author: Michael Hsu
Latest version: 0.3.7

# 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](https://github.com/kentcdodds/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)](https://github.com/evenchange4/react-intl.macro-example) [[DEMO](https://react-intlmacro.netlify.com/)]

## Usage

### Code

```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 (
      <React.Fragment>
        <FormattedMessage
          id="Foo.hello1"
          defaultMessage='Hello, {name}!'
          description='Greeting to welcome the user to the app'
        />
        <FormattedMessage
          id="Foo.hello2"
          defaultMessage='Hello, {name}!'
          description='Greeting to welcome the user to the app'
        />
      </React.Fragment>
    );
  }
}

const Component = () => (
  <FormattedHTMLMessage
    id="FormattedHTMLMessage.hello"
    defaultMessage='<div>Hello, {name}!</div>'
    description='Greeting to welcome the user to the app'
  />
)
```

### Extract CLI

#### 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](https://www.npmjs.com/package/cosmiconfig) to set the `babel-plugin-macros` configuration: https://github.com/kentcdodds/babel-plugin-macros/blob/master/other/docs/user.md#config-experimental

### `verbose`: To disable the log messages

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

### Requirements

- node >= 11.10.0
- yarn >= 1.13.0

```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](CHANGELOG.md)

## [LICENSE](LICENSE)

MIT: [http://michaelhsu.mit-license.org](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