ruby-lsp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b072ffa3ea73a83aba6d6c32b931c4de30b0de06fd70655d620c3ed95bd8aa4
-  data.tar.gz: 24568688b20ffed38defcbc0b00708eb22a7dad20a9b5f397348242a64359bfd
+  metadata.gz: f81baa8f09011e5130c955c4c5d2a33583379b0b073caee556719b874efc320e
+  data.tar.gz: 55a664f923d93bda9ddb06624303f889123496c672c46b31ea71c629cfa96a81
 SHA512:
-  metadata.gz: ea1830f0be08cb291e67d80bbe21dbe17f3e4b4d285b1d9112e004ca2feff32eaca85af755bc2635e3341ab4e64491710c3ba13c5bed617e34495534e1d7a5f8
-  data.tar.gz: f84b1b27c5c17455d1e8423f1e52f98a754ed123e1722bd536ee7bfdc754952e5d6619c0f4402664a33dc278bdc2422a3e7a37c8de5f172e4456e7a6c08b7a67
+  metadata.gz: 8a872f34699bfaa4f955c714c4e49eed52e87b009afc0a642d0ad434956f6a14690188ad9c359cc7aadd53e96fbd0d5d320e00aa263265e1ce3d3e369e8bd124
+  data.tar.gz: 06444ea3e08b961445db6cb1a9093fc322b40ddf47daa00deb09a77f3b114014be8f525d7d391430b578b7916042bf345759d113c74e41a8ea51d65791abe69c

data/CHANGELOG.md

