ruby-lsp-view_component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f750624290fc729f716c2bb2c20b13d56baa7fad7878014e795342cbdb61f148
+  data.tar.gz: 3b28ec82ce7c86cddf56b35595f472161b526cb0eb57ee2fb11204edb4355d24
+SHA512:
+  metadata.gz: 4738e8c1e9240ac1444aebdbf7f5ddb93df0d0374604811c234b36f5a14334b51d8638d813460e5f1bc66fe088e1233faaa38febaabbde17649f105079f39f77
+  data.tar.gz: 2e47b3801dde3a15a8757f3e767282a25bf0038d794a81dc5ab3b246b5b77cc2a8d870d07b7af9b01902ecf4f69f628385a1a95c8ab6e74ac0da9c29e3ce6030

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0]
+
+- `Jump to template` CodeLens on ViewComponent classes. It opens the component template, or a picker when the component has variants or sub-templates.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Daniel Retamal
+
+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,58 @@
+# ruby-lsp-view_component
+
+A [Ruby LSP](https://github.com/Shopify/ruby-lsp) add-on for [ViewComponent](https://viewcomponent.org). It adds a `Jump to template` CodeLens to each component class that opens the component's template.
+
+## Features
+
+### Jump to template
+
+The lens sits above the component class. When the component has a single template, a click opens it.
+
+![Jump to template](.github/assets/jump_to_template.gif)
+
+When the component has more than one template, the click opens a picker with the main template first.
+
+![Pick a template](.github/assets/pick_template.gif)
+
+For `app/components/bar_component.rb`, the lens lists:
+
+| File | What it is |
+|---|---|
+| `bar_component.html.erb` | [Main template](https://viewcomponent.org/guide/templates.html#sibling-file) |
+| `bar_component.html+phone.erb` | Variant of the main template |
+| `bar_component/bar_component.html.erb` | [Main template in a subdirectory](https://viewcomponent.org/guide/templates.html#subdirectory) |
+| `bar_component/list.html.erb` | Sub-template rendered with `call_list`, from [view_component_subtemplates](https://github.com/bukhr/view_component_subtemplates) |
+
+ERB, Haml and Slim templates are supported. Templates of nested components in the subdirectory, such as `bar_component/item_component.html.erb` next to `bar_component/item_component.rb`, belong to that component and are left out.
+
+Components without a template file of their own get no lens. That covers [inline](https://viewcomponent.org/guide/templates.html#inline) and [`call`](https://viewcomponent.org/guide/templates.html#call) components, and components that [inherit](https://viewcomponent.org/guide/templates.html#inherited) their template from a parent class.
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "ruby-lsp-view_component", require: false
+end
+```
+
+Run `bundle install` and restart Ruby LSP. Ruby LSP loads add-ons from the bundle, so there is nothing to configure.
+
+## Development
+
+```bash
+bundle install
+bundle exec rake
+```
+
+`rake` runs the tests and RuboCop.
+
+## Release
+
+1. Update the version in `lib/ruby_lsp_view_component/version.rb` and add it to `CHANGELOG.md`.
+2. Run `bundle exec rake release`. It builds the gem, tags the commit as `vX.Y.Z`, pushes the tag and pushes the gem to RubyGems. The gem requires MFA, so `gem push` asks for a one-time code.
+
+## License
+
+[MIT](LICENSE.txt)

data/lib/ruby_lsp/ruby_lsp_view_component/addon.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require_relative "../../ruby_lsp_view_component/version"
+require_relative "code_lens"
+
+RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.26.0")
+
+module RubyLsp
+  module RubyLspViewComponent
+    class Addon < ::RubyLsp::Addon
+      # @override
+      #: (GlobalState, Thread::Queue) -> void
+      def activate(global_state, outgoing_queue); end
+
+      # @override
+      #: -> void
+      def deactivate; end
+
+      # @override
+      #: -> String
+      def name
+        "Ruby LSP ViewComponent"
+      end
+
+      # @override
+      #: -> String
+      def version
+        VERSION
+      end
+
+      # @override
+      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], URI::Generic, Prism::Dispatcher) -> void
+      def create_code_lens_listener(response_builder, uri, dispatcher)
+        CodeLens.new(response_builder, uri, dispatcher)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_view_component/code_lens.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RubyLspViewComponent
+    class CodeLens
+      include Requests::Support::Common
+
+      TEMPLATE_EXTENSIONS = "{erb,haml,slim}"
+
+      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], URI::Generic, Prism::Dispatcher) -> void
+      def initialize(response_builder, uri, dispatcher)
+        @response_builder = response_builder
+        @path = uri.to_standardized_path #: String?
+        @seen_class = false
+        dispatcher.register(self, :on_class_node_enter) if @path&.end_with?(".rb")
+      end
+
+      #: (Prism::ClassNode) -> void
+      def on_class_node_enter(node)
+        return if @seen_class
+
+        @seen_class = true
+        uris = templates.map { |path| URI::Generic.from_path(path: path).to_s }
+        return if uris.empty?
+
+        @response_builder << create_code_lens(
+          node,
+          title: "Jump to template",
+          command_name: "rubyLsp.openFile",
+          arguments: [uris],
+          data: { type: "file" },
+        )
+      end
+
+      private
+
+      #: -> Array[String]
+      def templates
+        path = @path #: as !nil
+        dir = File.dirname(path)
+        name = File.basename(path, ".rb")
+        Dir.glob(["#{name}.*#{TEMPLATE_EXTENSIONS}", "#{name}/*.#{TEMPLATE_EXTENSIONS}"], base: dir)
+          .reject { |file| nested_component?(dir, file) }
+          .sort_by { |file| File.basename(file).start_with?("#{name}.") ? [0, file.length, file] : [1, 0, file] }
+          .map { |file| File.join(dir, file) }
+      end
+
+      #: (String, String) -> bool
+      def nested_component?(dir, file)
+        File.dirname(file) != "." &&
+          File.exist?(File.join(dir, File.dirname(file), "#{File.basename(file).split(".").first}.rb"))
+      end
+    end
+  end
+end

data/lib/ruby_lsp_view_component/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RubyLspViewComponent
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-view_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Retamal
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+description: Adds a CodeLens to ViewComponent classes that jumps to their templates
+email:
+- daniel.retamal.ahumada@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ruby_lsp/ruby_lsp_view_component/addon.rb
+- lib/ruby_lsp/ruby_lsp_view_component/code_lens.rb
+- lib/ruby_lsp_view_component/version.rb
+homepage: https://github.com/daniel-retamal/ruby-lsp-view_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/daniel-retamal/ruby-lsp-view_component
+  changelog_uri: https://github.com/daniel-retamal/ruby-lsp-view_component/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby LSP add-on for ViewComponent
+test_files: []