i18n-js 4.0.0.alpha4 → 4.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecf4853a33adc9a67520a585c733a55e7b05e07bdc436830c519213bfc728b6
-  data.tar.gz: 5a1b68a4182bc30fcc3c57438ab226ba72a97a7f16dd6c29ac938106f4c5e00c
+  metadata.gz: a5b5c71c903af1425bb6d7b12d0e74dc2da41894cf75a428da19bb11715dc371
+  data.tar.gz: 4914b448a0aca280c53412827d11b0148a7ec6393ff875fca78efea84bb68ce2
 SHA512:
-  metadata.gz: f8468f07c440fa8c29c84a6550ef8b7d5914cf08ce93d0b02f77caf65838a4057f8a7653cc221c33a1dfaf1ab0486aa195a368248ca9509af4af7071ab76ddaa
-  data.tar.gz: cb3822d5fe66aa90b20a4a596869a0adb93c3154d5877f66b1374794961536bc2916c051f8d5ce5f61d2d57c66951c25b477f8b808b7d737b39941875e545afb
+  metadata.gz: dd4f1880a36a9bee698766b843b73489517c1e09c86e143f1e5582811275423714c4c4a741cd01e86c7af558a33866738c9235399b309d09b97fd71375af77cb
+  data.tar.gz: 47e0d59fb0d12e2203508ff0c1bef534c9e42a77a895d78bea0d811f97ab6e2d2e0cc4461e46a36ba07016d0d77a4ac488b88fabdf71eb94325080b2fe2acd10

data/README.md

@@ -24,7 +24,7 @@
   <a href="https://tldrlegal.com/license/mit-license"><img src="https://img.shields.io/:License-MIT-blue.svg" alt="MIT License"></a>
 </p>
 
-![This branch contains the code for v4, our next major release.](https://messages-svg.herokuapp.com/warning.svg?message=This%20branch%20contains%20the%20code%20for%20v4%2C%20our%20next%20major%20release.)
+> **Warning**: This branch contains the code for v4, our next major release.
 
 ## Installation
 
@@ -111,6 +111,32 @@ default locale. Here's an example:
 This command will exist with status 1 whenever there are missing translations.
 This way you can use it as a CI linting.
 
+You can ignore keys by adding a list to the config file:
+
+```yml
+---
+translations:
+  - file: app/frontend/locales/en.json
+    patterns:
+      - "*"
+      - "!*.activerecord"
+      - "!*.errors"
+      - "!*.number.nth"
+
+  - file: app/frontend/locales/:locale.:digest.json
+    patterns:
+      - "*"
+
+check:
+  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.*`.
+
 ## Automatically export translations
 
 ### Using watchman

data/lib/i18n-js/cli/check_command.rb

@@ -69,9 +69,14 @@ module I18nJS
           )
         end
 
+        config = Glob::SymbolizeKeys.call(YAML.load_file(config_file))
+        Schema.validate!(config)
+
         load_require_file!(require_file) if require_file
+
         default_locale = I18n.default_locale
         available_locales = I18n.available_locales
+        ignored_keys = config.dig(:check, :ignore) || []
 
         mapping = available_locales.each_with_object({}) do |locale, buffer|
           buffer[locale] =
@@ -81,21 +86,50 @@ module I18nJS
 
         default_locale_keys = mapping.delete(default_locale)
 
+        if ignored_keys.any?
+          ui.stdout_print "=> Check #{options[:config_file].inspect} for " \
+                          "ignored keys."
+        end
+
         ui.stdout_print "=> #{default_locale}: #{default_locale_keys.size} " \
                         "translations"
 
         total_missing_count = 0
 
         mapping.each do |locale, partial_keys|
-          extraneous = partial_keys - default_locale_keys
-          missing = default_locale_keys - (partial_keys - extraneous)
+          ignored_count = 0
+
+          # Compute list of filtered keys (i.e. keys not ignored)
+          filtered_keys = partial_keys.reject do |key|
+            key = "#{locale}.#{key}"
+
+            ignored = ignored_keys.include?(key)
+            ignored_count += 1 if ignored
+            ignored
+          end
+
+          extraneous = (partial_keys - default_locale_keys).reject do |key|
+            key = "#{locale}.#{key}"
+            ignored = ignored_keys.include?(key)
+            ignored_count += 1 if ignored
+            ignored
+          end
+
+          missing = (default_locale_keys - (filtered_keys - extraneous))
+                    .reject {|key| ignored_keys.include?("#{locale}.#{key}") }
+
+          ignored_count += extraneous.size
           total_missing_count += missing.size
+
           ui.stdout_print "=> #{locale}: #{missing.size} missing, " \
-                          "#{extraneous.size} extraneous"
+                          "#{extraneous.size} extraneous, " \
+                          "#{ignored_count} ignored"
 
           all_keys = (default_locale_keys + extraneous + missing).uniq.sort
 
           all_keys.each do |key|
+            next if ignored_keys.include?("#{locale}.#{key}")
+
             label = if extraneous.include?(key)
                       ui.yellow("extraneous")
                     elsif missing.include?(key)

data/lib/i18n-js/schema.rb

@@ -4,8 +4,9 @@ module I18nJS
   class Schema
     InvalidError = Class.new(StandardError)
 
-    ROOT_KEYS = %i[translations].freeze
+    ROOT_KEYS = %i[translations check].freeze
     REQUIRED_ROOT_KEYS = %i[translations].freeze
+    REQUIRED_CHECK_KEYS = %i[ignore].freeze
     REQUIRED_TRANSLATION_KEYS = %i[file patterns].freeze
     TRANSLATION_KEYS = %i[file patterns].freeze
 
@@ -25,6 +26,17 @@ module I18nJS
       expect_required_keys(REQUIRED_ROOT_KEYS, target)
       reject_extraneous_keys(ROOT_KEYS, target)
       validate_translations
+      validate_check
+    end
+
+    def validate_check
+      return unless target.key?(:check)
+
+      check = target[:check]
+
+      expect_type(:check, check, Hash, target)
+      expect_required_keys(REQUIRED_CHECK_KEYS, check)
+      expect_type(:ignore, check[:ignore], Array, check)
     end
 
     def validate_translations

data/lib/i18n-js/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nJS
-  VERSION = "4.0.0.alpha4"
+  VERSION = "4.0.0.alpha5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha4
+  version: 4.0.0.alpha5
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -200,10 +200,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/i18n-js
   bug_tracker_uri: https://github.com/fnando/i18n-js/issues
-  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha4
-  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha4/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha4/README.md
-  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha4/LICENSE.md
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha5
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha5/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha5/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha5/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths: