i18n4react

i18n4React

React-Intl CLI for extracting strings for globalization.

Installation

$ npm install -g git+https://[e-mail]:ZBoxApp/i18n4react.git

Options

The CLI help will display this:

Usage:
  i18n4react [OPTIONS]

Options:
  -e, --extract PATH     Input directory
  -o, --output PATH      Output directory (Default is i18n)
  -l, --lang [STRING]    Set the default language to name the merged output
                         file  (Default is en)
  -c, --compare          Compare JSON files with the original and translated
                         flags
      --deep             Deep comparison includes values for each key
  -d, --diff             Create a diff file with missing keys and changed
                         values
  -j, --diffFile FILE    Differential JSON file
  -g, --original FILE    Original JSON file
  -t, --translated FILE  Translated JSON file
  -p, --patch            Patch an Original file with a Differential file
  -v, --version          Display the current version
  -h, --help             Display help and usage details

Usage

$ ./node_modules/.bin/i18n4react -e <directory with react-intl jsx files> -o <output directory> -l en-US

Dependencies

To be able to use i18n4react in your project you need to meet this dependencies:

1. Create a .babelrc file with the following content

{
    "presets": [
        "es2015",
        "react"
    ],
    "plugins": [
        "transform-object-rest-spread",
        "transform-runtime",
        ["zbox-intl", {
                    "messagesDir": "./temp/messages/",
                    "enforceDescriptions": false
        }]
    ]
}

1. In your project dev-dependencies install

   • babel-plugin-zbox-intl
   • babel-plugin-transform-object-rest-spread
   • babel-plugin-transform-runtime
   • babel-preset-es2015
   • babel-preset-react

2. Run the CLI from within your project working directory

License

(The MIT License)

Copyright (c) 2012 Sudhakar Mani

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.