i18n-js 4.0.0.alpha3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0fd83a034e8eaa82e97f46beb39a96da4d671952762f7751d093d4823e1aed
-  data.tar.gz: acff26df94aa46c0c50d5864c97b32bc1108a611a748c2dd7fff4d626ec41cf4
+  metadata.gz: 0b2fdace9fca14d471ff34c3b24055d4093d82ce2a1f72f2df06364a98454a31
+  data.tar.gz: 9ea6bd71626357c8fce24c28e991b9edc96f8a3230e55c4d55cf1dec3813c94e
 SHA512:
-  metadata.gz: d72a28ddbe75742e605c86d8e3b06ce2e1ada21bc95f2b189e2e120b671c7c0d4d239dfc7c3753abd4b97f57820146001cfdfb89e2c407ae3054ea93fba98d72
-  data.tar.gz: 5ed38c2ea91915fadcc6cc7a4b718d1473cc41afff0c5cd3f6dd6e1345e2eed29c53bace6403239dd516a180485b055414cd65c00291747d20c6055c6b2f6a2a
+  metadata.gz: 2c8da0348d02f04d805a013dadd24beb08fb7de555bfdded51e4e6c7c29ba392978a723b7e95be9d752dda2b35bbe6d6aefe4d4cf9166c1ddca09f003712533f
+  data.tar.gz: 882af1975b1f2e479ad4d8bdcbe812175fae165c80a2f915223e14fc71fb0b3236774254e103754169eab5a3d577e219e10803fd05e14fa3bac82471e4c770e1

data/.github/workflows/ruby-tests.yml

@@ -4,8 +4,6 @@ name: ruby-tests
 on:
   pull_request_target:
   push:
-    branches:
-      - v4
   workflow_dispatch:
     inputs: {}
 

data/CHANGELOG.md

@@ -11,6 +11,6 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
-## Unreleased
+## Jul 29, 2022
 
-- Initial release.
+- Official release of i18n-js v4.0.0.

data/README.md

@@ -19,13 +19,11 @@
 
 <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/v/i18n-js.svg?include_prereleases" 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>
 
-![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.)
-
 ## Installation
 
 ```bash
@@ -35,7 +33,7 @@ gem install i18n-js
 Or add the following line to your project's Gemfile:
 
 ```ruby
-gem "i18n-js", "~> 4.0.0.alpha1"
+gem "i18n-js"
 ```
 
 ## Usage
@@ -82,14 +80,61 @@ I18nJS.call(config: config)
 The CLI API:
 
 ```console
-$ i18n init --config config/i18n.yml
-$ i18n export --config config/i18n.yml --require config/environment.rb
+$ i18n --help
+Usage: i18n COMMAND FLAGS
+
+Commands:
+
+- init: Initialize a project
+- export: Export translations as JSON files
+- version: Show package version
+- check: Check for missing translations
+
+Run `i18n COMMAND --help` for more information on specific commands.
 ```
 
 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`.
 
+### Listing missing translations
+
+To list missing and extraneous translations, you can use `i18n check`. 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:
+
+![`i18n check` command in action](https://github.com/fnando/i18n-js/raw/main/images/i18njs-check.gif)
+
+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

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "benchmark"
+
+module I18nJS
+  class CLI
+    class CheckCommand < Command
+      command_name "check"
+      description "Check for missing translations"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name} [options]"
+
+        opts.on(
+          "-cCONFIG_FILE",
+          "--config=CONFIG_FILE",
+          "The configuration file that will be used"
+        ) do |config_file|
+          options[:config_file] = config_file
+        end
+
+        opts.on(
+          "-rREQUIRE_FILE",
+          "--require=REQUIRE_FILE",
+          "A Ruby file that must be loaded"
+        ) do |require_file|
+          options[:require_file] = require_file
+        end
+
+        opts.on(
+          "--[no-]color",
+          "Force colored output"
+        ) do |colored|
+          options[:colored] = colored
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          ui.exit_with opts.to_s
+        end
+      end
+
+      command do
+        set_defaults!
+        ui.colored = options[:colored]
+
+        unless options[:config_file]
+          ui.fail_with("=> ERROR: you need to specify the config file")
+        end
+
+        ui.stdout_print("=> Config file:", options[:config_file].inspect)
+        config_file = File.expand_path(options[:config_file])
+
+        if options[:require_file]
+          ui.stdout_print("=> Require file:", options[:require_file].inspect)
+          require_file = File.expand_path(options[:require_file])
+        end
+
+        unless File.file?(config_file)
+          ui.fail_with(
+            "=> ERROR: config file doesn't exist at",
+            config_file.inspect
+          )
+        end
+
+        if require_file && !File.file?(require_file)
+          ui.fail_with(
+            "=> ERROR: require file doesn't exist at",
+            require_file.inspect
+          )
+        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] =
+            Glob::Map.call(Glob.filter(I18nJS.translations, ["#{locale}.*"]))
+                     .map {|key| key.gsub(/^.*?\./, "") }
+        end
+
+        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|
+          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, " \
+                          "#{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)
+                      ui.red("missing")
+                    else
+                      next
+                    end
+
+            ui.stdout_print("   - #{locale}.#{key} (#{label})")
+          end
+        end
+
+        exit(1) if total_missing_count.nonzero?
+      end
+
+      private def set_defaults!
+        config_file = "./config/i18n.yml"
+        require_file = "./config/environment.rb"
+
+        options[:config_file] ||= config_file if File.file?(config_file)
+        options[:require_file] ||= require_file if File.file?(require_file)
+      end
+    end
+  end
+end

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

@@ -38,6 +38,32 @@ module I18nJS
       def options
         @options ||= {}
       end
+
+      private def load_require_file!(require_file)
+        require_without_warnings(require_file)
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        ui.stderr_print("=> ERROR: couldn't load",
+                        options[:require_file].inspect)
+        ui.fail_with(
+          "\n#{error_description(error)}\n#{error.backtrace.join("\n")}"
+        )
+      end
+
+      private def error_description(error)
+        [
+          error.class.name,
+          error.message
+        ].reject(&:empty?).join(" => ")
+      end
+
+      private def require_without_warnings(path)
+        old_verbose = $VERBOSE
+        $VERBOSE = nil
+
+        load path
+      ensure
+        $VERBOSE = old_verbose
+      end
     end
   end
 end

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

@@ -14,7 +14,7 @@ module I18nJS
         opts.on(
           "-cCONFIG_FILE",
           "--config=CONFIG_FILE",
-          "The configuration file that will be generated"
+          "The configuration file that will be used"
         ) do |config_file|
           options[:config_file] = config_file
         end
@@ -35,16 +35,15 @@ module I18nJS
       command do
         set_defaults!
 
-        ui.stdout_print("=> config file:", options[:config_file].inspect)
-        ui.stdout_print("=> require file:", options[:require_file].inspect)
-
         unless options[:config_file]
           ui.fail_with("=> ERROR: you need to specify the config file")
         end
 
+        ui.stdout_print("=> Config file:", options[:config_file].inspect)
         config_file = File.expand_path(options[:config_file])
 
         if options[:require_file]
+          ui.stdout_print("=> Require file:", options[:require_file].inspect)
           require_file = File.expand_path(options[:require_file])
         end
 
@@ -67,7 +66,7 @@ module I18nJS
           I18nJS.call(config_file: config_file)
         end
 
-        ui.stdout_print("=> done in #{time.round(2)}s")
+        ui.stdout_print("=> Done in #{time.round(2)}s")
       end
 
       private def set_defaults!
@@ -77,32 +76,6 @@ module I18nJS
         options[:config_file] ||= config_file if File.file?(config_file)
         options[:require_file] ||= require_file if File.file?(require_file)
       end
-
-      private def load_require_file!(require_file)
-        require_without_warnings(require_file)
-      rescue Exception => error # rubocop:disable Lint/RescueException
-        ui.stderr_print("=> ERROR: couldn't load",
-                        options[:require_file].inspect)
-        ui.fail_with(
-          "\n#{error_description(error)}\n#{error.backtrace.join("\n")}"
-        )
-      end
-
-      private def error_description(error)
-        [
-          error.class.name,
-          error.message
-        ].reject(&:empty?).join(" => ")
-      end
-
-      private def require_without_warnings(path)
-        old_verbose = $VERBOSE
-        $VERBOSE = nil
-
-        require path
-      ensure
-        $VERBOSE = old_verbose
-      end
     end
   end
 end

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

@@ -3,17 +3,21 @@
 module I18nJS
   class CLI
     class UI
