rubocop-lsp 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de59c33976acd6f570c9f4812248e905b8fc8b3ca2c61f5bc1a6acb82d903ee7
-  data.tar.gz: 4af340c2c6c89bdd5c19e152a26e94614ac83e7770387564f936276fc063a5c4
+  metadata.gz: 764e9fc1c28866c816e63128566630c67a64de01806866564321f79d24f8b6a0
+  data.tar.gz: 6fe1eec7178a026983f631c66e82c764994d86f4c4eb9336d6df947808547c31
 SHA512:
-  metadata.gz: 7cb778276e436791c288856e37f36e00ff22293f507368bb0170a3ccf8f0b289ca2f652a15f9eb5b24d28c8a70f3e18fe8732da3590045b252cc9c193a293a8f
-  data.tar.gz: d68688323dd99d361f11fbb7ce070e66b31e5492ef90f7829d536215fb0439e2efa0ffb9bc67df81f410e451c89b3bd149ea629d836b55181cf2debae6aed353
+  metadata.gz: d2f731dae661bd512c8531918d8f69e977b2acc992f683678761fa1cb9d88b5454cae9b7e3abdbb5d273b42c0a36f8842084369ccfd6e1a0143760d26bf52cf7
+  data.tar.gz: b824829e84e030748ef6808e3acd7b84744d7127baf6afa23e7904825cd7d0d4ade4f89ce34f5f9f91d1e053b8635f4a109e0a7e3150913556828415450d2b85

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-lsp (0.1.4)
+    rubocop-lsp (0.1.5)
       language_server-protocol (>= 3.16)
       rubocop (>= 1.0)
 

data/lib/rubocop/lsp/cli.rb

@@ -26,8 +26,8 @@ module Rubocop
           end
 
           on("textDocument/didChange") do |request|
-            uri = request[:params][:textDocument][:uri]
-            text = request[:params][:contentChanges][0][:text]
+            uri = request.dig(:params, :textDocument, :uri)
+            text = request.dig(:params, :contentChanges, 0, :text)
 
             collector = collect_diagnostics(uri: uri, text: text)
             send_diagnostics(collector)
@@ -36,8 +36,8 @@ module Rubocop
           end
 
           on("textDocument/didOpen") do |request|
-            uri = request[:params][:textDocument][:uri]
-            text = request[:params][:textDocument][:text]
+            uri = request.dig(:params, :textDocument, :uri)
+            text = request.dig(:params, :textDocument, :text)
 
             collector = collect_diagnostics(uri: uri, text: text)
             send_diagnostics(collector)
@@ -46,7 +46,7 @@ module Rubocop
           end
 
           on("textDocument/didClose") do |request|
-            uri = request[:params][:textDocument][:uri]
+            uri = request.dig(:params, :textDocument, :uri)
 
             clear_diagnostics(uri: uri)
 
@@ -54,16 +54,19 @@ module Rubocop
           end
 
           on("textDocument/formatting") do |request|
-            uri = request[:params][:textDocument][:uri]
+            uri = request.dig(:params, :textDocument, :uri)
 
             collector = collect_diagnostics(uri: uri, text: store.text_for(uri))
             send_text_edits(collector)
           end
 
           on("textDocument/codeAction") do |request|
-            uri = request[:params][:textDocument][:uri]
-            range = request[:params][:range]
-            line_range = Range.new(range[:start][:line], range[:end][:line])
+            uri = request.dig(:params, :textDocument, :uri)
+            range = request.dig(:params, :range)
+            start_line = range.dig(:start, :line)
+            end_line = range.dig(:end, :line)
+
+            line_range = Range.new(start_line, end_line)
 
             send_code_actions(uri, line_range)
           end

data/lib/rubocop/lsp/diagnostic_collector.rb

@@ -2,27 +2,40 @@
 
 require "rubocop/lsp/model/diagnostic_collection"
 
-class DiagnosticCollector < RuboCop::Formatter::BaseFormatter
+class DiagnosticCollector < RuboCop::Runner
+  RUBOCOP_FLAGS = [
+    "--stderr", # Print any output to stderr so that our stdout does not get polluted
+    "--format",
+    "quiet", # Supress any progress output by setting the formatter to `quiet`
+    "--auto-correct", # Apply the autocorrects on the supplied buffer
+  ]
+
   attr_reader :uri, :file, :text, :formatted_text, :diagnostics
 
   def initialize(uri:, text:)
-    super({}, nil)
     @uri = uri
     @file = CGI.unescape(URI.parse(uri).path)
     @text = text
     @formatted_text = nil
+
+    super(
+      ::RuboCop::Options.new.parse(RUBOCOP_FLAGS).first,
+      ::RuboCop::ConfigStore.new
+    )
   end
 
   def run
