syntax_tree 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3c35843b6e3148499ac001d05a9c5d613d69debff5fdc411dff89a9adc5ca4
-  data.tar.gz: 570ae99edf8b17b5d205142872621b0551632d29ac4671ee14fed8415cf9cfe4
+  metadata.gz: f8818212d64fea80bd776267ea9dac3a10c454e789b47ed72f4cf715dc087b30
+  data.tar.gz: ac90d097d6cbd8b50427c5ead994021448732022ce680a809c17e5e7fe9b427f
 SHA512:
-  metadata.gz: 7ec0e9d8f5f4f828ba0d451d49bd7fa9f5576570f7427c91973503e795fe068e21a61dac4f1880be12dbd551855eb0b8d27f359a9a682b964f3183aaf687e1da
-  data.tar.gz: b8ae5c0132ebc445d060b1d5cef477253c724ea2c7a22a536d4ea78b3fb2d905c560e1f044f8843b92f79e0dbc1a434cda2a38e76b2732b426719150785a59af
+  metadata.gz: cfe0af3c52f742ed24f5643710df53fd09b761f428c007ac9434d0e96828bc75c8e082884685173e6b7ea5cf5343d264219c5f5d2c9eb0a90a1fd58d2bec70c8
+  data.tar.gz: 0ee8b8362d6d18945f5bca0a0bfef1d1dc85e2fa5f27c61e807d7c4aa15b23cbb70fe6a8ebe4b1d6e73fd26e473c6fbb158287de2ee7343d0231e75b3529329b

data/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.9.0] - 2022-07-04
+
+- [#106](https://github.com/ruby-syntax-tree/syntax_tree/pull/106) - Add inlay hint support to match the LSP specification.
+
 ## [2.8.0] - 2022-06-21
 
 ### Added
@@ -272,7 +276,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.8.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.8.0...v2.1.0
 [2.8.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.7.1...v2.8.0
 [2.7.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.7.0...v2.7.1
 [2.7.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v2.6.0...v2.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (2.8.0)
+    syntax_tree (2.9.0)
       prettier_print
 
 GEM
@@ -9,7 +9,8 @@ GEM
   specs:
     ast (2.4.2)
     docile (1.4.0)
-    minitest (5.16.0)
+    json (2.6.2)
+    minitest (5.16.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -18,7 +19,8 @@ GEM
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.30.1)
+    rubocop (1.31.1)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -36,7 +38,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   arm64-darwin-21

data/lib/syntax_tree/language_server/inlay_hints.rb

@@ -2,18 +2,19 @@
 
 module SyntaxTree
   class LanguageServer
-    # This class provides inlay hints for the language server. It is loosely
-    # designed around the LSP spec, but existed before the spec was finalized so
-    # is a little different for now.
+    # This class provides inlay hints for the language server. It existed
+    # before the spec was finalized so, so it provides two result formats:
+    # aligned with the spec (`#all`) and proprietary (`#before` and `#after`).
     #
     # For more information, see the spec here:
     # https://github.com/microsoft/language-server-protocol/issues/956.
     #
     class InlayHints < Visitor
-      attr_reader :stack, :before, :after
+      attr_reader :stack, :all, :before, :after
 
       def initialize
         @stack = []
+        @all = []
         @before = Hash.new { |hash, key| hash[key] = +"" }
         @after = Hash.new { |hash, key| hash[key] = +"" }
       end
@@ -98,6 +99,13 @@ module SyntaxTree
       def visit_rescue(node)
         if node.exception.nil?
           after[node.location.start_char + "rescue".length] << " StandardError"
+          all << {
+            position: {
+              line: node.location.start_line - 1,
+              character: node.location.start_column + "rescue".length
+            },
+            label: " StandardError"
+          }
         end
 
         super
@@ -129,6 +137,20 @@ module SyntaxTree
       private
 
       def parentheses(location)
+        all << {
+          position: {
+            line: location.start_line - 1,
+            character: location.start_column
+          },
+          label: "₍"
+        }
+        all << {
+          position: {
+            line: location.end_line - 1,
+            character: location.end_column
+          },
+          label: "₎"
+        }
         before[location.start_char] << "₍"
         after[location.end_char] << "₎"
       end

data/lib/syntax_tree/language_server.rb

@@ -61,11 +61,19 @@ module SyntaxTree
            }
           write(id: id, result: [format(store[uri])])
         in {
+             # official RPC in LSP spec 3.17
+             method: "textDocument/inlayHint",
+             id:,
+             params: { textDocument: { uri: } }
+           }
+          write(id: id, result: inlay_hints(store[uri], false))
+        in {
+             # proprietary RPC (deprecated) between this gem and vscode-syntax-tree
              method: "textDocument/inlayHints",
              id:,
              params: { textDocument: { uri: } }
            }
-          write(id: id, result: inlay_hints(store[uri]))
+          write(id: id, result: inlay_hints(store[uri], true))
         in {
              method: "syntaxTree/visualizing",
              id:,
@@ -85,6 +93,9 @@ module SyntaxTree
     def capabilities
       {
         documentFormattingProvider: true,
+        inlayHintProvider: {
+          resolveProvider: false
+        },
         textDocumentSync: {
           change: 1,
           openClose: true
@@ -108,14 +119,18 @@ module SyntaxTree
       }
     end
 
-    def inlay_hints(source)
+    def inlay_hints(source, proprietary)
       inlay_hints = InlayHints.find(SyntaxTree.parse(source))
       serialize = ->(position, text) { { position: position, text: text } }
 
-      {
-        before: inlay_hints.before.map(&serialize),
-        after: inlay_hints.after.map(&serialize)
-      }
+      if proprietary
+        {
+          before: inlay_hints.before.map(&serialize),
+          after: inlay_hints.after.map(&serialize)
+        }
+      else
+        inlay_hints.all
+      end
     rescue Parser::ParseError
       # If there is a parse error, then we're not going to return any inlay
       # hints for this source.

data/lib/syntax_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTree
-  VERSION = "2.8.0"
+  VERSION = "2.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: A parser based on ripper