@formatjs/ts-transformer

What is @formatjs/ts-transformer?

@formatjs/ts-transformer is a TypeScript transformer for FormatJS, which is a set of libraries to internationalize your project. This transformer helps in extracting and compiling messages for localization, making it easier to manage and use localized strings in your TypeScript projects.

What are @formatjs/ts-transformer's main functionalities?

Message Extraction

This feature allows you to define and extract messages that can be used for localization. The `defineMessages` function is used to create a collection of messages with unique IDs, default messages, and descriptions.

const messages = defineMessages({
  greeting: {
    id: 'greeting',
    defaultMessage: 'Hello, World!',
    description: 'Greeting to welcome the user'
  }
});

Message Compilation

This feature compiles the defined messages into a format that can be used by the application. The `compile` function takes the messages and processes them for use in the application.

import { compile } from '@formatjs/ts-transformer';

const compiledMessages = compile(messages);

TypeScript Integration

This feature integrates with TypeScript's compiler to transform and process the messages during the build process. The `transform` function is used in the TypeScript configuration to apply the transformer.

import { transform } from '@formatjs/ts-transformer';

const tsConfig = {
  compilerOptions: {
    plugins: [{
      transform: '@formatjs/ts-transformer',
      type: 'config'
    }]
  }
};

Other packages similar to @formatjs/ts-transformer

babel-plugin-react-intl

babel-plugin-react-intl is a Babel plugin that extracts and compiles messages for React Intl, a library for internationalizing React applications. It is similar to @formatjs/ts-transformer but is specifically designed for use with Babel and React.

i18next

i18next is a popular internationalization framework for JavaScript applications. It provides a comprehensive set of tools for managing translations and supports various backends for loading translations. Unlike @formatjs/ts-transformer, i18next is not limited to TypeScript and can be used with any JavaScript project.

react-i18next

react-i18next is a powerful internationalization library for React based on i18next. It provides hooks and components for managing translations in React applications. While @formatjs/ts-transformer focuses on TypeScript and FormatJS, react-i18next leverages the i18next ecosystem for a broader range of internationalization features.

README

@formatjs/ts-transformer

We've migrated the docs to https://formatjs.io/docs/tooling/ts-transformer.