Merge pull request #27 from joe-re/rubocop-integration

Add rubocop integration

Author: mtsmfm

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Not released
 
+- rubocop support #27
+
 ## 0.8.0
 
 - Use RubyVM::InstructionSequence.compile instead of open3

language_server.gemspec

@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "m"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "rubocop"
 end

lib/language_server.rb

@@ -2,6 +2,7 @@
 require "language_server/logger"
 require "language_server/protocol"
 require "language_server/linter/ruby_wc"
+require "language_server/linter/rubocop"
 require "language_server/completion_provider/rcodetools"
 require "language_server/completion_provider/ad_hoc"
 require "language_server/definition_provider/ad_hoc"
@@ -93,8 +94,9 @@ def on(method, &callback)
     text = request[:params][:contentChanges][0][:text]
     file_store.cache(uri, text)
     project.recalculate_result(uri)
+    diagnostics = (Linter::Rubocop.new(text).call + Linter::RubyWC.new(text).call).flatten
 
-    diagnostics = Linter::RubyWC.new(text).call.map do |error|
+    diagnostics = diagnostics.map do |error|
       Protocol::Interface::Diagnostic.new(
         message: error.message,
         severity: error.warning? ? Protocol::Constant::DiagnosticSeverity::WARNING : Protocol::Constant::DiagnosticSeverity::ERROR,

lib/language_server/linter/rubocop.rb

@@ -0,0 +1,55 @@
+begin
+  require 'rubocop'
+rescue LoadError
+end
+
+module LanguageServer
+  module Linter
+    class Rubocop
+      def initialize(source, config_path="")
+        @source = source
+        @config_path = config_path
+      end
+
+
+      def call
+        return [] unless defined? ::RuboCop
+        args = []
+        args += ["--config", @config_path] if @config_path != ''
+        args += ["--format", "json","--stdin", "lsp_buffer.rb"]
+        o = nil
+        begin
+          $stdin = StringIO.new(@source)
+          $stdout = StringIO.new
+          config_store = ::RuboCop::ConfigStore.new
+          options, paths = ::RuboCop::Options.new.parse(args)
+          config_store.options_config = options[:config] if options[:config]
+          runner = ::RuboCop::Runner.new(options, config_store)
+          runner.run(paths)
+          o = $stdout.string
+        ensure
+          $stdin = STDIN
+          $stdout = STDOUT
+        end
+        return [] unless o
+        JSON
+          .parse(o)['files'].map { |v| v['offenses'] }
+          .flatten
+          .map { |v| Error.new(line_num: v['location']['line'].to_i - 1, message: v['message'], type: convert_type(v['severity'])) }
+      end
+
+      private
+
+      def convert_type(type)
+        case type
+        when 'refactor' then 'warning'
+        when 'convention' then 'warning'
+        when 'warning' then 'warning'
+        when 'error' then 'error'
+        when 'fatal' then 'error'
+        end
+      end
+
+    end
+  end
+end

test/fixtures/rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  DisabledByDefault: true
+
+Lint/UselessAssignment:
+  Enabled: true
+StringLiterals:
+  EnforcedStyle: single_quotes

test/language_server/linter/rubocop_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+module LanguageServer::Linter
+  class RubocopTest < Minitest::Test
+    def setup
+      @config_path = File.expand_path('./../../../fixtures/rubocop.yml', __FILE__)
+    end
+
+    def test_fatal_error
+      source = 'require "foo'
+      actual = Rubocop.new(source, @config_path).call
+      assert do
+        actual == [
+          Error.new(
+            line_num: 0,
+            message: "unterminated string meets end of file\n(Using Ruby 2.1 parser; configure using `TargetRubyVersion` parameter, under `AllCops`)",
+            type: 'error'
+          )
+        ]
+      end
+    end
+
+    def test_warning_error
+      source = "a = 'a'"
+      actual = Rubocop.new(source, @config_path).call
+      assert do
+        actual.first == Error.new(line_num: 0, message: "Useless assignment to variable - `a`.", type: 'warning')
+      end
+    end
+
+    def test_convention_error
+      source = 'require "foo"'
+      actual = Rubocop.new(source, @config_path).call
+      assert do
+        actual.first == Error.new(line_num: 0, message: "Prefer single-quoted strings when you don't need string interpolation or special symbols.", type: 'warning')
+      end
+    end
+  end
+end