i18nlint 1.0.0

data/lib/i18nlint/yaml_with_lines.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+module I18nLint
+  # Parse YAML such that every value is a ValueWithLineNumbers.
+  class YamlWithLines
+    ValueWithLineNumbers = Struct.new(:value, :lines)
+
+    class << self
+      def dupe_segments_by_file = @dupe_segments_by_file ||= Hash.new { |h, k| h[k] = {} }
+
+      # I18n, up to 1.14 as of writing, always unsafe-loads YAML because it should be from devs, not user-supplied. This
+      # is why we don't bother defining `safe_load` methods here. If any NoMethodError exceptions are being raised for a
+      # `safe_load*` method being called, please look into the version of I18n to see if it's changed, or if our
+      # patching-in of this class has a bug and is effecting other YAML-loading classes.
+
+      def unsafe_load(yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false, # rubocop:disable Metrics/ParameterLists
+                      strict_integer: false, parse_symbols: true)
+        result = parse(yaml, filename:)
+        return fallback unless result
+
+        Psych::Visitors::ToRubyWithLineNumbers.create(symbolize_names:, freeze:, strict_integer:, parse_symbols:)
+                                              .accept(result)[0]
+      end
+
+      # copy-paste from Psych.
+      def unsafe_load_file(filename, **kwargs)
+        ::File.open(filename, "r:bom|utf-8") do |f|
+          unsafe_load f, filename: filename, **kwargs
+        end
+      end
+
+      alias load_file unsafe_load_file # I18n relies on unsafe-loading, and < 1.8 relies on Psych defaulting to unsafe.
+
+      def parse(yaml, filename: nil)
+        handler = Psych::TreeWithLineNumbersBuilder.new
+        handler.parser = Psych::Parser.new(handler)
+        handler.parser.parse(yaml, filename:)
+        dupe_segments_by_file[filename] = handler.duplicate_segments
+        handler.root
+      end
+
+      def walk(val, key_parts = [], yield_hash_when: nil, &block)
+        case val
+        when ValueWithLineNumbers then yield key_parts, val.value, *first_last_lines(val)
+        when Hash
+          if yield_hash_when&.call(val)
+            yield key_parts, val.transform_values(&:value), *first_last_lines(val)
+          else
+            val.each { |each_key, each_val| walk(each_val, key_parts + [each_key], yield_hash_when:, &block) }
+          end
+        else yield key_parts, val
+        end
+      end
+
+      private
+
+      def first_last_lines(val)
+        case val
+        when ValueWithLineNumbers
+          [val.lines.first, val.lines.last]
+        when Hash
+          [val.values.first.lines.first, val.values.last.lines.last]
+        end
+      end
+    end
+  end
+end
+
+# Copied from https://gist.github.com/johncarney/7332f7b2075b86ea52177a4a82453806
+# I've edited it to apply line numbers to sequence values too, even though they're unlikely to be used in i18n.
+=begin # rubocop:disable Style/BlockComments
+Custom Psych parser that captures line number information from a YAML file.
+
+For a project I'm working on I need to be able to determine which line(s) in a YAML
+file a particular value comes from. There are a few bits of advice on the internet
+about this, the best of them that I've found involves monkey-patching, which is a
+fairly low bar for "best" in my opinion. I found it on Stack Overflow:
+
+  https://stackoverflow.com/questions/29462856/loading-yaml-with-line-number-for-each-key
+
+Here's my take without monkey-patching. It deals with values spanning multiple lines
+and handles YAML's << (insertion) operator, borrowing liberally from Psych's source code
+to do so.
+=end
+
+require "psych"
+
+class Psych::Nodes::ScalarWithLineNumber < Psych::Nodes::Scalar # rubocop:disable Style/Documentation,Style/ClassAndModuleChildren
+  attr_reader :line_number
+
+  def initialize(*args, line_number)
+    super(*args)
+    @line_number = line_number
+  end
+end
+
+class Psych::Nodes::SequenceWithLineNumber < Psych::Nodes::Sequence # rubocop:disable Style/Documentation,Style/ClassAndModuleChildren
+  attr_reader :line_number
+
+  def initialize(*args, line_number)
+    super(*args)
+    @line_number = line_number
+  end
+end
+
+class Psych::TreeWithLineNumbersBuilder < Psych::TreeBuilder # rubocop:disable Style/Documentation,Style/ClassAndModuleChildren
+  attr_accessor :parser
+
+  # Track duplicate segments across the same file.
+  class DuplicatesTracker
+    def initialize
+      @levels = []
+      @keys = []
+      @level = -1
+    end
+
+    def duplicate_segments
+      @keys.group_by(&:first)
+           .reject { |_key, key_positions| key_positions.size < 2 }
+           .transform_values { |key_positions| key_positions.map(&:last) }
+    end
+
+    def start_map!
+      @level += 1
+      @_last_was_scalar = false
+    end
+
+    def end_map!
+      @level -= 1
+      @_last_was_scalar = false
+      @levels.pop
+    end
+
+    def add_scalar!(val, lineno)
+      if @_last_was_scalar
+        @_last_was_scalar = false
+        @keys << [@levels.join("."), lineno]
+        return
+      end
+
+      @_last_was_scalar = true
+      @levels[@level] = val
+    end
+  end
+
+  def initialize(...)
+    super
+    @_dup_tracker = DuplicatesTracker.new
+  end
+
+  def duplicate_segments = @_dup_tracker.duplicate_segments
+
+  def scalar(*args)
+    @_dup_tracker.add_scalar!(args[0], parser.mark.line + 1)
+    node = Psych::Nodes::ScalarWithLineNumber.new(*args, parser.mark.line)
+    @last.children << node
+    node
+  end
+
+  def start_mapping(...)
+    @_dup_tracker.start_map!
+    super
+  end
+
+  def end_mapping(...)
+    @_dup_tracker.end_map!
+    super
+  end
+
+  def start_sequence(*args)
+    node = Psych::Nodes::SequenceWithLineNumber.new(*args, parser.mark.line)
+    @last.children << node
+    push node
+  end
+
+  def end_sequence
+    node = pop
+    set_end_location(node)
+    node
+  end
+end
+
+class Psych::Visitors::ToRubyWithLineNumbers < Psych::Visitors::ToRuby # rubocop:disable Style/Documentation,Style/ClassAndModuleChildren
+  def visit_Psych_Nodes_ScalarWithLineNumber(node) # rubocop:disable Naming/MethodName
+    visit_Psych_Nodes_Scalar(node)
+  end
+
+  def visit_Psych_Nodes_SequenceWithLineNumber(node) # rubocop:disable Naming/MethodName
+    visit_Psych_Nodes_Sequence(node)
+  end
+
+  if Gem.loaded_specs["psych"].version < Gem::Version.create("3.2.0")
+    def self.create(...)
+      super()
+    end
+  elsif Gem.loaded_specs["psych"].version < Gem::Version.create("5.0.0")
+    def self.create(*args, strict_integer:, parse_symbols:, **kwargs) # rubocop:disable Lint/UnusedMethodArgument
+      super(*args, **kwargs)
+    end
+  elsif Gem.loaded_specs["psych"].version < Gem::Version.create("5.3.0")
+    def self.create(*args, parse_symbols:, **kwargs) # rubocop:disable Lint/UnusedMethodArgument
+      super(*args, **kwargs)
+    end
+  end
+
+  private
+
+  def revive_hash(hash, node, tagged = false) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize,Metrics/MethodLength,Style/OptionalBooleanParameter
+    node.children.each_slice(2) do |k, v| # rubocop:disable Metrics/BlockLength
+      key = accept(k)
+      val = accept(v)
+
+      if v.is_a?(Psych::Nodes::ScalarWithLineNumber) || v.is_a?(Psych::Nodes::SequenceWithLineNumber)
+        start_line = end_line = v.line_number + 1
+
+        start_line = k.line_number + 1 if k.is_a?(v.class)
+        val = I18nLint::YamlWithLines::ValueWithLineNumbers.new(val, start_line..end_line)
+      end
+
+      if key == "<<" && k.tag != "tag:yaml.org,2002:str"
+        case v
+        when Psych::Nodes::Alias, Psych::Nodes::Mapping
+          begin
+            hash.merge! val
+          rescue TypeError
+            hash[key] = val
+          end
+        when Psych::Nodes::Sequence
+          begin
+            h = {}
+            val.reverse_each do |value|
+              h.merge! value
+            end
+            hash.merge! h
+          rescue TypeError
+            hash[key] = val
+          end
+        else
+          hash[key] = val
+        end
+      else
+        if !tagged && @symbolize_names && key.is_a?(String)
+          key = key.to_sym
+        elsif !@freeze && respond_to?(:deduplicate)
+          key = deduplicate(key)
+        end
+
+        hash[key] = val
+      end
+    end
+
+    hash
+  end
+end

data/lib/i18nlint.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+require_relative "i18nlint/version"
+require_relative "i18nlint/error"
+require_relative "i18nlint/configuration"
+require_relative "i18nlint/highlighters"
+require_relative "i18nlint/linter"
+require_relative "i18nlint/registry"
+require_relative "i18nlint/rule"
+require_relative "i18nlint/enumerator"
+
+require_relative "i18nlint/railtie" if defined?(Rails::Railtie)
+
+# Detect various "offences" in your I18n files.
+module I18nLint
+  def self.lint(filepaths, source_locale: nil)
+    linter = Linter.new(filepaths:, source_locale:)
+    linter.run
+    linter.run_comparison
+    linter.offences
+  end
+
+  def self.register_rule(rule)
+    Registry.register_rule(rule)
+  end
+
+  # Basic set of rules.
+  module Rules
+    # Built-in rules that should suit most use-cases.
+    module BuiltIn
+      # Match rules have no default configuration, so they must be defined in config to be registered.
+      require_relative "i18nlint/rules/built_in/match"
+      # Other built-ins aren't much configurable so they're always registered.
+      require_relative "i18nlint/rules/built_in/interpolations"
+      require_relative "i18nlint/rules/built_in/duplicates"
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: i18nlint
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Henry Blyth
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Linting for your I18n
+email:
+- blyth.henry@gmail.com
+executables:
+- i18nlint
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/i18nlint
+- lib/i18nlint.rb
+- lib/i18nlint/cli.rb
+- lib/i18nlint/cloneable_struct.rb
+- lib/i18nlint/configuration.rb
+- lib/i18nlint/enumerator.rb
+- lib/i18nlint/error.rb
+- lib/i18nlint/highlighters.rb
+- lib/i18nlint/highlighters/below_line.rb
+- lib/i18nlint/highlighters/colour.rb
+- lib/i18nlint/linter.rb
+- lib/i18nlint/railtie.rb
+- lib/i18nlint/registry.rb
+- lib/i18nlint/rspec/expect_offence.rb
+- lib/i18nlint/rule.rb
+- lib/i18nlint/rule_helper.rb
+- lib/i18nlint/rules/built_in/duplicates.rb
+- lib/i18nlint/rules/built_in/interpolations.rb
+- lib/i18nlint/rules/built_in/match.rb
+- lib/i18nlint/version.rb
+- lib/i18nlint/yaml_with_lines.rb
+homepage: https://github.com/henrahmagix/i18nlint
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/henrahmagix/i18nlint
+  source_code_uri: https://github.com/henrahmagix/i18nlint
+  changelog_uri: https://github.com/henrahmagix/i18nlint/blob/v1.0.0/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Linting for your I18n
+test_files: []