i18n-tasks Build Status Coverage Status Code Climate Gemnasium Gitter

Click here to lend your support to: i18n-tasks for Ruby and make a donation at pledgie.com !

i18n-tasks helps you find and manage missing and unused translations.

This gem analyses code statically for key usages, such as I18n.t('some.key'), in order to:

  • Report keys that are missing or unused.
  • Pre-fill missing keys, optionally from Google Translate.
  • Remove unused keys.

Thus addressing the two main problems of i18n gem design:

  • Missing keys only blow up at runtime.
  • Keys no longer in use may accumulate and introduce overhead, without you knowing it.

Installation

i18n-tasks can be used with any project using the ruby i18n gem (default in Rails).

Add i18n-tasks to the Gemfile:

ruby gem 'i18n-tasks', '~> 0.8.6'

Copy the default configuration file:

console $ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/

Copy rspec test to test for missing and unused translations as part of the suite (optional):

console $ cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/

Usage

Run i18n-tasks to get the list of all the tasks with short descriptions.

Check health

i18n-tasks health checks if any keys are missing or not used:

console $ i18n-tasks health

Add missing keys

Add missing keys with placeholders (base value or humanized key):

console $ i18n-tasks add-missing

This and other tasks accept arguments:

console $ i18n-tasks add-missing -v 'TRME %{value}' fr

Pass --help for more information:

console $ i18n-tasks add-missing --help Usage: i18n-tasks add-missing [options] [locale ...] -l, --locales Comma-separated list of locale(s) to process. Default: all. Special: base. -f, --format Output format: terminal-table, yaml, json, keys, inspect. Default: terminal-table. -v, --value Value. Interpolates: %{value}, %{human_key}, %{value_or_human_key}. Default: %{value_or_human_key}. -h, --help Display this help message.

Google Translate missing keys

Translate missing values with Google Translate (more below on the API key).

console $ i18n-tasks translate-missing # accepts from and locales options: $ i18n-tasks translate-missing --from base es fr

Find usages

See where the keys are used with i18n-tasks find:

bash $ i18n-tasks find common.help $ i18n-tasks find 'auth.*' $ i18n-tasks find '{number,currency}.format.*'

Remove unused keys

bash $ i18n-tasks unused $ i18n-tasks remove-unused

These tasks will infer dynamic keys such as t("category.\#{category.name}") by default. Pass -s or --strict to disable this feature.

Normalize data

Sort the keys:

console $ i18n-tasks normalize

Sort the keys, and move them to the respective files as defined by config.write:

console $ i18n-tasks normalize -p

Compose tasks

i18n-tasks also provides composable tasks for reading, writing and manipulating locale data. Examples below.

add-missing implemented with missing, tree-set-value and data-merge: console $ i18n-tasks missing -f yaml fr | i18n-tasks tree-set-value 'TRME %{value}' | i18n-tasks data-merge

remove-unused implemented with unused and data-remove (sans the confirmation): console $ i18n-tasks unused -f yaml | i18n-tasks data-remove

Remove all keys in fr but not en from fr: console $ i18n-tasks missing -t diff -f yaml en | i18n-tasks tree-rename-key en fr | i18n-tasks data-remove

See the full list of tasks with i18n-tasks --help.

Features and limitations

Relative keys

i18n-tasks offers partial support for relative keys, such as t '.title'.

✔ Keys relative to the file path they are used in (see relative roots configuration) are supported.

✔ Keys relative to controller.action_name in Rails controllers are supported. The closest def name is used.

Plural keys

✔ Plural keys, such as key.{one,many,other,...} are fully supported.

t() keyword arguments

scope keyword argument is supported, but only when it is the first argument.

default and other arguments are not supported.

Parsing keyword arguments correctly with Regexp is difficult. This can be improved with an s-expression parser.

Dynamic keys

By default, unused report will detect some dynamic keys and not report them, e.g.:

