i18n-js 4.0.1 → 4.1.0

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

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class PluginsCommand < Command
+      command_name "plugins"
+      description "List plugins that will be activated"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name} [options]"
+
+        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("-h", "--help", "Prints this help") do
+          ui.exit_with opts.to_s
+        end
+      end
+
+      command do
+        set_defaults!
+        ui.colored = options[:colored]
+
+        if options[:require_file]
+          ui.stdout_print("=> Require file:", options[:require_file].inspect)
+          require_file = File.expand_path(options[:require_file])
+        end
+
+        if require_file && !File.file?(require_file)
+          ui.fail_with(
+            "=> ERROR: require file doesn't exist at",
+            require_file.inspect
+          )
+        end
+
+        load_require_file!(require_file) if require_file
+
+        files = I18nJS.plugin_files
+
+        if files.empty?
+          ui.stdout_print("=> No plugins have been detected.")
+        else
+          ui.stdout_print("=> Plugins that will be activated:")
+
+          files.each do |file|
+            file = file.gsub("#{Dir.home}/", "~/")
+
+            ui.stdout_print("   * #{file}")
+          end
+        end
+      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.rb

@@ -6,6 +6,9 @@ require_relative "cli/ui"
 require_relative "cli/init_command"
 require_relative "cli/version_command"
 require_relative "cli/export_command"
+require_relative "cli/plugins_command"
+require_relative "cli/lint_translations_command"
+require_relative "cli/lint_scripts_command"
 require_relative "cli/check_command"
 
 module I18nJS
@@ -27,7 +30,15 @@ module I18nJS
     end
 
     private def command_classes
-      [InitCommand, ExportCommand, VersionCommand, CheckCommand]
+      [
+        InitCommand,
+        ExportCommand,
+        VersionCommand,
+        PluginsCommand,
+        LintTranslationsCommand,
+        LintScriptsCommand,
+        CheckCommand
+      ]
     end
 
     private def commands

data/lib/i18n-js/embed_fallback_translations_plugin.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module I18nJS
+  require "i18n-js/plugin"
+
+  class EmbedFallbackTranslationsPlugin < I18nJS::Plugin
+    CONFIG_KEY = :embed_fallback_translations
+
+    # 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 self.setup
+      I18nJS::Schema.root_keys << CONFIG_KEY
+    end
+
+    # 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`.
+    def self.validate_schema(config:)
+      return unless config.key?(CONFIG_KEY)
+
+      plugin_config = config[CONFIG_KEY]
+      valid_keys = %i[enabled]
+      schema = I18nJS::Schema.new(config)
+
+      schema.expect_required_keys(valid_keys, plugin_config)
+      schema.reject_extraneous_keys(valid_keys, plugin_config)
+      schema.expect_enabled_config(CONFIG_KEY, plugin_config[:enabled])
+    end
+
+    # 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`.
+    #
+    # Make sure you always check whether your plugin is active before
+    # transforming translations; otherwise, opting out transformation won't be
+    # possible.
+    def self.transform(translations:, config:)
+      return translations unless config.dig(CONFIG_KEY, :enabled)
+
+      translations_glob = Glob.new(translations)
+      translations_glob << "*"
+
+      mapping = translations.keys.each_with_object({}) do |locale, buffer|
+        buffer[locale] = Glob.new(translations[locale]).tap do |glob|
+          glob << "*"
+        end
+      end
+
+      default_locale = I18n.default_locale
+      default_locale_glob = mapping.delete(default_locale)
+      default_locale_paths = default_locale_glob.paths
+
+      mapping.each do |locale, glob|
+        missing_keys = default_locale_paths - glob.paths
+
+        missing_keys.each do |key|
+          components = key.split(".").map(&:to_sym)
+          fallback_translation = translations.dig(default_locale, *components)
+
+          next unless fallback_translation
+
+          translations_glob.set([locale, key].join("."), fallback_translation)
+        end
+      end
+
+      translations_glob.to_h
+    end
+  end
+
+  I18nJS.register_plugin(EmbedFallbackTranslationsPlugin)
+end