ruby-lsp-slim 0.1.0

data/lib/ruby_lsp/ruby_lsp_slim/slim_scanner.rb

@@ -0,0 +1,385 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module RubyLspSlim
+    # Scanner that extracts Ruby code from Slim templates while preserving byte positions.
+    # Produces two same-length strings: `@ruby` contains Ruby code (with spaces where host language is)
+    # and `@host_language` contains Slim markup (with spaces where Ruby code is).
+    class SlimScanner
+      attr_reader :ruby, :host_language
+
+      def initialize(source)
+        @source = source
+        @ruby = +"" # Ruby code with spaces for non-Ruby portions
+        @host_language = +"" # Host language with spaces for Ruby portions
+        @current_pos = 0
+        @line_start = true
+        @in_ruby_filter = false
+        @ruby_filter_indent = 0
+      end
+
+      def scan
+        while @current_pos < @source.length
+          if @line_start
+            scan_line_start
+          else
+            scan_inline
+          end
+        end
+      end
+
+      private
+
+      def scan_line_start
+        # Track position at beginning of line to measure indentation
+        line_begin = @current_pos
+
+        # Consume leading whitespace
+        consume_whitespace
+
+        indent_level = @current_pos - line_begin
+
+        # Check if we're at end of source
+        return if @current_pos >= @source.length
+
+        char = @source[@current_pos]
+
+        # Handle ruby: filter continuation
+        if @in_ruby_filter
+          if indent_level > @ruby_filter_indent
+            # This line is part of the ruby: filter - treat as Ruby
+            scan_ruby_line_to_end
+            return
+          else
+            # Indentation decreased, we've left the ruby: filter
+            @in_ruby_filter = false
+          end
+        end
+
+        case char
+        when "/"
+          # Slim comment — skip as host language
+          consume_to_eol_as_host
+          return
+        when "|", "'"
+          # Text block — treat as text content (supports interpolation)
+          push_host(char)
+          @current_pos += 1
+          if @current_pos < @source.length && @source[@current_pos] == " "
+            push_host(" ")
+            @current_pos += 1
+          end
+          scan_text_content
+          return
+        when "-"
+          # Control code: - ruby_code
+          push_host(" ")
+          @current_pos += 1
+
+          # Consume optional space after -
+          if @current_pos < @source.length && @source[@current_pos] == " "
+            push_host(" ")
+            @current_pos += 1
+          end
+
+          scan_ruby_line_to_end
+        when "="
+          # Output code: = expression or == expression
+          push_host(" ")
+          @current_pos += 1
+
+          if @current_pos < @source.length && @source[@current_pos] == "="
+            push_host(" ")
+            @current_pos += 1
+          end
+
+          # Consume optional space after = or ==
+          if @current_pos < @source.length && @source[@current_pos] == " "
+            push_host(" ")
+            @current_pos += 1
+          end
+
+          scan_ruby_line_to_end
+        when "\n"
+          push_newline
+          @current_pos += 1
+          @line_start = true
+        when "\r"
+          push_newline_cr
+          @current_pos += 1
+          if @current_pos < @source.length && @source[@current_pos] == "\n"
+            push_newline
+            @current_pos += 1
+          end
+          @line_start = true
+        else
+          # Check for ruby: filter
+          if looking_at?("ruby:")
+            remaining = @source[(@current_pos + 5)..]
+            if remaining.nil? || remaining.empty? || remaining.start_with?("\n") || remaining.start_with?("\r")
+              # This is a ruby: filter line
+              @in_ruby_filter = true
+              @ruby_filter_indent = indent_level
+              push_host("ruby:")
+              @current_pos += 5
+              consume_to_eol_as_host
+              return
+            end
+          end
+
+          # Check for tag with embedded Ruby (tag= expr or tag== expr)
+          scan_tag_line
+        end
+      end
+
+      def scan_tag_line
+        # Scan through tag name, classes, ids, etc. until we hit =, space+newline, or newline
+        while @current_pos < @source.length
+          char = @source[@current_pos]
+
+          case char
+          when "\n"
+            push_newline
+            @current_pos += 1
+            @line_start = true
+            return
+          when "\r"
+            push_newline_cr
+            @current_pos += 1
+            if @current_pos < @source.length && @source[@current_pos] == "\n"
+              push_newline
+              @current_pos += 1
+            end
+            @line_start = true
+            return
+          when "="
+            # Tag output: tag= expr or tag== expr
+            push_host(" ")
+            @current_pos += 1
+
+            if @current_pos < @source.length && @source[@current_pos] == "="
+              push_host(" ")
+              @current_pos += 1
+            end
+
+            # Consume optional space
+            if @current_pos < @source.length && @source[@current_pos] == " "
+              push_host(" ")
+              @current_pos += 1
+            end
+
+            scan_ruby_line_to_end
+            return
+          when "#"
+            # Check for interpolation in text
+            if @current_pos + 1 < @source.length && @source[@current_pos + 1] == "{"
+              push_host(" ") # #
+              @current_pos += 1
+              push_host(" ") # {
+              @current_pos += 1
+              scan_interpolation
+            else
+              push_host(char)
+              @current_pos += 1
+            end
+          when " "
+            # After space in a tag line, the rest is text content - scan for interpolation
+            push_host(" ")
+            @current_pos += 1
+            scan_text_content
+            return
+          else
+            push_host(char)
+            @current_pos += 1
+          end
+        end
+      end
+
+      def scan_text_content
+        while @current_pos < @source.length
+          char = @source[@current_pos]
+
+          case char
+          when "\n"
+            push_newline
+            @current_pos += 1
+            @line_start = true
+            return
+          when "\r"
+            push_newline_cr
+            @current_pos += 1
+            if @current_pos < @source.length && @source[@current_pos] == "\n"
+              push_newline
+              @current_pos += 1
+            end
+            @line_start = true
+            return
+          when "#"
+            if @current_pos + 1 < @source.length && @source[@current_pos + 1] == "{"
+              push_host(" ") # #
+              @current_pos += 1
+              push_host(" ") # {
+              @current_pos += 1
+              scan_interpolation
+            else
+              push_host(char)
+              @current_pos += 1
+            end
+          else
+            push_host(char)
+            @current_pos += 1
+          end
+        end
+      end
+
+      def scan_interpolation
+        brace_depth = 1
+        while @current_pos < @source.length && brace_depth.positive?
+          char = @source[@current_pos]
+
+          case char
+          when "{"
+            brace_depth += 1
+            push_ruby(char)
+            @current_pos += 1
+          when "}"
+            brace_depth -= 1
+            if brace_depth.zero?
+              push_host(" ") # closing }
+            else
+              push_ruby(char)
+            end
+            @current_pos += 1
+          when "\n"
+            push_newline
+            @current_pos += 1
+          when "\r"
+            push_newline_cr
+            @current_pos += 1
+            if @current_pos < @source.length && @source[@current_pos] == "\n"
+              push_newline
+              @current_pos += 1
+            end
+          else
+            push_ruby(char)
+            @current_pos += 1
+          end
+        end
+      end
+
+      def scan_ruby_line_to_end
+        @line_start = false
+        while @current_pos < @source.length
+          char = @source[@current_pos]
+
+          case char
+          when "\\"
+            # Backslash continuation: if followed by newline, keep scanning Ruby on next line
+            if @current_pos + 1 < @source.length && @source[@current_pos + 1] == "\n"
+              push_ruby(char)
+              @current_pos += 1
+              push_newline
+              @current_pos += 1
+              # Continue scanning Ruby on the next line (skip indentation)
+              while @current_pos < @source.length && [" ", "\t"].include?(@source[@current_pos])
+                push_ruby(" ")
+                @current_pos += 1
+              end
+            elsif @current_pos + 2 < @source.length && @source[@current_pos + 1] == "\r" &&
+                  @source[@current_pos + 2] == "\n"
+              push_ruby(char)
+              @current_pos += 1
+              push_newline_cr
+              @current_pos += 1
+              push_newline
+              @current_pos += 1
+              while @current_pos < @source.length && [" ", "\t"].include?(@source[@current_pos])
+                push_ruby(" ")
+                @current_pos += 1
+              end
+            else
+              push_ruby(char)
+              @current_pos += 1
+            end
+          when "\n"
+            push_newline
+            @current_pos += 1
+            @line_start = true
+            return
+          when "\r"
+            push_newline_cr
+            @current_pos += 1
+            if @current_pos < @source.length && @source[@current_pos] == "\n"
+              push_newline
+              @current_pos += 1
+            end
+            @line_start = true
+            return
+          else
+            push_ruby(char)
+            @current_pos += 1
+          end
+        end
+      end
+
+      def consume_whitespace
+        while @current_pos < @source.length
+          char = @source[@current_pos]
+          break unless [" ", "\t"].include?(char)
+
+          push_host(char)
+          @current_pos += 1
+        end
+      end
+
+      def consume_to_eol_as_host
+        while @current_pos < @source.length
+          char = @source[@current_pos]
+          case char
+          when "\n"
+            push_newline
+            @current_pos += 1
+            @line_start = true
+            return
+          when "\r"
+            push_newline_cr
+            @current_pos += 1
+            if @current_pos < @source.length && @source[@current_pos] == "\n"
+              push_newline
+              @current_pos += 1
+            end
+            @line_start = true
+            return
+          else
+            push_host(char)
+            @current_pos += 1
+          end
+        end
+      end
+
+      def push_ruby(char)
+        @ruby << char
+        @host_language << (" " * char.length)
+      end
+
+      def push_host(char)
+        @ruby << (" " * char.length)
+        @host_language << char
+      end
+
+      def push_newline
+        @ruby << "\n"
+        @host_language << "\n"
+      end
+
+      def push_newline_cr
+        @ruby << "\r"
+        @host_language << "\r"
+      end
+
+      def looking_at?(str)
+        @source[@current_pos, str.length] == str
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_slim/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyLspSlim
+  VERSION = "0.1.0"
+end