ruby t 'category.' + category.key # all 'category.:' keys considered used (: denotes one key segment) t "category.#{category.key}.name" # all 'category.:.name' keys considered used

This will not be on by default in future versions, in favour of encouraging explicit i18n-tasks-use hints. For now, you can disable dynamic key inference by passing -s or --strict to unused tasks.

Configuration

Configuration is read from config/i18n-tasks.yml or config/i18n-tasks.yml.erb. Inspect configuration with i18n-tasks config.

Install the default config file with:

console $ cp $(i18n-tasks gem-path)/templates/config/i18n-tasks.yml config/

Settings are compatible with Rails by default.

Locales

By default, base_locale is set to en and locales are inferred from the paths to data files. You can override these in the config.

Storage

The default data adapter supports YAML and JSON files.

Multiple locale files

i18n-tasks can manage multiple translation files and read translations from other gems. To find out more the data options in the config.

For writing to locale files i18n-tasks provides 2 options.

Pattern router

Pattern router organizes keys based on a list of key patterns, as in the example below:

data: router: pattern_router # a list of {key pattern => file} routes, matched top to bottom write: # write models.* and views.* keys to the respective files - ['{models,views}.*', 'config/locales/\1.%{locale}.yml'] # or, write every top-level key namespace to its own file - ['{:}.*', 'config/locales/\1.%{locale}.yml'] # default, sugar for ['*', path] - 'config/locales/%{locale}.yml'

Conservative router

Conservative router keeps the keys where they are found, or infers the path from base locale. If the key is completely new, conservative router will fall back to pattern router behaviour. Conservative router is the default router.

data: router: conservative_router write: - ['devise.*', 'config/locales/devise.%{locale}.yml'] - 'config/locales/%{locale}.yml'

Key pattern syntax

A special syntax similar to file glob patterns is used throughout i18n-tasks to match translation keys:

syntax description
* matches everything
: matches a single key
{a, b.c} match any in set, can use : and *, match is captured

Custom adapters

If you store data somewhere but in the filesystem, e.g. in the database or mongodb, you can implement a custom adapter. If you have implemented a custom adapter please share it on the wiki.

See the search section in the config file for all available configuration options. An example of a custom scanner can be found here: https://github.com/glebm/i18n-tasks/issues/138#issuecomment-87255708.

Fine-tuning

Add hints to static analysis with magic comment hints (lines starting with (#|/) i18n-tasks-use by default):

ruby # i18n-tasks-use t('activerecord.models.user') # let i18n-tasks know the key is used User.model_name.human

You can also explicitly ignore keys appearing in locale files via ignore* settings. See the config file to find out more.

### Google Translate

i18n-tasks translate-missing requires a Google Translate API key, get it at Google API Console.

Where this key is depends on your Google API console:

  • Old console: API Access -> Simple API Access -> Key for server apps.
  • New console: Project -> APIS & AUTH -> Credentials -> Public API access -> Key for server applications.

In both cases, you may need to create the key if it doesn’t exist.

Put the key in GOOGLE_TRANSLATE_API_KEY environment variable or in the config file.

yaml # config/i18n-tasks.yml translation: api_key: <Google Translate API key>

Interactive console

i18n-tasks irb starts an IRB session in i18n-tasks context. Type guide for more information.

XLSX

Export missing and unused data to XLSX:

console $ i18n-tasks xlsx-report

Add new tasks

Tasks that come with the gem are defined in lib/i18n/tasks/command/commands.

Add a custom task like the ones defined by the gem:

ruby # my_commands.rb module MyCommands include ::I18n::Tasks::Command::Collection cmd :my_task, desc: 'my custom task' def my_task(opts = {}) end end

yaml # config/i18n-tasks.yml <% require './my_commands' I18n::Tasks::Commands.send :include, MyCommands %>

Run with:

console $ i18n-tasks my-task

See more examples of custom tasks on the wiki.