rubocop-lsp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5008f097c351d59bce2270ed7339a927fb6793307512bcef8166e36b95c89d5c
+  data.tar.gz: 2fdfc892459fe05ffbd07c3e0f9af182b91d3ec6b7849792ca169977847fd489
+SHA512:
+  metadata.gz: 1f136d5ba9f513c6800daa16ef9f27d6c6241d5a260c303c38ac03673e14edfdcd5ca7327b36d05f14eb4cdeb5a861240ec6306e870d96392f9557cc62ac89df
+  data.tar.gz: 5edada0a8d7b8edc6645cc30ba5f476ff0f7a4670211600d0b4e7fb7a40f0aafeaf2adde292a7095c0d242824ba0d4beee4a68169b40b85362da189985bf0176

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "rubocop-lsp.trace.server": "verbose"
+}

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-lsp.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop-shopify", "~> 2.2"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    rubocop-lsp (0.1.0)
+      language_server-protocol (>= 3.16)
+      rubocop (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    language_server-protocol (3.16.0.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.2.0)
+      rubocop (~> 1.18)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rubocop-lsp!
+  rubocop-shopify (~> 2.2)
+
+BUNDLED WITH
+   2.2.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ufuk Kayserilioglu
+
+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,43 @@
+# RuboCop LSP
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/lsp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-lsp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-lsp
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paracycle/rubocop-lsp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/paracycle/rubocop-lsp/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Lsp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paracycle/rubocop-lsp/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubocop/lsp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rubocop-lsp

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/rubocop/lsp/cli"
+
+Rubocop::Lsp::Cli.start(ARGV)

data/lib/rubocop/lsp.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "lsp/version"
+
+module Rubocop
+  module Lsp
+  end
+end

data/lib/rubocop/lsp/cli.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "language_server-protocol"
+
+require "rubocop/lsp"
+require "rubocop/lsp/handler"
+
+module Rubocop
+  module Lsp
+    module Cli
+      Interface = LanguageServer::Protocol::Interface
+      Constant = LanguageServer::Protocol::Constant
+
+      def self.start(_argv)
+        handler = Handler.new
+
+        handler.config do
+          on("initialize") do
+            DiagnosticStore.clear_diagnostics
+            Interface::InitializeResult.new(
+              capabilities: Interface::ServerCapabilities.new(
+                text_document_sync: Interface::TextDocumentSyncOptions.new(
+                  change: Constant::TextDocumentSyncKind::FULL,
+                  open_close: true
+                ),
+                code_action_provider: true
+              ),
+            )
+          end
+
+          on("shutdown") do
+            DiagnosticStore.clear_diagnostics
+            nil
+          end
+
+          on("textDocument/didChange") do |request|
+            uri = request[:params][:textDocument][:uri]
+            text = request[:params][:contentChanges][0][:text]
+
+            send_diagnostics(uri: uri, text: text)
+
+            nil
+          end
+
+          on("textDocument/didOpen") do |request|
+            uri = request[:params][:textDocument][:uri]
+            text = request[:params][:textDocument][:text]
+
+            send_diagnostics(uri: uri, text: text)
+
+            nil
+          end
+
+          on("textDocument/didClose") do |request|
+            uri = request[:params][:textDocument][:uri]
+
+            DiagnosticStore.remove_diagnostics_for(uri)
+
+            send_diagnostics(uri: uri, diagnostics: [])
+
+            nil
+          end
+
+          on("textDocument/codeAction") do |request|
+            uri = request[:params][:textDocument][:uri]
+            range = request[:params][:range]
+
+            DiagnosticStore.code_actions_for(uri, range)
+          end
+        end
+
+        handler.start
+      end
+    end
+  end
+end

data/lib/rubocop/lsp/diagnostic_collector.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class DiagnosticCollector < RuboCop::Formatter::BaseFormatter
+  Interface = LanguageServer::Protocol::Interface
+  Constant = LanguageServer::Protocol::Constant
+
+  attr_reader :diagnostics
+
+  def initialize
+    super({}, nil)
+  end
+
+  def run(file:, text:)
+    config_store = ::RuboCop::ConfigStore.new
+    options, paths = ::RuboCop::Options.new.parse(["--stderr"])
+    # 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)
+  end
+
+  def file_finished(_file, offenses)
+    @diagnostics = offenses.map do |offense|
+      diagnostic_from_offense(offense)
+    end
+  end
+
+  private
+
+  def diagnostic_from_offense(offense)
+    Interface::Diagnostic.new(
+      message: offense.message,
+      severity: Constant::DiagnosticSeverity::INFORMATION,
+      range: Interface::Range.new(
+        start: Interface::Position.new(line: offense.line - 1, character: offense.column),
+        end: Interface::Position.new(line: offense.last_line - 1, character: offense.last_column)
+      ),
+      data: {
+        cop_name: offense.cop_name,
+        edits: replacements_from_offense(offense),
+      }
+    )
+  end
+
+  def replacements_from_offense(offense)
+    return unless offense.correctable?
+
+    offense.corrector.as_replacements.map do |range, replacement|
+      edit_from_replacement(range, replacement)
+    end
+  end
+
+  def edit_from_replacement(range, replacement)
+    Interface::TextEdit.new(
+      range: Interface::Range.new(
+        start: Interface::Position.new(line: range.line - 1, character: range.column),
+        end: Interface::Position.new(line: range.last_line - 1, character: range.last_column)
+      ),
+      new_text: replacement
+    )
+  end
+end

data/lib/rubocop/lsp/diagnostic_store.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module DiagnosticStore
+  @diagnostic_map = {}
+
+  def self.clear_diagnostics
+    @diagnostic_map = {}
+  end
+
+  def self.remove_diagnostics_for(uri)
+    @diagnostic_map.delete(uri)
+    []
+  end
+
+  def self.set_diagnostics_for(uri, diagnostics)
+    @diagnostic_map[uri] = diagnostics
+  end
+
+  def self.diagnostics_for(uri)
+    @diagnostic_map[uri] || []
+  end
+
+  def self.code_actions_for(uri, range)
+    line_range = Range.new(range[:start][:line], range[:end][:line])
+
+    file_diagnostics = diagnostics_for(uri)
+    line_diagnostics = file_diagnostics.select { |diagnostic| line_range.include?(diagnostic.range.start.line) }
+    actions = line_diagnostics.map { |diagnostic| code_action_from(uri, diagnostic) }
+
+    unless actions.empty?
+      actions << code_action_from_diagnostics(uri, line_diagnostics, title: "Autocorrect all offenses on line")
+      actions << code_action_from_diagnostics(uri, file_diagnostics, title: "Autocorrect all offenses in file")
+    end
+
+    actions
+  end
+
+  def self.code_action_from_diagnostics(uri, diagnostics, title:)
+    diagnostics = diagnostics.sort_by do |diagnostic|
+      [diagnostic.range.start.line, diagnostic.range.start.character]
+    end
+
+    LanguageServer::Protocol::Interface::CodeAction.new(
+      title: title,
+      kind: "rubocop.fix",
+      edit: LanguageServer::Protocol::Interface::WorkspaceEdit.new(
+        document_changes: [
+          LanguageServer::Protocol::Interface::TextDocumentEdit.new(
+            text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
+              uri: uri,
+              version: nil
+            ),
+            edits: diagnostics.flat_map { |d| d.data[:edits] }
+          ),
+        ]
+      ),
+      is_preferred: true,
+    )
+  end
+
+  def self.code_action_from(uri, diagnostic)
+    LanguageServer::Protocol::Interface::CodeAction.new(
+      title: "Autocorrect `#{diagnostic.data[:cop_name]}`",
+      kind: LanguageServer::Protocol::Constant::CodeActionKind::QUICK_FIX,
+      edit: LanguageServer::Protocol::Interface::WorkspaceEdit.new(
+        document_changes: [
+          LanguageServer::Protocol::Interface::TextDocumentEdit.new(
+            text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
+              uri: uri,
+              version: nil
+            ),
+            edits: diagnostic.data[:edits]
+          ),
+        ]
+      ),
+      is_preferred: true,
+    )
+  end
+end

