@formatjs/cli

What is @formatjs/cli?

@formatjs/cli is a command-line tool for internationalizing JavaScript applications. It provides functionalities for extracting, compiling, and managing translation messages, making it easier to handle localization in your projects.

What are @formatjs/cli's main functionalities?

Extract Messages

This command extracts all the translation messages from the JavaScript files in the 'src' directory and outputs them to a JSON file named 'en.json'.

npx formatjs extract 'src/**/*.js' --out-file lang/en.json

Compile Messages

This command compiles the extracted messages from 'en.json' into a format that can be used by the application, outputting the result to 'en-compiled.json'.

npx formatjs compile lang/en.json --out-file lang/en-compiled.json

Compile Messages with Pseudo-Localization

This command compiles the messages with pseudo-localization, which is useful for testing how the application handles different languages and character sets. The output is saved to 'en-pseudo.json'.

npx formatjs compile lang/en.json --pseudo-locale --out-file lang/en-pseudo.json

Format Messages

This command formats the extracted messages in 'en.json' to ensure consistency and readability, saving the formatted messages to 'en-formatted.json'.

npx formatjs format lang/en.json --out-file lang/en-formatted.json

Other packages similar to @formatjs/cli

i18next

i18next is a popular internationalization framework for JavaScript. It provides a complete solution for localizing your application, including features for translation management, language detection, and interpolation. Compared to @formatjs/cli, i18next offers a more comprehensive set of tools for managing translations and supports a wider range of use cases.

react-intl

react-intl is a library for internationalizing React applications. It provides React components and an API for formatting dates, numbers, and strings, as well as handling pluralization and gender-specific messages. While @formatjs/cli focuses on command-line tools for managing translations, react-intl integrates directly with React to provide runtime localization support.

README

@formatjs/cli

We've migrated the docs to https://formatjs.github.io/docs/tooling/cli.