@@ -6,6 +6,18 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.2.0]
+
+- Add semantic token for keyword and keyword rest params (https://github.com/Shopify/ruby-lsp/pull/142)
+- Return error responses on exceptions (https://github.com/Shopify/ruby-lsp/pull/160)
+- Sanitize home directory for telemetry (https://github.com/Shopify/ruby-lsp/pull/171)
+- Avoid adding semantic tokens for special methods (https://github.com/Shopify/ruby-lsp/pull/162)
+- Properly respect excluded files in RuboCop requests (https://github.com/Shopify/ruby-lsp/pull/173)
+- Clear diagnostics when closing files (https://github.com/Shopify/ruby-lsp/pull/174)
+- Avoid pushing ranges for single line partial ranges (https://github.com/Shopify/ruby-lsp/pull/185)
+- Change folding ranges to include closing tokens (https://github.com/Shopify/ruby-lsp/pull/181)
+- Remove RuboCop dependency and fallback to SyntaxTree formatting (https://github.com/Shopify/ruby-lsp/pull/184)
+
 ## [0.1.0]
 
 - Implement token modifiers in SemanticTokenEncoder ([#112](https://github.com/Shopify/ruby-lsp/pull/112))

data/Gemfile

@@ -5,10 +5,11 @@ source "https://rubygems.org"
 gemspec
 
 gem "debug", "~> 1.5", require: false
-gem "minitest", "~> 5.15"
+gem "minitest", "~> 5.16"
 gem "minitest-reporters", "~> 1.5"
 gem "rake", "~> 13.0"
-gem "rubocop-shopify", "~> 2.7", require: false
+gem "rubocop", ">= 1.0.0"
+gem "rubocop-shopify", "~> 2.8", require: false
 gem "rubocop-minitest", "~> 0.20.1", require: false
 gem "rubocop-rake", "~> 0.6.0", require: false
 gem "rubocop-sorbet", "~> 0.6", require: false

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    ruby-lsp (0.1.0)
+    ruby-lsp (0.2.0)
       language_server-protocol
-      rubocop (>= 1.0)
       sorbet-runtime
       syntax_tree (>= 2.4)
 
@@ -21,9 +20,10 @@ GEM
     io-console (0.5.11)
     irb (1.4.1)
       reline (>= 0.3.0)
+    json (2.6.2)
     language_server-protocol (3.16.0.3)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     minitest-reporters (1.5.0)
       ansi
       builder
@@ -38,7 +38,7 @@ GEM
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbi (0.0.14)
+    rbi (0.0.15)
       ast
       parser (>= 2.6.4.0)
       sorbet-runtime (>= 0.5.9204)
@@ -47,7 +47,8 @@ GEM
     reline (0.3.1)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.30.1)
+    rubocop (1.31.1)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -62,26 +63,26 @@ GEM
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-shopify (2.7.0)
-      rubocop (~> 1.30)
-    rubocop-sorbet (0.6.8)
+    rubocop-shopify (2.8.0)
+      rubocop (~> 1.31)
+    rubocop-sorbet (0.6.11)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
-    sorbet (0.5.10092)
-      sorbet-static (= 0.5.10092)
-    sorbet-runtime (0.5.10092)
-    sorbet-static (0.5.10092-universal-darwin-21)
-    sorbet-static (0.5.10092-x86_64-linux)
-    sorbet-static-and-runtime (0.5.10092)
-      sorbet (= 0.5.10092)
-      sorbet-runtime (= 0.5.10092)
+    sorbet (0.5.10139)
+      sorbet-static (= 0.5.10139)
+    sorbet-runtime (0.5.10139)
+    sorbet-static (0.5.10139-universal-darwin-21)
+    sorbet-static (0.5.10139-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10139)
+      sorbet (= 0.5.10139)
+      sorbet-runtime (= 0.5.10139)
     spoom (1.1.11)
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    syntax_tree (2.7.1)
+    syntax_tree (2.8.0)
       prettier_print
-    tapioca (0.8.1)
+    tapioca (0.8.3)
       bundler (>= 1.17.3)
       parallel (>= 1.21.0)
       pry (>= 0.12.2)
@@ -91,7 +92,7 @@ GEM
       thor (>= 1.2.0)
       yard-sorbet
     thor (1.2.1)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
     unparser (0.6.5)
       diff-lcs (~> 1.3)
       parser (>= 3.1.0)
@@ -108,12 +109,13 @@ PLATFORMS
 
 DEPENDENCIES
   debug (~> 1.5)
-  minitest (~> 5.15)
+  minitest (~> 5.16)
   minitest-reporters (~> 1.5)
   rake (~> 13.0)
+  rubocop (>= 1.0.0)
   rubocop-minitest (~> 0.20.1)
   rubocop-rake (~> 0.6.0)
-  rubocop-shopify (~> 2.7)
+  rubocop-shopify (~> 2.8)
   rubocop-sorbet (~> 0.6)
   ruby-lsp!
   sorbet-static-and-runtime

data/README.md

@@ -17,7 +17,8 @@ end
 If using VS Code, install the [Ruby LSP plugin](https://github.com/Shopify/vscode-ruby-lsp) to get the extra features in
 the editor.
 
-See the [documentation](https://shopify.github.io/ruby-lsp) for supported features.
+See the [documentation](https://shopify.github.io/ruby-lsp) for
+[supported features](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).
 
 ## Contributing
 

data/Rakefile

@@ -11,7 +11,14 @@ Rake::TestTask.new(:test) do |t|
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.options = ["--markup", "markdown", "--output-dir", "docs"]
+  t.options = [
+    "--markup",
+    "markdown",
+    "--output-dir",
+    "docs",
+    "--asset",
+    "misc",
+  ]
 end
 
 require "rubocop/rake_task"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# typed: strict
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/ruby_lsp/internal"
+require "irb"
+
+extend T::Sig
+
+sig { params(source: String).returns(RubyLsp::Document) }
+def new_doc(source)
+  RubyLsp::Document.new(source)
+end
+
+@source = T.let(File.read(File.expand_path("../lib/ruby_lsp/handler.rb", __dir__)), String)
+@document = T.let(new_doc(@source), RubyLsp::Document)
+
+IRB.start(__FILE__)

data/lib/ruby_lsp/cli.rb

@@ -41,6 +41,7 @@ module RubyLsp
         on("textDocument/didClose") do |request|
           uri = request.dig(:params, :textDocument, :uri)
           store.delete(uri)
+          clear_diagnostics(uri)
 
           RubyLsp::Handler::VOID
         end

data/lib/ruby_lsp/handler.rb

@@ -62,7 +62,16 @@ module RubyLsp
             error = e
           end
 
-          @writer.write(id: request[:id], result: result) unless result == VOID
+          if error
+            @writer.write(
+              {
+                id: request[:id],
+                error: { code: Constant::ErrorCodes::INTERNAL_ERROR, message: error.inspect, data: request.to_json },
+              }
+            )
+          elsif result != VOID
+            @writer.write(id: request[:id], result: result)
+          end
         end
       end
 
@@ -94,7 +103,7 @@ module RubyLsp
         Interface::SemanticTokensRegistrationOptions.new(
           document_selector: { scheme: "file", language: "ruby" },
           legend: Interface::SemanticTokensLegend.new(
-            token_types: Requests::SemanticHighlighting::TOKEN_TYPES,
+            token_types: Requests::SemanticHighlighting::TOKEN_TYPES.keys,
             token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys
           ),
           range: false,
@@ -187,6 +196,14 @@ module RubyLsp
       )
     end
 
+    sig { params(uri: String).void }
+    def clear_diagnostics(uri)
+      @writer.write(
+        method: "textDocument/publishDiagnostics",
+        params: Interface::PublishDiagnosticsParams.new(uri: uri, diagnostics: [])
+      )
+    end
+
     sig do
       params(uri: String, range: T::Range[Integer]).returns(T::Array[LanguageServer::Protocol::Interface::CodeAction])
     end
@@ -227,7 +244,7 @@ module RubyLsp
         params[:errorMessage] = error.message
       end
 
-      params[:uri] = uri if uri
+      params[:uri] = uri.sub(%r{.*://#{Dir.home}}, "~") if uri
       params
     end
   end

data/lib/ruby_lsp/requests/code_actions.rb

@@ -3,6 +3,8 @@
 
 module RubyLsp
   module Requests
+    # ![Code actions demo](../../misc/code_actions.gif)
+    #
     # The [code actions](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction)
     # request informs the editor of RuboCop quick fixes that can be applied. These are accesible by hovering over a
     # specific diagnostic.

data/lib/ruby_lsp/requests/diagnostics.rb

@@ -1,8 +1,12 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "ruby_lsp/requests/support/rubocop_diagnostics_runner"
+
 module RubyLsp
   module Requests
+    # ![Diagnostics demo](../../misc/diagnostics.gif)
+    #
     # The
     # [diagnostics](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics)
     # request informs the editor of RuboCop offenses for a given file.
@@ -14,9 +18,16 @@ module RubyLsp
     # puts "Hello" # --> diagnostics: incorrect indentantion
     # end
     # ```
-    class Diagnostics < RuboCopRequest
+    class Diagnostics < BaseRequest
       extend T::Sig
 
+      sig { params(uri: String, document: Document).void }
+      def initialize(uri, document)
+        super(document)
+
+        @uri = uri
+      end
+
       sig do
         override.returns(
           T.any(
@@ -27,15 +38,9 @@ module RubyLsp
       end
       def run
         return syntax_error_diagnostics if @document.syntax_errors?
+        return [] unless defined?(Support::RuboCopDiagnosticsRunner)
 
-        super
-
-        @diagnostics
-      end
-
-      sig { params(_file: String, offenses: T::Array[RuboCop::Cop::Offense]).void }
-      def file_finished(_file, offenses)
-        @diagnostics = offenses.map { |offense| Support::RuboCopDiagnostic.new(offense, @uri) }
+        Support::RuboCopDiagnosticsRunner.instance.run(@uri, @document)
       end
 
       private

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -3,6 +3,8 @@
 
 module RubyLsp
   module Requests
+    # ![Document highlight demo](../../misc/document_highlight.gif)
+    #
     # The [document highlight](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight)
     # informs the editor all relevant elements of the currently pointed item for highlighting. For example, when
     # the cursor is on the `F` of the constant `FOO`, the editor should identify other occurences of `FOO`

data/lib/ruby_lsp/requests/document_symbol.rb

@@ -3,6 +3,8 @@
 
 module RubyLsp
   module Requests
+    # ![Document symbol demo](../../misc/document_symbol.gif)
+    #
     # The [document
     # symbol](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol) request
     # informs the editor of all the important symbols, such as classes, variables, and methods, defined in a file. With

data/lib/ruby_lsp/requests/folding_ranges.rb

@@ -3,10 +3,13 @@
 
 module RubyLsp
   module Requests
+    # ![Folding ranges demo](../../misc/folding_ranges.gif)
+    #
     # The [folding ranges](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange)
-    # request informs the editor of the ranges where code can be folded.
+    # request informs the editor of the ranges where and how code can be folded.
     #
     # # Example
+    #
     # ```ruby
     # def say_hello # <-- folding range start
     #   puts "Hello"
@@ -32,12 +35,13 @@ module RubyLsp
         SyntaxTree::Unless,
         SyntaxTree::Until,
         SyntaxTree::While,
+        SyntaxTree::Else,
+        SyntaxTree::Ensure,
+        SyntaxTree::Begin,
       ].freeze, T::Array[T.class_of(SyntaxTree::Node)])
 
       NODES_WITH_STATEMENTS = T.let([
-        SyntaxTree::Else,
         SyntaxTree::Elsif,
-        SyntaxTree::Ensure,
         SyntaxTree::In,
         SyntaxTree::Rescue,
         SyntaxTree::When,
@@ -45,9 +49,7 @@ module RubyLsp
 
       StatementNode = T.type_alias do
         T.any(
-          SyntaxTree::Else,
           SyntaxTree::Elsif,
-          SyntaxTree::Ensure,
           SyntaxTree::In,
           SyntaxTree::Rescue,
           SyntaxTree::When,
@@ -77,11 +79,10 @@ module RubyLsp
 
         case node
         when *SIMPLE_FOLDABLES
-          add_node_range(T.must(node))
+          location = T.must(node).location
+          add_lines_range(location.start_line, location.end_line - 1)
         when *NODES_WITH_STATEMENTS
           add_statements_range(T.must(node), T.cast(node, StatementNode).statements)
-        when SyntaxTree::Begin
-          add_statements_range(node, node.bodystmt.statements)
         when SyntaxTree::Call, SyntaxTree::CommandCall
           add_call_range(node)
           return
@@ -135,6 +136,11 @@ module RubyLsp
             kind: @kind
           )
         end
+
+        sig { returns(T::Boolean) }
+        def multiline?
+          @end_line > @start_line
+        end
       end
 
       sig { params(node: T.nilable(SyntaxTree::Node)).returns(T::Boolean) }
@@ -175,7 +181,7 @@ module RubyLsp
       def emit_partial_range
         return if @partial_range.nil?
 
-        @ranges << @partial_range.to_range
+        @ranges << @partial_range.to_range if @partial_range.multiline?
         @partial_range = nil
       end
 
@@ -195,7 +201,7 @@ module RubyLsp
           end
         end
 
-        add_lines_range(receiver.location.start_line, node.location.end_line)
+        add_lines_range(receiver.location.start_line, node.location.end_line - 1)
 
         visit(node.arguments)
       end
@@ -205,9 +211,10 @@ module RubyLsp
         params_location = node.params.location
 
         if params_location.start_line < params_location.end_line
-          add_lines_range(params_location.end_line, node.location.end_line)
+          add_lines_range(params_location.end_line, node.location.end_line - 1)
         else
-          add_node_range(node)
+          location = node.location
+          add_lines_range(location.start_line, location.end_line - 1)
         end
 
         visit(node.bodystmt.statements)
@@ -215,7 +222,7 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::Node, statements: SyntaxTree::Statements).void }
       def add_statements_range(node, statements)
-        add_lines_range(node.location.start_line, statements.location.end_line) unless statements.empty?
+        add_lines_range(node.location.start_line, statements.body.last.location.end_line) unless statements.empty?
       end
 
       sig { params(node: SyntaxTree::StringConcat).void }
@@ -223,13 +230,7 @@ module RubyLsp
         left = T.let(node.left, SyntaxTree::Node)
         left = left.left while left.is_a?(SyntaxTree::StringConcat)
 
-        add_lines_range(left.location.start_line, node.right.location.end_line)
-      end
-
-      sig { params(node: SyntaxTree::Node).void }
-      def add_node_range(node)
-        location = node.location
-        add_lines_range(location.start_line, location.end_line)
+        add_lines_range(left.location.start_line, node.right.location.end_line - 1)
       end
 
       sig { params(start_line: Integer, end_line: Integer).void }

data/lib/ruby_lsp/requests/formatting.rb

@@ -1,8 +1,12 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "ruby_lsp/requests/support/rubocop_formatting_runner"
+
 module RubyLsp
   module Requests
+    # ![Formatting symbol demo](../../misc/formatting.gif)
+    #
     # The [formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting)
     # request uses RuboCop to fix auto-correctable offenses in the document. This requires enabling format on save and
     # registering the ruby-lsp as the Ruby formatter.
@@ -14,43 +18,43 @@ module RubyLsp
     # puts "Hello" # --> formatting: fixes the indentation on save
     # end
     # ```
-    class Formatting < RuboCopRequest
+    class Formatting < BaseRequest
       extend T::Sig
 
-      RUBOCOP_FLAGS = T.let((COMMON_RUBOCOP_FLAGS + ["--auto-correct"]).freeze, T::Array[String])
-
       sig { params(uri: String, document: Document).void }
       def initialize(uri, document)
-        super
-        @formatted_text = T.let(nil, T.nilable(String))
+        super(document)
+
+        @uri = uri
       end
 
       sig { override.returns(T.nilable(T.all(T::Array[LanguageServer::Protocol::Interface::TextEdit], Object))) }
       def run
-        super
+        formatted_text = formatted_file
+        return unless formatted_text
 
-        @formatted_text = @options[:stdin] # Rubocop applies the corrections on stdin
-        return unless @formatted_text
+        size = @document.source.size
 
         [
           LanguageServer::Protocol::Interface::TextEdit.new(
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(line: 0, character: 0),
-              end: LanguageServer::Protocol::Interface::Position.new(
-                line: text.size,
-                character: text.size
-              )
+              end: LanguageServer::Protocol::Interface::Position.new(line: size, character: size)
             ),
-            new_text: @formatted_text
+            new_text: formatted_text
           ),
         ]
       end
 
       private
 
-      sig { returns(T::Array[String]) }
-      def rubocop_flags
-        RUBOCOP_FLAGS
+      sig { returns(T.nilable(String)) }
+      def formatted_file
+        if defined?(Support::RuboCopFormattingRunner)
+          Support::RuboCopFormattingRunner.instance.run(@uri, @document)
+        else
+          SyntaxTree.format(@document.source)
+        end
       end
     end
   end

data/lib/ruby_lsp/requests/selection_ranges.rb

@@ -3,6 +3,8 @@
 
 module RubyLsp
   module Requests
+    # ![Selection ranges demo](../../misc/selection_ranges.gif)
+    #
     # The [selection ranges](https://microsoft.github.io/language-server-protocol/specification#textDocument_selectionRange)
     # request informs the editor of ranges that the user may want to select based on the location(s)
     # of their cursor(s).

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -3,6 +3,8 @@
 
 module RubyLsp
   module Requests
+    # ![Semantic highlighting demo](../../misc/semantic_highlighting.gif)
+    #
     # The [semantic
     # highlighting](https://microsoft.github.io/language-server-protocol/specification#textDocument_semanticTokens)
     # request informs the editor of the correct token types to provide consistent and accurate highlighting for themes.
@@ -19,11 +21,31 @@ module RubyLsp
     class SemanticHighlighting < BaseRequest
       extend T::Sig
 
-      TOKEN_TYPES = T.let([
-        :variable,
-        :method,
-        :namespace,
-      ].freeze, T::Array[Symbol])
+      TOKEN_TYPES = T.let({
+        namespace: 0,
+        type: 1,
+        class: 2,
+        enum: 3,
+        interface: 4,
+        struct: 5,
+        typeParameter: 6,
+        parameter: 7,
+        variable: 8,
+        property: 9,
+        enumMember: 10,
+        event: 11,
+        function: 12,
+        method: 13,
+        macro: 14,
+        keyword: 15,
+        modifier: 16,
+        comment: 17,
+        string: 18,
+        number: 19,
+        regexp: 20,
+        operator: 21,
+        decorator: 22,
+      }.freeze, T::Hash[Symbol, Integer])
 
       TOKEN_MODIFIERS = T.let({
         declaration: 0,
@@ -38,6 +60,11 @@ module RubyLsp
         default_library: 9,
       }.freeze, T::Hash[Symbol, Integer])
 
+      SPECIAL_RUBY_METHODS = T.let((Module.instance_methods(false) +
+        Kernel.methods(false) + Bundler::Dsl.instance_methods(false) +
+        Module.private_instance_methods(false))
+        .map(&:to_s), T::Array[String])
+
       class SemanticToken < T::Struct
         const :location, SyntaxTree::Location
         const :length, Integer
@@ -52,6 +79,7 @@ module RubyLsp
         @encoder = encoder
         @tokens = T.let([], T::Array[SemanticToken])
         @tree = T.let(document.tree, SyntaxTree::Node)
+        @special_methods = T.let(nil, T.nilable(T::Array[String]))
       end
 
       sig do
@@ -83,7 +111,7 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::Command).void }
       def visit_command(node)
-        add_token(node.message.location, :method)
+        add_token(node.message.location, :method) unless special_method?(node.message.value)
         visit(node.arguments)
       end
 
@@ -125,7 +153,7 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::FCall).void }
       def visit_fcall(node)
-        add_token(node.value.location, :method)
+        add_token(node.value.location, :method) unless special_method?(node.value.value)
         visit(node.arguments)
       end
 
@@ -144,6 +172,16 @@ module RubyLsp
         end
       end
 
+      sig { params(node: SyntaxTree::Params).void }
+      def visit_params(node)
+        node.keywords.each do |keyword,|
+          location = keyword.location
+          add_token(location_without_colon(location), :variable)
+        end
+
+        add_token(node.keyword_rest.name.location, :variable) if node.keyword_rest
+      end
+
       sig { params(node: SyntaxTree::VarField).void }
       def visit_var_field(node)
         case node.value
@@ -166,7 +204,7 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::VCall).void }
       def visit_vcall(node)
-        add_token(node.value.location, :method)
+        add_token(node.value.location, :method) unless special_method?(node.value.value)
       end
 
       sig { params(location: SyntaxTree::Location, type: Symbol, modifiers: T::Array[Symbol]).void }
@@ -177,11 +215,37 @@ module RubyLsp
           SemanticToken.new(
             location: location,
             length: length,
-            type: T.must(TOKEN_TYPES.index(type)),
+            type: T.must(TOKEN_TYPES[type]),
             modifier: modifiers_indices
           )
         )
       end
+
+      private
+
+      # Exclude the ":" symbol at the end of a location
+      # We use it on keyword parameters to be consistent
+      # with the rest of the parameters
+      sig { params(location: T.untyped).returns(SyntaxTree::Location) }
+      def location_without_colon(location)
+        SyntaxTree::Location.new(
+          start_line: location.start_line,
+          start_column: location.start_column,
+          start_char: location.start_char,
+          end_char: location.end_char - 1,
+          end_column: location.end_column - 1,
+          end_line: location.end_line,
+        )
+      end
+
+      # Textmate provides highlighting for a subset
+      # of these special Ruby-specific methods.
+      # We want to utilize that highlighting, so we
+      # avoid making a semantic token for it.
+      sig { params(method_name: String).returns(T::Boolean) }
+      def special_method?(method_name)
+        SPECIAL_RUBY_METHODS.include?(method_name)
+      end
     end
   end
 end

data/lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require "rubocop"
+rescue LoadError
+  return
+end
+
+require "cgi"
+require "singleton"
+
+module RubyLsp
+  module Requests
+    module Support
+      # :nodoc:
+      class RuboCopDiagnosticsRunner < RuboCop::Runner
+        extend T::Sig
+        include Singleton
+
+        sig { void }
+        def initialize
+          @options = T.let({}, T::Hash[Symbol, T.untyped])
+          @uri = T.let(nil, T.nilable(String))
+          @diagnostics = T.let([], T::Array[Support::RuboCopDiagnostic])
+
+          super(
+            ::RuboCop::Options.new.parse([
+              "--stderr", # Print any output to stderr so that our stdout does not get polluted
+              "--force-exclusion",
+              "--format",
+              "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
+            ]).first,
+            ::RuboCop::ConfigStore.new
+          )
+        end
+
+        sig { params(uri: String, document: Document).returns(T::Array[Support::RuboCopDiagnostic]) }
+        def run(uri, document)
+          @diagnostics.clear
+          @uri = uri
+
+          file = CGI.unescape(URI.parse(uri).path)
+          # We communicate with Rubocop via stdin
+          @options[:stdin] = document.source
+
+          # Invoke RuboCop with just this file in `paths`
+          super([file])
+          @diagnostics
+        end
+
+        private
+
+        sig { params(_file: String, offenses: T::Array[RuboCop::Cop::Offense]).void }
+        def file_finished(_file, offenses)
+          @diagnostics = offenses.map { |offense| Support::RuboCopDiagnostic.new(offense, T.must(@uri)) }
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb

@@ -0,0 +1,50 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require "rubocop"
+rescue LoadError
+  return
+end
+
+require "cgi"
+require "singleton"
+
+module RubyLsp
+  module Requests
+    module Support
+      # :nodoc:
+      class RuboCopFormattingRunner < RuboCop::Runner
+        extend T::Sig
+        include Singleton
+
+        sig { void }
+        def initialize
+          @options = T.let({}, T::Hash[Symbol, T.untyped])
+
+          super(
+            ::RuboCop::Options.new.parse([
+              "--stderr", # Print any output to stderr so that our stdout does not get polluted
+              "--force-exclusion",
+              "--format",
+              "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
+              "-a", # --auto-correct
+            ]).first,
+            ::RuboCop::ConfigStore.new
+          )
+        end
+
+        sig { params(uri: String, document: Document).returns(T.nilable(String)) }
+        def run(uri, document)
+          file = CGI.unescape(URI.parse(uri).path)
+          # We communicate with Rubocop via stdin
+          @options[:stdin] = document.source
+
+          # Invoke RuboCop with just this file in `paths`
+          super([file])
+          @options[:stdin]
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests.rb

@@ -2,18 +2,28 @@
 # frozen_string_literal: true
 
 module RubyLsp
+  # Supported features
+  #
+  # - {RubyLsp::Requests::DocumentSymbol}
+  # - {RubyLsp::Requests::FoldingRanges}
+  # - {RubyLsp::Requests::SelectionRanges}
+  # - {RubyLsp::Requests::SemanticHighlighting}
+  # - {RubyLsp::Requests::Formatting}
+  # - {RubyLsp::Requests::Diagnostics}
+  # - {RubyLsp::Requests::CodeActions}
+  # - {RubyLsp::Requests::DocumentHighlight}
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
     autoload :DocumentSymbol, "ruby_lsp/requests/document_symbol"
     autoload :FoldingRanges, "ruby_lsp/requests/folding_ranges"
     autoload :SelectionRanges, "ruby_lsp/requests/selection_ranges"
     autoload :SemanticHighlighting, "ruby_lsp/requests/semantic_highlighting"
-    autoload :RuboCopRequest, "ruby_lsp/requests/rubocop_request"
     autoload :Formatting, "ruby_lsp/requests/formatting"
     autoload :Diagnostics, "ruby_lsp/requests/diagnostics"
     autoload :CodeActions, "ruby_lsp/requests/code_actions"
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
 
+    # :nodoc:
     module Support
       autoload :RuboCopDiagnostic, "ruby_lsp/requests/support/rubocop_diagnostic"
       autoload :SelectionRange, "ruby_lsp/requests/support/selection_range"

data/rakelib/check_docs.rake

@@ -8,9 +8,13 @@ task :check_docs do
   require "syntax_tree"
   require "logger"
   require "ruby_lsp/requests/base_request"
-  require "ruby_lsp/requests/rubocop_request"
+  require "ruby_lsp/requests/support/rubocop_diagnostics_runner"
+  require "ruby_lsp/requests/support/rubocop_formatting_runner"
 
-  Dir["#{Dir.pwd}/lib/ruby_lsp/requests/*.rb"].each do |file|
+  request_doc_files = Dir["#{Dir.pwd}/lib/ruby_lsp/requests/*.rb"]
+  request_doc_files << "#{Dir.pwd}/lib/ruby_lsp/requests.rb"
+
+  request_doc_files.each do |file|
     require(file)
     YARD.parse(file, [], Logger::Severity::FATAL)
   end
@@ -19,6 +23,8 @@ task :check_docs do
   error_messages = RubyLsp::Requests
     .constants # rubocop:disable Sorbet/ConstantsFromStrings
     .each_with_object(Hash.new { |h, k| h[k] = [] }) do |request, errors|
+    next if request == :Support
+
     full_name = "RubyLsp::Requests::#{request}"
     docs = YARD::Registry.at(full_name).docstring
     next if /:nodoc:/.match?(docs)
@@ -32,15 +38,33 @@ task :check_docs do
         For example, if your request handles text document hover, you should add a link to
         https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover.
       MESSAGE
+    elsif !%r{!\[.* demo\]\(\.\./\.\./misc/.*\.gif\)}.match?(docs)
+      errors[full_name] << <<~MESSAGE
+        Documentation for request handler class must contain a demonstration GIF, in the following format:
+
+        ![Request name demo](../../misc/request_name.gif)
+
+        See the misc/ folder for examples.
+      MESSAGE
     elsif !/# Example/.match?(docs)
       errors[full_name] << <<~MESSAGE
         Documentation for request handler class must contain an example.
 
-        = Example
-            def my_method # <-- something happens here
-            end
+        # # Example
+        #
+        # ```ruby
+        # def my_method # <-- something happens here
+        # end
+        # ```
       MESSAGE
     end
+
+    supported_features = YARD::Registry.at("RubyLsp::Requests").docstring
+    next if /- {#{full_name}}/.match?(supported_features)
+
+    errors[full_name] << <<~MESSAGE
+      Documentation for request handler class must be listed in the RubyLsp::Requests module documentation.
+    MESSAGE
   end
 
   formatted_errors = error_messages.map { |name, errors| "#{name}: #{errors.join(", ")}" }

data/ruby-lsp.gemspec

@@ -7,20 +7,21 @@ Gem::Specification.new do |s|
   s.email = ["ruby@shopify.com"]
   s.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  s.summary = "A simple language server for ruby"
-  s.description = "A simple language server for ruby"
+  s.summary = "An opinionated language server for Ruby"
+  s.description = "An opinionated language server for Ruby"
   s.homepage = "https://github.com/Shopify/ruby-lsp"
   s.license = "MIT"
 
   s.files = Dir.chdir(File.expand_path(__dir__)) do
-    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|misc)/}) }
   end
   s.bindir = "exe"
   s.executables = s.files.grep(/\Aexe/) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency("language_server-protocol")
-  s.add_dependency("rubocop", ">= 1.0")
   s.add_dependency("sorbet-runtime")
   s.add_dependency("syntax_tree", ">= 2.4")
+
+  s.required_ruby_version = ">= 2.7.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.4'
-description: A simple language server for ruby
+description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
 executables:
@@ -92,6 +78,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/console
 - bin/rubocop
 - bin/tapioca
 - bin/test
@@ -110,10 +97,11 @@ files:
 - lib/ruby_lsp/requests/document_symbol.rb
 - lib/ruby_lsp/requests/folding_ranges.rb
 - lib/ruby_lsp/requests/formatting.rb
-- lib/ruby_lsp/requests/rubocop_request.rb
 - lib/ruby_lsp/requests/selection_ranges.rb
 - lib/ruby_lsp/requests/semantic_highlighting.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
+- lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb
+- lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb
 - lib/ruby_lsp/requests/support/selection_range.rb
 - lib/ruby_lsp/requests/support/semantic_token_encoder.rb
 - lib/ruby_lsp/requests/support/syntax_error_diagnostic.rb
@@ -179,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -189,5 +177,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: A simple language server for ruby
+summary: An opinionated language server for Ruby
 test_files: []

data/lib/ruby_lsp/requests/rubocop_request.rb

@@ -1,60 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "rubocop"
-require "cgi"
-
-module RubyLsp
-  module Requests
-    # :nodoc:
-    class RuboCopRequest < RuboCop::Runner
-      extend T::Sig
-      extend T::Helpers
-
-      abstract!
-
-      COMMON_RUBOCOP_FLAGS = T.let([
-        "--stderr", # Print any output to stderr so that our stdout does not get polluted
-        "--format",
-        "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
-      ].freeze, T::Array[String])
-
-      sig { returns(String) }
-      attr_reader :file
-
-      sig { returns(String) }
-      attr_reader :text
-
-      sig { params(uri: String, document: Document).void }
-      def initialize(uri, document)
-        @file = T.let(CGI.unescape(URI.parse(uri).path), String)
-        @document = document
-        @text = T.let(document.source, String)
-        @uri = uri
-        @options = T.let({}, T::Hash[Symbol, T.untyped])
-        @diagnostics = T.let([], T::Array[Support::RuboCopDiagnostic])
-
-        super(
-          ::RuboCop::Options.new.parse(rubocop_flags).first,
-          ::RuboCop::ConfigStore.new
-        )
-      end
-
-      sig { overridable.returns(Object) }
-      def run
-        # We communicate with Rubocop via stdin
-        @options[:stdin] = text
-
-        # Invoke the actual run method with just this file in `paths`
-        super([file])
-      end
-
-      private
-
-      sig { returns(T::Array[String]) }
-      def rubocop_flags
-        COMMON_RUBOCOP_FLAGS
-      end
-    end
-  end
-end