i18n-js 3.2.1 → 4.2.2

data/README.md

@@ -1,925 +1,573 @@
-# I18n.js
+<p align="center">
+  <img width="250" height="58" src="https://github.com/fnando/i18n-js/raw/main/images/i18njs.png" alt="i18n.js">
+</p>
+
+<p align="center">
+  Export <a href="https://rubygems.org/gems/i18n">i18n</a> translations to JSON.
+  <br>
+  A perfect fit if you want to export translations to JavaScript.
+</p>
+
+<p align="center">
+  <small>
+    Oh, you don't use Ruby? No problem! You can still use i18n-js
+    <br>
+    and the
+    <a href="https://www.npmjs.com/package/i18n-js/v/latest">companion JavaScript package</a>.
+  </small>
+</p>
+
+<p align="center">
+  <a href="https://github.com/fnando/i18n-js"><img src="https://github.com/fnando/i18n-js/workflows/ruby-tests/badge.svg" alt="Tests"></a>
+  <a href="https://rubygems.org/gems/i18n-js"><img src="https://img.shields.io/gem/v/i18n-js.svg" alt="Gem"></a>
+  <a href="https://rubygems.org/gems/i18n-js"><img src="https://img.shields.io/gem/dt/i18n-js.svg" alt="Gem"></a>
+  <a href="https://tldrlegal.com/license/mit-license"><img src="https://img.shields.io/:License-MIT-blue.svg" alt="MIT License"></a>
+</p>
+
+## Installation
 
