Run bundle exec 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,
that interpolations variables are consistent across locales,
and that all the locale files are normalized (auto-formatted):
$ i18n-tasks health
Add missing keys
Add missing keys with placeholders (base value or humanized key):
$ i18n-tasks add-missing
This and other tasks accept arguments:
$ i18n-tasks add-missing -v 'TRME %{value}' fr
Pass --help for more information:
$ i18n-tasks add-missing --helpUsage: 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}, %{key}. Default: %{value_or_human_key}. -h, --help Display this help message.
✔ 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.
Reference keys
✔ Reference keys (keys with :symbol values) are fully supported. These keys are copied as-is in
add/translate-missing, and can be looked up by reference or value in find.
t() keyword arguments
✔scope keyword argument is fully supported by the AST scanner, and also by the Regexp scanner but only when it is the first argument.
✔default argument can be used to pre-fill locale files (AST scanner only).
Dynamic keys
By default, dynamic keys such as t "cats.#{cat}.name" are not recognized.
I encourage you to mark these with i18n-tasks-use hints.
Alternatively, you can enable dynamic key inference by setting search.strict to false in the config. In this case,
all the dynamic parts of the key will be considered used, e.g. cats.tenderlove.name would not be reported as unused.
Note that only one section of the key is treated as a wildcard for each string interpolation; i.e. in this example,
cats.tenderlove.special.namewill be reported as unused.
I18n.localize
I18n.localize is not supported, use i18n-tasks-use hints.
This is because the key generated by I18n.localize depends on the type of the object passed in and thus cannot be inferred statically.
Configuration
Configuration is read from config/i18n-tasks.yml or config/i18n-tasks.yml.erb.
Inspect the configuration with i18n-tasks config.
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 see the data options in the config.
NB: By default, only %{locale}.yml files are read, not namespace.%{locale}.yml. Make sure to check 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.
If you want to have i18n-tasks reorganize your existing keys using data.write, either set the router to
pattern_router as above, or run i18n-tasks normalize -p (forcing the use of the pattern router for that run).
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
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.
Usage search
i18n-tasks uses an AST scanner for .rb and .html.erb files, and a regexp scanner for all other files.
New scanners can be added easily: please refer to this example.
See the search section in the config file for all available configuration options.
NB: By default, only the app/ directory is searched.
Fine-tuning
Add hints to static analysis with magic comment hints (lines starting with (#|/) i18n-tasks-use by default):
# i18n-tasks-use t('activerecord.models.user') # let i18n-tasks know the key is usedUser.model_name.human
You can also explicitly ignore keys appearing in locale files via ignore* settings.
If you have helper methods that generate translation keys, such as a page_title method that returns t '.page_title',
or a Spree.t(key) method that returns t "spree.#{key}", use the built-in PatternMapper to map these.
For more complex cases, you can implement a custom scanner.
客服电话
APP下载
官方微信
请发表评论