-    config_store = ::RuboCop::ConfigStore.new
-    options, paths = ::RuboCop::Options.new.parse(["--stderr", "--auto-correct"])
-    # config_store.options_config = options[:config] if options[:config]
-    options[:stdin] = text
-    paths << file
-    runner = ::RuboCop::Runner.new(options, config_store)
-    runner.send(:formatter_set).clear.push(self)
-    runner.run(paths)
-    @formatted_text = options[:stdin]
+    # Send text via "stdin".
+    # RuboCop reads all of stdin into the "stdin" option, when `--stdin`
+    # flag is supplied
+    @options[:stdin] = text
+
+    # Invoke the actual run method with just this file in `paths`
+    super([file])
+
+    # RuboCop applies autocorrections to the "stdin" option,
+    # so read that into the formatted text attribute
+    @formatted_text = @options[:stdin]
   end
 
   def file_finished(_file, offenses)

data/lib/rubocop/lsp/model/diagnostic.rb

@@ -2,34 +2,70 @@
 
 module Model
   class Diagnostic
-    attr_reader :cop_name, :message, :start, :end, :replacements, :diagnostic_response
+    attr_reader :badge, :message, :start, :end, :replacements
+
+    DOCS_URLS = {
+      "Bundler":          "https://docs.rubocop.org/rubocop/cops_bundler.html#%{anchor}",
+      "Gemspec":          "https://docs.rubocop.org/rubocop/cops_gemspec.html#%{anchor}",
+      "Layout":           "https://docs.rubocop.org/rubocop/cops_layout.html#%{anchor}",
+      "Lint":             "https://docs.rubocop.org/rubocop/cops_lint.html#%{anchor}",
+      "Metrics":          "https://docs.rubocop.org/rubocop/cops_metrics.html#%{anchor}",
+      "Migration":        "https://docs.rubocop.org/rubocop/cops_migration.html#%{anchor}",
+      "Naming":           "https://docs.rubocop.org/rubocop/cops_naming.html#%{anchor}",
+      "Security":         "https://docs.rubocop.org/rubocop/cops_security.html#%{anchor}",
+      "Style":            "https://docs.rubocop.org/rubocop/cops_style.html#%{anchor}",
+      "Minitest":         "https://docs.rubocop.org/rubocop-minitest/cops_minitest.html#%{anchor}",
+      "Performance":      "https://docs.rubocop.org/rubocop-performance/cops_performance.html#%{anchor}",
+      "Rails":            "https://docs.rubocop.org/rubocop-rails/cops_rails.html#%{anchor}",
+      "RSpec":            "https://docs.rubocop.org/rubocop-rspec/cops_rspec.html#%{anchor}",
+      "RSpec/Capybara":   "https://docs.rubocop.org/rubocop-rspec/cops_rspec/capybara.html#%{anchor}",
+      "RSpec/FactoryBot": "https://docs.rubocop.org/rubocop-rspec/cops_rspec/factorybot.html#%{anchor}",
+      "RSpec/Rails":      "https://docs.rubocop.org/rubocop-rspec/cops_rspec/rails.html#%{anchor}",
+      "Sorbet":           "https://github.com/Shopify/rubocop-sorbet/blob/master/manual/cops_sorbet.md#%{anchor}",
+    }
 
     def initialize(offense)
-      @cop_name = offense.cop_name
+      @badge = RuboCop::Cop::Badge.parse(offense.cop_name)
       @message = offense.message
       @start = Interface::Position.new(line: offense.line - 1, character: offense.column)
       @end = Interface::Position.new(line: offense.last_line - 1, character: offense.last_column)
       @replacements = replacements_from_offense(offense)
-      @diagnostic_response = diagnostic_from_offense(offense)
     end
 
     def correctable?
       !!@replacements
     end
 
-    private
+    def cop_name
+      @cop_name ||= badge.to_s
+    end
 
-    def diagnostic_from_offense(offense)
-      Interface::Diagnostic.new(
-        message: offense.message,
+    def diagnostic_response
+      @diagnostic_response ||= Interface::Diagnostic.new(
+        message: message,
+        "source": "RuboCop",
+        code: cop_name,
+        code_description: Interface::CodeDescription.new(
+          href: doc_url
+        ),
         severity: Constant::DiagnosticSeverity::INFORMATION,
         range: Interface::Range.new(
-          start: @start,
-          end: @end
+          start: start,
+          end: self.end
         )
       )
     end
 
+    private
+
+    def doc_url
+      @doc_url ||= begin
+        anchor = cop_name.downcase.gsub(%r{/}, "")
+
+        format(DOCS_URLS[badge.department], anchor: anchor)
+      end
+    end
+
     def replacements_from_offense(offense)
       return unless offense.correctable?
 

data/lib/rubocop/lsp/model/diagnostic_collection.rb

@@ -55,7 +55,7 @@ module Model
 
       Interface::CodeAction.new(
         title: title,
-        kind: "rubocop.fix",
+        kind: kind,
         edit: Interface::WorkspaceEdit.new(
           document_changes: [
             Interface::TextDocumentEdit.new(

data/lib/rubocop/lsp/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Lsp
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-lsp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop