standard 1.23.0 → 1.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec668f31e8de1959e062f5dbb2cf5e35271df24c5852658594c6ad3e9b36369a
-  data.tar.gz: 458b4c01b10be7f37ffa140575d3ccf90d8be56778a4b4752961c9cb0b6e8940
+  metadata.gz: 69342b56c2cb5d98f491d5c02cb7d787c667954fe4422654ddc434d0f34384b4
+  data.tar.gz: 7945846b4e2a92e4543752ccd7034a8ce5e441d126f5604d72333cd3b2ec1966
 SHA512:
-  metadata.gz: 3da9df5fa960b922f29da77dfa2f8379180726bed9d0021916a08dae0d7c082056985c1c22ff7c855db050d7006d0b02370b58b2adeb9c5591f7a3fb42122ed9
-  data.tar.gz: 549557b4f5bf4ad6a9e7d63b4414ddac999bd0088992e28580158b68a43100677bc066ebebbe29a382a9efb431bbb1c32bca60e5c333ac443730229763b42f05
+  metadata.gz: 49e59dc51822c205910db0f1dc318e26012875ae727c00d1f358779b7292799e1d6ce4df36d321fd4a1633471afc86a218697bfd9dc7b00b73e62efc2bdbe7c8
+  data.tar.gz: 29dfd9bb60acb15d038be99e338e6376894237e8fe1fac78915b9c8f76040a17e6b3fcd7f14a072b9c6e712f256e8ef51445099993604a57c3b14d9675bb4285

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.24.1
+
+* _Further_ improve `--lsp` server to better support commands used by VS Code
+
+## 1.24.0
+
+* Improve `--lsp` server to better support the commands used by VS Code
+
 ## 1.23.0
 
 * Update rubocop from 1.42.0 to [1.44.1](https://github.com/rubocop/rubocop/releases/tag/v1.44.1)

data/Gemfile

@@ -7,6 +7,7 @@ gem "minitest", "~> 5.0"
 gem "pry"
 gem "rake", "~> 13.0"
 gem "gimme"
+gem "m"
 
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.5")
   gem "simplecov"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (1.23.0)
+    standard (1.24.1)
       language_server-protocol (~> 3.17.0.2)
       rubocop (= 1.44.1)
       rubocop-performance (= 1.15.2)
@@ -15,17 +15,20 @@ GEM
     gimme (0.5.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    m (1.6.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
     method_source (1.0.0)
     minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.2)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rubocop (1.44.1)
       json (~> 2.3)
@@ -58,6 +61,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   gimme
+  m
   minitest (~> 5.0)
   pry
   rake (~> 13.0)

data/lib/standard/lsp/kills_server.rb

@@ -0,0 +1,10 @@
+module Standard
+  module Lsp
+    class KillsServer
+      def call(&blk)
+        at_exit(&blk) unless blk.nil?
+        exit 0
+      end
+    end
+  end
+end

data/lib/standard/lsp/logger.rb

@@ -0,0 +1,9 @@
+module Standard
+  module Lsp
+    class Logger
+      def puts(message)
+        warn("[server] #{message}")
+      end
+    end
+  end
+end

data/lib/standard/lsp/routes.rb

@@ -0,0 +1,194 @@
+require_relative "kills_server"
+
+module Standard
+  module Lsp
+    class Routes
+      def initialize(writer, logger, standardizer)
+        @writer = writer
+        @logger = logger
+        @standardizer = standardizer
+
+        @text_cache = {}
+        @kills_server = KillsServer.new
+      end
+
+      def self.handle(name, &block)
+        define_method("handle_#{name}", &block)
+      end
+
+      def for(name)
+        name = "handle_#{name}"
+        if respond_to?(name)
+          method(name)
+        end
+      end
+
+      handle "initialize" do |request|
+        @writer.write(id: request[:id], result: Proto::Interface::InitializeResult.new(
+          capabilities: Proto::Interface::ServerCapabilities.new(
+            document_formatting_provider: true,
+            diagnostic_provider: true,
+            execute_command_provider: true,
+            text_document_sync: Proto::Interface::TextDocumentSyncOptions.new(
+              change: Proto::Constant::TextDocumentSyncKind::FULL
+            )
+          )
+        ))
+      end
+
+      handle "initialized" do |request|
+        @logger.puts "Standard Ruby v#{Standard::VERSION} LSP server initialized, pid #{Process.pid}"
+      end
+
+      handle "shutdown" do |request|
+        @logger.puts "Client asked to shutdown Standard LSP server."
+        @kills_server.call do
+          @writer.write(id: request[:id], result: nil)
+          @logger.puts "Exiting..."
+        end
+      end
+
+      handle "textDocument/diagnostic" do |request|
+        doc = request[:params][:textDocument]
+        result = diagnostic(doc[:uri], doc[:text])
+        @writer.write(result)
+      end
+
+      handle "textDocument/didChange" do |request|
+        params = request[:params]
+        result = diagnostic(params[:textDocument][:uri], params[:contentChanges][0][:text])
+        @writer.write(result)
+      end
+
+      handle "textDocument/didOpen" do |request|
+        doc = request[:params][:textDocument]
+        result = diagnostic(doc[:uri], doc[:text])
+        @writer.write(result)
+      end
+
+      handle "textDocument/didClose" do |request|
+        @text_cache.delete(request.dig(:params, :textDocument, :uri))
+      end
+
+      handle "textDocument/formatting" do |request|
+        uri = request[:params][:textDocument][:uri]
+        @writer.write({id: request[:id], result: format_file(uri)})
+      end
+
+      handle "workspace/didChangeWatchedFiles" do |request|
+        if request[:params][:changes].any? { |change| change[:uri].end_with?(".standard.yml") }
+          @logger.puts "Configuration file changed; restart required"
+          @kills_server.call
+        end
+      end
+
+      handle "workspace/executeCommand" do |request|
+        if request[:params][:command] == "standardRuby.formatAutoFixes"
+          uri = request[:params][:arguments][0][:uri]
+          @writer.write({
+            id: request[:id],
+            method: "workspace/applyEdit",
+            params: {
+              label: "Format with Standard Ruby auto-fixes",
+              edit: {
+                changes: {
+                  uri => format_file(uri)
+                }
+              }
+            }
+          })
+        else
+          handle_unsupported_method(request, request[:params][:command])
+        end
+      end
+
+      handle "textDocument/didSave" do |_request|
+        # Nothing to do
+      end
+
+      handle "$/cancelRequest" do |_request|
+        # Can't cancel anything because single-threaded
+      end
+
+      handle "$/setTrace" do |_request|
+        # No-op, we log everything
+      end
+
+      def handle_unsupported_method(request, method = request[:method])
+        @writer.write({id: request[:id], error: Proto::Interface::ResponseError.new(
+          code: Proto::Constant::ErrorCodes::METHOD_NOT_FOUND,
+          message: "Unsupported Method: #{method}"
+        )})
+        @logger.puts "Unsupported Method: #{method}"
+      end
+
+      private
+
+      def format_file(file_uri)
+        text = @text_cache[file_uri]
+        if text.nil?
+          @logger.puts "Format request arrived before text synchonized; skipping: `#{file_uri}'"
+          []
+        else
+          new_text = @standardizer.format(text)
+          if new_text == text
+            []
+          else
+            [{
+              newText: new_text,
+              range: {
+                start: {line: 0, character: 0},
+                end: {line: text.count("\n") + 1, character: 0}
+              }
+            }]
+          end
+        end
+      end
+
+      def diagnostic(file_uri, text)
+        @text_cache[file_uri] = text
+        offenses = @standardizer.offenses(text)
+
+        lsp_diagnostics = offenses.map { |o|
+          code = o[:cop_name]
+
+          msg = o[:message].delete_prefix(code)
+          loc = o[:location]
+
+          severity = case o[:severity]
+          when "error", "fatal"
+            SEV::ERROR
+          when "warning"
+            SEV::WARNING
+          when "convention"
+            SEV::INFORMATION
+          when "refactor", "info"
+            SEV::HINT
+          else # the above cases fully cover what RuboCop sends at this time
+            logger.puts "Unknown severity: #{severity.inspect}"
+            SEV::HINT
+          end
+
+          {
+            code: code,
+            message: msg,
+            range: {
+              start: {character: loc[:start_column] - 1, line: loc[:start_line] - 1},
+              end: {character: loc[:last_column] - 1, line: loc[:last_line] - 1}
+            },
+            severity: severity,
+            source: "standard"
+          }
+        }
+
+        {
+          method: "textDocument/publishDiagnostics",
+          params: {
+            uri: file_uri,
+            diagnostics: lsp_diagnostics
+          }
+        }
+      end
+    end
+  end
+end

data/lib/standard/lsp/server.rb

@@ -1,144 +1,41 @@
 require "language_server-protocol"
 require_relative "standardizer"
+require_relative "routes"
+require_relative "logger"
 
 module Standard
-  module LSP
-    class Server
-      Proto = LanguageServer::Protocol
-      SEV = Proto::Constant::DiagnosticSeverity
+  module Lsp
+    Proto = LanguageServer::Protocol
+    SEV = Proto::Constant::DiagnosticSeverity
 
+    class Server
       def self.start(standardizer)
         new(standardizer).start
       end
 
-      attr_accessor :standardizer, :writer, :reader, :logger, :text_cache, :subscribers
-
       def initialize(standardizer)
-        self.standardizer = standardizer
-        self.writer = Proto::Transport::Io::Writer.new($stdout)
-        self.reader = Proto::Transport::Io::Reader.new($stdin)
-        self.logger = $stderr
-        self.text_cache = {}
-
-        self.subscribers = {
-          "initialize" => ->(request) {
-            init_result = Proto::Interface::InitializeResult.new(
-              capabilities: Proto::Interface::ServerCapabilities.new(
-                document_formatting_provider: true,
-                diagnostic_provider: true,
-                text_document_sync: Proto::Constant::TextDocumentSyncKind::FULL
-              )
-            )
-            writer.write(id: request[:id], result: init_result)
-          },
-
-          "initialized" => ->(request) { logger.puts "standard v#{Standard::VERSION} initialized, pid #{Process.pid}" },
-
-          "shutdown" => ->(request) {
-            logger.puts "asked to shutdown, exiting..."
-            exit
-          },
-
-          "textDocument/didChange" => ->(request) {
-            params = request[:params]
-            result = diagnostic(params[:textDocument][:uri], params[:contentChanges][0][:text])
-            writer.write(result)
-          },
-
-          "textDocument/didOpen" => ->(request) {
-            td = request[:params][:textDocument]
-            result = diagnostic(td[:uri], td[:text])
-            writer.write(result)
-          },
-
-          "textDocument/didClose" => ->(request) {
-            text_cache.delete(request.dig(:params, :textDocument, :uri))
-          },
-
-          "textDocument/formatting" => ->(request) {
-            uri = request[:params][:textDocument][:uri]
-            writer.write({id: request[:id], result: format_file(uri)})
-          },
-
-          "textDocument/didSave" => ->(request) {}
-        }
+        @standardizer = standardizer
+        @writer = Proto::Transport::Io::Writer.new($stdout)
+        @reader = Proto::Transport::Io::Reader.new($stdin)
+        @logger = Logger.new
+        @routes = Routes.new(@writer, @logger, @standardizer)
       end
 
       def start
-        reader.read do |request|
+        @reader.read do |request|
+          next unless request.key?(:method) # ignore responses without methods
+
           method = request[:method]
-          if (subscriber = subscribers[method])
-            subscriber.call(request)
+          if (route = @routes.for(method))
+            route.call(request)
           else
-            logger.puts "unknown method: #{method}"
+            @routes.handle_unsupported_method(request)
           end
         rescue => e
-          logger.puts "error #{e.class} #{e.message[0..100]}"
-          logger.puts e.backtrace.inspect
+          @logger.puts "Error #{e.class} #{e.message[0..100]}"
+          @logger.puts e.backtrace.inspect
         end
       end
-
-      def format_file(file_uri)
-        text = text_cache[file_uri]
-        new_text = standardizer.format(text)
-
-        if new_text == text
-          []
-        else
-          [{
-            newText: new_text,
-            range: {
-              start: {line: 0, character: 0},
-              end: {line: text.count("\n") + 1, character: 0}
-            }
-          }]
-        end
-      end
-
-      def diagnostic(file_uri, text)
-        text_cache[file_uri] = text
-        offenses = standardizer.offenses(text)
-
-        lsp_diagnostics = offenses.map { |o|
-          code = o[:cop_name]
-
-          msg = o[:message].delete_prefix(code)
-          loc = o[:location]
-
-          severity = case o[:severity]
-          when "error", "fatal"
-            SEV::ERROR
-          when "warning"
-            SEV::WARNING
-          when "convention"
-            SEV::INFORMATION
-          when "refactor", "info"
-            SEV::HINT
-          else # the above cases fully cover what RuboCop sends at this time
-            logger.puts "unknown severity: #{severity.inspect}"
-            SEV::HINT
-          end
-
-          {
-            code: code,
-            message: msg,
-            range: {
-              start: {character: loc[:start_column] - 1, line: loc[:start_line] - 1},
-              end: {character: loc[:last_column] - 1, line: loc[:last_line] - 1}
-            },
-            severity: severity,
-            source: "standard"
-          }
-        }
-
-        {
-          method: "textDocument/publishDiagnostics",
-          params: {
-            diagnostics: lsp_diagnostics,
-            uri: file_uri
-          }
-        }
-      end
     end
   end
 end

data/lib/standard/lsp/standardizer.rb

@@ -2,7 +2,7 @@ require_relative "../runners/rubocop"
 require "tempfile"
 
 module Standard
-  module LSP
+  module Lsp
     class Standardizer
       def initialize(config)
         @template_options = config

data/lib/standard/runners/lsp.rb

@@ -4,8 +4,8 @@ module Standard
   module Runners
     class Lsp
       def call(config)
-        standardizer = Standard::LSP::Standardizer.new(config)
-        Standard::LSP::Server.start(standardizer)
+        standardizer = Standard::Lsp::Standardizer.new(config)
+        Standard::Lsp::Server.start(standardizer)
       end
     end
   end

data/lib/standard/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("1.23.0")
+  VERSION = Gem::Version.new("1.24.1")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.1
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.17.0.2
-description: 
+description:
 email:
 - searls@gmail.com
 executables:
@@ -102,6 +102,9 @@ files:
 - lib/standard/formatter.rb
 - lib/standard/loads_runner.rb
 - lib/standard/loads_yaml_config.rb
+- lib/standard/lsp/kills_server.rb
+- lib/standard/lsp/logger.rb
+- lib/standard/lsp/routes.rb
 - lib/standard/lsp/server.rb
 - lib/standard/lsp/standardizer.rb
 - lib/standard/merges_settings.rb
@@ -120,7 +123,7 @@ files:
 homepage: https://github.com/testdouble/standard
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer
 test_files: []