Localer is a tool that automatically detects missing I18n translations.
The goal is to preserve the integrity of translations. Localer parses and merges all application locales’ keys. At the next step, it searches for missing translations among the calculated keys.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install localer
At the root directory of a Rails app, run:
$ localer check .
or for specific Rails path:
$ localer check /path/to/rails/application
Localer is easy to integrate into your favorite CI workflow:
# .travis.yml # other configuration options script: - bundle exec bundle-audit - bundle exec rubocop - bundle exec rspec - bundle exec localer
# Rakefile # other requirements require 'localer/rake_task' Localer::RakeTask.new() task(:default).clear task default: [:rubocop, :spec, :localer]
- Ruby: 2.4, 2.5, 2.6, 2.7
- Rails: 5.0, 5.1, 5.2, 6.0
The behavior of Localer can be controlled via the
.localer.yml configuration file. It makes it possible to disable locales and keys. The file can be placed in your project directory.
Disable specific locale
By default, Localer enables all locales, but you can disable it:
Locale: EN: Enabled: false
Exclude keys globally
By default, Localer enables all keys, but you can disable keys started with specified string or by regex:
Exclude: - /population\z/ - .countries.france
Exclude keys for specific locale
Locale: EN: Exclude: - /population\z/ - .countries.france
Localer ships with a rake task. To use Localer's rake task you simply need to require the task file and define a task with it. Below is a rake task that will run
require 'rubygems' require 'localer' require 'localer/rake_task' Localer::RakeTask.new(:localer)
When you now run:
$ rake -T
you should see
rake localer # Run Localer
After checking out the repo, run
bundle exec appraisal install to install dependencies for each appraisal. Then, run
bundle exec appraisal rake to run the tests.
- Thor - Used for building command-line interfaces.
- Appraisal - Used for testing against different versions of dependencies
- Cucumber + Aruba - Used for testing command-line commands
Special thanks to Roman Shamin for the logo.
Bug reports and pull requests are welcome on GitHub at https://github.com/aderyabin/localer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Localer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.