data/lib/ruby_lsp_slim.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "ruby_lsp/ruby_lsp_slim/version"

data/ruby-lsp-slim.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_lsp/ruby_lsp_slim/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-lsp-slim"
+  spec.version = RubyLspSlim::VERSION
+  spec.authors = ["Andrea Fomera"]
+  spec.license = "MIT"
+
+  spec.summary = "Ruby LSP addon for Slim templates"
+  spec.description = "A Ruby LSP addon that provides language server features for Slim template files."
+  spec.homepage = "https://github.com/afomera/ruby-lsp-slim"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?("test/", ".git", ".github", "bin/")
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-lsp", ">= 0.26.0", "< 1.0"
+  spec.add_dependency "slim", ">= 4.0", "< 6.0"
+end

data/vscode/.vscodeignore

@@ -0,0 +1,4 @@
+src/**
+node_modules/**
+tsconfig.json
+.gitignore

data/vscode/README.md

@@ -0,0 +1,39 @@
+# Ruby LSP Slim
+
+Slim template support for [Ruby LSP](https://github.com/Shopify/ruby-lsp) — hover, go-to-definition, completion, and more for Ruby code in `.slim` files.
+
+## Setup
+
+1. Add the gem to your project:
+
+```ruby
+group :development do
+  gem "ruby-lsp-slim"
+end
+```
+
+2. Run `bundle install`
+3. Reload your VS Code window
+
+## Features
+
+- **Hover** — see method signatures and documentation
+- **Go-to-definition** — jump to method/class definitions
+- **Completion** — autocomplete Ruby methods and variables
+- **Document symbols** — outline view for Ruby code
+- **Diagnostics** — syntax errors and warnings
+- **Semantic highlighting** — rich syntax coloring for embedded Ruby
+
+## How it works
+
+This extension runs a dedicated Ruby LSP server for `.slim` files. The `ruby-lsp-slim` gem is loaded as an addon that teaches the server how to parse Slim syntax and extract Ruby code for analysis.
+
+## Requirements
+
+- [Ruby LSP](https://github.com/Shopify/ruby-lsp) installed in your project
+- `ruby-lsp-slim` gem in your Gemfile
+- Ruby >= 3.0.0
+
+## License
+
+MIT

data/vscode/language-configuration.json

@@ -0,0 +1,28 @@
+{
+  "comments": {
+    "lineComment": "/"
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "surroundingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "indentationRules": {
+    "increaseIndentPattern": "^\\s*([-=]\\s*.*(do|\\{)\\s*|.*[|\\\\]\\s*)$",
+    "decreaseIndentPattern": "^\\s*(end|\\})\\s*$"
+  }
+}