ruby-lsp-slim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3e8a5ae3d3e90f420d313250c86e1b2ecffda0532d51058e82d94c571170419
+  data.tar.gz: 8a87834930733a4ac9e27ef782cf788eb77cc18664925f77576a66d63e498e17
+SHA512:
+  metadata.gz: ef57f5abed3a7fde8abe4887f2753e3d8a0c7cfce3f27a72f1c63649f92804c4d740a4c763f5f16117d01ad0173cd03806f104c871756911415bdc9dcfa508df
+  data.tar.gz: 31d46434beec784235683d91e1ed1e949162b254281d1dff1c565822456e5f3cf488b249c3d8a44a28802467e501437dc4f22ab5000ee73864532dc8d3cb35d5

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/PredicateMethod:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release
+- Support for hover, go-to-definition, completion, document symbols, diagnostics, and semantic highlighting in Slim templates
+- Handles control code (`-`), output (`=`, `==`), interpolation (`#{}`), ruby filter, comments, text blocks, and backslash continuation

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Andrea Fomera
+
+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,67 @@
+# Ruby LSP Slim
+
+A [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon that provides language server features for [Slim](http://slim-lang.com/) template files.
+
+## Features
+
+- **Hover** — see method signatures and documentation
+- **Go-to-definition** — jump to method/class definitions from Slim templates
+- **Completion** — autocomplete Ruby methods and variables
+- **Document symbols** — outline view for Ruby code in templates
+- **Diagnostics** — syntax errors and warnings
+- **Semantic highlighting** — rich syntax coloring for embedded Ruby
+
+## Installation
+
+### 1. Add the gem
+
+Add `ruby-lsp-slim` to your project's `Gemfile`:
+
+```ruby
+group :development do
+  gem "ruby-lsp-slim"
+end
+```
+
+Then run `bundle install`.
+
+### 2. Install the VS Code extension
+
+Install the **Ruby LSP Slim** extension from the VS Code marketplace, or search for "Ruby LSP Slim" in the Extensions panel.
+
+The extension runs a dedicated Ruby LSP server for `.slim` files, so all standard Ruby LSP features work inside your templates.
+
+### 3. Restart VS Code
+
+After installing both the gem and extension, reload your VS Code window (`Cmd+Shift+P` → "Developer: Reload Window").
+
+## Supported Slim syntax
+
+| Pattern | Example |
+|---|---|
+| Control code | `- x = 1` |
+| Output | `= link_to "Home", root_path` |
+| Unescaped output | `== raw_html` |
+| Tag output | `h1= title` |
+| Interpolation | `p Hello #{user.name}` |
+| Ruby filter | `ruby:` block |
+| Comments | `/ comment` |
+| Text blocks | `\| text content` |
+| Backslash continuation | `- x = 1 + \` (continues next line) |
+
+## Requirements
+
+- Ruby >= 3.0.0
+- ruby-lsp >= 0.26.0, < 1.0
+- slim >= 4.0
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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: %i[test rubocop]

data/examples/slim_app/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "ruby-lsp"
+gem "ruby-lsp-slim", path: "../.."
+gem "slim"

data/examples/slim_app/app/helpers/application_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+  def link_to(text, url)
+    "<a href=\"#{url}\">#{text}</a>"
+  end
+
+  def pluralize(count, singular, plural = nil)
+    word = count == 1 ? singular : (plural || "#{singular}s")
+    "#{count} #{word}"
+  end
+
+  def time_ago_in_words(time)
+    seconds = Time.now - time
+    case seconds
+    when 0..59 then "just now"
+    when 60..3599 then "#{(seconds / 60).to_i} minutes ago"
+    when 3600..86_399 then "#{(seconds / 3600).to_i} hours ago"
+    else "#{(seconds / 86_400).to_i} days ago"
+    end
+  end
+
+  def current_user
+    User.new(name: "Alice", email: "alice@example.com", role: "admin")
+  end
+end

data/examples/slim_app/app/models/user.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class User
+  attr_accessor :name, :email, :role, :created_at
+
+  def initialize(name:, email:, role: "member", created_at: Time.now)
+    @name = name
+    @email = email
+    @role = role
+    @created_at = created_at
+  end
+
+  def admin?
+    role == "admin"
+  end
+
+  def display_name
+    "#{name} (#{email})"
+  end
+
+  def self.all
+    [
+      new(name: "Alice", email: "alice@example.com", role: "admin"),
+      new(name: "Bob", email: "bob@example.com"),
+      new(name: "Charlie", email: "charlie@example.com")
+    ]
+  end
+end

data/examples/slim_app/app/views/home/index.slim

@@ -0,0 +1,22 @@
+h1 Welcome to the Slim App
+
+- if current_user
+  p Hello, #{current_user.display_name}!
+
+  - if current_user.admin?
+    .admin-panel
+      h2 Admin Dashboard
+      p You have admin access.
+      = link_to "Manage Users", "/users"
+  - else
+    p You are logged in as a regular user.
+- else
+  p Please sign in to continue.
+  = link_to "Sign In", "/login"
+
+section.features
+  h2 Features
+  ul
+    - ["Hover", "Go to Definition", "Completion", "Diagnostics"].each do |feature|
+      li= feature
+ 

data/examples/slim_app/app/views/home/test.erb

@@ -0,0 +1,3 @@
+<%= link_to "Home", "/" %>
+<%= current_user.name %>
+<%= User.all %>

data/examples/slim_app/app/views/layouts/application.slim

@@ -0,0 +1,17 @@
+doctype html
+html
+  head
+    title My Slim App
+    meta charset="utf-8"
+  body
+    header
+      nav
+        ul
+          li
+            a href="/" Home
+          li
+            a href="/users" Users
+    main
+      == yield
+    footer
+      p Copyright #{Time.now.year} My App

data/examples/slim_app/app/views/users/index.slim

@@ -0,0 +1,24 @@
+h1 Users
+
+- users = User.all
+
+p= pluralize(users.length, "user")
+
+table
+  thead
+    tr
+      th Name
+      th Email
+      th Role
+      th Joined
+  tbody
+    - users.each do |user|
+      tr
+        td= user.name
+        td= user.email
+        td= user.role
+        td= time_ago_in_words(user.created_at)
+
+- if current_user.admin?
+  .actions
+    = link_to "Add User", "/users/new"

data/examples/slim_app/app/views/users/show.slim

@@ -0,0 +1,32 @@
+- user = User.all.first
+
+h1= user.display_name
+
+.user-profile
+  dl
+    dt Email
+    dd= user.email
+
+    dt Role
+    dd= user.role
+
+    dt Member Since
+    dd= user.created_at.strftime("%B %d, %Y")
+
+  - if user.admin?
+    .badge Admin
+
+ruby:
+  stats = {
+    posts: 42,
+    comments: 128,
+    likes: 256
+  }
+
+h2 Activity
+dl
+  - stats.each do |label, count|
+    dt= label.to_s.capitalize
+    dd= count
+
+= link_to "Back to Users", "/users"

data/lib/ruby_lsp/ruby_lsp_slim/addon.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require_relative "slim_document"
+require_relative "version"
+
+module RubyLsp
+  module RubyLspSlim
+    class Addon < ::RubyLsp::Addon
+      def activate(global_state, outgoing_queue)
+        @outgoing_queue = outgoing_queue
+
+        RubyLsp::Store.prepend(StorePatch) unless RubyLsp::Store.ancestors.include?(StorePatch)
+        RubyLsp::Server.prepend(ServerPatch) unless RubyLsp::Server.ancestors.include?(ServerPatch)
+
+        register_slim_capability if global_state.client_capabilities.supports_watching_files
+
+        outgoing_queue << Notification.window_log_message(
+          "[Ruby LSP Slim] Addon v#{::RubyLspSlim::VERSION} activated",
+          type: Constant::MessageType::INFO
+        )
+      end
+
+      def deactivate; end
+
+      def name
+        "Ruby LSP Slim"
+      end
+
+      def version
+        ::RubyLspSlim::VERSION
+      end
+
+      private
+
+      def register_slim_capability
+        registration = Request.new(
+          id: "ruby-lsp-slim-register",
+          method: "client/registerCapability",
+          params: Interface::RegistrationParams.new(
+            registrations: [
+              Interface::Registration.new(
+                id: "ruby-lsp-slim-text-sync",
+                method: "textDocument/didOpen",
+                register_options: Interface::TextDocumentRegistrationOptions.new(
+                  document_selector: [
+                    { language: "slim" }
+                  ]
+                )
+              ),
+              Interface::Registration.new(
+                id: "ruby-lsp-slim-did-change",
+                method: "textDocument/didChange",
+                register_options: Interface::TextDocumentChangeRegistrationOptions.new(
+                  document_selector: [
+                    { language: "slim" }
+                  ],
+                  sync_kind: Constant::TextDocumentSyncKind::INCREMENTAL
+                )
+              ),
+              Interface::Registration.new(
+                id: "ruby-lsp-slim-did-close",
+                method: "textDocument/didClose",
+                register_options: Interface::TextDocumentRegistrationOptions.new(
+                  document_selector: [
+                    { language: "slim" }
+                  ]
+                )
+              )
+            ]
+          )
+        )
+        @outgoing_queue << registration
+      end
+    end
+
+    module StorePatch
+      def get(uri)
+        super
+      rescue Store::NonExistingDocumentError
+        path = uri.to_standardized_path
+        raise unless path && File.extname(path) == ".slim" && File.file?(path)
+
+        set(uri: uri, source: File.binread(path), version: 0, language_id: :slim)
+        @state[uri.to_s]
+      end
+
+      def set(uri:, source:, version:, language_id:)
+        if language_id == :slim
+          @state[uri.to_s] = SlimDocument.new(
+            source: source,
+            version: version,
+            uri: uri,
+            global_state: @global_state
+          )
+        else
+          super
+        end
+      end
+    end
+
+    module ServerPatch
+      def text_document_did_open(message)
+        text_document = message.dig(:params, :textDocument)
+        uri = text_document[:uri]
+        path = uri.is_a?(URI::Generic) ? uri.to_standardized_path : uri.to_s
+
+        if text_document[:languageId] == "slim" || (path && File.extname(path) == ".slim")
+          @store.set(
+            uri: uri,
+            source: text_document[:text],
+            version: text_document[:version],
+            language_id: :slim
+          )
+
+          document = @store.get(uri)
+          if document.past_expensive_limit? && uri.respond_to?(:scheme) && uri.scheme == "file"
+            send_message(
+              Notification.new(
+                method: "window/logMessage",
+                params: Interface::LogMessageParams.new(
+                  type: Constant::MessageType::WARNING,
+                  message: "The file #{path} is too long. Semantic highlighting and diagnostics will be disabled."
+                )
+              )
+            )
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_slim/slim_document.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "slim_scanner"
+
+module RubyLsp
+  module RubyLspSlim
+    class SlimDocument < RubyLsp::ERBDocument
+      def parse!
+        return false unless @needs_parsing
+
+        @needs_parsing = false
+        scanner = SlimScanner.new(@source)
+        scanner.scan
+        @host_language_source = scanner.host_language
+        @parse_result = Prism.parse_lex(scanner.ruby, partial_script: true)
+        @code_units_cache = @parse_result.code_units_cache(@encoding)
+        true
+      rescue StandardError => e
+        @host_language_source = +""
+        @parse_result = Prism.parse_lex("", partial_script: true)
+        @code_units_cache = @parse_result.code_units_cache(@encoding)
+        $stderr.puts("[Ruby LSP Slim] Parse error: #{e.message}")
+        true
+      end
+
+      def language_id
+        # Return :erb so that ruby-lsp's Definition listener applies the same
+        # "Object" receiver-type fallback it uses for ERB templates, allowing
+        # bare method calls like `current_user` to resolve via the index.
+        :erb
+      end
+    end
+  end
+end