# react-intl-po > Extract POT from react-intl and convert back to json. Latest version **2.2.2** (published 2018-04-30) · MIT license · 0 weekly downloads ## Install ```sh npm install react-intl-po pnpm add react-intl-po yarn add react-intl-po bun add react-intl-po ``` Provides the commands `rip`, `react-intl-po`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.2.2 | | Published | 2018-04-30 | | First published | 2016-03-30 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 86.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 88 | | Author | Michael Hsu | | Maintainers | evenchange4 | | Keywords | react-intl, babel-plugin-react-intl, po, pot | ## Links - npm: https://www.npmjs.com/package/react-intl-po - Repository: https://github.com/evenchange4/react-intl-po - Homepage: https://github.com/evenchange4/react-intl-po#readme - Issues: https://github.com/evenchange4/react-intl-po/issues - npm.io page: https://npm.io/package/react-intl-po ## Dependencies (6) - [glob](https://npm.io/package/glob.md) ^7.1.2 - [chalk](https://npm.io/package/chalk.md) ^2.3.2 - [ramda](https://npm.io/package/ramda.md) ^0.25.0 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1 - [po2json](https://npm.io/package/po2json.md) ^0.4.5 - [commander](https://npm.io/package/commander.md) ^2.15.1 ## Alternatives - [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads - [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads - [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads - [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads - [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads ## Recent versions - 2.2.2 (latest) — 2018-04-30 - 2.2.1 — 2018-04-11 - 2.2.0 — 2018-03-13 - 2.1.3 — 2018-01-25 - 2.1.2 — 2018-01-16 - 2.1.1 — 2017-07-19 - 2.1.0 — 2017-07-17 - 2.0.2 — 2017-03-02 - 2.0.1 — 2017-02-11 - 2.0.0 — 2017-02-11 - 1.2.0 — 2017-02-11 - 1.1.0 — 2016-10-26 - 1.0.10 — 2016-10-21 - 1.0.9 — 2016-09-21 - 1.0.7 — 2016-09-13 - … 5 more at https://npm.io/package/react-intl-po/versions ## README # react-intl-po > Extract POT from react-intl and convert back to json. > > messages.json → POT → PO → translation.json [![Travis][build-badge]][build] [![Codecov Status][codecov-badge]][codecov] [![npm package][npm-badge]][npm] [![npm downloads][npm-downloads]][npm] [![Dependency Status][dependency-badge]][dependency] [![devDependency Status][devdependency-badge]][devdependency] [![peerDependency Status][peerdependency-badge]][peerdependency] [![license][license-badge]][license] [![prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) ## Tutorial Please take a look at standalone repo based on Create-React-App: https://github.com/evenchange4/react-intl-po-example ## Installation ```sh $ yarn add react-intl-po ``` ## Requirements and Workflow * [react-intl](https://github.com/yahoo/react-intl) `^2.0.0` * [babel-plugin-react-intl](https://github.com/yahoo/babel-plugin-react-intl) `^2.0.0` ![RIP Workflow](./docs/workflow.png) ## Usage There are two sub-commands of `react-intl-po` or `rip`: 1. json2pot: Convert the json files extracted from _babel-plugin-react-intl_ into one `.pot` file. 2. po2json: Convert translated _.po_ files back to `.json` format. ### json2pot ```sh $ rip json2pot '_translations/src/**/*.json' \ -o ./mcs-public.pot ``` | **Arguments** | **Description** | | --------------------------------- | --------------------------------------------------------------------- | | `srcPatterns` | The pattern of _.json_ files extracted from _babel-plugin-react-intl_ | | `-o, --output ` | The output pathname of _.pot_ file to be translated | | `-k, --message-key [key]` | [Optional] Translation message key (default key is `defaultMessage`) | | `-c, --message-context [context]` | [Optional] Translation message context (defaults to no context) | ### po2json #### Case 1: Output one file per locale if a `directory` is set ```sh $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \ -m './_translations/src/**/*.json' \ -o './translations' ``` #### Case 2: Output one merged file if a `.json file` is set ```sh $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \` -m './_translations/src/**/*.json' \ -o './translations.json' ``` | **Arguments** | **Description** | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `srcPatterns` | The pattern of translated _.po_ files | | `-m, --messages-pattern ` | The pattern of _.json_ files extracted from _babel-plugin-react-intl_ | | `-o, --output ` | The output pathname of a file / directory | | `-k, --message-key [key]` | [Optional] Translation message key (default key is `defaultMessage`) | | `-c, --message-context [context]` | [Optional] Translation message context (defaults to no context) | | `-l, --lang-mapper-pattern ` | [Optional] Custom regex to use for lang mapping. [PR#122](https://github.com/evenchange4/react-intl-po/pull/122) | | `-i, --lang-mapper-pattern-index [index]` | [Optional] When specifying a custom lang-mapper-pattern, the index of match to use for the lang mapping. Default is 1, index is ignored if not using a custom lang mapping regex. [PR#122](https://github.com/evenchange4/react-intl-po/pull/122) | | `--indentation ` | [Optional] Specify a number of spaces or a set of characters to be used before each entry of the resulting json file. Defaults to `null`, which means the entries are not prefixed with spaces. | | `--sort-by-id` | [Optional] If specified, the entries of each language are sorted by id before being output | ## Property ## Q&A ### How to translate the same message into two different meanings? #### Option 1 (Recommended): Set the `message-context (-c)` to `'id'` of message object from _babel-plugin-react-intl_ (there is no context by default). The advantage of this option over Option 2 (below) is that PO file editors that provide features such as translation suggestions or error-checking often expect the message key to be `defaultMessage`. ```sh $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \ -m './_translations/src/**/*.json' \ -o './translations' \ -c 'id' $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \` -m './_translations/src/**/*.json' \ -o './translations.json' \ -c 'id' ``` Example: https://github.com/evenchange4/react-intl-po-example#option #### Option 2: [Maybe deprecated next major release] Set the `message-key (-k)` to `'id'` of message object from _babel-plugin-react-intl_ (default key is `'defaultMessage'`). ([#41](https://github.com/evenchange4/react-intl-po/pull/41)) ```sh $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \ -m './_translations/src/**/*.json' \ -o './translations' \ -k 'id' $ rip po2json './node_modules/mcs-translation/po/mcs-public*.po' \` -m './_translations/src/**/*.json' \ -o './translations.json' \ -k 'id' ``` ## Development ```sh $ yarn install --pure-lockfile ``` ### Ramda.js You can use `R.tap()` for developing. ```diff R.pipe( R.concat(...), + R.tap(e => console.log(e)), R.mergeAll, ); ``` ### Requirements * node >= 9.11.1 * yarn >= 1.5.1 ### Test ```sh $ yarn run format $ yarn run eslint $ yarn run test:watch ``` ### NPM Release > Any git tags. 1. Create a new git tag 2. Update `CHANGELOG.md` ```sh $ npm version patch ``` --- ## 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 (`$ yarn run test`). ## [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-po/master.svg?style=flat-square [build]: https://travis-ci.org/evenchange4/react-intl-po [npm-badge]: https://img.shields.io/npm/v/react-intl-po.svg?style=flat-square [npm]: https://www.npmjs.org/package/react-intl-po [codecov-badge]: https://img.shields.io/codecov/c/github/evenchange4/react-intl-po.svg?style=flat-square [codecov]: https://codecov.io/github/evenchange4/react-intl-po?branch=master [npm-downloads]: https://img.shields.io/npm/dt/react-intl-po.svg?style=flat-square [license-badge]: https://img.shields.io/npm/l/react-intl-po.svg?style=flat-square [license]: http://michaelhsu.mit-license.org/ [dependency-badge]: https://david-dm.org/evenchange4/react-intl-po.svg?style=flat-square [dependency]: https://david-dm.org/evenchange4/react-intl-po [devdependency-badge]: https://david-dm.org/evenchange4/react-intl-po/dev-status.svg?style=flat-square [devdependency]: https://david-dm.org/evenchange4/react-intl-po#info=devDependencies [peerdependency-badge]: https://david-dm.org/evenchange4/react-intl-po/peer-status.svg?style=flat-square [peerdependency]: https://david-dm.org/evenchange4/react-intl-po#info=peerDependencies --- _Source: https://npm.io/package/react-intl-po · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._