ruby-lsp-i18n 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f0fdc0478778d6e3c1f0a1214050b93bbf1e7fc5e88f1ca0b9600e1936d2952
+  data.tar.gz: 26070828190643f05f77cef165b995810eec828510ae78def86cae0d65588ad9
+SHA512:
+  metadata.gz: 5a9da889bf6f3fdb0ef5b773c7dd64c1b210cb62ff438b314b43ee1d57778324d7ada0ab36745119b9cb32b1080d6bb1988618b9a269a3232d2343d85e0bf8ce
+  data.tar.gz: f198ccadd9f2e09dccb32f149e030a901a8f479042d34aac0d4301bb822bfaabb4160991d913b1b3b94721de01ef848aa13beb32c389933bceb1392c56f22404

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "cSpell.words": [
+        "rubocop",
+        "shopify"
+    ],
+    "editor.inlayHints.enabled": "offUnlessPressed",
+    "rubyLsp.addonSettings": {
+        "Ruby LSP I18n": {
+            "enabled": true
+        }
+    }
+}

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## [Unreleased]
+
+## [0.3.0] - 2025-07-18
+
+- Fix inlay hints patch thanks to [@enmy](https://github.com/enmy)
+- Publish to rubygems
+
+## [0.2.4] - 2025-01-13
+
+- Update ruby lsp version to 0.23.0
+
+## [0.2.3] - 2024-11-29
+
+- Update ruby lsp version to 0.22.0
+
+## [0.2.2] - 2024-11-18
+
+- Update ruby LSP version to 0.21.3 and change runtime dependency to version constraint using the RubyLSP version constraint API to be forward compatible with new LSP versions. Now when the LSP get a breaking change the addon is disabled instead of locking the core LSP version in the editor.
+
+## [0.2.1] - 2024-09-09
+
+- Fix translation missing inlay hint in scoped I18n.t calls
+
+## [0.2.0] - 2024-09-09
+
+- Added enable/disable addon vía .vscode.settings.json file using <https://github.com/Shopify/ruby-lsp/pull/2513>
+
+## [0.1.0] - 2024-09-03
+
+- Added inlay hints with translation value for I18n.t("key") calls
+- Added autocompletion for I18n.t("key") calls
+- Added "translation-missing" for I18n.t("key") calls as inlay hint
+- Added file path suggestion for I18n.t("key") missing calls
+- Added tooltip with translations and file path for I18n.t("key") calls
+
+## [0.0.0] - 2024-08-22

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dedwards@buk.cl. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 domingo2000
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# RubyLspI18n
+
+The `ruby-lsp-i18n` gem provides internationalization support for Ruby Lsp.
+
+## Installation
+
+Add to the following line to your application's development Gemfile:
+
+```ruby
+gem 'ruby-lsp-i18n', git: 'https://github.com/bukhr/ruby-lsp-i18n', require: false
+```
+
+Then run the following command to install the gem:
+
+```bash
+bundle install
+```
+
+## Features
+
+- Inlay Hints for translations
+  - Show value as inlay hint for translation keys
+  - Hover with the translation value
+  - Hover with the file path of the translation
+
+- Autocompletion for translation keys
+- Synchronization of yml translation files
+
+![Ruby LSP I18n Demo](media/demo.gif)
+
+### Configuration
+
+The addon is enabled by default but can be disabled using the .vscode/settings.json file in your project.
+
+```json
+{
+  "rubyLsp.addonSettings": {
+    "Ruby LSP I18n": {
+        "enabled": false
+    }
+  }
+}
+```
+
+## Development
+
+1. Clone the repository
+2. Install dependencies with `bundle install`
+3. Run the tests with `bundle exec rake test`
+4. Check types with `bundle exec srb tc`
+5. Run the linter with `bundle exec rubocop`
+6. Make a PR and wait for aproval
+7. Merge the PR
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Updating Ruby LSP
+
+It is important to maintain this gem up to date with the latest version of Ruby Lsp. So the users of the gem have the updated features of the core LSP. To do so update the Ruby LSP version in the `ruby-lsp-i18n.gemspec` file. Then run the tests and make sure everything is working as expected.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/bukhr/ruby-lsp-i18n>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bukhr/ruby-lsp-i18n/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubyLspI18n project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bukhr/ruby-lsp-i18n/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/es.yml

@@ -0,0 +1,4 @@
+es:
+  a: "sadfdasdasfds"
+  b: 
+   c: "hello"

data/example/app/example.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "i18n"
+
+I18n.t("hello.world")
+
+I18n.t("hello.alo")
+
+I18n.t("mi.super.llave")
+
+I18n.t("a.b")
+
+I18n.t("mi.super.llave")

data/example/config/locales/a/es.yml

@@ -0,0 +1,4 @@
+---
+es:
+  a:
+    b: "Senkuuu ishigami"

data/example/config/locales/es.yml

@@ -0,0 +1,6 @@
+es:
+  hello:
+    world: "Hello world!"
+  mi:
+    super:
+      llave: "Mi super llave"

data/lib/ruby_lsp/ruby_lsp_i18n/addon.rb

@@ -0,0 +1,138 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require_relative "requests/inlay_hints"
+require_relative "listeners/inlay_hints"
+require_relative "listeners/completion"
+require_relative "i18n_index"
+require_relative "../../ruby_lsp_i18n/version"
+
+RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.24.0")
+
+module RubyLsp
+  module RubyLspI18n
+    GLOB_PATH = "**/config/locales/**/es.yml"
+    # This class is the entry point for the addon. It is responsible for activating and deactivating the addon
+    class Addon < ::RubyLsp::Addon
+      extend T::Sig
+
+      sig { void }
+      def initialize
+        super
+        @i18n_index = T.let(I18nIndex.new(language: "es"), I18nIndex)
+        @enabled = T.let(true, T::Boolean)
+      end
+
+      # Performs any activation that needs to happen once when the language server is booted)}
+      sig { override.params(global_state: RubyLsp::GlobalState, message_queue: Thread::Queue).void }
+      def activate(global_state, message_queue)
+        settings = global_state.settings_for_addon(name) || {}
+        @enabled = settings[:enabled] if settings.key?(:enabled)
+
+        return unless @enabled
+
+        files = Dir[GLOB_PATH]
+        files.each do |file|
+          @i18n_index.sync_file(file)
+        end
+
+        message_queue << Request.new(
+          id: "ruby-lsp-my-gem-file-watcher",
+          method: "client/registerCapability",
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: "workspace/didChangeWatchedFilesMyGem",
+                method: "workspace/didChangeWatchedFiles",
+                register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
+                  watchers: [
+                    Interface::FileSystemWatcher.new(
+                      glob_pattern: GLOB_PATH,
+                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE,
+                    ),
+                  ],
+                ),
+              ),
+            ],
+          ),
+        )
+      end
+
+      # Performs any cleanup when shutting down the server, like terminating a subprocess
+      sig { override.void }
+      def deactivate; end
+
+      sig { params(changes: T::Array[T::Hash[Symbol, T.untyped]]).void }
+      def workspace_did_change_watched_files(changes)
+        changes.each do |change|
+          change = Interface::FileEvent.new(uri: change[:uri], type: change[:type])
+          uri = T.let(change.uri, String)
+
+          next unless uri.end_with?("es.yml")
+
+          path = URI.parse(uri).path
+
+          next if path.nil?
+
+          path = path.gsub(Dir.pwd + "/", "")
+          @i18n_index.sync_file(path)
+        end
+      end
+
+      sig { override.returns(String) }
+      def version
+        RubyLsp::RubyLspI18n::VERSION
+      end
+
+      # Returns the name of the addon
+      sig { override.returns(String) }
+      def name
+        "Ruby LSP I18n"
+      end
+
+      sig do
+        params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder,
+          dispatcher: Prism::Dispatcher,
+          document: T.any(RubyDocument, ERBDocument),
+        ).void
+      end
+      def create_inlay_hints_listener(response_builder, dispatcher, document)
+        return unless @enabled
+
+        InlayHints.new(@i18n_index, response_builder, dispatcher, document)
+      end
+
+      sig do
+        override.params(
+          response_builder: RubyLsp::ResponseBuilders::CollectionResponseBuilder,
+          node_context: RubyLsp::NodeContext,
+          dispatcher: Prism::Dispatcher,
+          uri: URI::Generic,
+        ).void
+      end
+      def create_completion_listener(response_builder, node_context, dispatcher, uri)
+        return unless @enabled
+
+        Completion.new(@i18n_index, response_builder, dispatcher)
+      end
+    end
+  end
+end
+
+# Patch the InlayHints request to support addons
+module RubyLsp
+  class Addon
+    extend T::Sig
+    sig do
+      params(
+        response_builder: ResponseBuilders::CollectionResponseBuilder,
+        dispatcher: Prism::Dispatcher,
+        document: T.any(RubyDocument, ERBDocument),
+      ).void
+    end
+    def create_inlay_hints_listener(response_builder, dispatcher, document)
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_i18n/i18n_index.rb

