# react-intl-extractor-cli > CLI tool to extract messages JSON for react-intl library with smart merging Latest version **1.0.5** (published 2023-01-13) · MIT license · 0 weekly downloads ## Install ```sh npm install react-intl-extractor-cli pnpm add react-intl-extractor-cli yarn add react-intl-extractor-cli bun add react-intl-extractor-cli ``` Provides the command `intl_extractor`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; large bundle. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.5 | | Published | 2023-01-13 | | First published | 2023-01-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 18.12.1 | | Dependencies | 14 | | Unpacked size | 12.8 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Tomasz Bajorek | | Maintainers | tomedio | | Keywords | cli, globalization, intl, internationalization, i18n, locale, localization, react, react-intl, reactjs, translate, translation | ## Links - npm: https://www.npmjs.com/package/react-intl-extractor-cli - Repository: https://github.com/tomedio/react-intl-extractor-cli - Issues: https://github.com/tomedio/react-intl-extractor-cli/issues - npm.io page: https://npm.io/package/react-intl-extractor-cli ## Dependencies (14) - [url](https://npm.io/package/url.md) ^0.11.0 - [path](https://npm.io/package/path.md) ^0.12.7 - [chalk](https://npm.io/package/chalk.md) ^5.2.0 - [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.0 - [commander](https://npm.io/package/commander.md) ^9.5.0 - [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.12 - [typescript](https://npm.io/package/typescript.md) ^4.9.4 - [loud-rejection](https://npm.io/package/loud-rejection.md) ^2.2.0 - [@formatjs/cli-lib](https://npm.io/package/@formatjs/cli-lib.md) ^5.1.12 - [@vue/compiler-sfc](https://npm.io/package/@vue/compiler-sfc.md) ^3.2.45 - [json-stable-stringify](https://npm.io/package/json-stable-stringify.md) ^1.0.2 - [@ungap/structured-clone](https://npm.io/package/@ungap/structured-clone.md) ^1.0.1 - [@formatjs/ts-transformer](https://npm.io/package/@formatjs/ts-transformer.md) ^3.11.5 - [@formatjs/icu-messageformat-parser](https://npm.io/package/@formatjs/icu-messageformat-parser.md) ^2.1.14 ## 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 - 1.0.5 (latest) — 2023-01-13 - 1.0.3 — 2023-01-13 ## README # React-intl-exporter CLI This library adapts `@formatjs/cli` tool to export translations in a smart way. React-intl-exporter CLI extracts all messages from the application and saves them for all specified languages. If a file already exists, the tool merges its content with currently extracted messages. Every message is an object with at least two fields: - `defaultMessage` - same like generated by the original tool; contains value of `defaultMessage` found in the application; - `translatedMessage` - it's a message `defaultMessage` translated to the current language; when generated for first time, it has the same value as `defaultMessage`; it should be translated manually; compilation process should take this values into account, not from `defaultMessage` fields. If there is a new message not available in the JSON file, it will be added. If a message from JSON is not extracted, it will be removed from the file. If in JSON file is already a message with the same key but different `defaultMessage` than in generated, generated message will replace the existing one. If both key and `defaultMessage` are the same, message is not changed. **NOTE** All commands here assumes that you use `yarn` tool. Using `npm` or any other tool doesn't change much. Please adapt an exact command to the tool you use. ## Installation You can add this tool to your application in these steps: 1. Install the package: ```shell yarn add react-intl-extractor-cli -D ``` 2. Add a new script to `scripts` section in your `packages.json` file, e.g. ``` "intl:extract": "intl_extractor extract "src/**/!(*.test).js" --languages en,de,pl", ``` 3. Create a file with formatter defined by the tool (to support `translatedMessage` instead of `defaultMessage`). Minimal file `formatter.js` is: ```js const defaultFormatter = require('react-intl-extractor-cli').defaultFormatter; module.exports.default = defaultFormatter; ``` 4. When you use compiler from `@formatjs/cli`, specify `--format ` parameter where ` ` Most of the parameters used in this command are the same as for original `formatjs extract` command. You can check them [here](https://formatjs.io/docs/tooling/cli/). Below are described differences. `` is a pattern to determine in which files messages are located. Eg. `"src/**/!(*.test).js"`. `` determines where output files with extracted messages should be located. It's also a location where currently existing message files are tried to be found. ### Parameters `--languages ` It's the most important parameter as it specifies language codes for which translation messages should be generated. `` contain code strings separated by comma "," signs. `--verbose` Using this parameter you inform the tool that you expect more details about processed languages and messages. ## Help `intl_extractor help` It just displays help message --- _Source: https://npm.io/package/react-intl-extractor-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._