@lingui/babel-plugin-extract-messages

What is @lingui/babel-plugin-extract-messages?

@lingui/babel-plugin-extract-messages is a Babel plugin designed to extract messages from your code for internationalization (i18n) purposes. It works in conjunction with the LinguiJS framework to help developers manage and translate text in their applications.

What are @lingui/babel-plugin-extract-messages's main functionalities?

Extracting Messages

This feature allows you to extract messages from your codebase into a specified directory. The configuration specifies the directory where the extracted messages will be stored and whether to extract messages from `formatMessage` calls.

```json
{
  "presets": ["@babel/preset-env", "@babel/preset-react"],
  "plugins": [
    [
      "@lingui/babel-plugin-extract-messages",
      {
        "localeDir": "./locales/",
        "extractFromFormatMessageCall": true
      }
    ]
  ]
}
```

Custom Message Extraction

This feature allows you to define custom formatters for message extraction. The configuration includes a custom formatter with a specific name and pattern, enabling more flexible message extraction.

```json
{
  "presets": ["@babel/preset-env", "@babel/preset-react"],
  "plugins": [
    [
      "@lingui/babel-plugin-extract-messages",
      {
        "localeDir": "./locales/",
        "extractFromFormatMessageCall": true,
        "customFormatters": [
          {
            "name": "customFormatter",
            "pattern": "customPattern"
          }
        ]
      }
    ]
  ]
}
```

Other packages similar to @lingui/babel-plugin-extract-messages

babel-plugin-react-intl

babel-plugin-react-intl is a Babel plugin for extracting messages from React components that use the react-intl library. It is similar to @lingui/babel-plugin-extract-messages but is specifically designed for use with react-intl, making it a good choice for projects already using that library.

i18next-extract-gettext

i18next-extract-gettext is a tool for extracting translation keys from JavaScript and TypeScript codebases that use the i18next library. It provides similar functionality to @lingui/babel-plugin-extract-messages but is tailored for use with i18next, offering a different approach to internationalization.

README

@lingui/babel-plugin-extract-messages

Babel plugin which extracts messages for translation from source files

@lingui/babel-plugin-extract-messages is part of js-lingui. See the documentation for all information, tutorials and examples.

Installation

yarn add --dev @lingui/babel-plugin-extract-messages
# npm install --save-dev @lingui/babel-plugin-extract-messages

Usage

Via .babelrc (Recommended)

.babelrc

{
  "plugins": ["@lingui/babel-plugin-extract-messages"]
}

Via CLI

babel --plugins @lingui/babel-plugin-extract-messages script.js

Via Node API

require("@babel/core").transform("code", {
  plugins: ["@lingui/babel-plugin-extract-messages"]
})

License

MIT