@@ -0,0 +1,130 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "prefix_tree"
+module RubyLsp
+  module RubyLspI18n
+    # The index holds a data structure that maps i18n keys
+    # to their values and the files they are defined in.
+
+    class Entry
+      extend T::Sig
+
+      sig { returns(String) }
+      attr_reader :value
+
+      sig { returns(String) }
+      attr_reader :file
+
+      sig { params(value: String, file: String).void }
+      def initialize(value, file)
+        @value = value
+        @file = file
+      end
+    end
+
+    class I18nIndex
+      extend T::Sig
+
+      sig { params(language: String).void }
+      def initialize(language:)
+        @language = language
+        @data = T.let({}, T::Hash[String, T::Array[Entry]])
+
+        @file_keys = T.let(
+          Hash.new do |hash, key|
+            hash[key] = []
+          end,
+          T::Hash[String, T::Array[String]],
+        )
+
+        @keys_tree = T.let(RubyLsp::RubyLspI18n::PrefixTree.new, RubyLsp::RubyLspI18n::PrefixTree[String])
+      end
+
+      sig { params(key: String, value: String, file: String).void }
+      def add(key, value, file)
+        entry = Entry.new(value, file)
+        @data[key] ||= []
+        T.must(@data[key]) << entry
+        T.must(@file_keys[file]) << key
+        @keys_tree.insert(key, key)
+      end
+
+      sig { params(key: String, file: String).void }
+      def remove(key, file)
+        return unless @data[key]
+
+        T.must(@data[key]).delete_if { |v| v.file == file }
+        T.must(@file_keys[file]).delete(key)
+        @keys_tree.delete(key)
+      end
+
+      sig { params(key: String).returns(T::Array[RubyLsp::RubyLspI18n::Entry]) }
+      def find(key)
+        datum = @data.dig(key)
+        datum.nil? ? [] : datum
+      end
+
+      sig { params(prefix: String).returns(T::Array[String]) }
+      def find_prefix(prefix)
+        @keys_tree.search(prefix)
+      end
+
+      sig { params(key: String, value: String, file: String).void }
+      def update(key, value, file)
+        remove(key, file)
+        add(key, value, file)
+      end
+
+      sig { params(path: String).void }
+      def sync_file(path)
+        # Clean entries from the file
+        current_keys = get_keys_from_file(path)
+        current_keys.each do |key|
+          remove(key, path)
+        end
+
+        return unless File.exist?(path)
+
+        # Load translations only if the current yaml is valid
+        begin
+          translations = YAML.load_file(path, aliases: true)
+        rescue Psych::SyntaxError
+          return
+        end
+
+        # If there is no translations, do nothing
+        return unless translations.is_a?(Hash)
+
+        # If the translations are empty, do nothing
+        return if translations.dig(@language).nil?
+
+        # Add entries again
+        translations = translations.dig(@language)
+        return unless translations.is_a?(Hash) # Check format of the translations
+
+        process_translations(translations, path)
+      end
+
+      private
+
+      sig { params(file: String).returns(T::Array[String]) }
+      def get_keys_from_file(file)
+        T.must(@file_keys[file])
+      end
+
+      sig { params(translations: T::Hash[String, T.untyped], file: String, prefix: T.nilable(String)).void }
+      def process_translations(translations, file, prefix = nil)
+        translations.each do |key, value|
+          full_key = prefix ? "#{prefix}.#{key}" : key
+          full_key = full_key.to_s
+          if value.is_a?(Hash)
+            process_translations(value, file, full_key)
+          else
+            update(full_key, value, file)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_i18n/listeners/completion.rb

