Merge pull request #1651 from puremourning/inlay-hints

Inlay hints

Author: mergify[bot]

build.py

@@ -95,7 +95,7 @@ def Exit( self ):
   '09650af5c9dc39f0b40981bcdaa2170cbbc5bb003ac90cdb07fbb57381ac47b2'
 )
 
-RUST_TOOLCHAIN = 'nightly-2021-10-26'
+RUST_TOOLCHAIN = 'nightly-2022-08-17'
 RUST_ANALYZER_DIR = p.join( DIR_OF_THIRD_PARTY, 'rust-analyzer' )
 
 BUILD_ERROR_MESSAGE = (
@@ -868,7 +868,7 @@ def EnableGoCompleter( args ):
   new_env.pop( 'GOROOT', None )
   new_env[ 'GOBIN' ] = p.join( new_env[ 'GOPATH' ], 'bin' )
 
-  gopls = 'golang.org/x/tools/gopls@v0.7.1'
+  gopls = 'golang.org/x/tools/gopls@v0.9.4'
   CheckCall( [ go, 'install', gopls ],
              env = new_env,
              quiet = args.quiet,

docs/index.html

@@ -682,6 +682,57 @@ definitions:
         items:
           $ref: "#/definitions/DiagnosticData"
 
+  SemanticToken:
+    type: object
+    description: |-
+      A item describing the type of token covered by the supplied range.
+    required:
+       - range
+       - type
+       - modifiers
+    properties:
+      range:
+        $ref: '#/definitions/Range'
+      type:
+        type: string
+        description: |-
+          One of the token types supported by LSP, or custom ones provided by
+          the semantic engine. Should be mapped to some syntax group understood
+          by the client.
+      modifiers:
+        type: array
+        description: List of token modifiers, provided by the sematnic engine
+        items: string
+
+  InlayHint:
+    type: object
+    description: |-
+      An inlay hint to be rendered in the docuemnt body but not part of the
+      text. Includes optional padding before and after and a kind, which is one
+      of the LSP or tsserver kinds.
+    required:
+       - kind
+       - position
+       - label
+       - paddingLeft
+       - paddingRight
+    properties:
+      kind:
+        type: string
+        enum:
+          - Type
+          - Parameter
+          - Enum
+      position:
+        $ref: '#/definitions/Location'
+      label:
+        type: string
+        description: Text to display
+      paddingLeft:
+        type: boolean
+      paddingRight:
+        type: boolean
+
 paths:
   /event_notification:
     post:
@@ -1708,3 +1759,102 @@ paths:
           description: An error occurred
           schema:
             $ref: "#/definitions/ExceptionResponse"
+  /semantic_tokens:
+    post:
+      summary: Compute semantic tokens for a range, or the whole document
+      description: |-
+        Compute and return semantic tokens
+      produces:
+        application/json
+      parameters:
+        - name: request_data
+          in: body
+          description: |-
+            The context data, including the current cursor position, and details
+            of dirty buffers.
+          required: true
+          schema:
+            type: object
+            required:
+              - filepath
+              - file_data
+            properties:
+              filepath:
+                $ref: "#/definitions/FilePath"
+              file_data:
+                $ref: "#/definitions/FileDataMap"
+              range:
+                $ref: "#/definitions/Range"
+      responses:
+        200:
+          description: |-
+            Hints created, or not supported (emtpy list)
+          schema:
+            type: object
+            required:
+              - semantic_tokens
+              - errors
+            properties:
+              semantic_tokens:
+                type: object
+                properties:
+                  tokens:
+                    $ref: "#/definitions/SemanticToken"
+              errors:
+                type: array
+                items:
+                  $ref: "#/definitions/Exception"
+        500:
+          description: An error occurred
+          schema:
+            $ref: "#/definitions/ExceptionResponse"
+  /inlay_hints:
+    post:
+      summary: Compute inlay hints for a range
+      description: |-
+        Compute and return inlay hints for a document range.
+      produces:
+        application/json
+      parameters:
+        - name: request_data
+          in: body
+          description: |-
+            The context data, including the current cursor position, and details
+            of dirty buffers.
+          required: true
+          schema:
+            type: object
+            required:
+              - filepath
+              - file_data
+              - range
+            properties:
+              filepath:
+                $ref: "#/definitions/FilePath"
+              file_data:
+                $ref: "#/definitions/FileDataMap"
+              range:
+                $ref: "#/definitions/Range"
+      responses:
+        200:
+          description: |-
+            Hints created, or not supported (emtpy list)
+          schema:
+            type: object
+            required:
+              - inlay_hints
+              - errors
+            properties:
+              inlay_hints:
+                type: array
+                items:
+                  $ref: "#/definitions/InlayHint"
+              errors:
+                type: array
+                items:
+                  $ref: "#/definitions/Exception"
+
+        500:
+          description: An error occurred
+          schema:
+            $ref: "#/definitions/ExceptionResponse"

docs/openapi.yml

@@ -1,6 +1,6 @@
 {
   "description": "ycmd tern runtime area with required typescript version and plugins",
   "dependencies": {
-    "typescript": "4.5.2"
+    "typescript": "4.7.4"
   }
 }

third_party/tsserver/package.json

@@ -373,6 +373,10 @@ def ComputeSemanticTokens( self, request_data ):
     return {}
 
 
+  def ComputeInlayHints( self, request_data ):
+    return []
+
+
   def DefinedSubcommands( self ):
     subcommands = sorted( self.GetSubcommandsMap().keys() )
     try:

ycmd/completers/completer.py

@@ -78,6 +78,25 @@ def SupportedFiletypes( self ):
     return [ 'go' ]
 
 
+  def _SetUpSemanticTokenAtlas( self, capabilities: dict ):
+    if 'semanticTokensProvider' not in capabilities:
+      # gopls is broken and doesn't provide a legend, instead assuming the
+      # tokens specified by the client are the legend. This is broken, but
+      # easily worked around:
+      #
+      # https://github.com/golang/go/issues/54531
+      import ycmd.completers.language_server.language_server_protocol as lsp
+      capabilities[ 'semanticTokensProvider' ] = {
+        'full': True,
+        'legend': {
+          'tokenTypes': lsp.TOKEN_TYPES,
+          'tokenModifiers': lsp.TOKEN_MODIFIERS
+        }
+      }
+
+    return super()._SetUpSemanticTokenAtlas( capabilities )
+
+
   def GetDoc( self, request_data ):
     assert self._settings[ 'ls' ][ 'hoverKind' ] == 'Structured'
     try:
@@ -98,7 +117,20 @@ def GetType( self, request_data ):
 
 
   def DefaultSettings( self, request_data ):
-    return { 'hoverKind': 'Structured' }
+    return {
+      'hoverKind': 'Structured',
+      'hints': {
+        'assignVariableTypes': True,
+        'compositeLiteralFields': True,
+        'compositeLiteralTypes': True,
+        'constantValues': True,
+        'functionTypeParameters': True,
+        'parameterNames': True,
+        'rangeVariableTypes': True,
+      },
+      'semanticTokens': True
+    }
+
 
 
   def ExtraCapabilities( self ):

ycmd/completers/go/go_completer.py

@@ -22,7 +22,7 @@
 
 
 def GetCompleter( user_options ):
-  if ShouldEnableTernCompleter():
+  if ShouldEnableTernCompleter( user_options ):
     return TernCompleter( user_options )
   if ShouldEnableTypeScriptCompleter( user_options ):
     return TypeScriptCompleter( user_options )

ycmd/completers/javascript/hook.py

@@ -54,12 +54,16 @@
 LOGFILE_FORMAT = 'tern_{port}_{std}_'
 
 
-def ShouldEnableTernCompleter():
+def ShouldEnableTernCompleter( user_options ):
   """Returns whether or not the tern completer is 'installed'. That is whether
   or not the tern submodule has a 'node_modules' directory. This is pretty much
   the only way we can know if the user added '--js-completer' on
   install or manually ran 'npm install' in the tern submodule directory."""
 
+  if user_options.get( 'disable_tern' ):
+    LOGGER.info( 'Not using Tern completer: disabled by user' )
+    return False
+
   if not PATH_TO_NODE:
     LOGGER.warning( 'Not using Tern completer: unable to find node' )
     return False

ycmd/completers/javascript/tern_completer.py

@@ -1551,10 +1551,13 @@ def ComputeSemanticTokens( self, request_data ):
     if not self._semantic_token_atlas:
       return {}
 
+    range_supported = self._server_capabilities[ 'semanticTokensProvider' ].get(
+      'range', False )
+
     self._UpdateServerWithCurrentFileContents( request_data )
 
     request_id = self.GetConnection().NextRequestId()
-    body = lsp.SemanticTokens( request_id, request_data )
+    body = lsp.SemanticTokens( request_id, range_supported, request_data )
 
     for _ in RetryOnFailure( [ lsp.Errors.ContentModified ] ):
       response = self._connection.GetResponse(
@@ -1578,6 +1581,53 @@ def ComputeSemanticTokens( self, request_data ):
     }
 
 
+  def ComputeInlayHints( self, request_data ):
+    if not self._initialize_event.wait( REQUEST_TIMEOUT_COMPLETION ):
+      return []
+
+    if not self._ServerIsInitialized():
+      return []
+
+    if 'inlayHintProvider' not in self._server_capabilities:
+      return []
+
+    self._UpdateServerWithCurrentFileContents( request_data )
+    request_id = self.GetConnection().NextRequestId()
+    body = lsp.InlayHints( request_id, request_data )
+
+    for _ in RetryOnFailure( [ lsp.Errors.ContentModified ] ):
+      response = self._connection.GetResponse(
+        request_id,
+        body,
+        3 * REQUEST_TIMEOUT_COMPLETION )
+
+    if response is None:
+      return []
+
+    file_contents = GetFileLines( request_data, request_data[ 'filepath' ] )
+
+    def BuildLabel( label_or_labels ):
+      if isinstance( label_or_labels, list ):
+        return ' '.join( label[ 'value' ] for label in label_or_labels )
+      return label_or_labels
+
+    def BuildInlayHint( inlay_hint: dict ):
+      return {
+        'kind': lsp.INLAY_HINT_KIND[ inlay_hint[ 'kind' ] ],
+        'position': responses.BuildLocationData(
+          _BuildLocationAndDescription(
+            request_data[ 'filepath' ],
+            file_contents,
+            inlay_hint[ 'position' ] )[ 0 ]
+        ),
+        'label': BuildLabel( inlay_hint[ 'label' ] ),
+        'paddingLeft': inlay_hint.get( 'paddingLeft', False ),
+        'paddingRight': inlay_hint.get( 'paddingRight', False ),
+      }
+
+    return [ BuildInlayHint( h ) for h in response.get( 'result' ) or [] ]
+
+
   def GetDetailedDiagnostic( self, request_data ):
     self._UpdateServerWithFileContents( request_data )
 
@@ -3117,11 +3167,11 @@ def _LocationListToGoTo( request_data, positions ):
     if len( positions ) > 1:
       return [
         responses.BuildGoToResponseFromLocation(
-          *_PositionToLocationAndDescription( request_data, position ) )
+          *_LspLocationToLocationAndDescription( request_data, position ) )
         for position in positions
       ]
     return responses.BuildGoToResponseFromLocation(
-      *_PositionToLocationAndDescription( request_data, positions[ 0 ] ) )
+      *_LspLocationToLocationAndDescription( request_data, positions[ 0 ] ) )
   except ( IndexError, KeyError ):
     raise RuntimeError( 'Cannot jump to location' )
 