-[![Gem Version](http://img.shields.io/gem/v/i18n-js.svg?style=flat-square)](http://badge.fury.io/rb/i18n-js)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-
-[![Build Status](http://img.shields.io/travis/fnando/i18n-js.svg?style=flat-square)](https://travis-ci.org/fnando/i18n-js)
-[![Coverage Status](http://img.shields.io/coveralls/fnando/i18n-js.svg?style=flat-square)](https://coveralls.io/r/fnando/i18n-js)
-
-[![Gitter](https://img.shields.io/badge/gitter-join%20chat-1dce73.svg?style=flat-square)](https://gitter.im/fnando/i18n-js)
-
-It's a small library to provide the Rails I18n translations on the JavaScript.
-
-Features:
-
-- Pluralization
-- Date/Time localization
-- Number localization
-- Locale fallback
-- Asset pipeline support
-- Lots more! :)
-
-## Version Notice
-The `master` branch (including this README) is for latest `3.0.0` instead of `2.x`.
-
-
-## Usage
-
-### Installation
+```bash
+gem install i18n-js
+```
 
-#### Rails app
+Or add the following line to your project's Gemfile:
 
-Add the gem to your Gemfile.
 ```ruby
 gem "i18n-js"
 ```
 
-#### Rails app with [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
-
-If you're using the [asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html),
-then you must add the following line to your `app/assets/javascripts/application.js`.
-
-```javascript
-//
-// This is optional (in case you have `I18n is not defined` error)
-// If you want to put this line, you must put it BEFORE `i18n/translations`
-//= require i18n
-// Some people even need to add the extension to make it work, see https://github.com/fnando/i18n-js/issues/283
-//= require i18n.js
-//
-// This is a must
-//= require i18n/translations
-```
-
-#### Rails app without [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
-
-
-First, put this in your `application.html` (layout file).
-Then get the JS files following the instructions below.
-```erb
-<%# This is just an example, you can put `i18n.js` and `translations.js` anywhere you like %>
-<%# Unlike the Asset Pipeline example, you need to require both **in order** %>
-<%= javascript_include_tag "i18n" %>
-<%= javascript_include_tag "translations", skip_pipeline: true %>
-```
+## Usage
 
-**There are two ways to get `translations.js` (For Rails app without Asset Pipeline).**
+About patterns:
 
-1. This `translations.js` file can be automatically generated by the `I18n::JS::Middleware`.
-  Just add `config.middleware.use I18n::JS::Middleware` to your `config/application.rb` file.
-2. If you can't or prefer not to generate this file,
-  you can move the middleware line to your `config/environments/development.rb` file
-  and run `rake i18n:js:export` before deploying.
-  This will export all translation files, including the custom scopes
-  you may have defined on `config/i18n-js.yml`.
-  If `I18n.available_locales` is set (e.g. in your Rails `config/application.rb` file)
-  then only the specified locales will be exported.
-  Current version of `i18n.js` will also be exported to avoid version mismatching by downloading.
+- Patterns can use `*` as a wildcard and can appear more than once.
+  - `*` will include everything
+  - `*.messages.*`
+- Patterns starting with `!` are excluded.
+  - `!*.activerecord.*` will exclude all ActiveRecord translations.
+- You can use groups:
+  - `{pt-BR,en}.js.*` will include only `pt-BR` and `en` translations, even if
+    more languages are available.
 
-#### Export Configuration (For translations)
+> **Note**:
+>
+> Patterns use [glob](https://rubygems.org/gems/glob), so check it out for the
+> most up-to-date documentation about what's available.
 
-Exported translation files generated by `I18n::JS::Middleware` or `rake i18n:js:export` can be customized with config file `config/i18n-js.yml`
-(use `rails generate i18n:js:config` to create it).
-You can even get more files generated to different folders and with different translations to best suit your needs.
-The config file also affects developers using Asset Pipeline to require translations.
-Except the option `file`, since all translations are required by adding `//= require i18n/translations`.
+The config file:
 
-Examples:
-```yaml
+```yml
+---
 translations:
-- file: 'public/javascripts/path-to-your-messages-file.js'
-  only: '*.date.formats'
-- file: 'public/javascripts/path-to-your-second-file.js'
-  only: ['*.activerecord', '*.admin.*.title']
-```
+  - file: app/frontend/locales/en.json
+    patterns:
+      - "*"
+      - "!*.activerecord"
+      - "!*.errors"
+      - "!*.number.nth"
 
-If `only` is omitted all the translations will be saved. Also, make sure you add that initial `*`; it specifies that all languages will be exported. If you want to export only one language, you can do something like this:
-```yaml
-translations:
-- file: 'public/javascripts/en.js'
-  only: 'en.*'
-- file: 'public/javascripts/pt-BR.js'
-  only: 'pt-BR.*'
+  - file: app/frontend/locales/:locale.:digest.json
+    patterns:
+      - "*"
 ```
 
-Optionally, you can auto generate a translation file per available locale if you specify the `%{locale}` placeholder.
-```yaml
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
-- file: "public/javascripts/frontend/i18n/%{locale}.js"
-  only: ['*.frontend', '*.users.*']
-```
-
-You can also include ERB in your config file.
-```yaml
-translations:
-<% Widgets.each do |widget| %>
-- file: <%= "'#{widget.file}'" %>
-  only: <%= "'#{widget.only}'" %>
-<% end %>
-```
-
-You are able to exclude certain phrases or whole groups of phrases by
-specifying the YAML key(s) in the `except` configuration option. The outputted
-JS translations file (exported or generated by the middleware) will omit any
-keys listed in `except` configuration param:
-
-```yaml
-translations:
-  - except: ['*.active_admin', '*.ransack', '*.activerecord.errors']
-```
-
-
-#### Export Configuration (For other things)
+The output path can use the following placeholders:
 
-- `I18n::JS.config_file_path`
-  Expected Type: `String`
-  Default: `config/i18n-js.yml`
-  Behaviour: Try to read the config file from that location
+- `:locale`: the language that's being exported.
+- `:digest`: the MD5 hex digest of the exported file.
 
-- `I18n::JS.export_i18n_js_dir_path`
-  Expected Type: `String`
-  Default: `public/javascripts`
-  Behaviour:
-  - Any `String`: considered as a relative path for a folder to `Rails.root` and export `i18n.js` to that folder for `rake i18n:js:export`
-  - Any non-`String` (`nil`, `false`, `:none`, etc): Disable `i18n.js` exporting
+The config file is processed as erb, so you can have dynamic content on it if
+you want. The following example shows how to use groups from a variable.
 
-- `I18n::JS.sort_translation_keys`
-  Expected Type: `Boolean`
-  Default: `true`
-  Behaviour:
-  - Sets whether or not to deep sort all translation keys in order to generate identical output for the same translations
-  - Set to true to ensure identical asset fingerprints for the asset pipeline
-
-- You may also set `export_i18n_js` and `sort_translation_keys` in your config file, e.g.:
-
-```yaml
-export_i18n_js: false
-# OR
-export_i18n_js: "my/path"
-
-sort_translation_keys: false
+```yml
+---
+<% group = "{en,pt}" %>
 
 translations:
-  - ...
+  - file: app/frontend/translations.json
+    patterns:
+      - "<%= group %>.*"
+      - "!<%= group %>.activerecord"
+      - "!<%= group %>.errors"
+      - "!<%= group %>.number.nth"
 ```
 
-To find more examples on how to use the configuration file please refer to the tests.
-
-#### Fallbacks
-
-If you specify the `fallbacks` option, you will be able to fill missing translations with those inside fallback locale(s).
-Default value is `true`.
+The Ruby API:
 
-Examples:
-```yaml
-fallbacks: true
-
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
-```
-This will enable merging fallbacks into each file. (set to `false` to disable).
-If you use `I18n` with fallbacks, the fallbacks defined there will be used.
-Otherwise `I18n.default_locale` will be used.
-
-```yaml
-fallbacks: :de
+```ruby
+require "i18n-js"
 
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
+I18nJS.call(config_file: "config/i18n.yml")
+I18nJS.call(config: config)
 ```
-Here, the specified locale `:de` will be used as fallback for all locales.
 
-```yaml
-fallbacks:
-  fr: ["de", "en"]
-  de: "en"
+The CLI API:
 
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
-```
-Fallbacks defined will be used, if not defined (e.g. `:pl`) `I18n.fallbacks` or `I18n.default_locale` will be used.
+```console
+$ i18n --help
+Usage: i18n COMMAND FLAGS
 
-```yaml
-fallbacks: :default_locale
+Commands:
 
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
-```
-Setting the option to `:default_locale` will enforce the fallback to use the `I18n.default_locale`, ignoring `I18n.fallbacks`.
-
-Examples:
-```yaml
-fallbacks: false
+- init: Initialize a project
+- export: Export translations as JSON files
+- version: Show package version
+- plugins: List plugins that will be activated
+- lint:translations: Check for missing translations
+- lint:scripts: Lint files using TypeScript
 
-translations:
-- file: "public/javascripts/i18n/%{locale}.js"
-  only: '*'
+Run `i18n COMMAND --help` for more information on specific commands.
 ```
-You must disable this feature by setting the option to `false`.
 
-To find more examples on how to use the configuration file please refer to the tests.
+By default, `i18n` will use `config/i18n.yml` and `config/environment.rb` as the
+configuration files. If you don't have these files, then you'll need to specify
+both `--config` and `--require`.
 
+### Plugins
 
-#### Namespace
+#### Built-in plugins:
 
-Setting the `namespace` option will change the namespace of the output Javascript file to something other than `I18n`.
-This can be useful in no-conflict scenarios. Example:
-
-```yaml
-translations:
-- file: "public/javascripts/i18n/translations.js"
-  namespace: "MyNamespace"
-```
-
-will create:
-
-```
-MyNamespace.translations || (MyNamespace.translations = {});
-MyNamespace.translations["en"] = { ... }
-```
+##### `embed_fallback_translations`:
 
+Embed fallback translations inferred from the default locale. This can be useful
+in cases where you have multiple large translation files and don't want to load
+the default locale together with the target locale.
 
-#### Pretty Print
-
-Set the `pretty_print` option if you would like whitespace and indentation in your output file (default: false)
+To use it, add the following to your configuration file:
 
 ```yaml
-translations:
-- file: "public/javascripts/i18n/translations.js"
-  pretty_print: true
+embed_fallback_translations:
+  enabled: true
 ```
 
+##### `export_files`:
 
-#### Javascript Deep Merge (:js_extend option)
-
-By default, the output file Javascript will call the `I18n.extend` method to ensure that newly loaded locale
-files are deep-merged with any locale data already in memory. To disable this either globally or per-file,
-set the `js_extend` option to false
+By default, i18n-js will export only JSON files out of your translations. This
+plugin allows exporting other file formats. To use it, add the following to your
+configuration file:
 
 ```yaml
-js_extend: false  # this will disable Javascript I18n.extend globally
-translations:
-- file: "public/javascripts/i18n/translations.js"
-  js_extend: false  # this will disable Javascript I18n.extend for this file
+export_files:
+  enabled: true
+  files:
+    - template: path/to/template.erb
+      output: "%{dir}/%{base_name}.ts"
 ```
 
+You can export multiple files by define more entries.
 
-#### Vanilla JavaScript
-
-Just add the `i18n.js` file to your page. You'll have to build the translations object
-by hand or using your favorite programming language. More info below.
-
+The output name can use the following placeholders:
 
-#### Via NPM with webpack and CommonJS
+- `%{dir}`: the directory where the translation file is.
+- `%{name}`: file name with extension.
+- `%{base_name}`: file name without extension.
+- `%{digest}`: MD5 hexdigest from the generated file.
 
-
-Add the following line to your package.json dependencies  
-where version is the version you want  
-```javascript
-"i18n-js": "{version_constraint}"
-
-// Or if you want unreleased version
-// npm install requires it to be the gzipped tarball, see [npm install](https://www.npmjs.org/doc/cli/npm-install.html)
-"i18n-js": "https://github.com/fnando/i18n-js/archive/{tag_name_or_branch_name_or_commit_sha}.tar.gz"
-```
-Run npm install then use via
-```javascript
-var i18n = require("i18n-js");
-```
-
-
-### Setting up
-
-You **don't** need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify specific contexts, you can follow the rest of this setting up section.
-
-Set your locale is easy as
-```javascript
-I18n.defaultLocale = "pt-BR";
-I18n.locale = "pt-BR";
-I18n.currentLocale();
-// pt-BR
-```
-
-**NOTE:** You can now apply your configuration **before I18n** is loaded like this:
-```javascript
-I18n = {} // You must define this object in top namespace, which should be `window`
-I18n.defaultLocale = "pt-BR";
-I18n.locale = "pt-BR";
-
-// Load I18n from `i18n.js`, `application.js` or whatever
-
-I18n.currentLocale();
-// pt-BR
-```
-
-In practice, you'll have something like the following in your `application.html.erb`:
+The template file must be a valid eRB template. You can execute arbitrary Ruby
+code, so be careful. An example of how you can generate a file can be seen
+below:
 
 ```erb
-<script type="text/javascript">
-  I18n.defaultLocale = "<%= I18n.default_locale %>";
-  I18n.locale = "<%= I18n.locale %>";
-</script>
-```
-
-You can use translate your messages:
-
-```javascript
-I18n.t("some.scoped.translation");
-// or translate with explicit setting of locale
-I18n.t("some.scoped.translation", {locale: "fr"});
-```
-
-You can also interpolate values:
-
-```javascript
-// You need the `translations` object setup first
-I18n.translations["en"] = {
-  greeting: "Hello %{name}"
-}
-
-I18n.t("greeting", {name: "John Doe"});
-```
-You can set default values for missing scopes:
-```javascript
-// simple translation
-I18n.t("some.missing.scope", {defaultValue: "A default message"});
-
-// with interpolation
-I18n.t("noun", {defaultValue: "I'm a {{noun}}", noun: "Mac"});
-```
+/* eslint-disable */
+<%= banner %>
 
-You can also provide a list of default fallbacks for missing scopes:
+import { i18n } from "config/i18n";
 
-```javascript
-// As a scope
-I18n.t("some.missing.scope", {defaults: [{scope: "some.existing.scope"}]});
-
-// As a simple translation
-I18n.t("some.missing.scope", {defaults: [{message: "Some message"}]});
+i18n.store(<%= JSON.pretty_generate(translations) %>);
 ```
 
-Default values must be provided as an array of hashs where the key is the
-type of translation desired, a `scope` or a `message`. The translation returned
-will be either the first scope recognized, or the first message defined.
+This template is loading the instance from `config/i18n` and storing the
+translations that have been loaded. The
+`banner(comment: "// ", include_time: true)` method is built-in. The generated
+file will look something like this:
 
-The translation will fallback to the `defaultValue` translation if no scope
-in `defaults` matches and if no default of type `message` is found.
+```typescript
+/* eslint-disable */
+// File generated by i18n-js on 2022-12-10 15:37:00 +0000
 
-Translation fallback can be enabled by enabling the `I18n.fallbacks` option:
+import { i18n } from "config/i18n";
 
-```erb
-<script type="text/javascript">
-  I18n.fallbacks = true;
-</script>
+i18n.store({
+  en: {
+    "bunny rabbit adventure": "bunny rabbit adventure",
+    "hello sunshine!": "hello sunshine!",
+    "time for bed!": "time for bed!",
+  },
+  es: {
+    "bunny rabbit adventure": "conejito conejo aventura",
+    bye: "adios",
+    "time for bed!": "hora de acostarse!",
+  },
+  pt: {
+    "bunny rabbit adventure": "a aventura da coelhinha",
+    bye: "tchau",
+    "time for bed!": "hora de dormir!",
+  },
+});
 ```
 
-By default missing translations will first be looked for in less
-specific versions of the requested locale and if that fails by taking
-them from your `I18n.defaultLocale`.
-
-```javascript
-// if I18n.defaultLocale = "en" and translation doesn't exist
-// for I18n.locale = "de-DE" this key will be taken from "de" locale scope
-// or, if that also doesn't exist, from "en" locale scope
-I18n.t("some.missing.scope");
-```
+#### Plugin API
 
-Custom fallback rules can also be specified for a particular language. There
-are three different ways of doing it so:
+You can transform the exported translations by adding plugins. A plugin must
+inherit from `I18nJS::Plugin` and can have 4 class methods (they're all optional
+and will default to a noop implementation). For real examples, see [lib/i18n-js/embed_fallback_translations_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/embed_fallback_translations_plugin.rb) and [lib/i18n-js/export_files_plugin.rb](https://github.com/fnando/i18n-js/blob/main/lib/i18n-js/export_files_plugin.rb)
 
-```javascript
-I18n.locales.no = ["nb", "en"];
-I18n.locales.no = "nb";
-I18n.locales.no = function(locale){ return ["nb"]; };
-```
-
-By default a missing translation will be displayed as
+```ruby
+# frozen_string_literal: true
+
+module I18nJS
+  class SamplePlugin < I18nJS::Plugin
+    # This method is responsible for transforming the translations. The
+    # translations you'll receive may be already be filtered by other plugins
+    # and by the default filtering itself. If you need to access the original
+    # translations, use `I18nJS.translations`.
+    def transform(translations:)
+      # transform `translations` here…
+
+      translations
+    end
 
-    [missing "name of scope" translation]
+    # In case your plugin accepts configuration, this is where you must validate
+    # the configuration, making sure only valid keys and type is provided.
+    # If the configuration contains invalid data, then you must raise an
+    # exception using something like
+    # `raise I18nJS::Schema::InvalidError, error_message`.
+    #
+    # Notice the validation will only happen when the plugin configuration is
+    # set (i.e. the configuration contains your config key).
+    def validate_schema
+      # validate plugin schema here…
+    end
 
-While you are developing or if you do not want to provide a translation
-in the default language you can set
+    # This method must set up the basic plugin configuration, like adding the
+    # config's root key in case your plugin accepts configuration (defined via
+    # the config file).
+    #
+    # If you don't add this key, the linter will prevent non-default keys from
+    # being added to the configuration file.
+    def setup
+      # If you plugin has configuration, uncomment the line below
+      # I18nJS::Schema.root_keys << config_key
+    end
 
-```javascript
-I18n.missingBehaviour='guess';
+    # This method is called whenever `I18nJS.call(**kwargs)` finishes exporting
+    # JSON files based on your configuration.
+    #
+    # You can use it to further process exported files, or generate new files
+    # based on the translations that have been exported.
+    def after_export(files:)
+      # process exported files here…
+    end
+  end
+end
 ```
 
-this will take the last section of your scope and guess the intended value.
-Camel case becomes lower cased text and underscores are replaced with space
+The class `I18nJS::Plugin` implements some helper methods that you can use:
 
-    questionnaire.whatIsYourFavorite_ChristmasPresent
+- `I18nJS::Plugin#config_key`: the configuration key that was inferred out of
+  your plugin's class name.
+- `I18nJS::Plugin#config`: the plugin configuration.
+- `I18nJS::Plugin#enabled?`: whether the plugin is enabled or not based on the
+  plugin's configuration.
 
-becomes "what is your favorite Christmas present"
+To distribute this plugin, you need to create a gem package that matches the
+pattern `i18n-js/*_plugin.rb`. You can test whether your plugin will be found by
+installing your gem, opening a iRB session and running
+`Gem.find_files("i18n-js/*_plugin.rb")`. If your plugin is not listed, then you
+need to double check your gem load path and see why the file is not being
+loaded.
 
-In order to still detect untranslated strings, you can
-i18n.missingTranslationPrefix to something like:
-```javascript
-I18n.missingTranslationPrefix = 'EE: ';
-```
-
-And result will be:
-```javascript
-"EE: what is your favorite Christmas present"
-```
+### Listing missing translations
 
-This will help you doing automated tests against your localisation assets.
+To list missing and extraneous translations, you can use
+`i18n lint:translations`. This command will load your translations similarly to
+how `i18n export` does, but will output the list of keys that don't have a
+matching translation against the default locale. Here's an example:
 
-Some people prefer returning `null` for missing translation:
-```javascript
-I18n.missingTranslation = function () { return undefined; };
+```console
+$ i18n lint:translations
+=> Config file: "./config/i18n.yml"
+=> Require file: "./config/environment.rb"
+=> Check "./config/i18n.yml" for ignored keys.
+=> en: 232 translations
+=> pt-BR: 5 missing, 1 extraneous, 1 ignored
+   - pt-BR.actors.github.metrics (missing)
+   - pt-BR.actors.github.metrics_hint (missing)
+   - pt-BR.actors.github.repo_metrics (missing)
+   - pt-BR.actors.github.repository (missing)
+   - pt-BR.actors.github.user_metrics (missing)
+   - pt-BR.github.repository (extraneous)
 ```
 
-Pluralization is possible as well and by default provides English rules:
+This command will exist with status 1 whenever there are missing translations.
+This way you can use it as a CI linting.
 
-```javascript
-I18n.t("inbox.counting", {count: 10}); // You have 10 messages
-```
+You can ignore keys by adding a list to the config file:
 
-The sample above expects the following translation:
+```yml
+---
+translations:
+  - file: app/frontend/locales/en.json
+    patterns:
+      - "*"
+      - "!*.activerecord"
+      - "!*.errors"
+      - "!*.number.nth"
+
+  - file: app/frontend/locales/:locale.:digest.json
+    patterns:
+      - "*"
+
+lint_translations:
+  ignore:
+    - en.mailer.login.subject
+    - en.mailer.login.body
+```
+
+> **Note**:
+>
+> In order to avoid mistakenly ignoring keys, this configuration option only
+> accepts the full translation scope, rather than accepting a pattern like
+> `pt.ignored.scope.*`.
+
+### Linting your JavaScript/TypeScript files
+
+To lint your script files and check for missing translations (which can signal
+that you're either using wrong scopes or forgot to add the translation), use
+`i18n lint:scripts`. This command will parse your JavaScript/TypeScript files
+and extract all scopes being used. This command requires a Node.js runtime. You
+can either specify one via `--node-path`, or let the plugin infer a binary from
+your `$PATH`.
+
+The comparison will be made against the export JSON files, which means it'll
+consider transformations performed by plugins (e.g. the output files may be
+affected by `embed_fallback_translations` plugin).
+
+The translations that will be extract must be called as one of the following
+ways:
+
+- `i18n.t(scope, options)`
+- `i18n.translate(scope, options)`
+- `t(scope, options)`
+
+Notice that only literal strings can be used, as in `i18n.t("message")`. If
+you're using dynamic scoping through variables (e.g.
+`const scope = "message"; i18n.t(scope)`), they will be skipped.
+
+```console
+$ i18n lint:scripts
+=> Config file: "./config/i18n.yml"
+=> Require file: "./config/environment.rb"
+=> Node: "/Users/fnando/.asdf/shims/node"
+=> Available locales: [:en, :es, :pt]
+=> Patterns: ["!(node_modules)/**/*.js", "!(node_modules)/**/*.ts", "!(node_modules)/**/*.jsx", "!(node_modules)/**/*.tsx"]
+=> 9 translations, 11 missing, 4 ignored
+   - test/scripts/lint/file.js:1:1: en.js.missing
+   - test/scripts/lint/file.js:1:1: es.js.missing
+   - test/scripts/lint/file.js:1:1: pt.js.missing
+   - test/scripts/lint/file.js:2:8: en.base.js.missing
+   - test/scripts/lint/file.js:2:8: es.base.js.missing
+   - test/scripts/lint/file.js:2:8: pt.base.js.missing
+   - test/scripts/lint/file.js:4:8: en.js.missing
+   - test/scripts/lint/file.js:4:8: es.js.missing
+   - test/scripts/lint/file.js:4:8: pt.js.missing
+   - test/scripts/lint/file.js:6:1: en.another_ignore_scope
+   - test/scripts/lint/file.js:6:1: es.another_ignore_scope
+```
+
+This command will list all locales and their missing translations. Avoid listing
+a particular translation, you can set `lint.ignore` on your config file.
 
 ```yaml
-en:
-  inbox:
-    counting:
-      one: You have 1 new message
-      other: You have {{count}} new messages
-      zero: You have no messages
-```
-
-**NOTE:** Rails I18n recognizes the `zero` option.
-
-If you need special rules just define them for your language, for example Russian, just add a new pluralizer:
-
-```javascript
-I18n.pluralization["ru"] = function (count) {
-  var key = count % 10 == 1 && count % 100 != 11 ? "one" : [2, 3, 4].indexOf(count % 10) >= 0 && [12, 13, 14].indexOf(count % 100) < 0 ? "few" : count % 10 == 0 || [5, 6, 7, 8, 9].indexOf(count % 10) >= 0 || [11, 12, 13, 14].indexOf(count % 100) >= 0 ? "many" : "other";
-  return [key];
-};
-```
-
-You can find all rules on <http://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html>.
-
-If you're using the same scope over and over again, you may use the `scope` option.
-
-```javascript
-var options = {scope: "activerecord.attributes.user"};
-
-I18n.t("name", options);
-I18n.t("email", options);
-I18n.t("username", options);
-```
-
-You can also provide an array as scope.
-
-```javascript
-// use the greetings.hello scope
-I18n.t(["greetings", "hello"]);
-```
-
-#### Number formatting
-
-Similar to Rails helpers, you have localized number and currency formatting.
-
-```javascript
-I18n.l("currency", 1990.99);
-// $1,990.99
-
-I18n.l("number", 1990.99);
-// 1,990.99
-
-I18n.l("percentage", 123.45);
-// 123.450%
-```
-
-To have more control over number formatting, you can use the
-`I18n.toNumber`, `I18n.toPercentage`, `I18n.toCurrency` and `I18n.toHumanSize`
-functions.
+---
+translations:
+  - file: app/frontend/translations.json
+    patterns:
+      - "*"
 
-```javascript
-I18n.toNumber(1000);     // 1,000.000
-I18n.toCurrency(1000);   // $1,000.00
-I18n.toPercentage(100);  // 100.000%
+lint_scripts:
+  ignore:
+    - ignore_scope # will ignore this scope on all languages
+    - pt.another_ignore_scope # will ignore this scope only on `pt`
 ```
 
-The `toNumber` and `toPercentage` functions accept the following options:
-
-- `precision`: defaults to `3`
-- `separator`: defaults to `.`
-- `delimiter`: defaults to `,`
-- `strip_insignificant_zeros`: defaults to `false`
+You can also set the patterns that will be looked up. By default, it scans all
+JavaScript and TypeScript files that don't live on `node_modules`.
 
-See some number formatting examples:
+```yaml
+---
+translations:
+  - file: app/frontend/translations.json
+    patterns:
+      - "*"
 
-```javascript
-I18n.toNumber(1000, {precision: 0});                   // 1,000
-I18n.toNumber(1000, {delimiter: ".", separator: ","}); // 1.000,000
-I18n.toNumber(1000, {delimiter: ".", precision: 0});   // 1.000
+lint:
+  patterns:
+    - "app/assets/**/*.ts"
 ```
 
-The `toCurrency` function accepts the following options:
-
-- `precision`: sets the level of precision
-- `separator`: sets the separator between the units
-- `delimiter`: sets the thousands delimiter
-- `format`: sets the format of the output string
-- `unit`: sets the denomination of the currency
-- `strip_insignificant_zeros`: defaults to `false`
-- `sign_first`: defaults to `true`
+## Automatically export translations
 
-You can provide only the options you want to override:
+### Using [watchman](https://facebook.github.io/watchman/)
 
-```javascript
-I18n.toCurrency(1000, {precision: 0}); // $1,000
-```
-
-The `toHumanSize` function accepts the following options:
-
-- `precision`: defaults to `1`
-- `separator`: defaults to `.`
-- `delimiter`: defaults to `""`
-- `strip_insignificant_zeros`: defaults to `false`
-- `format`: defaults to `%n%u`
+Create a script at `bin/i18n-watch`.
 
-<!---->
+```bash
+#!/usr/bin/env bash
+
+root=`pwd`
+
+watchman watch-del "$root"
+watchman watch-project "$root"
+watchman trigger-del "$root" i18n
+
+watchman -j <<-JSON
+[
+  "trigger",
+  "$root",
+  {
+    "name": "i18n",
+    "expression": [
+      "anyof",
+      ["match", "config/locales/**/*.yml", "wholename"],
+      ["match", "config/i18n.yml", "wholename"]
+    ],
+    "command": ["i18n", "export"]
+  }
+]
+JSON
 
-```javascript
-I18n.toHumanSize(1234); // 1KB
-I18n.toHumanSize(1234 * 1024); // 1MB
+# If you're running this through Foreman,
+# the uncomment the following lines:
+# while true; do
+#   sleep 1
+# done
 ```
 
+Make it executable with `chmod +x bin/i18n-watch`. To watch for changes, run
+`./bin/i18n-watch`. If you're using Foreman, make sure you uncommented the lines
+that keep the process running (`while..`), and add something like the following
+line to your Procfile:
 
-#### Date formatting
-
-```javascript
-// accepted formats
-I18n.l("date.formats.short", "2009-09-18");           // yyyy-mm-dd
-I18n.l("time.formats.short", "2009-09-18 23:12:43");  // yyyy-mm-dd hh:mm:ss
-I18n.l("time.formats.short", "2009-11-09T18:10:34");  // JSON format with local Timezone (part of ISO-8601)
-I18n.l("time.formats.short", "2009-11-09T18:10:34Z"); // JSON format in UTC (part of ISO-8601)
-I18n.l("date.formats.short", 1251862029000);          // Epoch time
-I18n.l("date.formats.short", "09/18/2009");           // mm/dd/yyyy
-I18n.l("date.formats.short", (new Date()));           // Date object
 ```
-
-You can also add placeholders to the date format:
-
-```javascript
-I18n.translations["en"] = {
-  date: {
-    formats: {
-      ordinal_day: "%B %{day}"
-    }
-  }
-}
-I18n.l("date.formats.ordinal_day", "2009-09-18", { day: '18th' }); // Sep 18th
+i18n: ./bin/i18n-watch
 ```
 
-If you prefer, you can use the `I18n.toTime` and `I18n.strftime` functions to format dates.
+### Using [guard](https://rubygems.org/gems/guard)
 
-```javascript
-var date = new Date();
-I18n.toTime("date.formats.short", "2009-09-18");
-I18n.toTime("date.formats.short", date);
-I18n.strftime(date, "%d/%m/%Y");
-```
+Install [guard](https://rubygems.org/gems/guard) and
+[guard-compat](https://rubygems.org/gems/guard-compat). Then create a Guardfile
+with the following configuration:
 
-The accepted formats for `I18n.strftime` are:
-
-    %a  - The abbreviated weekday name (Sun)
-    %A  - The full weekday name (Sunday)
-    %b  - The abbreviated month name (Jan)
-    %B  - The full month name (January)
-    %d  - Day of the month (01..31)
-    %-d - Day of the month (1..31)
-    %H  - Hour of the day, 24-hour clock (00..23)
-    %-H - Hour of the day, 24-hour clock (0..23)
-    %I  - Hour of the day, 12-hour clock (01..12)
-    %-I - Hour of the day, 12-hour clock (1..12)
-    %m  - Month of the year (01..12)
-    %-m - Month of the year (1..12)
-    %M  - Minute of the hour (00..59)
-    %-M - Minute of the hour (0..59)
-    %p  - Meridian indicator (AM  or  PM)
-    %S  - Second of the minute (00..60)
-    %-S - Second of the minute (0..60)
-    %w  - Day of the week (Sunday is 0, 0..6)
-    %y  - Year without a century (00..99)
-    %-y - Year without a century (0..99)
-    %Y  - Year with century
-    %z  - Timezone offset (+0545)
-
-Check out `spec/*.spec.js` files for more examples!
-
-#### Using pluralization and number formatting together
-Sometimes you might want to display translation with formatted number, like adding thousand delimiters to displayed number  
-You can do this:  
-```json
-{
-  "en": {
-    "point": {
-      "one": "1 Point",
-      "other": "{{formatted_number}} Points",
-      "zero": "0 Points"
-    }
-  }
-}
-```
-```js
-var point_in_number = 1000;
-I18n.t('point', { count: point_in_number, formatted_number: I18n.toNumber(point_in_number) });
+```ruby
+guard(:"i18n-js",
+      run_on_start: true,
+      config_file: "./config/i18n.yml",
+      require_file: "./config/environment.rb") do
+  watch(%r{^(app|config)/locales/.+\.(yml|po)$})
+  watch(%r{^config/i18n.yml$})
+  watch("Gemfile")
+end
 ```
-Output should be `1,000 points`
-
-
-## Using multiple exported translation files on a page.
-This method is useful for very large apps where a single contained translations.js file is not desirable. Examples would be a global translations file and a more specific route translation file.
-
-### Rails without asset pipeline
-1. Setup your `config/i18n-js.yml` to have multiple files and try to minimize any overlap.
-
-  ```yaml
-  sort_translation_keys: true
-  fallbacks: false
-
-  translations:
-    + file: "app/assets/javascript/nls/welcome.js"
-      only:
-        + '*.welcome.*'
-
-    + file: "app/assets/javascript/nls/albums.js"
-      only:
-        + '*.albums.*'
-
-    + file: "app/assets/javascript/nls/global.js"
-      only:
-        + '*'
-      # Exempt any routes specific translations from being
-      # included in the global translation file
-      except:
-        + '*.welcome.*'
-        + '*.albums.*'
-  ```
-  When `rake i18n:js:export` is executed it will create 3 translations files that can be loaded via the `javascript_include_tag`
-
-2. Add the `javascript_include_tag` to your layout and to any route specific files that will require it.
-  ```ruby
-    # views/layouts/application.html.erb
-    <%= javascript_include_tag(
-          "i18n"
-          "nls/global"
-        ) %>
-  ```
-  and in the route specific
-
-  ```ruby
-    # views/welcome/index.html.erb
-    <%= javascript_include_tag(
-          "nls/welcome"
-        ) %>
-  ```
-
-3. Make sure that you add these files to your `config/application.rb`
-
-  ```ruby
-    config.assets.precompile += %w(
-      i18n
-      nls/*
-    )
-  ```
-
-### Using require.js / r.js
-
-To use this with require.js we are only going to change a few things from above.
-
-1. In your `config/i18n-js.yml` we need to add a better location for the i18n to be exported. You want to use this location so that it can be properly precompiled by r.js.
-
-  ```yaml
-  export_i18n_js: "app/assets/javascript/nls"
-  ```
-
-2. In your `config/require.yml` we need to add a map, shim all the translations, and include them into the appropriate modules
-
-  ```yaml
-  # In your maps add (if you do not have this you will need to add it)
-  map:
-    '*':
-      i18n: 'nls/i18n'
-
-  # In your shims
-  shims:
-    nls/welcome:
-      deps:
-        + i18n
-
-    nls/global:
-      deps:
-        + i18n
-
-  # Finally in your modules
-  modules:
-    + name: 'application'
-      include:
-        + i18n
-        + 'nls/global'
-
-    + name: 'welcome'
-      exclude:
-        + application
-      include:
-        + 'nls/welcome'
-  ```
-3. When `rake assets:precompile` is executed it will optimize the translations into the correct modules so they are loaded with their assigned module, and loading them with requirejs is as simple as requiring any other shim.
-
-  ```javascript
-  define(['welcome/other_asset','nls/welcome'], function (otherAsset){
-      // ...
-  });
-  ```
-4. (optional) As an additional configuration we can make a task to be run before the requirejs optimizer. This will allow any automated scripts that run the requirejs optimizer to export the strings before we run r.js
-
-  ```rake
-  # lib/tasks/i18n.rake
-  Rake::Task[:'i18n:js:export'].prerequisites.clear
-  task :'i18n:js:export' => :'i18n:js:before_export'
-  task :'requirejs:precompile:external' => :'i18n:js:export'
-
-  namespace :i18n do
-    namespace :js do
-      task :before_export => :'assets:environment' do
-        I18n.load_path += Dir[Rails.root.join('config', 'locales', '*.{yml,rb}')]
-        I18n.backend.load_translations
-      end
-    end
-  end
-  ```
 
-## Using I18n.js with other languages (Python, PHP, ...)
+If your files are located in a different path, remember to configure file paths
+accordingly.
 
-The JavaScript library is language agnostic; so you can use it with PHP, Python, [your favorite language here].
-The only requirement is that you need to set the `translations` attribute like following:
+Now you can run `guard start -i`.
 
-```javascript
-I18n.translations = {};
+### Using [listen](https://rubygems.org/gems/listen)
 
-I18n.translations["en"] = {
-  message: "Some special message for you"
-}
+Create a file under `config/initializers/i18n.rb` with the following content:
 
-I18n.translations["pt-BR"] = {
-  message: "Uma mensagem especial para você"
-}
+```ruby
+Rails.application.config.after_initialize do
+  require "i18n-js/listen"
+  I18nJS.listen
+end
 ```
 
+The code above will watch for changes based on `config/i18n.yml` and
+`config/locales`. You can customize these options:
 
-## Known Issues
-
-### Missing translations in precompiled file(s) after adding any new locale file
+- `config_file` - i18n-js configuration file
+- `locales_dir` - one or multiple directories to watch for locales changes
+- `options` - passed directly to
+  [listen](https://github.com/guard/listen/#options)
+- `run_on_start` - export files on start. Defaults to `true`. When disabled,
+  files will be exported only when there are file changes.
 
-Due to the design of `sprockets`:
+Example:
 
-- `depend_on` only takes file paths, not directory paths
-- registered `preprocessors` are only run when the fingerprint of any asset file, including `.erb` files, is changed
-
-This means that new locale files will not be detected, and so they will not trigger a i18n-js refresh. There are a few approaches to work around this:
-
-1. You can force i18n-js to update its translations by completely clearing the assets cache. Use one of the following:
-  
-```bash
-$ rake assets:clobber
-# Or, with older versions of Rails:
-$ rake tmp:cache:clear
-```
-
-These commands will remove *all* fingerprinted assets, and you will have to recompile them with
-
-```bash
-$ rake assets:precompile
+```ruby
+I18nJS.listen(
+  config_file: "config/i18n.yml",
+  locales_dir: ["config/locales", "app/views"],
+  options: {only: %r{.yml$}},
+  run_on_start: false
+)
 ```
 
-or similar commands.  If you are precompiling assets on the target machine(s), cached pages may be broken by this, so they will need to be refreshed.
-
-2. You can change something in a different locale file.
-
-3. Finally, you can change `config.assets.version`.
-
-**Note:** See issue [#213](https://github.com/fnando/i18n-js/issues/213) for more details and discussion of this issue.
-
-### Translations in JS are not updated when Sprockets not loaded before this gem
+### Integrating with your frontend
 
-The "rails engine" declaration will try to detect existence of "sprockets" before adding the initailizer
-If sprockets is loaded after this gem, the preprocessor for 
-making JS translations file cache to depend on content of locale files will not be hooked.
-So ensure sprockets is loaded before this gem like moving entry of sprockets in Gemfile or adding "require" statements for sprockets somewhere.
+You're done exporting files, now what? Well, go to
+[i18n](https://github.com/fnando/i18n) to discover how to use the NPM package
+that loads all the exported translation.
 
-**Note:** See issue [#404](https://github.com/fnando/i18n-js/issues/404) for more details and discussion of this issue.
+### FAQ
 
-### JS `I18n.toCurrency` & `I18n.toNumber` cannot handle large integers
+#### I'm running v3. Is there a migration plan?
 
-The above methods use `toFixed` and it only supports 53 bit integers.  
-Ref: http://2ality.com/2012/07/large-integers.html
+[There's a document](https://github.com/fnando/i18n-js/tree/main/MIGRATING_FROM_V3_TO_V4.md)
+outlining some of the things you need to do to migrate from v3 to v4. It may not
+be as complete as we'd like it to be, so let us know if you face any issues
+during the migration is not outline is that document.
 
-Feel free to find & discuss possible solution(s) at issue [#511](https://github.com/fnando/i18n-js/issues/511)
+#### How can I export translations without having a database around?
 
-### Only works with `Simple` backend
-
-If you set `I18n.backend` to something other than the default `Simple` backend, you will likely get an exception like this:
-
-```
-Undefined method 'initialized?' for <your backend class>
-```
-
-For now, i18n-js is only compatible with the `Simple` backend.
-If you need a more sophisticated backend for your rails application, like `I18n::Backend::ActiveRecord`, you can setup i18n-js to get translations from a separate `Simple` backend, by adding the following in an initializer:
-
-```ruby
-I18n::JS.backend = I18n.backend
-I18n.backend = I18n::Backend::Chain.new(<your other backend(s)>, I18n.backend)
-```
-
-This will use your backend with the default `Simple` backend as fallback, while i18n-js only sees and uses the simple backend.
-This means however, that only translations from your static locale files will be present in JavaScript.
-
-If you do cannot use a `Chain`-Backend for some reason, you can also set
+Some people may have a build process using something like Docker that don't
+necessarily have a database available. In this case, you may define your own
+loading file by using something like
+`i18n export --require ./config/i18n_export.rb`, where `i18n_export.rb` may look
+like this:
 
 ```ruby
-I18n::JS.backend = I18n::Backend::Simple.new
-I18n.backend = <something different>
-```
+# frozen_string_literal: true
 
-However, the automatic reloading of translations in developement will not work in this case.
-This is because Rails calls `I18n.reload!` for each request in development, but `reload!` will not be called on `I18n::JS.backend`, since it is a different object.
-One option would be to patch `I18n.reload!` in an initializer:
+require "bundler/setup"
+require "rails"
+require "active_support/railtie"
+require "action_view/railtie"
 
-```ruby
-module I18n
-  def self.reload!
-    I18n::JS.backend.reload!
-    super
-  end
-end
+I18n.load_path += Dir["./config/locales/**/*.yml"]
 ```
 
-See issue [#428](https://github.com/fnando/i18n-js/issues/428) for more details and discussion of this issue.
+> **Note**:
+>
+> You may not need to load ActiveSupport and ActionView lines, or even may need
+> to add additional requires for other libs. With this approach you have full
+> control on what's going to be loaded.
 
 ## Maintainer
 
-- Nando Vieira - <http://nandovieira.com.br>
-
-## Contributing
-
-Once you've made your great commits:
-
-1. [Fork](http://help.github.com/forking/) I18n.js
-2. Create a branch with a clear name
-3. Make your changes (Please also add/change spec, README and CHANGELOG if applicable)
-4. Push changes to the created branch
-5. [Create an Pull Request](http://github.com/fnando/i18n-js/pulls)
-6. That's it!
+- [Nando Vieira](https://github.com/fnando)
 
-Please respect the indentation rules and code style.
-And use 2 spaces, not tabs. And don't touch the versioning thing.
+## Contributors
 
-## Running tests
+- https://github.com/fnando/i18n-js/contributors
 
-You can run I18n tests using Node.js or your browser.
-
-To use Node.js, install the `jasmine-node` library:
-
-    $ npm install jasmine-node
-
-Then execute the following command from the lib's root directory:
+## Contributing
 
-    $ npm test
+For more details about how to contribute, please read
+https://github.com/fnando/i18n-js/blob/main/CONTRIBUTING.md.
 
-To run using your browser, just open the `spec/js/specs.html` file.
+## License
 
-You can run both Ruby and JavaScript specs with `rake spec`.
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/i18n-js/blob/main/LICENSE.md.
 
-## License
+## Code of Conduct
 
-(The MIT License)
-
-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.
+Everyone interacting in the i18n-js project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/i18n-js/blob/main/CODE_OF_CONDUCT.md).