A set of cops for detecting strings that need i18n decoration in your project.
Supports the following framework styles:
- gettext
- rails-i18n
Add this line to your application's Gemfile:
gem 'rubocop-i18n'And then execute:
$ bundle
Or install it yourself as:
$ gem install rubocop-i18n
In your rubocop.yml:
require:
- rubocop-i18n
...
# You *must* choose GetText or Rails-i18n style checking
# If you want GetText-style checking
I18n/GetText:
Enabled: true
I18n/RailsI18n:
Enabled: false
# If you want rails-i18n-style checking
I18n/RailsI18n:
Enabled: true
I18n/GetText:
Enabled: false
# If you want custom control of all the cops
I18n/GetText/DecorateString:
Enabled: false
# Disable the autocorrect
AutoCorrect: false
I18n/GetText/DecorateFunctionMessage:
Enabled: false
I18n/GetText/DecorateStringFormattingUsingInterpolation:
Enabled: false
I18n/GetText/DecorateStringFormattingUsingPercent:
Enabled: false
I18n/RailsI18n/DecorateString:
Enabled: false
This cop is looks for strings that appear to be sentences but are not decorated. Sentences are determined by the STRING_REGEXP.
decorator is missing around sentence
"Result is bad."_("Result is good.")"string"
"A string with out a punctuation at the end"
"a string that doesn't start with a capital letter."This cop looks for any raise or fail functions and checks that the user visible message is using gettext decoration with the _() function. This cop makes sure the message is decorated, as well as checking that the formatting of the message is compliant according to the follow rules. This cop supports autocorrecting of Simple decoration of a message. See the rubocop documentation on how to run autocorrect.
Simple message strings should be decorated with the _() function
'raise' function, message string should be decorated
raise("Warning")raise(_("Warning"))The message should not span multiple lines, it causes issues during the translation process.
'raise' function, message should not be a multi-line string
raise("this is a multi" \
"line message")raise(_("this is a multi line message"))The message should not concatenate multiple strings, it causes issues during translation and with the gettext.
'raise' function, message should not be a concatenated string
raise("this is a concatenated" + "message")raise(_("this is a concatenated message"))The message should be formated in this particular style. Otherwise it causes issues during translation and with the gettext gem.
'raise' function, message should use correctly formatted interpolation
raise("this is an interpolated message IE #{variable}")raise(_("this is an interpolated message IE %{value0}") % {value0: var,})The raise or fail function does not contain any decoration, or a simple string
'raise' function, message should be decorated
raise(someOtherFuntioncall(foo, "bar"))In this raise or fail function, the message does not contain any decoration at all and the message is not a simple string. It may make sense to convert the message to a simple string. eg Simple decoration of a message. Or ignore this raise or fail function following this How to ignore rules in code section.
This cop looks for decorated gettext methods _() and checks that all strings contained within do not use string interpolation '#{}'
Simple message strings should be decorated with the _() function
'_' function, message string should not contain #{} formatting
puts _("a message with a #{'interpolation'}")puts _("a message that is %{type}") % { type: 'translatable' }This cop looks for decorated gettext methods _() and checks that all strings contained within do not use sprintf formatting '%s' etc
'_' function, message string should not contain sprintf style formatting (ie %s)
raise(_("Warning is %s") % ['bad'])raise(_("Warning is %{value}") % { value: 'bad' })This cop looks for decorated rails-i18n methods.
decorator is missing around sentence
raise("Warning is %s" % ['bad'])raise(t("Warning is %{value}") % { value: 'good' })
raise(translate("Warning is %{value}") % { value: 'good' })
raise(I18n.t("Warning is %{value}") % { value: 'good' })This cop looks for decorated rails-i18n methods like t() and translate() and checks that all strings contained
within do not use string interpolation '#{}'
Simple message strings should be decorated with the t() function
't' function, message key string should not contain #{} formatting
puts t("path.to.key.with.#{'interpolation'}")puts t("path.to.key.with.interpolation")It may be necessary to ignore a cop for a particular piece of code. We follow standard rubocop idioms.
raise("We don't want this translated.") # rubocop:disable I18n/GetText/DecorateString
raise("We don't want this translated.") # rubocop:disable I18n/RailsI18n/DecorateString
raise("We don't want this translated") # rubocop:disable I18n/GetText/DecorateFunctionMessage
raise(_("We don't want this translated #{crazy}") # rubocop:disable I18n/GetText/DecorateStringFormattingUsingInterpolation)
raise(_("We don't want this translated %s") % ['crazy'] # rubocop:disable I18n/GetText/DecorateStringFormattingUsingPercent)Rubocop currently does not detect Heredoc style messages in functions correctly, which in turn prevents this plugin from detecting them correctly. Not all sprintf formatting strings are detected.
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that allows you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which creates a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/puppetlabs/rubocop-i18n. 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.