i18n-linter-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8be824b04d9dc87841bb4a53ded28fdc99c745db2b5ec0473aefb3feb0903430
+  data.tar.gz: 7cc5a3f6398b114022e1c103f639642c9200dbfda01e61e1b0e13671e675faa0
+SHA512:
+  metadata.gz: 66b748b2fcdb6d546c0678fccc86dec7e5d9316c6f4ced5c3bd0edf3c511363988971648be72e40b3d56668b45e5b32bdf3f1197a90fd23c4860dac6355d2ca2
+  data.tar.gz: 9b7963b6f8c53d4e372831455ca52bcc8ac2ebb4ab8d9305a72be8e5df97a60e7db81b5d23f7650f2638b630721c2b3211d16aae1011320e8261a203b9015fa4

data/exe/i18n-linter-rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "i18n_linter_rb"
+
+I18nLinterRb.lint(ARGV)

data/lib/i18n_linter_rb/cli.rb

@@ -0,0 +1,116 @@
+require "optparse"
+require "i18n_linter_rb/linter"
+
+module I18nLinterRb
+  class Cli
+    DEFAULT_LOCALES_PATH = "config/locales".freeze
+    DEFAULT_SOURCE_LOCALE = "en".freeze
+    DEFAULT_TARGET_LOCALES = %w[es].freeze
+
+    USAGE_GUIDE = <<~GUIDE
+
+      No locales directory found.
+
+      i18n-linter-rb looks for a Rails locales directory by default:
+        config/locales/
+
+      If your translations live somewhere else, pass the path explicitly:
+
+        i18n-linter-rb --path path/to/locales
+        i18n-linter-rb --path path/to/locales --from en --to es fr pt
+
+      You can also create an .i18n_linter.yml file in your project root:
+
+        locales_path: path/to/locales
+        source_locale: en
+        target_locales: [es, fr]
+
+    GUIDE
+
+    def initialize(argv)
+      @argv = argv
+      @options = {}
+    end
+
+    def run
+      parse_options
+      resolve_locales_path
+
+      source_path = File.join(@locales_path, "#{@options[:from]}.yml")
+      missing = {}
+
+      @options[:to].each do |target_locale|
+        target_path = File.join(@locales_path, "#{target_locale}.yml")
+        linter = Linter.new(source_locale: @options[:from], target_locale: target_locale)
+        keys = linter.missing_keys_in_target(source_path, target_path)
+        missing[target_locale] = keys unless keys.empty?
+      end
+
+      report(missing)
+    end
+
+    private
+
+    def parse_options
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: i18n-linter-rb [options]"
+
+        opts.on("-p", "--path PATH", "Locales directory (default: #{DEFAULT_LOCALES_PATH})") do |path|
+          @options[:path] = path
+        end
+
+        opts.on("-f", "--from LOCALE", "Source locale (default: #{DEFAULT_SOURCE_LOCALE})") do |locale|
+          @options[:from] = locale
+        end
+
+        opts.on("-t", "--to LOCALES x,y,z", Array, "Target locales (default: #{DEFAULT_TARGET_LOCALES.join(',')})") do |locales|
+          @options[:to] = locales
+        end
+
+        opts.on("-v", "--version", "Show version") do
+          puts I18nLinterRb::VERSION
+          exit
+        end
+
+        opts.on("-h", "--help", "Show this help") do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!(@argv)
+      @options[:from] ||= load_config["source_locale"] || DEFAULT_SOURCE_LOCALE
+      @options[:to] ||= load_config["target_locales"] || DEFAULT_TARGET_LOCALES
+    end
+
+    def resolve_locales_path
+      @locales_path = @options[:path] || load_config["locales_path"] || DEFAULT_LOCALES_PATH
+
+      unless File.directory?(@locales_path)
+        abort(USAGE_GUIDE)
+      end
+    end
+
+    def load_config
+      @load_config ||= begin
+        config_path = ".i18n_linter.yml"
+        File.exist?(config_path) ? YAML.load_file(config_path) : {}
+      rescue Psych::SyntaxError => e
+        warn("Invalid .i18n_linter.yml: #{e.message}")
+        {}
+      end
+    end
+
+    def report(missing)
+      if missing.empty?
+        puts "All translations are complete."
+      else
+        missing.each do |locale, keys|
+          puts "Missing keys in #{locale}.yml:"
+          keys.each { |key| puts "  - #{key}" }
+        end
+        exit 1
+      end
+    end
+  end
+end

data/lib/i18n_linter_rb/linter.rb

@@ -0,0 +1,44 @@
+require "yaml"
+
+module I18nLinterRb
+  class Linter
+    attr_reader :source_locale, :target_locale
+
+    def initialize(source_locale:, target_locale:)
+      @source_locale = source_locale
+      @target_locale = target_locale
+    end
+
+    def missing_keys_in_target(source_path, target_path)
+      source_keys = locale_keys(source_path)
+      target_keys = locale_keys(target_path)
+
+      source_keys - target_keys
+    end
+
+    private
+
+    def locale_keys(path)
+      data = YAML.load_file(path)
+      flatten_hash(root_data(data)).keys
+    end
+
+    def root_data(data)
+      data.values.first || {}
+    end
+
+    def flatten_hash(hash, prefix = "")
+      result = {}
+
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          result.merge!(flatten_hash(value, "#{prefix}#{key}."))
+        else
+          result["#{prefix}#{key}"] = value
+        end
+      end
+
+      result
+    end
+  end
+end

data/lib/i18n_linter_rb/version.rb

@@ -0,0 +1,3 @@
+module I18nLinterRb
+  VERSION = "0.1.0".freeze
+end

data/lib/i18n_linter_rb.rb

@@ -0,0 +1,9 @@
+require "i18n_linter_rb/version"
+require "i18n_linter_rb/linter"
+require "i18n_linter_rb/cli"
+
+module I18nLinterRb
+  def self.lint(argv = ARGV)
+    Cli.new(argv).run
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: i18n-linter-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MarceloM47
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Detects missing translation keys across locale files. Works out of the
+  box with Rails config/locales and supports custom paths.
+email:
+executables:
+- i18n-linter-rb
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/i18n-linter-rb
+- lib/i18n_linter_rb.rb
+- lib/i18n_linter_rb/cli.rb
+- lib/i18n_linter_rb/linter.rb
+- lib/i18n_linter_rb/version.rb
+homepage: https://github.com/marcelom47/i18n-linter-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marcelom47/i18n-linter-rb
+  source_code_uri: https://github.com/marcelom47/i18n-linter-rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Linter for YAML i18n locale files, built for Ruby and Rails projects
+test_files: []