@@ -3130,7 +3180,7 @@ def _SymbolInfoListToGoTo( request_data, symbols ):
   """Convert a list of LSP SymbolInformation into a YCM GoTo response"""
 
   def BuildGoToLocationFromSymbol( symbol ):
-    location, line_value = _PositionToLocationAndDescription(
+    location, line_value = _LspLocationToLocationAndDescription(
       request_data,
       symbol[ 'location' ] )
 
@@ -3157,10 +3207,10 @@ def BuildGoToLocationFromSymbol( symbol ):
     return locations
 
 
-def _PositionToLocationAndDescription( request_data, position ):
-  """Convert a LSP position to a ycmd location."""
+def _LspLocationToLocationAndDescription( request_data, location ):
+  """Convert a LSP Location to a ycmd location."""
   try:
-    filename = lsp.UriToFilePath( position[ 'uri' ] )
+    filename = lsp.UriToFilePath( location[ 'uri' ] )
     file_contents = GetFileLines( request_data, filename )
   except lsp.InvalidUriException:
     LOGGER.debug( 'Invalid URI, file contents not available in GoTo' )
@@ -3176,7 +3226,7 @@ def _PositionToLocationAndDescription( request_data, position ):
 
   return _BuildLocationAndDescription( filename,
                                        file_contents,
-                                       position[ 'range' ][ 'start' ] )
+                                       location[ 'range' ][ 'start' ] )
 
 
 def _LspToYcmdLocation( file_contents, location ):