Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

extract-react-intl-messages

1.0.1 • Public • Published

extract-react-intl-messages

Build Status tested with jest styled with prettier MIT License All Contributors

This package will generate json or yaml files from a glob. It will generate one file per locale, with the ids of each message defined by the defineMessages function of react-intl. The value of each of these keys will be an empty string, except for your defaultLocale which will be populated with the defaultMessage.

Dependencies

Babel

  • 1.x works with Babel 7
  • 0.x works with Babel 6

Install

$ npm install --save-dev extract-react-intl-messages

Usage

app/components/App/messages.js

import { defineMessages } from 'react-intl'
 
export default defineMessages({
  hello: {
    id: 'a.hello',
    defaultMessage: 'hello'
  },
  world: {
    id: 'a.world',
    defaultMessage: 'world'
  }
})

Run Script

$ extract-messages -l=en,ja -o app/translations -d en --flat false 'app/**/!(*.test).js'

Output

app/translations/en.json

{
  "a": {
    "hello": "hello",
    "world": "world"
  },
  "b": {
    "hello": "hello",
    "world": "world"
  }
}

app/translations/ja.json

{
  "a": {
    "hello": "",
    "world": ""
  },
  "b": {
    "hello": "",
    "world": ""
  }
}

Recommend

Use with babel-plugin-react-intl-auto: i18n for the component age. Auto management react-intl ID.

CLI

$ extract-messages --help
 
  Extract react-intl messages
 
  Usage
  $ extract-react-intl-messages <input>
  $ extract-messages <input>
 
  Options
  -o, --output       Output directory [require: true]
  -l, --locales      locales [require: true]
  -f, --format       json|yaml [default: json]
  --flat             json [default: true] | yaml [default: false]
  --default-locale   default locale [default: en]
  --delimiter        json | yaml [default: .]
  --module-name      module source name from where components are imported [default: react-intl]
 
  Example
  $ extract-messages --locales=ja,en --output app/translations 'app/**/*.js'
  $ extract-messages -l=ja,en -o i18n 'src/**/*.js'
  $ extract-messages -l=ja,en -o app/translations -f yaml 'app/**/messages.js'

create-react-app user

create .babelrc like this.

{
  "presets": ["react-app"]
}

Run with NODE_ENV=development.

$ NODE_ENV=development extract-messages ...

API

extractReactIntlMessages(locales, input, buildDir, [options])

locales

Type: Array<string>

Example: ['en', 'ja']

input

Type: Array<string>

Target files. glob.

buildDir

Type: string

Export directory.

options

defaultLocale

Type: string
Default: en

format

Type: json | yaml
Default: json

Set extension to output.

flat

Type: boolean
Default: true

If format is yaml, set to false.

Be careful if false. See this issue.

moduleName

Type: string
Default: react-intl

Set from where defineMessages, <FormatterMessage /> and <FormattedHTML /> are imported.

Contributors

Thanks goes to these wonderful people (emoji key):

akameco
akameco

💻 ⚠️ 📖 🚇
Hoan Tran
Hoan Tran

💻 ⚠️
giantpinkwalrus
giantpinkwalrus

💻
enrique-ramirez
enrique-ramirez

📖
Stefan Gojan
Stefan Gojan

🐛 💻 ⚠️
Solomon English
Solomon English

💻
Filip "Filson" Pasternak
Filip "Filson" Pasternak

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © akameco

install

npm i extract-react-intl-messages

Downloadsweekly downloads

9,194

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability