i18n-tasks 1.0.14 → 1.1.0

data/lib/i18n/tasks/cli.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks'
-require 'i18n/tasks/commands'
-require 'optparse'
+require "i18n/tasks"
+require "i18n/tasks/commands"
+require "optparse"
 
 class I18n::Tasks::CLI
   include ::I18n::Tasks::Logging
@@ -11,9 +11,9 @@ class I18n::Tasks::CLI
     new.start(argv)
   end
 
-  def initialize; end
-
   def start(argv)
+    load_dotenv
+
     auto_output_coloring do
       exit 1 if run(argv) == :exit1
     rescue OptionParser::ParseError => e
@@ -35,7 +35,7 @@ class I18n::Tasks::CLI
 
   def run(argv)
     argv.each_with_index do |arg, i|
-      next unless ['--config', '-c'].include?(arg)
+      next unless ["--config", "-c"].include?(arg)
 
       _, config_file = argv.slice!(i, 2)
       if File.exist?(config_file)
@@ -59,7 +59,7 @@ class I18n::Tasks::CLI
   def commands
     # load base task to initialize plugins
     base_task
-    @commands ||= ::I18n::Tasks::Commands.cmds.transform_keys { |k| k.to_s.tr('_', '-') }
+    @commands ||= ::I18n::Tasks::Commands.cmds.transform_keys { |k| k.to_s.tr("_", "-") }
   end
 
   private
@@ -72,7 +72,7 @@ class I18n::Tasks::CLI
     command = parse_command! argv
     options = optparse! command, argv
     parse_options! options, command, argv
-    [command.tr('-', '_'), options.update(arguments: argv)]
+    [command.tr("-", "_"), options.update(arguments: argv)]
   end
 
   def optparse!(command, argv)
@@ -85,8 +85,8 @@ class I18n::Tasks::CLI
 
   def optparse_command!(command, argv)
     cmd_conf = commands[command]
-    flags    = cmd_conf[:args].dup
-    options  = {}
+    flags = cmd_conf[:args].dup
+    options = {}
     OptionParser.new("Usage: #{program_name} #{command} [options] #{cmd_conf[:pos]}".strip) do |op|
       flags.each do |flag|
         op.on(*optparse_args(flag)) { |v| options[option_name(flag)] = v }
@@ -98,9 +98,9 @@ class I18n::Tasks::CLI
   end
 
   def optparse_no_command!(argv)
-    argv << '--help' if argv.empty?
+    argv << "--help" if argv.empty?
     OptionParser.new("Usage: #{program_name} [command] [options]") do |op|
-      op.on('-v', '--version', 'Print the version') do
+      op.on("-v", "--version", "Print the version") do
         puts I18n::Tasks::VERSION
         exit
       end
@@ -111,12 +111,12 @@ class I18n::Tasks::CLI
 
   def allow_help_arg_first!(argv)
     # allow `i18n-tasks --help command` in addition to `i18n-tasks command --help`
-    argv[0], argv[1] = argv[1], argv[0] if %w[-h --help].include?(argv[0]) && argv[1] && !argv[1].start_with?('-')
+    argv[0], argv[1] = argv[1], argv[0] if %w[-h --help].include?(argv[0]) && argv[1] && !argv[1].start_with?("-")
   end
 
   def parse_command!(argv)
     allow_help_arg_first! argv
-    if argv[0] && !argv[0].start_with?('-')
+    if argv[0] && !argv[0].start_with?("-")
       if commands.keys.include?(argv[0])
         argv.shift
       else
@@ -126,28 +126,28 @@ class I18n::Tasks::CLI
   end
 
   def verbose_option(op)
-    op.on('--verbose', 'Verbose output') do
+    op.on("--verbose", "Verbose output") do
       ::I18n::Tasks.verbose = true
     end
   end
 
   def help_option(op)
-    op.on('-h', '--help', 'Show this message') do
-      $stderr.puts op
+    op.on("-h", "--help", "Show this message") do
+      warn op
       exit
     end
   end
 
   # @param [OptionParser] op
   def commands_summary(op)
-    op.separator ''
-    op.separator 'Available commands:'
-    op.separator ''
+    op.separator ""
+    op.separator "Available commands:"
+    op.separator ""
     commands.each do |cmd, cmd_conf|
-      op.separator "    #{cmd.ljust(op.summary_width + 1, ' ')}#{try_call cmd_conf[:desc]}"
+      op.separator "    #{cmd.ljust(op.summary_width + 1, " ")}#{try_call cmd_conf[:desc]}"
     end
-    op.separator ''
-    op.separator 'See `i18n-tasks <command> --help` for more information on a specific command.'
+    op.separator ""
+    op.separator "See `i18n-tasks <command> --help` for more information on a specific command."
   end
 
   def optparse_args(flag)
@@ -155,14 +155,14 @@ class I18n::Tasks::CLI
     args.map! { |v| try_call v }
     conf = args.extract_options!
     if conf.key?(:default)
-      args[-1] = "#{args[-1]}. #{I18n.t('i18n_tasks.cmd.args.default_text', value: conf[:default])}"
+      args[-1] = "#{args[-1]}. #{I18n.t("i18n_tasks.cmd.args.default_text", value: conf[:default])}"
     end
     args
   end
 
   def parse_options!(options, command, argv)
     commands[command][:args].each do |flag|
-      name          = option_name flag
+      name = option_name flag
       options[name] = parse_option flag, options[name], argv, context
     end
   end
@@ -170,7 +170,7 @@ class I18n::Tasks::CLI
   def parse_option(flag, val, argv, context)
     conf = flag.last.is_a?(Hash) ? flag.last : {}
     if conf[:consume_positional]
-      val = Array(val) + Array(flag.include?(Array) ? argv.flat_map { |x| x.split(',') } : argv)
+      val = Array(val) + Array(flag.include?(Array) ? argv.flat_map { |x| x.split(",") } : argv)
     end
     val = conf[:default] if val.nil? && conf.key?(:default)
     val = conf[:parser].call(val, context) if conf.key?(:parser)
@@ -179,8 +179,8 @@ class I18n::Tasks::CLI
 
   def option_name(flag)
     flag.detect do |f|
-      f.start_with?('--')
-    end.sub(/\A--(\[no-\])?/, '').sub(/[^\-\w].*\z/, '').to_sym
+      f.start_with?("--")
+    end.sub(/\A--(\[no-\])?/, "").sub(/[^\-\w].*\z/, "").to_sym
   end
 
   def try_call(v)
@@ -205,11 +205,18 @@ class I18n::Tasks::CLI
     end
   end
 
-  def auto_output_coloring(coloring = ENV['I18N_TASKS_COLOR'] || $stdout.isatty)
-    coloring_was    = Rainbow.enabled
+  def auto_output_coloring(coloring = ENV["I18N_TASKS_COLOR"] || $stdout.isatty)
+    coloring_was = Rainbow.enabled
     Rainbow.enabled = coloring
     yield
   ensure
     Rainbow.enabled = coloring_was
   end
+
+  def load_dotenv
+    require "dotenv"
+    Dotenv.load
+  rescue LoadError
+    # dotenv not available, continue without it
+  end
 end

data/lib/i18n/tasks/command/collection.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/command/dsl'
-require 'i18n/tasks/command/options/common'
-require 'i18n/tasks/command/options/locales'
-require 'i18n/tasks/command/options/data'
+require "i18n/tasks/command/dsl"
+require "i18n/tasks/command/options/common"
+require "i18n/tasks/command/options/locales"
+require "i18n/tasks/command/options/data"
 
 module I18n::Tasks
   module Command

data/lib/i18n/tasks/command/commander.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'i18n/tasks/cli'
-require 'i18n/tasks/reports/terminal'
+require "i18n/tasks/cli"
+require "i18n/tasks/reports/terminal"
 
 module I18n::Tasks
   module Command
@@ -16,10 +16,10 @@ module I18n::Tasks
       end
 
       def run(name, opts = {})
-        log_stderr "#{Rainbow('#StandWith').bg(:blue)}#{Rainbow('Ukraine').bg(:yellow)}"
+        log_stderr "#{Rainbow("#StandWith").bg(:blue)}#{Rainbow("Ukraine").bg(:yellow)}"
         name = name.to_sym
-        public_name = name.to_s.tr '_', '-'
-        log_verbose "task: #{public_name}(#{opts.map { |k, v| "#{k}: #{v.inspect}" } * ', '})"
+        public_name = name.to_s.tr "_", "-"
+        log_verbose "task: #{public_name}(#{opts.map { |k, v| "#{k}: #{v.inspect}" } * ", "})"
         if opts.empty? || method(name).arity.zero?
           send name
         else

data/lib/i18n/tasks/command/commands/check_prism.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module I18n::Tasks
+  module Command
+    module Commands
+      module CheckPrism
+        include Command::Collection
+
+        arg :prism_mode,
+          "--prism_mode MODE",
+          "Prism parser mode: 'rails' or 'ruby'. Defaults to 'rails' if Rails is available in the project, otherwise 'ruby'."
+
+        cmd :check_prism,
+          desc: t("i18n_tasks.cmd.desc.check_prism"),
+          args: %i[prism_mode]
+
+        # Run both the default (Parser-based) and the Prism-enabled scanning
+        # and produce a plain-text report in tmp/i18n_tasks_check_prism.md suitable
+        # for pasting into an issue.
+        def check_prism(opt = {})
+          now = Time.now
+          report_path = File.join(Dir.pwd, "tmp", "i18n_tasks_check_prism.md")
+          FileUtils.mkdir_p(File.dirname(report_path))
+
+          # keep original search config and clear caches helper
+          orig_search = (i18n.config[:search] || {}).dup
+
+          results = {}
+
+          # determine prism mode: use provided opt or default to rails when Rails present
+          chosen_prism_mode = (opt[:prism_mode].presence || (rails_available? ? "rails" : "ruby")).to_s
+          unless %w[rails ruby].include?(chosen_prism_mode)
+            fail CommandError, "--prism-mode must be 'rails' or 'ruby'"
+          end
+
+          {default: nil, prism: chosen_prism_mode}.each do |label, prism_mode|
+            i18n.config[:search] = orig_search.merge(prism: prism_mode)
+            # clear caches used by UsedKeys
+            i18n.instance_variable_set(:@scanner, nil)
+            i18n.instance_variable_set(:@search_config, nil)
+            i18n.instance_variable_set(:@keys_used_in_source_tree, nil)
+
+            tree = i18n.used_in_source_tree
+            keys = tree.nodes.select { |n| n.data[:occurrences].present? }
+            results[label] = keys.each_with_object({}) do |node, h|
+              full_key = node.full_key(root: false)
+              h[full_key] = node.data[:occurrences]
+            end
+          end
+
+          # restore original config and caches
+          i18n.config[:search] = orig_search
+          i18n.instance_variable_set(:@scanner, nil)
+          i18n.instance_variable_set(:@search_config, nil)
+          i18n.instance_variable_set(:@keys_used_in_source_tree, nil)
+
+          default_keys = results[:default].keys
+          prism_keys = results[:prism].keys
+
+          only_default = (default_keys - prism_keys).sort
+          only_prism = (prism_keys - default_keys).sort
+          both = (default_keys & prism_keys).sort
+
+          File.open(report_path, "w") do |f|
+            f.puts "# i18n-tasks check_prism report"
+            f.puts "Generated at: #{now.utc}"
+            f.puts "Prism mode: #{chosen_prism_mode}"
+            f.puts "Gem version: #{I18n::Tasks::VERSION}"
+            f.puts ""
+            f.puts "Summary"
+            f.puts "- total keys (default parser): #{default_keys.size}"
+            f.puts "- total keys (prism): #{prism_keys.size}"
+            f.puts "- keys in both: #{both.size}"
+            f.puts "- keys only in default parser: #{only_default.size}"
+            f.puts "- keys only in prism: #{only_prism.size}"
+            f.puts ""
+
+            unless only_default.empty?
+              f.puts "## Keys found by the default parser but NOT by Prism (#{only_default.size})"
+              only_default.each do |k|
+                f.puts "\n### #{k}"
+                results[:default][k].first(5).each do |occ|
+                  src = (occ.raw_key || k).to_s
+                  line = (occ.line || "").strip
+                  highlighted = line.gsub(src) { |m| "`#{m}`" }
+                  f.puts "- #{occ.path}:#{occ.line_num} `#{src}` — #{highlighted}"
+                end
+              end
+            end
+
+            unless only_prism.empty?
+              f.puts "## Keys found by Prism but NOT by the default parser (#{only_prism.size})"
+              only_prism.each do |k|
+                f.puts "\n### #{k}"
+                results[:prism][k].each do |occ|
+                  src = (occ.raw_key || k).to_s
+                  line = (occ.line || "").strip
+                  highlighted = line.gsub(src) { |m| "`#{m}`" }
+                  f.puts "- #{occ.path}:#{occ.line_num} `#{src}` — #{highlighted}"
+                end
+              end
+            end
+
+            f.puts "\n## Notes"
+            f.puts "- This report compares keys discovered by the project default parser and by Prism (rails mode)."
+          end
+
+          log_stderr "Wrote check_prism report: #{report_path}"
+          puts File.read(report_path)
+        end
+
+        private
+
+        def rails_available?
+          return true if defined?(Rails)
+          return true if Gem.loaded_specs.key?("rails")
+          lock = File.join(Dir.pwd, "Gemfile.lock")
+          return false unless File.exist?(lock)
+          File.read(lock).lines.any? { |l| l.strip.start_with?("rails ") || l.strip =~ /^rails \(/ }
+        rescue
+          false
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/command/commands/data.rb

@@ -7,24 +7,24 @@ module I18n::Tasks
         include Command::Collection
 
         arg :pattern_router,
-            '-p',
-            '--pattern_router',
-            t('i18n_tasks.cmd.args.desc.pattern_router')
+          "-p",
+          "--pattern_router",
+          t("i18n_tasks.cmd.args.desc.pattern_router")
 
         cmd :normalize,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.normalize'),
-            args: %i[locales pattern_router]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.normalize"),
+          args: %i[locales pattern_router]
 
         def normalize(opt = {})
           i18n.normalize_store! locales: opt[:locales],
-                                force_pattern_router: opt[:pattern_router]
+            force_pattern_router: opt[:pattern_router]
         end
 
         cmd :check_normalized,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.check_normalized'),
-            args: %i[locales]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.check_normalized"),
+          args: %i[locales]
 
         def check_normalized(opt)
           non_normalized = i18n.non_normalized_paths locales: opt[:locales]
@@ -33,10 +33,10 @@ module I18n::Tasks
         end
 
         cmd :mv,
-            pos: 'FROM_KEY_PATTERN TO_KEY_PATTERN',
-            desc: t('i18n_tasks.cmd.desc.mv')
+          pos: "FROM_KEY_PATTERN TO_KEY_PATTERN",
+          desc: t("i18n_tasks.cmd.desc.mv")
         def mv(opt = {})
-          fail CommandError, 'requires FROM_KEY_PATTERN and TO_KEY_PATTERN' if opt[:arguments].size < 2
+          fail CommandError, "requires FROM_KEY_PATTERN and TO_KEY_PATTERN" if opt[:arguments].size < 2
 
           from_pattern = opt[:arguments].shift
           to_pattern = opt[:arguments].shift
@@ -47,10 +47,10 @@ module I18n::Tasks
         end
 
         cmd :cp,
-            pos: 'FROM_KEY_PATTERN TO_KEY_PATTERN',
-            desc: t('i18n_tasks.cmd.desc.cp')
+          pos: "FROM_KEY_PATTERN TO_KEY_PATTERN",
+          desc: t("i18n_tasks.cmd.desc.cp")
         def cp(opt = {})
-          fail CommandError, 'requires FROM_KEY_PATTERN and TO_KEY_PATTERN' if opt[:arguments].size < 2
+          fail CommandError, "requires FROM_KEY_PATTERN and TO_KEY_PATTERN" if opt[:arguments].size < 2
 
           from_pattern = opt[:arguments].shift
           to_pattern = opt[:arguments].shift
@@ -61,32 +61,32 @@ module I18n::Tasks
         end
 
         cmd :rm,
-            pos: 'KEY_PATTERN [KEY_PATTERN...]',
-            desc: t('i18n_tasks.cmd.desc.rm')
+          pos: "KEY_PATTERN [KEY_PATTERN...]",
+          desc: t("i18n_tasks.cmd.desc.rm")
         def rm(opt = {})
-          fail CommandError, 'requires KEY_PATTERN' if opt[:arguments].empty?
+          fail CommandError, "requires KEY_PATTERN" if opt[:arguments].empty?
 
           forest = i18n.data_forest
           results = opt[:arguments].each_with_object({}) do |key_pattern, h|
-            h.merge! forest.mv_key!(compile_key_pattern(key_pattern), '', root: false)
+            h.merge! forest.mv_key!(compile_key_pattern(key_pattern), "", root: false)
           end
           i18n.data.write forest
           terminal_report.mv_results results
         end
 
         cmd :data,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.data'),
-            args: %i[locales out_format]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.data"),
+          args: %i[locales out_format]
 
         def data(opt = {})
           print_forest i18n.data_forest(opt[:locales]), opt
         end
 
         cmd :data_merge,
-            pos: '[tree ...]',
-            desc: t('i18n_tasks.cmd.desc.data_merge'),
-            args: %i[data_format nostdin]
+          pos: "[tree ...]",
+          desc: t("i18n_tasks.cmd.desc.data_merge"),
+          args: %i[data_format nostdin]
 
         def data_merge(opt = {})
           forest = merge_forests_stdin_and_pos!(opt)
@@ -95,9 +95,9 @@ module I18n::Tasks
         end
 
         cmd :data_write,
-            pos: '[tree]',
-            desc: t('i18n_tasks.cmd.desc.data_write'),
-            args: %i[data_format nostdin]
+          pos: "[tree]",
+          desc: t("i18n_tasks.cmd.desc.data_write"),
+          args: %i[data_format nostdin]
 
         def data_write(opt = {})
           forest = forest_pos_or_stdin!(opt)
@@ -106,13 +106,13 @@ module I18n::Tasks
         end
 
         cmd :data_remove,
-            pos: '[tree]',
-            desc: t('i18n_tasks.cmd.desc.data_remove'),
-            args: %i[data_format nostdin]
+          pos: "[tree]",
+          desc: t("i18n_tasks.cmd.desc.data_remove"),
+          args: %i[data_format nostdin]
 
         def data_remove(opt = {})
           removed = i18n.data.remove_by_key!(forest_pos_or_stdin!(opt))
-          log_stderr 'Removed:'
+          log_stderr "Removed:"
           print_forest removed, opt
         end
       end

data/lib/i18n/tasks/command/commands/eq_base.rb

@@ -7,9 +7,9 @@ module I18n::Tasks
         include Command::Collection
 
         cmd :eq_base,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.eq_base'),
-            args: %i[locales out_format]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.eq_base"),
+          args: %i[locales out_format]
 
         def eq_base(opt = {})
           forest = i18n.eq_base_keys(opt)

data/lib/i18n/tasks/command/commands/health.rb

@@ -7,20 +7,21 @@ module I18n::Tasks
         include Command::Collection
 
         cmd :health,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.health'),
-            args: %i[locales out_format config]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.health"),
+          args: %i[locales out_format config]
 
         def health(opt = {})
           forest = i18n.data_forest(opt[:locales])
-          stats  = i18n.forest_stats(forest)
-          fail CommandError, t('i18n_tasks.health.no_keys_detected') if stats[:key_count].zero?
+          stats = i18n.forest_stats(forest)
+          fail CommandError, t("i18n_tasks.health.no_keys_detected") if stats[:key_count].zero?
 
           terminal_report.forest_stats forest, stats
           [
             missing(**opt),
             unused(**opt),
             check_consistent_interpolations(**opt),
+            check_reserved_interpolations(**opt),
             check_normalized(**opt)
           ].detect { |result| result == :exit1 }
         end

data/lib/i18n/tasks/command/commands/interpolations.rb

@@ -7,15 +7,26 @@ module I18n::Tasks
         include Command::Collection
 
         cmd :check_consistent_interpolations,
-            pos: '[locale ...]',
-            desc: t('i18n_tasks.cmd.desc.check_consistent_interpolations'),
-            args: %i[locales out_format]
+          pos: "[locale ...]",
+          desc: t("i18n_tasks.cmd.desc.check_consistent_interpolations"),
+          args: %i[locales out_format]
 
         def check_consistent_interpolations(opt = {})
           forest = i18n.inconsistent_interpolations(**opt.slice(:locales, :base_locale))
           print_forest forest, opt, :inconsistent_interpolations
           :exit1 unless forest.empty?
         end
+
+        cmd :check_reserved_interpolations,
+          pos: "[locale]",
+          desc: t("i18n_tasks.cmd.desc.check_reserved_interpolations"),
+          args: %i[locales out_format]
+
+        def check_reserved_interpolations(opt = {})
+          forest = i18n.reserved_interpolations(**opt.slice(:locale))
+          print_forest forest, opt, :reserved_interpolations
+          :exit1 unless forest.empty?
+        end
       end
     end
   end

data/lib/i18n/tasks/command/commands/meta.rb

@@ -7,28 +7,28 @@ module I18n::Tasks
         include Command::Collection
 
         cmd :config,
-            pos: '[section ...]',
-            desc: t('i18n_tasks.cmd.desc.config')
+          pos: "[section ...]",
+          desc: t("i18n_tasks.cmd.desc.config")
 
         def config(opts = {})
           cfg = i18n.config_for_inspect
           cfg = cfg.slice(*opts[:arguments]) if opts[:arguments].present?
           cfg = cfg.to_yaml
-          cfg.sub!(/\A---\n/, '')
+          cfg.sub!(/\A---\n/, "")
           cfg.gsub!(/^([^\s-].+?:)/, Rainbow('\1').cyan.bright)
           puts cfg
         end
 
-        cmd :gem_path, desc: t('i18n_tasks.cmd.desc.gem_path')
+        cmd :gem_path, desc: t("i18n_tasks.cmd.desc.gem_path")
 
         def gem_path
           puts I18n::Tasks.gem_path
         end
 
-        cmd :irb, desc: t('i18n_tasks.cmd.desc.irb')
+        cmd :irb, desc: t("i18n_tasks.cmd.desc.irb")
 
         def irb
-          require 'i18n/tasks/console_context'
+          require "i18n/tasks/console_context"
           ::I18n::Tasks::ConsoleContext.start
         end
       end