standard 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18c18f211f0cdcadb84cc05bbf54f6ea8fc40de394978df75e90ee46b7e5f378
-  data.tar.gz: aa65d3f56f7d7cb51abe64e9473ceea973316ce1bbfd6f3af8654136b669ffbd
+  metadata.gz: 6db13f12aa4f1f0b9e7a2243b59de1902c323835a0a98bc80f261154ede30342
+  data.tar.gz: ff4117589900989c5e6d80b01845ce0572a3351fb0be0a2d5cc4801d744db971
 SHA512:
-  metadata.gz: 27903c69ab28846399bff4716b3bd0894ced1870fe9ebf8ded2178f5b5092f2c260b7a21b835bec214ac318dc3e278d1fbc003777f78788428311a40f9ae9b47
-  data.tar.gz: 36011dac9b213b11ffd7a924482aef7d12c34171a0e5527cbc0bbac71098fb027fd01a48b7b87089a384d19a950eff9f182c7bb77ac7261cad83e608c73d0600
+  metadata.gz: a02ed1dcdbc8ae45c450e886b5c1a7869ef5cb905e4f2f606b3a93022284031850ef6405022898dcc552c707e75759cf79cceaccf6da0846d14bd5a4cfb55ca0
+  data.tar.gz: e04163746057abfac81ef9dfdb219b21f6a95ecc02e903fe98fc2f7ed537a6319e75bb9b740ce930c4b57762b2ab65e80a930e5e2358fc56ab383538a0a272b8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.19.0
+
+* Add a language server protocol (LSP) server via the new `standardrb --lsp`
+  command line mode. All credit to [@will](https://github.com/)!
+  [#475](https://github.com/testdouble/standard/pull/475)
+
 ## 1.18.1
 
 * Update rubocop-performance from 1.15.0 to [1.15.1](https://github.com/rubocop/rubocop-performance/releases/tag/v1.15.1)

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    standard (1.18.1)
+    standard (1.19.0)
+      language_server-protocol (= 3.17.0.1)
       rubocop (= 1.39.0)
       rubocop-performance (= 1.15.1)
 
@@ -13,10 +14,11 @@ GEM
     docile (1.4.0)
     gimme (0.5.0)
     json (2.6.2)
+    language_server-protocol (3.17.0.1)
     method_source (1.0.0)
     minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -35,7 +37,7 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)

data/README.md

@@ -432,12 +432,32 @@ information.
 ## How do I run Standard in my editor?
 
 It can be very handy to know about failures while editing to shorten the
-feedback loop. Some editors support asynchronously running linters.
+feedback loop.
+
+### Language Server Protocol support
+
+To provide immediate feedback of Standard violations and support autofixing
+of your code while avoiding the performance cost of starting and stopping the
+`standardrb` binary repeatedly, Standard Ruby ships with a built-in [Language
+Server Protocol](https://microsoft.github.io/language-server-protocol/) server,
+which is powered by the [language_server-protocol
+gem](https://github.com/mtsmfm/language_server-protocol-ruby) and can be
+activated from the command line with the `--lsp` flag.
+
+Most likely, you'd instantiate this server indirectly in your editor's
+configuration, as can be demonstrated easily with
+[neovim](https://github.com/testdouble/standard/wiki/IDE:-neovim).
+Theoretically, this feature could be leveraged by a purpose-built editor plugin
+to performantly format and fix your code. (If you're looking for a project, we'd
+love to see one created for VS Code!)
+
+### Editor-specific guides
 
 - [Atom](https://github.com/testdouble/standard/wiki/IDE:-Atom)
 - [emacs (via flycheck)](https://github.com/julianrubisch/flycheck-standardrb)
 - [RubyMine](https://www.jetbrains.com/help/ruby/rubocop.html#disable_rubocop)
 - [vim (via ALE)](https://github.com/testdouble/standard/wiki/IDE:-vim)
+- [neovim (via LSP)](https://github.com/testdouble/standard/wiki/IDE:-neovim)
 - [VS Code](https://github.com/testdouble/standard/wiki/IDE:-vscode)
 
 ## Why aren't `frozen_string_literal: true` magic comments enforced?

data/lib/standard/loads_yaml_config.rb

@@ -32,7 +32,7 @@ module Standard
         default_ignores: standard_yaml.key?("default_ignores") ? !!standard_yaml["default_ignores"] : true,
         config_root: yaml_path ? Pathname.new(yaml_path).dirname.to_s : nil,
         todo_file: todo_path,
-        todo_ignore_files: (todo_yaml["ignore"] || []).map { |f| Hash === f ? f.keys.first : f }
+        todo_ignore_files: (todo_yaml["ignore"] || []).map { |f| (Hash === f) ? f.keys.first : f }
       }
     end
 

data/lib/standard/lsp/server.rb

@@ -0,0 +1,144 @@
+require "language_server-protocol"
+require_relative "standardizer"
+
+module Standard
+  module LSP
+    class Server
+      Proto = LanguageServer::Protocol
+      SEV = Proto::Constant::DiagnosticSeverity
+
+      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) {}
+        }
+      end
+
+      def start
+        reader.read do |request|
+          method = request[:method]
+          if (subscriber = subscribers[method])
+            subscriber.call(request)
+          else
+            logger.puts "unknown method: #{method}"
+          end
+        rescue => e
+          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

@@ -0,0 +1,53 @@
+require_relative "../runners/rubocop"
+require "tempfile"
+
+module Standard
+  module LSP
+    class Standardizer
+      def initialize(config)
+        @template_options = config
+        @runner = Standard::Runners::Rubocop.new
+      end
+
+      def format(text)
+        run_standard(text, format: true)
+      end
+
+      def offenses(text)
+        results = run_standard(text, format: false)
+        JSON.parse(results, symbolize_names: true).dig(:files, 0, :offenses)
+      end
+
+      private
+
+      BASENAME = ["source", ".rb"].freeze
+      def run_standard(text, format:)
+        Tempfile.open(BASENAME) do |temp|
+          temp.write(text)
+          temp.flush
+          stdout = capture_rubocop_stdout(make_config(temp.path, format))
+          format ? File.read(temp.path) : stdout
+        end
+      end
+
+      def make_config(file, format)
+        # Can't make frozen versions of this hash because RuboCop mutates it
+        o = if format
+          {autocorrect: true, formatters: [["Standard::Formatter", nil]], parallel: true, todo_file: nil, todo_ignore_files: [], safe_autocorrect: true}
+        else
+          {autocorrect: false, formatters: [["json"]], parallel: true, todo_file: nil, todo_ignore_files: [], format: "json"}
+        end
+        Standard::Config.new(@template_options.runner, [file], o, @template_options.rubocop_config_store)
+      end
+
+      def capture_rubocop_stdout(config)
+        redir = StringIO.new
+        $stdout = redir
+        @runner.call(config)
+        redir.string
+      ensure
+        $stdout = STDOUT
+      end
+    end
+  end
+end

data/lib/standard/merges_settings.rb

@@ -20,7 +20,7 @@ module Standard
 
     def separate_argv(argv)
       argv.partition do |flag|
-        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--help", "-h"].include?(flag)
+        ["--generate-todo", "--fix", "--no-fix", "--version", "-v", "--help", "-h", "--lsp"].include?(flag)
       end
     end
 
@@ -41,6 +41,8 @@ module Standard
         :version
       elsif (argv & ["--generate-todo"]).any?
         :genignore
+      elsif (argv & ["--lsp"]).any?
+        :lsp
       else
         :rubocop
       end

data/lib/standard/runners/help.rb

@@ -4,8 +4,8 @@ module Standard
   module Runners
     class Help
       def call(config)
-        puts <<-MESSAGE.gsub(/^ {10}/, "")
-          Usage: standardrb [--fix] [-vh] [--format <name>] [--] [FILE]...
+        puts <<~MESSAGE
+          Usage: standardrb [--fix] [--lsp] [-vh] [--format <name>] [--] [FILE]...
 
           Options:
 
@@ -13,6 +13,7 @@ module Standard
             --no-fix          Do not automatically fix failures
             --format <name>   Format output with any RuboCop formatter (e.g. "json")
             --generate-todo   Create a .standard_todo.yml that lists all the files that contain errors
+            --lsp             Start a LSP server listening on STDIN
             -v, --version     Print the version of Standard
             -h, --help        Print this message
             FILE              Files to lint [default: ./]

data/lib/standard/runners/lsp.rb

@@ -0,0 +1,12 @@
+require_relative "../lsp/server"
+
+module Standard
+  module Runners
+    class Lsp
+      def call(config)
+        standardizer = Standard::LSP::Standardizer.new(config)
+        Standard::LSP::Server.start(standardizer)
+      end
+    end
+  end
+end

data/lib/standard/version.rb

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

data/standard.gemspec

@@ -21,4 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rubocop", "1.39.0"
   spec.add_dependency "rubocop-performance", "1.15.1"
+
+  # not semver: first three are lsp protocol version, last is patch
+  spec.add_dependency "language_server-protocol", "3.17.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,7 +38,21 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.15.1
-description: 
+- !ruby/object:Gem::Dependency
+  name: language_server-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.17.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.17.0.1
+description:
 email:
 - searls@gmail.com
 executables:
@@ -87,6 +101,8 @@ files:
 - lib/standard/formatter.rb
 - lib/standard/loads_runner.rb
 - lib/standard/loads_yaml_config.rb
+- lib/standard/lsp/server.rb
+- lib/standard/lsp/standardizer.rb
 - lib/standard/merges_settings.rb
 - lib/standard/parses_cli_option.rb
 - lib/standard/railtie.rb
@@ -94,6 +110,7 @@ files:
 - lib/standard/rubocop/ext.rb
 - lib/standard/runners/genignore.rb
 - lib/standard/runners/help.rb
+- lib/standard/runners/lsp.rb
 - lib/standard/runners/rubocop.rb
 - lib/standard/runners/version.rb
 - lib/standard/version.rb
@@ -101,7 +118,7 @@ files:
 homepage: https://github.com/testdouble/standard
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +133,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.7
+signing_key:
 specification_version: 4
 summary: Ruby Style Guide, with linter & automatic code fixer
 test_files: []