i18n-js 4.0.0 → 4.1.0

data/bin/pack

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require_relative "../lib/i18n-js/version"
+
+def write_file(path, contents)
+  File.open(File.expand_path(path), "w") do |io|
+    io << contents
+  end
+end
+
+changelog_path = "./CHANGELOG.md"
+version_path = "./lib/i18n-js/version.rb"
+
+version = nil
+segments = I18nJS::VERSION.split(".")
+major, minor, patch = *segments.take(3).map(&:to_i)
+pre = segments[4].to_s
+pre_version = pre.gsub(/[^\d]/m, "").to_i
+date = Time.now.strftime("%b %d, %Y")
+release = false
+alpha = false
+
+OptionParser.new do |opts|
+  opts.on("--major") do
+    version = "#{major + 1}.0.0"
+  end
+
+  opts.on("--minor") do
+    version = "#{major}.#{minor + 1}.0"
+  end
+
+  opts.on("--patch") do
+    version = "#{major}.#{minor}.#{patch + 1}"
+  end
+
+  opts.on("--alpha") do
+    alpha = true
+  end
+
+  opts.on("--release") do
+    release = true
+  end
+end.parse!
+
+version = "#{version}.alpha#{pre_version + 1}" if alpha
+
+unless version
+  puts "ERROR: You need to use either one of: --major, --minor, --patch"
+  exit 1
+end
+
+puts "=> Current version: #{I18nJS::VERSION}"
+puts "=> Next version: #{version}"
+
+system "yarn", "install"
+system "yarn", "compile"
+
+write_file changelog_path,
+           File.read(changelog_path)
+               .gsub("Unreleased", "v#{version} - #{date}")
+
+puts "=> Updated #{changelog_path}"
+
+write_file version_path,
+           File.read(version_path)
+               .gsub(/VERSION = ".*?"/, %[VERSION = "#{version}"])
+
+puts "=> Updated #{version_path}"
+
+if release
+  system "git", "add", changelog_path, version_path
+  system "git", "commit", "-m", "Bump up version (v#{version})"
+  system "git", "tag", "v#{version}"
+end
+
+system "rake", "build"
+system "git", "checkout", changelog_path, version_path unless release

data/i18n-js.gemspec

@@ -28,19 +28,22 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`
       .split("\x0")
-      .reject {|f| f.match(%r{^(test|spec|features)/}) }
+      .reject {|f| f.match(%r{^(test|spec|features|images)/}) }
   end
 
+  spec.files << "lib/i18n-js/lint.js"
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "glob"
+  spec.add_dependency "glob", ">= 0.4.0"
   spec.add_dependency "i18n"
 
   spec.add_development_dependency "activesupport"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "pry-meta"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"

data/lib/guard/i18n-js.rb

@@ -53,13 +53,30 @@ module Guard
       info("Changes detected: #{changes.join(', ')}") if changes
 
       @current_thread = Thread.new do
-        require @require_file
-        ::I18nJS.call(config_file: @config_file)
+        capture do
+          system "i18n",
+                 "export",
+                 "--config",
+                 config_file.to_s,
+                 "--require",
+                 require_file.to_s,
+                 "--quiet"
+        end
       end
 
       current_thread.join
     end
 
+    def capture
+      original = $stdout
+      $stdout = StringIO.new
+      yield
+    rescue StandardError
+      # noop
+    ensure
+      $stdout = original
+    end
+
     def validate_file(key, file)
       return true if file && File.file?(file)
 
@@ -68,11 +85,11 @@ module Guard
     end
 
     def error(message)
-      ::Guard::UI.error "[guard-i18n-js] #{message}"
+      ::Guard::UI.error "[i18n-js] #{message}"
     end
 
     def info(message)
-      ::Guard::UI.info "[guard-i18n-js] #{message}"
+      ::Guard::UI.info "[i18n-js] #{message}"
     end
   end
 end

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

@@ -1,156 +1,16 @@
 # frozen_string_literal: true
 
-require "benchmark"
-
 module I18nJS
   class CLI
-    class CheckCommand < Command
+    class CheckCommand < LintTranslationsCommand
       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"
+      description "Check for missing translations based on the default " \
+                  "locale (DEPRECATED: Use `i18n lint:translations` instead)"
 
-        options[:config_file] ||= config_file if File.file?(config_file)
-        options[:require_file] ||= require_file if File.file?(require_file)
+      def command
+        ui.stderr_print "=> WARNING: `i18n check` has been deprecated in " \
+                        "favor of `i18n lint:translations`"
+        super
       end
     end
   end

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

@@ -39,6 +39,16 @@ module I18nJS
         @options ||= {}
       end
 
+      private def load_config_file(config_file)
+        config = Glob::SymbolizeKeys.call(YAML.load_file(config_file))
+
+        if config.key?(:check)
+          config[:lint_translations] ||= config.delete(:check)
+        end
+
+        config
+      end
+
       private def load_require_file!(require_file)
         require_without_warnings(require_file)
       rescue Exception => error # rubocop:disable Lint/RescueException

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

@@ -27,6 +27,14 @@ module I18nJS
           options[:require_file] = require_file
         end
 
+        opts.on(
+          "-q",
+          "--quiet",
+          "A Ruby file that must be loaded"
+        ) do |quiet|
+          options[:quiet] = quiet
+        end
+
         opts.on("-h", "--help", "Prints this help") do
           ui.exit_with opts.to_s
         end
@@ -39,11 +47,11 @@ module I18nJS
           ui.fail_with("=> ERROR: you need to specify the config file")
         end
 
-        ui.stdout_print("=> Config file:", options[:config_file].inspect)
+        log("=> 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)
+          log("=> Require file:", options[:require_file].inspect)
           require_file = File.expand_path(options[:require_file])
         end
 
@@ -66,7 +74,13 @@ module I18nJS
           I18nJS.call(config_file: config_file)
         end
 
-        ui.stdout_print("=> Done in #{time.round(2)}s")
+        log("=> Done in #{time.round(2)}s")
+      end
+
+      private def log(*args)
+        return if options[:quiet]
+
+        ui.stdout_print(*args)
       end
 
       private def set_defaults!

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

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class LintScriptsCommand < Command
+      command_name "lint:scripts"
+      description "Lint files using TypeScript"
+
+      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(
+          "-nNODE_PATH",
+          "--node-path=NODE_PATH",
+          "Set node.js path"
+        ) do |node_path|
+          options[:node_path] = node_path
+        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
+
+        node_path = options[:node_path] || find_node
+        ui.stdout_print("=> Node:", node_path.inspect)
+
+        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
+
+        found_node = node_path && File.executable?(File.expand_path(node_path))
+
+        unless found_node
+          ui.fail_with(
+            "=> ERROR: node.js couldn't be found (path: #{node_path})"
+          )
+        end
+
+        config = load_config_file(config_file)
+        Schema.validate!(config)
+
+        load_require_file!(require_file) if require_file
+
+        available_locales = I18n.available_locales
+        ignored_keys = config.dig(:lint_scripts, :ignore) || []
+
+        ui.stdout_print "=> Available locales: #{available_locales.inspect}"
+
+        exported_files = I18nJS.call(config_file: config_file)
+        data = exported_files.each_with_object({}) do |file, buffer|
+          buffer.merge!(JSON.load_file(file, symbolize_names: true))
+        end
+
+        lint_file = File.expand_path(File.join(__dir__, "../lint.js"))
+        patterns = config.dig(:lint_scripts, :patterns) || %w[
+          !(node_modules)/**/*.js
+          !(node_modules)/**/*.ts
+          !(node_modules)/**/*.jsx
+          !(node_modules)/**/*.tsx
+        ]
+
+        ui.stdout_print "=> Patterns: #{patterns.inspect}"
+
+        out = IO.popen([node_path, lint_file, patterns.join(":")]).read
+        scopes = JSON.parse(out, symbolize_names: true)
+        map = Glob::Map.call(data)
+        missing_count = 0
+        ignored_count = 0
+
+        messages = []
+
+        available_locales.each do |locale|
+          scopes.each do |scope|
+            scope_with_locale = "#{locale}.#{scope[:full]}"
+
+            ignored = ignored_keys.include?(scope[:full]) ||
+                      ignored_keys.include?(scope_with_locale)
+
+            if ignored
+              ignored_count += 1
+              next
+            end
+
+            next if map.include?(scope_with_locale)
+
+            missing_count += 1
+            messages << "   - #{scope[:location]}: #{scope_with_locale}"
+          end
+        end
+
+        ui.stdout_print "=> #{map.size} translations, #{missing_count} " \
+                        "missing, #{ignored_count} ignored"
+        ui.stdout_print messages.sort.join("\n")
+
+        exit(missing_count.size)
+      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
+
+      private def find_node
+        ENV["PATH"]
+          .split(File::PATH_SEPARATOR)
+          .map {|dir| File.join(dir, "node") }
+          .find {|bin| File.executable?(bin) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class LintTranslationsCommand < Command
+      command_name "lint:translations"
+      description "Check for missing translations based on the default locale"
+
+      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 = load_config_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(:lint_translations, :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