-      def initialize(stdout:, stderr:)
+      attr_reader :stdout, :stderr
+      attr_accessor :colored
+
+      def initialize(stdout:, stderr:, colored: nil)
         @stdout = stdout
         @stderr = stderr
+        @colored = colored
       end
 
       def stdout_print(*message)
-        @stdout << "#{message.join(' ')}\n"
+        stdout << "#{message.join(' ')}\n"
       end
 
       def stderr_print(*message)
-        @stderr << "#{message.join(' ')}\n"
+        stderr << "#{message.join(' ')}\n"
       end
 
       def fail_with(*message)
@@ -25,6 +29,36 @@ module I18nJS
         stdout_print(message)
         exit(0)
       end
+
+      def yellow(text)
+        ansi(text, 33)
+      end
+
+      def red(text)
+        ansi(text, 31)
+      end
+
+      def colored?
+        colored_output = if colored.nil?
+                           stdout.tty?
+                         else
+                           colored
+                         end
+
+        colored_output && !no_color?
+      end
+
+      def ansi(text, code)
+        if colored?
+          "\e[#{code}m#{text}\e[0m"
+        else
+          text
+        end
+      end
+
+      def no_color?
+        !ENV["NO_COLOR"].nil? && ENV["NO_COLOR"] == "1"
+      end
     end
   end
 end

data/lib/i18n-js/cli.rb

@@ -6,14 +6,15 @@ require_relative "cli/ui"
 require_relative "cli/init_command"
 require_relative "cli/version_command"
 require_relative "cli/export_command"
+require_relative "cli/check_command"
 
 module I18nJS
   class CLI
     attr_reader :ui
 
-    def initialize(argv:, stdout:, stderr:)
+    def initialize(argv:, stdout:, stderr:, colored: stdout.tty?)
       @argv = argv.dup
-      @ui = UI.new(stdout: stdout, stderr: stderr)
+      @ui = UI.new(stdout: stdout, stderr: stderr, colored: colored)
     end
 
     def call
@@ -26,7 +27,7 @@ module I18nJS
     end
 
     private def command_classes
-      [InitCommand, ExportCommand, VersionCommand]
+      [InitCommand, ExportCommand, VersionCommand, CheckCommand]
     end
 
     private def commands

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.alpha3"
+  VERSION = "4.0.0"
 end

data/lib/i18n-js.rb

@@ -21,24 +21,31 @@ module I18nJS
 
     config = Glob::SymbolizeKeys.call(config || YAML.load_file(config_file))
     Schema.validate!(config)
+    exported_files = []
 
     config[:translations].each do |group|
-      export_group(group)
+      exported_files += export_group(group)
     end
+
+    exported_files
   end
 
   def self.export_group(group)
     filtered_translations = Glob.filter(translations, group[:patterns])
     output_file_path = File.expand_path(group[:file])
+    exported_files = []
 
     if output_file_path.include?(":locale")
       filtered_translations.each_key do |locale|
         locale_file_path = output_file_path.gsub(/:locale/, locale.to_s)
-        write_file(locale_file_path, locale => filtered_translations[locale])
+        exported_files << write_file(locale_file_path,
+                                     locale => filtered_translations[locale])
       end
     else
-      write_file(output_file_path, filtered_translations)
+      exported_files << write_file(output_file_path, filtered_translations)
     end
+
+    exported_files
   end
 
   def self.write_file(file_path, translations)
@@ -51,6 +58,8 @@ module I18nJS
     File.open(file_path, "w") do |file|
       file << contents
     end
+
+    file_path
   end
 
   def self.translations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha3
+  version: 4.0.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -178,11 +178,13 @@ files:
 - exe/i18n
 - i18n-js.gemspec
 - i18njs.png
+- images/i18njs-check.gif
 - lib/guard/i18n-js.rb
 - lib/guard/i18n-js/templates/Guardfile
 - lib/guard/i18n-js/version.rb
 - lib/i18n-js.rb
 - lib/i18n-js/cli.rb
+- lib/i18n-js/cli/check_command.rb
 - lib/i18n-js/cli/command.rb
 - lib/i18n-js/cli/export_command.rb
 - lib/i18n-js/cli/init_command.rb
@@ -198,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.alpha3
-  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/README.md
-  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/LICENSE.md
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -213,11 +215,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Export i18n translations and use them on JavaScript.