@@ -0,0 +1,65 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module RubyLspI18n
+    class Completion
+      extend T::Sig
+      include Requests::Support::Common
+
+      sig do
+        params(
+          i18n_index: I18nIndex,
+          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def initialize(i18n_index, response_builder, dispatcher)
+        @i18n_index = i18n_index
+        @response_builder = response_builder
+        @dispatcher = dispatcher
+
+        dispatcher.register(
+          self,
+          :on_call_node_enter,
+        )
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        return unless node.name == :t
+
+        receiver = node.receiver
+        return unless receiver.is_a?(Prism::ConstantReadNode)
+
+        return unless receiver.name == :I18n
+
+        arguments = node.arguments
+        return unless arguments
+        return if arguments.arguments.empty?
+
+        key_node = arguments.arguments.first
+        return unless key_node.is_a?(Prism::StringNode)
+
+        key = key_node.unescaped
+        quote = T.must(key_node.opening_loc).slice
+        candidates = @i18n_index.find_prefix(key)
+
+        candidates.each do |candidate|
+          new_text = "#{quote}#{candidate}#{quote}"
+          response = Interface::CompletionItem.new(
+            label: new_text,
+            detail: candidate,
+            documentation: "candidate",
+            text_edit: Interface::TextEdit.new(
+              range: range_from_location(key_node.location),
+              new_text: new_text,
+            ),
+            kind: Constant::CompletionItemKind::VALUE,
+          )
+          @response_builder << response
+        end
+      end
+    end
+  end
+end