data/lib/rubocop/lsp/handler.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "rubocop/lsp/diagnostic_store"
+require "rubocop/lsp/diagnostic_collector"
+
+class Handler
+  Interface = LanguageServer::Protocol::Interface
+  Constant = LanguageServer::Protocol::Constant
+
+  attr_reader :writer, :reader
+
+  def initialize
+    @writer = LanguageServer::Protocol::Transport::Stdio::Writer.new
+    @reader = LanguageServer::Protocol::Transport::Stdio::Reader.new
+    @handlers = {}
+  end
+
+  def config(&blk)
+    instance_exec(&blk)
+  end
+
+  def start
+    reader.read do |request|
+      handle(request)
+    end
+  end
+
+  private
+
+  def on(message, &blk)
+    @handlers[message.to_s] = blk
+  end
+
+  def handler_for(request)
+    @handlers[request[:method]]
+  end
+
+  def handle(request)
+    log("Got request method: #{request[:method]}")
+    handler = handler_for(request)
+    result = handler.call(request) if handler
+    writer.write(id: request[:id], result: result) if result
+  end
+
+  def log(msg)
+    $stderr.puts(msg)
+  end
+
+  def notify(method:, params: {})
+    log("In notify: #{writer}")
+    writer.write(method: method, params: params)
+  end
+
+  def send_diagnostics(uri:, text: nil, diagnostics: [])
+    diagnostics = collect_diagnostics(uri: uri, text: text) if text
+
+    notify(
+      method: "textDocument/publishDiagnostics",
+      params: Interface::PublishDiagnosticsParams.new(
+        uri: uri,
+        diagnostics: diagnostics
+      )
+    )
+  end
+
+  def collect_diagnostics(uri:, text:)
+    file = CGI.unescape(URI.parse(uri).path)
+    collector = DiagnosticCollector.new
+    collector.run(file: file, text: text)
+    DiagnosticStore.set_diagnostics_for(uri, collector.diagnostics)
+  end
+end

data/lib/rubocop/lsp/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Lsp
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-lsp.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/lsp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-lsp"
+  spec.version       = Rubocop::Lsp::VERSION
+  spec.authors       = ["Shopify"]
+  spec.email         = ["ruby@shopify.com"]
+
+  spec.summary       = "A Language Server Provider for RuboCop"
+  spec.homepage      = "https://github.com/Shopify/rubocop-lsp"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Shopify/rubocop-lsp"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency("rubocop", ">= 1.0")
+  spec.add_dependency("language_server-protocol", ">= 3.16")
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-lsp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shopify
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-22 00:00:00.000000000 Z
+dependencies:
+- !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: language_server-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description:
+email:
+- ruby@shopify.com
+executables:
+- rubocop-lsp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rubocop-lsp
+- lib/rubocop/lsp.rb
+- lib/rubocop/lsp/cli.rb
+- lib/rubocop/lsp/diagnostic_collector.rb
+- lib/rubocop/lsp/diagnostic_store.rb
+- lib/rubocop/lsp/handler.rb
+- lib/rubocop/lsp/version.rb
+- rubocop-lsp.gemspec
+homepage: https://github.com/Shopify/rubocop-lsp
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/rubocop-lsp
+  source_code_uri: https://github.com/Shopify/rubocop-lsp
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.20
+signing_key:
+specification_version: 4
+summary: A Language Server Provider for RuboCop
+test_files: []