/react-intl-translations-manager

Manage all translations based on the extracted messages of the babel-plugin-react-intl

Primary LanguageJavaScriptMIT LicenseMIT

React-intl-translations-manager

Greenkeeper badge travis-ci Codecov Commitizen friendly semantic-release npm-downloads npm-version npm-license

React-intl-translations-manager will help you in managing your translations. Hereby it will give you the current status of your translation, telling you what duplicate keys you have, what messages aren't translated yet, what messages were added/deleted since the last time you checked.

You'll still need to update the translations manually in your json files, but now you know what messages you still need to update.

Installing

yarn add --dev react-intl-translations-manager

or

npm i --save-dev react-intl-translations-manager

Setup

Basic

This is an example of the most basic usage of this plugin, in the API documentation below you can find more options.

Create a script in your package.json

{
  "scripts": {
    "manage:translations": "node ./translationRunner.js"
  }
}

Create a file with your config you can run with the npm script

// translationRunner.js
const manageTranslations = require('react-intl-translations-manager').default;

// es2015 import
// import manageTranslations from 'react-intl-translations-manager';

manageTranslations({
  messagesDirectory: 'src/translations/extractedMessages',
  translationsDirectory: 'src/translations/locales/',
  languages: ['nl'] // any language you need
});

Run the translation manager with your new npm script

npm run manage:translations

Usage

Now you can check the status of your translations by just running the script. Then you can change the missing translations in the translation files.

If you encounter messages that are identical in translation in a certain language as in your default language (example: Dashboard (english) = Dashboard (dutch)), then you can whitelist the translation-key in the language specific whitelist file. This will prevent the message from showing up as untranslated when checking the translations status.

API

manageTranslations

This will maintain all translation files. Based on your config you will get output for duplicate ids, and per specified language you will get the deleted translations, added messages (new messages that need to be translated), and not yet translated messages. It will also maintain a whitelist file per language where you can specify translation keys where the translation is identical to the default message. This way you can avoid untranslated message warnings for these messages.

Config

  • messagesDirectory (required),
    • Directory where the babel plugin puts the extracted messages. This path is relative to your projects root.
    • example: src/locales/extractedMessages
  • translationsDirectory (required),
    • Directory of the translation files the translation manager needs to maintain.
    • example: src/locales/lang
  • whitelistsDirectory (optional, default: translationsDirectory)
    • Directory of the whitelist files the translation manager needs to maintain. These files contain the key of translations that have the exact same text in a specific language as the defaultMessage. Specifying this key will suppress unmaintained translation warnings.
    • example: Dashboard in english is also accepted as a valid translation for dutch.
  • languages (optional, default: [])
    • What languages the translation manager needs to maintain. Specifying no languages actually doesn't make sense, but won't break the translationManager either. (Please do not include the default language, react-intl will automatically include it.)
    • example: for ['nl', 'fr'] the translation manager will maintain a nl.json, fr.json, whitelist_nl.json and a whitelist_fr.json file
  • singleMessagesFile (optional, default: false)
    • Option to output a single JSON file containing the aggregate of all extracted messages, grouped by the file they were extracted from.
    • example:
    [
  {
    "path": "src/components/foo.json",
    "descriptors": [
      {
        "id": "bar",
        "description": "Text for bar",
        "defaultMessage": "Bar"
      }
    ]
  }
]
  • detectDuplicateIds (optional, default: true)
    • If you want the translationManager to log duplicate message ids or not
  • sortKeys (optional, default: true)
    • If you want the translationManager to sort it's output, both json and console output
  • jsonOptions (optional, default: { space: 2, trailingNewline: false })
  • overridePrinters (optional, default: {})
    • Here you can specify custom logging methods. If not specified a default printer is used.
    • Possible printers to configure:
    const printers = {
  printDuplicateIds: duplicateIds => {
    console.log(`You have ${duplicateIds.length} duplicate IDs`);
  },
  printLanguageReport: report => {
    console.log('Log report for a language');
  },
  printNoLanguageFile: lang => {
    console.log(
      `No existing ${lang} translation file found. A new one is created.`
    );
  },
  printNoLanguageWhitelistFile: lang => {
    console.log(`No existing ${lang} file found. A new one is created.`);
  }
};
  • overrideCoreMethods (optional, default: {})
    • Here you can specify overrides for the core hooks. If not specified, the default methods will be used.
    • Possible overrides to configure:
    const overrideCoreMethods = {
  provideExtractedMessages: () => {},
  outputSingleFile: () => {},
  outputDuplicateKeys: () => {},
  beforeReporting: () => {},
  provideLangTemplate: () => {},
  provideTranslationsFile: () => {},
  provideWhitelistFile: () => {},
  reportLanguage: () => {},
  afterReporting: () => {}
};

Fully configured

This is the config with all options applied:

// import manageTranslations from 'react-intl-translations-manager';

manageTranslations({
  messagesDirectory: 'src/translations/extractedMessages',
  translationsDirectory: 'src/translations/locales/',
  whitelistsDirectory: 'src/translations/locales/whitelists/',
  languages: ['nl'], // any language you need
  singleMessagesFile: true,
  detectDuplicateIds: false,
  sortKeys: false,
  jsonOptions: {
    space: 4,
    trailingNewline: true
  },
  overridePrinters: {
    printDuplicateIds: duplicateIds => {
      console.log(`You have ${duplicateIds.length} duplicate IDs`);
    },
    printLanguageReport: report => {
      console.log('Log report for a language');
    },
    printNoLanguageFile: lang => {
      console.log(
        `No existing ${lang} translation file found. A new one is created.`
      );
    },
    printNoLanguageWhitelistFile: lang => {
      console.log(`No existing ${lang} file found. A new one is created.`);
    }
  },
  overrideCoreMethods: {
    provideExtractedMessages: () => {},
    outputSingleFile: () => {},
    outputDuplicateKeys: () => {},
    beforeReporting: () => {},
    provideLangTemplate: () => {},
    provideTranslationsFile: () => {},
    provideWhitelistFile: () => {},
    reportLanguage: () => {},
    afterReporting: () => {}
  }
});

*This config is only as illustration for all possible options, these arent recommended configuration options.

CoreMethods

These are the core methods of the translationManager and what purpose they serve.

provideExtractedMessages

const extractedMessages = provideExtractedMessages();

Here you should return all extracted messages. This should be an array, with an object per file. Each object should at least contain a descriptors key which in turn has an array of message objects. Each message object should at least contain the id and message. Example:

// Minimal expected return value
const extractedMessages = [
  {
    descriptors: [
      {
        id: 'foo_ok',
        defaultMessage: 'OK'
      }
    ]
  }
];

outputSingleFile

outputSingleFile(extractedMessages);

This gives you the option to output the extractedMessages. This way you can for example shrink all extracted files into a single File containing all messages.

outputDuplicateKeys

outputDuplicateKeys(duplicateIds);

This gives you the option to warn for duplicate ids.

beforeReporting

beforeReporting();

Here you can do the preparation of the reporting, like creating the necessary folders, or printing a start message

provideLangTemplate

const languageResults = provideLangTemplate(lang);

Here you should provide the template for the language results. This is just a basic object ({}) which can contain pre-filled in data, potentially based on the language. The following keys are restricted and will be overridden by the core: report, noTranslationFile and noWhitelistFile.

provideTranslationsFile

const translationsFile = provideTranslationsFile(languageResults);

Here you should return the translations for the specified language. This must be an object with the message id and message in a key value format.

const translationsFile = {
  messageId: 'message'
};

provideWhitelistFile

const whitelistFile = provideWhitelistFile(languageResults);

Here you should return the whitelisted messsage ids for the specified language. This must be an array of strings.

const whitelistFile = ['messageId'];

reportLanguage

reportLanguage(languageResults);

Here you can handle the reporting of the results for a language, like logging and creating files based on the results.

afterReporting

afterReporting();

Here you can do actions after all reports are made, like cleanup or printing a finished message.

readMessageFiles

const extractedMessages = readMessageFiles(messagesDirectory);

This is a babel-plugin-react-intl specific helper method. It will read all extracted JSON file for the specified directory, filter out all files without any messages, and output an array with all messages.

Example output:

const extractedMessages = [
  {
    path: 'src/components/Foo.json',
    descriptors: [
      {
        id: 'foo_ok',
        description: 'Ok text',
        defaultMessage: 'OK'
      }
    ]
  }
];

createSingleMessagesFile

createSingleMessagesFile({ messages, directory });

This helper method will output all messages (potentially read by readMessageFiles) in a single jsonFile.

  • messages: (required)
  • directory: (required, string) contains the path to the directory where the file should be written into.
  • fileName: (optional, default: defaultMessages.json) this filename should contain the .json extension
  • jsonSpaceIndentation: (optional, default: 2) number of spaces used for indentation (0-10)

getDefaultMessages

const messages = getDefaultMessages(extractedMessages);

This helper method will flatten all files (as returned from readMessageFiles) into a single object.

const messages = {
  messages: {
    messageId: 'message'
  },
  duplicateIds: [
    // potentially double used message keys,
  ]
};

License

See the LICENSE file for license rights and limitations (MIT).