language-server-protocol Documentation

File: _config.yml Copy Chapter

Site settings

title: Official page for Language Server Protocol
Language Server Protocol documentation and specification page.

baseurl: /language-server-protocol # the subpath of your site, e.g. /blog/
url: https://microsoft.github.io # the base hostname & protocol for your site
git_address: https://github.com/Microsoft/language-server-protocol
git_edit_address: https://github.com/Microsoft/language-server-protocol/blob/gh-pages

Build settings

markdown: kramdown
highlighter: rouge

plugins:

• github-pages
• jemoji
• jekyll-redirect-from

exclude:

• Gemfile
• Gemfile.lock
• .idea/
• .gitignore
• README.md
• resources/
• vendor/

timezone: Europe/Zurich

defaults:

• scope:
  path: _implementors
  type: implementors
  values:
  layout: implementors
  sectionid: implementors

• scope:
  path: _specifications
  type: specifications
  values:
  layout: specifications
  sectionid: specifications

• scope:
  path: _overviews
  type: overviews
  values:
  layout: overviews
  sectionid: overviews

collections:
implementors:
permalink: /:collection/:path/
output: true
specifications:
permalink: /:collection/:path/
output: true
overviews:
permalink: /:collection/:path/
output: true

File: License-code.txt Copy Chapter

MIT License

Copyright (c) Microsoft Corporation.

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

File: License.txt Copy Chapter

Attribution 4.0 International

=======================================================================

Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.

Using Creative Commons Public Licenses

Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.

Considerations for licensors: Our public licenses are
 intended for use by those authorized to give the public
 permission to use material in ways otherwise restricted by
 copyright and certain other rights. Our licenses are
 irrevocable. Licensors should read and understand the terms
 and conditions of the license they choose before applying it.
 Licensors should also secure all rights necessary before
 applying our licenses so that the public can reuse the
 material as expected. Licensors should clearly mark any
 material not subject to the license. This includes other CC-
 licensed material, or material used under an exception or
 limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors

 Considerations for the public: By using one of our public
 licenses, a licensor grants the public permission to use the
 licensed material under specified terms and conditions. If
 the licensor's permission is not necessary for any reason--for
 example, because of any applicable exception or limitation to
 copyright--then that use is not regulated by the license. Our
 licenses grant only permissions under copyright and certain
 other rights that a licensor has authority to grant. Use of
 the licensed material may still be restricted for other
 reasons, including because others have copyright or other
 rights in the material. A licensor may make special requests,
 such as asking that all changes be marked or described.
 Although not required by our licenses, you are encouraged to
 respect those requests where reasonable. More_considerations
 for the public:
wiki.creativecommons.org/Considerations_for_licensees

=======================================================================

Creative Commons Attribution 4.0 International Public License

By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution 4.0 International Public License ("Public License"). To the
extent this Public License may be interpreted as a contract, You are
granted the Licensed Rights in consideration of Your acceptance of
these terms and conditions, and the Licensor grants You such rights in
consideration of benefits the Licensor receives from making the
Licensed Material available under these terms and conditions.

Section 1 -- Definitions.

a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.

b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.

c. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.

d. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.

e. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.

f. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.

g. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.

h. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.

i. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.

j. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.

k. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.

Section 2 -- Scope.

a. License grant.

1. Subject to the terms and conditions of this Public License,
      the Licensor hereby grants You a worldwide, royalty-free,
      non-sublicensable, non-exclusive, irrevocable license to
      exercise the Licensed Rights in the Licensed Material to:

        a. reproduce and Share the Licensed Material, in whole or
           in part; and

        b. produce, reproduce, and Share Adapted Material.

   2. Exceptions and Limitations. For the avoidance of doubt, where
      Exceptions and Limitations apply to Your use, this Public
      License does not apply, and You do not need to comply with
      its terms and conditions.

   3. Term. The term of this Public License is specified in Section
      6(a).

   4. Media and formats; technical modifications allowed. The
      Licensor authorizes You to exercise the Licensed Rights in
      all media and formats whether now known or hereafter created,
      and to make technical modifications necessary to do so. The
      Licensor waives and/or agrees not to assert any right or
      authority to forbid You from making technical modifications
      necessary to exercise the Licensed Rights, including
      technical modifications necessary to circumvent Effective
      Technological Measures. For purposes of this Public License,
      simply making modifications authorized by this Section 2(a)
      (4) never produces Adapted Material.

   5. Downstream recipients.

        a. Offer from the Licensor -- Licensed Material. Every
           recipient of the Licensed Material automatically
           receives an offer from the Licensor to exercise the
           Licensed Rights under the terms and conditions of this
           Public License.

        b. No downstream restrictions. You may not offer or impose
           any additional or different terms or conditions on, or
           apply any Effective Technological Measures to, the
           Licensed Material if doing so restricts exercise of the
           Licensed Rights by any recipient of the Licensed
           Material.

   6. No endorsement. Nothing in this Public License constitutes or
      may be construed as permission to assert or imply that You
      are, or that Your use of the Licensed Material is, connected
      with, or sponsored, endorsed, or granted official status by,
      the Licensor or others designated to receive attribution as
      provided in Section 3(a)(1)(A)(i).

b. Other rights.

1. Moral rights, such as the right of integrity, are not
      licensed under this Public License, nor are publicity,
      privacy, and/or other similar personality rights; however, to
      the extent possible, the Licensor waives and/or agrees not to
      assert any such rights held by the Licensor to the limited
      extent necessary to allow You to exercise the Licensed
      Rights, but not otherwise.

   2. Patent and trademark rights are not licensed under this
      Public License.

   3. To the extent possible, the Licensor waives any right to
      collect royalties from You for the exercise of the Licensed
      Rights, whether directly or through a collecting society
      under any voluntary or waivable statutory or compulsory
      licensing scheme. In all other cases the Licensor expressly
      reserves any right to collect such royalties.

Section 3 -- License Conditions.

Your exercise of the Licensed Rights is expressly made subject to the
following conditions.

a. Attribution.

1. If You Share the Licensed Material (including in modified
      form), You must:

        a. retain the following if it is supplied by the Licensor
           with the Licensed Material:

             i. identification of the creator(s) of the Licensed
                Material and any others designated to receive
                attribution, in any reasonable manner requested by
                the Licensor (including by pseudonym if
                designated);

            ii. a copyright notice;

           iii. a notice that refers to this Public License;

            iv. a notice that refers to the disclaimer of
                warranties;

             v. a URI or hyperlink to the Licensed Material to the
                extent reasonably practicable;

        b. indicate if You modified the Licensed Material and
           retain an indication of any previous modifications; and

        c. indicate the Licensed Material is licensed under this
           Public License, and include the text of, or the URI or
           hyperlink to, this Public License.

   2. You may satisfy the conditions in Section 3(a)(1) in any
      reasonable manner based on the medium, means, and context in
      which You Share the Licensed Material. For example, it may be
      reasonable to satisfy the conditions by providing a URI or
      hyperlink to a resource that includes the required
      information.

   3. If requested by the Licensor, You must remove any of the
      information required by Section 3(a)(1)(A) to the extent
      reasonably practicable.

   4. If You Share Adapted Material You produce, the Adapter's
      License You apply must not prevent recipients of the Adapted
      Material from complying with this Public License.

Section 4 -- Sui Generis Database Rights.

Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:

a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;

b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material; and

c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.

For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.

Section 5 -- Disclaimer of Warranties and Limitation of Liability.

a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.

b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.

c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.

Section 6 -- Term and Termination.

a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.

b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:

1. automatically as of the date the violation is cured, provided
      it is cured within 30 days of Your discovery of the
      violation; or

   2. upon express reinstatement by the Licensor.

 For the avoidance of doubt, this Section 6(b) does not affect any
 right the Licensor may have to seek remedies for Your violations
 of this Public License.

c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.

d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.

Section 7 -- Other Terms and Conditions.

a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.

b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.

Section 8 -- Interpretation.

a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.

b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.

c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.

d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.

=======================================================================

Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.

Creative Commons may be contacted at creativecommons.org.

File: SECURITY.md Copy Chapter

Security Copy Chapter

Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include Microsoft, Azure, DotNet, AspNet, Xamarin, and our GitHub organizations.

If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's definition of a security vulnerability, please report it to us as described below.

Reporting Security Issues Copy Chapter

Please do not report security vulnerabilities through public GitHub issues.

Instead, please report them to the Microsoft Security Response Center (MSRC) at https://msrc.microsoft.com/create-report.

If you prefer to submit without logging in, send email to [email protected]. If possible, encrypt your message with our PGP key; please download it from the Microsoft Security Response Center PGP Key page.

You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at microsoft.com/msrc.

Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:

• Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
• Full paths of source file(s) related to the manifestation of the issue
• The location of the affected source code (tag/branch/commit or direct URL)
• Any special configuration required to reproduce the issue
• Step-by-step instructions to reproduce the issue
• Proof-of-concept or exploit code (if possible)
• Impact of the issue, including how an attacker might exploit the issue

This information will help us triage your report more quickly.

If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our Microsoft Bug Bounty Program page for more details about our active programs.

Preferred Languages Copy Chapter

We prefer all communications to be in English.

Policy Copy Chapter

Microsoft follows the principle of Coordinated Vulnerability Disclosure.

File: ThirdPartyNotices.txt Copy Chapter

THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
For Microsoft language-server-protocol

This project incorporates material from the project(s) listed below (collectively, “Third Party Code”).
Microsoft is not the original author of the Third Party Code. The original copyright notice and license
under which Microsoft received such Third Party Code are set out below. This Third Party Code is licensed
to you under their original license terms set forth below. Microsoft reserves all other rights not expressly
granted, whether by implication, estoppel or otherwise.

1. Jekyll (https://jekyllrb.com/)

The MIT License (MIT)

Copyright (c) 2008-2017 Tom Preston-Werner and Jekyll contributors

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.

2. Bootstrap (https://getbootstrap.com/)

The MIT License (MIT)

Copyright (c) 2011-2016 Twitter, Inc.

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.

3. Font Awesome (https://fontawesome.com)

License: https://fontawesome.com/license

4. jemoji (https://github.com/jekyll/jemoji)

The MIT License (MIT)

Copyright (c) 2014-2017 GitHub, Inc. and contributors

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.

File: _data/base-0-9-toc.yml Copy Chapter

• title: Table of Contents
  reveal: baseProtocol
  children:
  • title: Base Protocol
    anchor: baseProtocol
    children:
    • title: Header Part
      anchor: headerPart
    • title: Content Part
      anchor: contentPart
    • title: Capabilities
      anchor: capabilities
    • title: Message Ordering
      anchor: messageOrdering
    • title: Message Documentation
      anchor: messageDocumentation
  • title: JSON Structures
    anchor: basicJsonStructures
    children:
    • title: Base Types
      anchor: baseTypes
    • title: URI
      anchor: uri
    • title: Regular Expression
      anchor: regExp
    • title: Enumerations
      anchor: enumerations
    • title: Abstract Message
      anchor: abstractMessage
    • title: Request Message
      anchor: requestMessage
    • title: Response Message
      anchor: responseMessage
    • title: Notification Message
      anchor: notificationMessage
    • title: Cancellation Support
      anchor: cancelRequest
    • title: Progress Support
      anchor: progress
    • title: Trace Value
      anchor: traceValue
  • title: Lifecycle Messages
    anchor: lifecycle
    children:
    • title: Initialize
      anchor: initialize
    • title: Initialized
      anchor: initialized
    • title: Register Capability
      anchor: client_registerCapability
    • title: Unregister Capability
      anchor: client_unregisterCapability
    • title: Set Trace
      anchor: setTrace
    • title: Log Trace
      anchor: logTrace
    • title: Shutdown
      anchor: shutdown
    • title: Exit
      anchor: exit
  • title: Window Features
    anchor: windowFeatures
    children:
    • title: Show Message Notification
      anchor: window_showMessage
    • title: Show Message Request
      anchor: window_showMessageRequest
    • title: Log Message
      anchor: window_logMessage
    • title: Sent Telemetry
      anchor: telemetry_event

File: _data/linkableTypes.yml Copy Chapter

• name: "Linkable Types"
  children:
  • type: 'integer'
    link: '#integer'
  • type: 'uinteger'
    link: '#uinteger'
  • type: 'decimal'
    link: '#decimal'
  • type: 'BaseAny'
    link: '#baseAny'
  • type: 'LSPAny'
    link: '#lspAny'
  • type: 'BaseObject'
    link: '#baseObject'
  • type: 'LSPObject'
    link: '#lspObject'
  • type: 'BaseArray'
    link: '#baseArray'
  • type: 'LSPArray'
    link: '#lspArray'
  • type: 'Message'
    link: '#message'
  • type: 'RequestMessage'
    link: '#requestMessage'
  • type: 'ResponseMessage'
    link: '#responseMessage'
  • type: 'ResponseError'
    link: '#responseError'
  • type: 'ErrorCodes'
    link: '#errorCodes'
  • type: 'NotificationMessage'
    link: '#notificationMessage'
  • type: 'CancelParams'
    link: '#cancelRequest'
  • type: 'ProgressParams'
    link: '#progress'
  • type: 'ProgressToken'
    link: '#progress'
  • type: 'Uri'
    link: '#uri'
  • type: 'URI'
    link: '#uri'
  • type: 'DocumentUri'
    link: '#documentUri'
  • type: 'RegularExpressionsClientCapabilities'
    link: '#regExp'
  • type: 'TextDocument'
    link: '#textDocuments'
  • type: 'EOL'
    link: '#textDocuments'
  • type: 'Position'
    link: '#position'
  • type: 'PositionEncodingKind'
    link: '#positionEncodingKind'
  • type: 'Range'
    link: '#range'
  • type: 'Location'
    link: '#location'
  • type: 'LocationLink'
    link: '#locationLink'
  • type: 'LocationUriOnly'
    link: '#locationUriOnly'
  • type: 'Diagnostic'
    link: '#diagnostic'
  • type: 'DiagnosticSeverity'
    link: '#diagnosticSeverity'
  • type: 'DiagnosticTag'
    link: '#diagnosticTag'
  • type: 'DiagnosticRelatedInformation'
    link: '#diagnosticRelatedInformation'
  • type: 'CodeDescription'
    link: '#codeDescription'
  • type: 'Command'
    link: '#command'
  • type: 'TextEdit'
    link: '#textEdit'
  • type: 'ChangeAnnotation'
    link: '#changeAnnotation'
  • type: 'ChangeAnnotationIdentifier'
    link: '#changeAnnotationIdentifier'
  • type: 'ChangeAnnotationsSupportOptions'
    link: '#changeAnnotationsSupportOptions'
  • type: 'AnnotatedTextEdit'
    link: '#annotatedTextEdit'
  • type: 'TextDocumentEdit'
    link: '#textDocumentEdit'
  • type: 'CreateFileOptions'
    link: '#createFileOptions'
  • type: 'CreateFile'
    link: '#createFile'
  • type: 'RenameFileOptions'
    link: '#renameFileOptions'
  • type: 'RenameFile'
    link: '#renameFile'
  • type: 'DeleteFileOptions'
    link: '#deleteFileOptions'
  • type: 'DeleteFile'
    link: '#deleteFile'
  • type: 'WorkspaceEdit'
    link: '#workspaceEdit'
  • type: 'WorkspaceEditClientCapabilities'
    link: '#workspaceEditClientCapabilities'
  • type: 'ResourceOperationKind'
    link: '#resourceOperationKind'
  • type: 'FailureHandlingKind'
    link: '#failureHandlingKind'
  • type: 'TextDocumentIdentifier'
    link: '#textDocumentIdentifier'
  • type: 'TextDocumentItem'
    link: '#textDocumentItem'
  • type: 'VersionedTextDocumentIdentifier'
    link: '#versionedTextDocumentIdentifier'
  • type: 'OptionalVersionedTextDocumentIdentifier'
    link: '#optionalVersionedTextDocumentIdentifier'
  • type: 'TextDocumentPositionParams'
    link: '#textDocumentPositionParams'
  • type: 'DocumentFilter'
    link: '#documentFilter'
  • type: 'DocumentSelector'
    link: '#documentSelector'
  • type: 'StaticRegistrationOptions'
    link: '#staticRegistrationOptions'
  • type: 'TextDocumentRegistrationOptions'
    link: '#textDocumentRegistrationOptions'
  • type: 'MarkupKind'
    link: '#markupContent'
  • type: 'MarkupContent'
    link: '#markupContentInnerDefinition'
  • type: 'MarkdownClientCapabilities'
    link: '#markdownClientCapabilities'
  • type: 'WorkDoneProgressBegin'
    link: '#workDoneProgressBegin'
  • type: '$/progress'
    link: '#workDoneProgressBegin'
  • type: 'WorkDoneProgressReport'
    link: '#workDoneProgressReport'
  • type: 'WorkDoneProgressEnd'
    link: '#workDoneProgressEnd'
  • type: 'WorkDoneProgressParams'
    link: '#workDoneProgressParams'
  • type: 'WorkDoneProgressOptions'
    link: '#workDoneProgressOptions'
  • type: 'PartialResultParams'
    link: '#partialResultParams'
  • type: 'TraceValue'
    link: '#traceValue'
  • type: 'InitializeParams'
    link: '#initializeParams'
  • type: 'ClientInfo'
    link: '#clientInfo'
  • type: 'InitializeResult'
    link: '#initializeResult'
  • type: 'ServerInfo'
    link: '#serverInfo'
  • type: 'InitializedParams'
    link: '#initialized'
  • type: 'InitializeErrorCodes'
    link: '#initializeErrorCodes'
  • type: 'InitializeError'
    link: '#initializeError'
  • type: 'TextDocumentClientCapabilities'
    link: '#textDocumentClientCapabilities'
  • type: 'NotebookDocumentClientCapabilities'
    link: '#notebookDocumentClientCapabilities'
  • type: 'ClientCapabilities'
    link: '#clientCapabilities'
  • type: 'WorkspaceClientCapabilities'
    link: '#workspaceClientCapabilities'
  • type: 'FileOperationClientCapabilities'
    link: '#fileOperationClientCapabilities'
  • type: 'WindowClientCapabilities'
    link: '#windowClientCapabilities'
  • type: 'GeneralClientCapabilities'
    link: '#generalClientCapabilities'
  • type: 'StaleRequestSupportOptions'
    link: '#staleRequestSupportOptions'
  • type: 'ServerCapabilities'
    link: '#serverCapabilities'
  • type: 'WorkspaceOptions'
    link: '#workspaceOptions'
  • type: 'FileOperationOptions'
    link: '#fileOperationOptions'
  • type: 'LogTraceParams'
    link: '#logTrace'
  • type: 'SetTraceParams'
    link: '#setTrace'
  • type: 'ShowMessageParams'
    link: '#window_showMessage'
  • type: 'MessageType'
    link: '#messageType'
  • type: 'ShowMessageRequestClientCapabilities'
    link: '#window_showMessageRequest'
  • type: 'ClientShowMessageActionItemOptions'
    link: '#clientShowMessageActionItemOptions'
  • type: 'ShowMessageRequestParams'
    link: '#showMessageRequestParams'
  • type: 'MessageActionItem'
    link: '#messageActionItem'
  • type: 'ShowDocumentClientCapabilities'
    link: '#window_showDocument'
  • type: 'ShowDocumentParams'
    link: '#showDocumentParams'
  • type: 'ShowDocumentResult'
    link: '#showDocumentResult'
  • type: 'LogMessageParams'
    link: '#logMessageParams'
  • type: 'WorkDoneProgressCreateParams'
    link: '#window_workDoneProgress_create'
  • type: 'WorkDoneProgressCancelParams'
    link: '#window_workDoneProgress_cancel'
  • type: 'telemetry/event'
    link: '#telemetry_event'
  • type: 'Registration'
    link: '#registration'
  • type: 'RegistrationParams'
    link: '#registrationParams'
  • type: 'Unregistration'
    link: '#unregistration'
  • type: 'UnregistrationParams'
    link: '#unregistrationParams'
  • type: 'WorkspaceFoldersServerCapabilities'
    link: '#workspaceFoldersServerCapabilities'
  • type: 'WorkspaceFolder'
    link: '#workspaceFolder'
  • type: 'workspace/workspaceFolders'
    link: '#workspace_workspaceFolders'
  • type: 'DidChangeWorkspaceFoldersParams'
    link: '#didChangeWorkspaceFoldersParams'
  • type: 'WorkspaceFoldersChangeEvent'
    link: '#workspaceFoldersChangeEvent'
  • type: 'DidChangeConfigurationClientCapabilities'
    link: '#didChangeConfigurationClientCapabilities'
  • type: 'DidChangeConfigurationParams'
    link: '#didChangeConfigurationParams'
  • type: 'ConfigurationParams'
    link: '#configurationParams'
  • type: 'ConfigurationItem'
    link: '#configurationItem'
  • type: 'DidChangeWatchedFilesClientCapabilities'
    link: '#didChangeWatchedFilesClientCapabilities'
  • type: 'DidChangeWatchedFilesRegistrationOptions'
    link: '#didChangeWatchedFilesRegistrationOptions'
  • type: 'Pattern'
    link: '#pattern'
  • type: 'RelativePattern'
    link: '#relativePattern'
  • type: 'GlobPattern'
    link: '#globPattern'
  • type: 'FileSystemWatcher'
    link: '#fileSystemWatcher'
  • type: 'WatchKind'
    link: '#watchKind'
  • type: 'DidChangeWatchedFilesParams'
    link: '#didChangeWatchedFilesParams'
  • type: 'FileEvent'
    link: '#fileEvent'
  • type: 'FileChangeType'
    link: '#fileChangeType'
  • type: 'WorkspaceSymbolClientCapabilities'
    link: '#workspace_symbol'
  • type: 'ClientSymbolResolveOptions'
    link: '#clientSymbolResolveOptions'
  • type: 'WorkspaceSymbolOptions'
    link: '#workspaceSymbolOptions'
  • type: 'WorkspaceSymbolRegistrationOptions'
    link: '#workspaceSymbolRegistrationOptions'
  • type: 'WorkspaceSymbolParams'
    link: '#workspaceSymbolParams'
  • type: 'WorkspaceSymbol'
    link: '#workspaceSymbol'
  • type: 'workspace/executeCommand'
    link: '#workspace_executeCommand'
  • type: 'ExecuteCommandClientCapabilities'
    link: '#executeCommandClientCapabilities'
  • type: 'ExecuteCommandOptions'
    link: '#executeCommandOptions'
  • type: 'ExecuteCommandRegistrationOptions'
    link: '#executeCommandRegistrationOptions'
  • type: 'ExecuteCommandParams'
    link: '#executeCommandParams'
  • type: 'workspace/applyEdit'
    link: '#workspace_applyEdit'
  • type: 'ApplyWorkspaceEditParams'
    link: '#applyWorkspaceEditParams'
  • type: 'WorkspaceEditMetadata'
    link: '#workspaceEditMetadata'
  • type: 'ApplyWorkspaceEditResult'
    link: '#applyWorkspaceEditResult'
  • type: 'ApplyWorkspaceEditResponse'
    link: '#applyWorkspaceEditResponse'
  • type: 'workspace/willCreateFiles'
    link: '#workspace_willCreateFiles'
  • type: 'FileOperationRegistrationOptions'
    link: '#fileOperationRegistrationOptions'
  • type: 'FileOperationPatternKind'
    link: '#fileOperationPatternKind'
  • type: 'FileOperationPatternOptions'
    link: '#fileOperationPatternOptions'
  • type: 'FileOperationPattern'
    link: '#fileOperationPattern'
  • type: 'FileOperationFilter'
    link: '#fileOperationFilter'
  • type: 'CreateFilesParams'
    link: '#createFilesParams'
  • type: 'FileCreate'
    link: '#fileCreate'
  • type: 'workspace/didCreateFiles'
    link: '#workspace_didCreateFiles'
  • type: 'workspace/willRenameFiles'
    link: '#workspace_willRenameFiles'
  • type: 'RenameFilesParams'
    link: '#renameFilesParams'
  • type: 'FileRename'
    link: '#fileRename'
  • type: 'workspace/didRenameFiles'
    link: '#workspace_didRenameFiles'
  • type: 'workspace/willDeleteFiles'
    link: '#workspace_willDeleteFiles'
  • type: 'DeleteFilesParams'
    link: '#deleteFilesParams'
  • type: 'FileDelete'
    link: '#fileDelete'
  • type: 'workspace/didDeleteFiles'
    link: '#workspace_didDeleteFiles'
  • type: 'TextDocumentSyncKind'
    link: '#textDocumentSyncKind'
  • type: 'TextDocumentSyncOptions'
    link: '#textDocumentSyncOptions'
  • type: 'textDocument/didOpen'
    link: '#textDocument_didOpen'
  • type: 'DidOpenTextDocumentParams'
    link: '#didOpenTextDocumentParams'
  • type: 'textDocument/didChange'
    link: '#textDocument_didChange'
  • type: 'TextDocumentChangeRegistrationOptions'
    link: '#textDocumentChangeRegistrationOptions'
  • type: 'DidChangeTextDocumentParams'
    link: '#didChangeTextDocumentParams'
  • type: 'TextDocumentContentChangeEvent'
    link: '#textDocumentContentChangeEvent'
  • type: 'TextDocumentContentChangeWholeDocument'
    link: '#textDocumentContentChangeWholeDocument'
  • type: 'TextDocumentContentChangePartial'
    link: '#textDocumentContentChangePartial'
  • type: 'textDocument/willSave'
    link: '#textDocument_willSave'
  • type: 'WillSaveTextDocumentParams'
    link: '#willSaveTextDocumentParams'
  • type: 'TextDocumentSaveReason'
    link: '#textDocumentSaveReason'
  • type: 'textDocument/willSaveWaitUntil'
    link: '#textDocument_willSaveWaitUntil'
  • type: 'textDocument/didSave'
    link: '#textDocument_didSave'
  • type: 'SaveOptions'
    link: '#saveOptions'
  • type: 'TextDocumentSaveRegistrationOptions'
    link: '#textDocumentSaveRegistrationOptions'
  • type: 'DidSaveTextDocumentParams'
    link: '#didSaveTextDocumentParams'
  • type: 'textDocument/didClose'
    link: '#textDocument_didClose'
  • type: 'DidCloseTextDocumentParams'
    link: '#didCloseTextDocumentParams'
  • type: 'TextDocumentSyncClientCapabilities'
    link: '#textDocumentSyncClientCapabilities'
  • type: 'TextDocumentSyncKind'
    link: '#textDocumentSyncKind'
  • type: 'TextDocumentSyncOptions'
    link: '#textDocumentSyncOptions'
  • type: 'textDocument/publishDiagnostics'
    link: '#textDocument_publishDiagnostics'
  • type: 'PublishDiagnosticsClientCapabilities'
    link: '#publishDiagnosticsClientCapabilities'
  • type: 'ClientDiagnosticsTagOptions'
    link: '#clientDiagnosticsTagOptions'
  • type: 'PublishDiagnosticsParams'
    link: '#publishDiagnosticsParams'
  • type: 'textDocument/completion'
    link: '#textDocument_completion'
  • type: 'CompletionClientCapabilities'
    link: '#completionClientCapabilities'
  • type: 'ClientCompletionItemOptions'
    link: '#clientCompletionItemOptions'
  • type: 'CompletionItemTagOptions'
    link: '#completionItemTagOptions'
  • type: 'ClientCompletionItemResolveOptions'
    link: '#clientCompletionItemResolveOptions'
  • type: 'ClientCompletionItemInsertTextModeOptions'
    link: '#clientCompletionItemInsertTextModeOptions'
  • type: 'ClientCompletionItemOptionsKind'
    link: '#clientCompletionItemOptionsKind'
  • type: 'CompletionListCapabilities'
    link: '#completionListCapabilities'
  • type: 'CompletionOptions'
    link: '#completionOptions'
  • type: 'CompletionItemDefaults'
    link: '#completionItemDefaults'
  • type: 'CompletionItemApplyKinds'
    link: '#completionItemApplyKinds'
  • type: 'ServerCompletionItemOptions'
    link: '#serverCompletionItemOptions'
  • type: 'CompletionRegistrationOptions'
    link: '#completionRegistrationOptions'
  • type: 'CompletionParams'
    link: '#completionParams'
  • type: 'CompletionTriggerKind'
    link: '#completionTriggerKind'
  • type: 'CompletionContext'
    link: '#completionContext'
  • type: 'EditRangeWithInsertReplace'
    link: '#editRangeWithInsertReplace'
  • type: 'CompletionList'
    link: '#completionList'
  • type: 'InsertTextFormat'
    link: '#insertTextFormat'
  • type: 'CompletionItemTag'
    link: '#completionItemTag'
  • type: 'InsertReplaceEdit'
    link: '#insertReplaceEdit'
  • type: 'InsertTextMode'
    link: '#insertTextMode'
  • type: 'CompletionItemLabelDetails'
    link: '#completionItemLabelDetails'
  • type: 'CompletionItem'
    link: '#completionItem'
  • type: 'CompletionItemKind'
    link: '#completionItemKind'
  • type: 'completionItem/resolve'
    link: '#completionItem_resolve'
  • type: 'textDocument/hover'
    link: '#textDocument_hover'
  • type: 'HoverClientCapabilities'
    link: '#hoverClientCapabilities'
  • type: 'HoverOptions'
    link: '#hoverOptions'
  • type: 'HoverRegistrationOptions'
    link: '#hoverRegistrationOptions'
  • type: 'HoverParams'
    link: '#hoverParams'
  • type: 'Hover'
    link: '#hover'
  • type: 'MarkedString'
    link: '#markedString'
  • type: 'textDocument/signatureHelp'
    link: '#textDocument_signatureHelp'
  • type: 'SignatureHelpClientCapabilities'
    link: '#signatureHelpClientCapabilities'
  • type: 'ClientSignatureInformationOptions'
    link: '#clientSignatureInformationOptions'
  • type: 'ClientSignatureParameterInformationOptions'
    link: '#clientSignatureParameterInformationOptions'
  • type: 'SignatureHelpOptions'
    link: '#signatureHelpOptions'
  • type: 'SignatureHelpRegistrationOptions'
    link: '#signatureHelpRegistrationOptions'
  • type: 'SignatureHelpParams'
    link: '#signatureHelpParams'
  • type: 'SignatureHelpTriggerKind'
    link: '#signatureHelpTriggerKind'
  • type: 'SignatureHelpContext'
    link: '#signatureHelpContext'
  • type: 'SignatureHelp'
    link: '#signatureHelp'
  • type: 'SignatureInformation'
    link: '#signatureInformation'
  • type: 'ParameterInformation'
    link: '#parameterInformation'
  • type: 'textDocument/declaration'
    link: '#textDocument_declaration'
  • type: 'DeclarationClientCapabilities'
    link: '#declarationClientCapabilities'
  • type: 'DeclarationOptions'
    link: '#declarationOptions'
  • type: 'DeclarationRegistrationOptions'
    link: '#declarationRegistrationOptions'
  • type: 'DeclarationParams'
    link: '#declarationParams'
  • type: 'textDocument/definition'
    link: '#textDocument_definition'
  • type: 'DefinitionClientCapabilities'
    link: '#definitionClientCapabilities'
  • type: 'DefinitionOptions'
    link: '#definitionOptions'
  • type: 'DefinitionRegistrationOptions'
    link: '#definitionRegistrationOptions'
  • type: 'DefinitionParams'
    link: '#definitionParams'
  • type: 'textDocument/typeDefinition'
    link: '#textDocument_typeDefinition'
  • type: 'TypeDefinitionClientCapabilities'
    link: '#typeDefinitionClientCapabilities'
  • type: 'TypeDefinitionOptions'
    link: '#typeDefinitionOptions'
  • type: 'TypeDefinitionRegistrationOptions'
    link: '#typeDefinitionRegistrationOptions'
  • type: 'TypeDefinitionParams'
    link: '#typeDefinitionParams'
  • type: 'textDocument/implementation'
    link: '#textDocument_implementation'
  • type: 'ImplementationClientCapabilities'
    link: '#implementationClientCapabilities'
  • type: 'ImplementationOptions'
    link: '#implementationOptions'
  • type: 'ImplementationRegistrationOptions'
    link: '#implementationRegistrationOptions'
  • type: 'ImplementationParams'
    link: '#implementationParams'
  • type: 'textDocument/references'
    link: '#textDocument_references'
  • type: 'ReferenceClientCapabilities'
    link: '#referenceClientCapabilities'
  • type: 'ReferenceOptions'
    link: '#referenceOptions'
  • type: 'ReferenceRegistrationOptions'
    link: '#referenceRegistrationOptions'
  • type: 'ReferenceParams'
    link: '#referenceParams'
  • type: 'ReferenceContext'
    link: '#referenceContext'
  • type: 'textDocument/documentHighlight'
    link: '#textDocument_documentHighlight'
  • type: 'DocumentHighlightClientCapabilities'
    link: '#documentHighlightClientCapabilities'
  • type: 'DocumentHighlightOptions'
    link: '#documentHighlightOptions'
  • type: 'DocumentHighlightRegistrationOptions'
    link: '#documentHighlightRegistrationOptions'
  • type: 'DocumentHighlightParams'
    link: '#documentHighlightParams'
  • type: 'DocumentHighlight'
    link: '#documentHighlight'
  • type: 'DocumentHighlightKind'
    link: '#documentHighlightKind'
  • type: 'textDocument/documentSymbol'
    link: '#textDocument_documentSymbol'
  • type: 'DocumentSymbolClientCapabilities'
    link: '#documentSymbolClientCapabilities'
  • type: 'ClientSymbolKindOptions'
    link: '#clientSymbolKindOptions'
  • type: 'ClientSymbolTagOptions'
    link: '#clientSymbolTagOptions'
  • type: 'DocumentSymbolOptions'
    link: '#documentSymbolOptions'
  • type: 'DocumentSymbolRegistrationOptions'
    link: '#documentSymbolRegistrationOptions'
  • type: 'DocumentSymbolParams'
    link: '#documentSymbolParams'
  • type: 'SymbolKind'
    link: '#symbolKind'
  • type: 'SymbolTag'
    link: '#symbolTag'
  • type: 'DocumentSymbol'
    link: '#documentSymbol'
  • type: 'SymbolInformation'
    link: '#symbolInformation'
  • type: 'textDocument/codeAction'
    link: '#textDocument_codeAction'
  • type: 'CodeActionClientCapabilities'
    link: '#codeActionClientCapabilities'
  • type: 'ClientCodeActionLiteralOptions'
    link: '#clientCodeActionLiteralOptions'
  • type: 'ClientCodeActionKindOptions'
    link: '#clientCodeActionKindOptions'
  • type: 'ClientCodeActionResolveOptions'
    link: '#clientCodeActionResolveOptions'
  • type: 'CodeActionTagOptions'
    link: '#codeActionTagOptions'
  • type: 'CodeActionOptions'
    link: '#codeActionOptions'
  • type: 'CodeActionRegistrationOptions'
    link: '#codeActionRegistrationOptions'
  • type: 'CodeActionParams'
    link: '#codeActionParams'
  • type: 'CodeActionKind'
    link: '#codeActionKind'
  • type: 'CodeActionContext'
    link: '#codeActionContext'
  • type: 'CodeActionTriggerKind'
    link: '#codeActionTriggerKind'
  • type: 'CodeActionDisabled'
    link: '#codeActionDisabled'
  • type: 'CodeAction'
    link: '#codeAction'
  • type: 'codeAction/resolve'
    link: '#codeAction_resolve'
  • type: 'textDocument/codeLens'
    link: '#textDocument_codeLens'
  • type: 'CodeLensClientCapabilities'
    link: '#codeLensClientCapabilities'
  • type: 'CodeLensOptions'
    link: '#codeLensOptions'
  • type: 'CodeLensRegistrationOptions'
    link: '#codeLensRegistrationOptions'
  • type: 'CodeLensParams'
    link: '#codeLensParams'
  • type: 'CodeLens'
    link: '#codeLens'
  • type: 'codeLens/resolve'
    link: '#codeLens_resolve'
  • type: 'CodeLensWorkspaceClientCapabilities'
    link: '#codeLensWorkspaceClientCapabilities'
  • type: 'workspace/codeLens/refresh'
    link: '#codeLens_refresh'
  • type: 'DocumentLinkClientCapabilities'
    link: '#documentLinkClientCapabilities'
  • type: 'textDocument/documentLink'
    link: '#textDocument_documentLink'
  • type: 'DocumentLinkOptions'
    link: '#documentLinkOptions'
  • type: 'DocumentLinkRegistrationOptions'
    link: '#documentLinkRegistrationOptions'
  • type: 'DocumentLinkParams'
    link: '#documentLinkParams'
  • type: 'DocumentLink'
    link: '#documentLink'
  • type: 'documentLink/resolve'
    link: '#documentLink_resolve'
  • type: 'textDocument/documentColor'
    link: '#textDocument_documentColor'
  • type: 'DocumentColorClientCapabilities'
    link: '#documentColorClientCapabilities'
  • type: 'DocumentColorOptions'
    link: '#documentColorOptions'
  • type: 'DocumentColorRegistrationOptions'
    link: '#documentColorRegistrationOptions'
  • type: 'DocumentColorParams'
    link: '#documentColorParams'
  • type: 'ColorInformation'
    link: '#colorInformation'
  • type: 'Color'
    link: '#color'
  • type: 'textDocument/colorPresentation'
    link: '#textDocument_colorPresentation'
  • type: 'ColorPresentationParams'
    link: '#colorPresentationParams'
  • type: 'ColorPresentation'
    link: '#colorPresentation'
  • type: 'DocumentFormattingClientCapabilities'
    link: '#documentFormattingClientCapabilities'
  • type: 'textDocument/formatting'
    link: '#textDocument_formatting'
  • type: 'DocumentFormattingClientCapabilities'
    link: '#documentFormattingClientCapabilities'
  • type: 'DocumentFormattingOptions'
    link: '#documentFormattingOptions'
  • type: 'DocumentFormattingRegistrationOptions'
    link: '#documentFormattingRegistrationOptions'
  • type: 'DocumentFormattingParams'
    link: '#documentFormattingParams'
  • type: 'FormattingOptions'
    link: '#formattingOptions'
  • type: 'textDocument/rangeFormatting'
    link: '#textDocument_rangeFormatting'
  • type: 'DocumentRangeFormattingClientCapabilities'
    link: '#documentRangeFormattingClientCapabilities'
  • type: 'DocumentRangeFormattingOptions'
    link: '#documentRangeFormattingOptions'
  • type: 'DocumentRangeFormattingRegistrationOptions'
    link: '#documentRangeFormattingRegistrationOptions'
  • type: 'DocumentRangeFormattingParams'
    link: '#documentRangeFormattingParams'
  • type: 'DocumentRangesFormattingParams'
    link: '#documentRangesFormattingParams'
  • type: 'DocumentOnTypeFormattingClientCapabilities'
    link: '#documentOnTypeFormattingClientCapabilities'
  • type: 'textDocument/onTypeFormatting'
    link: '#textDocument_onTypeFormatting'
  • type: 'DocumentOnTypeFormattingOptions'
    link: '#documentOnTypeFormattingOptions'
  • type: 'DocumentOnTypeFormattingRegistrationOptions'
    link: '#documentOnTypeFormattingRegistrationOptions'
  • type: 'DocumentOnTypeFormattingParams'
    link: '#documentOnTypeFormattingParams'
  • type: 'PrepareSupportDefaultBehavior'
    link: '#prepareSupportDefaultBehavior'
  • type: 'RenameClientCapabilities'
    link: '#renameClientCapabilities'
  • type: 'RenameOptions'
    link: '#renameOptions'
  • type: 'RenameRegistrationOptions'
    link: '#renameRegistrationOptions'
  • type: 'textDocument/rename'
    link: '#textDocument_rename'
  • type: 'RenameParams'
    link: '#renameParams'
  • type: 'textDocument/prepareRename'
    link: '#textDocument_prepareRename'
  • type: 'PrepareRenameParams'
    link: '#prepareRenameParams'
  • type: 'PrepareRenamePlaceholder'
    link: '#prepareRenamePlaceholder'
  • type: 'PrepareRenameDefaultBehavior'
    link: '#prepareRenameDefaultBehavior'
  • type: 'PrepareRenameResult'
    link: '#prepareRenameResult'
  • type: 'textDocument/foldingRange'
    link: '#textDocument_foldingRange'
  • type: 'FoldingRangeClientCapabilities'
    link: '#foldingRangeClientCapabilities'
  • type: 'ClientFoldingRangeKindOptions'
    link: '#clientFoldingRangeKindOptions'
  • type: 'ClientFoldingRangeOptions'
    link: '#clientFoldingRangeOptions'
  • type: 'FoldingRangeOptions'
    link: '#foldingRangeOptions'
  • type: 'FoldingRangeRegistrationOptions'
    link: '#foldingRangeRegistrationOptions'
  • type: 'FoldingRangeParams'
    link: '#foldingRangeParams'
  • type: 'FoldingRangeKind'
    link: '#foldingRangeKind'
  • type: 'FoldingRange'
    link: '#foldingRange'
  • type: 'workspace/foldingRange/refresh'
    link: '#workspace_foldingRange_refresh'
  • type: 'FoldingRangeWorkspaceClientCapabilities'
    link: '#foldingRangeWorkspaceClientCapabilities'
  • type: 'textDocument/selectionRange'
    link: '#textDocument_selectionRange'
  • type: 'SelectionRangeClientCapabilities'
    link: '#selectionRangeClientCapabilities'
  • type: 'SelectionRangeOptions'
    link: '#selectionRangeOptions'
  • type: 'SelectionRangeRegistrationOptions'
    link: '#selectionRangeRegistrationOptions'
  • type: 'SelectionRangeParams'
    link: '#selectionRangeParams'
  • type: 'SelectionRange'
    link: '#selectionRange'
  • type: 'textDocument/prepareCallHierarchy'
    link: '#textDocument_prepareCallHierarchy'
  • type: 'CallHierarchyClientCapabilities'
    link: '#callHierarchyClientCapabilities'
  • type: 'CallHierarchyOptions'
    link: '#callHierarchyOptions'
  • type: 'CallHierarchyRegistrationOptions'
    link: '#callHierarchyRegistrationOptions'
  • type: 'CallHierarchyPrepareParams'
    link: '#callHierarchyPrepareParams'
  • type: 'CallHierarchyItem'
    link: '#callHierarchyItem'
  • type: 'callHierarchy/incomingCalls'
    link: '#callHierarchy_incomingCalls'
  • type: 'CallHierarchyIncomingCallsParams'
    link: '#callHierarchyIncomingCallsParams'
  • type: 'CallHierarchyIncomingCall'
    link: '#callHierarchyIncomingCall'
  • type: 'callHierarchy/outgoingCalls'
    link: '#callHierarchy_outgoingCalls'
  • type: 'CallHierarchyOutgoingCallsParams'
    link: '#callHierarchyOutgoingCallsParams'
  • type: 'CallHierarchyOutgoingCall'
    link: '#callHierarchyOutgoingCall'
  • type: 'SemanticTokenTypes'
    link: '#semanticTokenTypes'
  • type: 'SemanticTokenModifiers'
    link: '#semanticTokenModifiers'
  • type: 'TokenFormat'
    link: '#tokenFormat'
  • type: 'SemanticTokensLegend'
    link: '#semanticTokensLegend'
  • type: 'SemanticTokensClientCapabilities'
    link: '#semanticTokensClientCapabilities'
  • type: 'ClientSemanticTokensRequestOptions'
    link: '#clientSemanticTokensRequestOptions'
  • type: 'ClientSemanticTokensRequestFullDelta'
    link: '#clientSemanticTokensRequestFullDelta'
  • type: 'SemanticTokensOptions'
    link: '#semanticTokensOptions'
  • type: 'SemanticTokensRegistrationOptions'
    link: '#semanticTokensRegistrationOptions'
  • type: 'textDocument/semanticTokens/full'
    link: '#semanticTokens_fullRequest'
  • type: 'SemanticTokensParams'
    link: '#semanticTokensParams'
  • type: 'SemanticTokens'
    link: '#semanticTokens'
  • type: 'SemanticTokensPartialResult'
    link: '#semanticTokensPartialResult'
  • type: 'textDocument/semanticTokens/full/delta'
    link: '#semanticTokens_deltaRequest'
  • type: 'SemanticTokensDeltaParams'
    link: '#semanticTokensDeltaParams'
  • type: 'SemanticTokensDelta'
    link: '#semanticTokensDelta'
  • type: 'SemanticTokensFullDelta'
    link: '#semanticTokensFullDelta'
  • type: 'SemanticTokensEdit'
    link: '#semanticTokensEdit'
  • type: 'SemanticTokensDeltaPartialResult'
    link: '#semanticTokensDeltaPartialResult'
  • type: 'textDocument/semanticTokens/range'
    link: '#semanticTokens_rangeRequest'
  • type: 'SemanticTokensRangeParams'
    link: '#semanticTokensRangeParams'
  • type: 'SemanticTokensWorkspaceClientCapabilities'
    link: '#semanticTokensWorkspaceClientCapabilities'
  • type: 'workspace/semanticTokens/refresh'
    link: '#semanticTokens_refreshRequest'
  • type: 'textDocument/linkedEditingRange'
    link: '#textDocument_linkedEditingRange'
  • type: 'LinkedEditingRangeClientCapabilities'
    link: '#linkedEditingRangeClientCapabilities'
  • type: 'LinkedEditingRangeOptions'
    link: '#linkedEditingRangeOptions'
  • type: 'LinkedEditingRangeRegistrationOptions'
    link: '#linkedEditingRangeRegistrationOptions'
  • type: 'LinkedEditingRangeParams'
    link: '#linkedEditingRangeParams'
  • type: 'LinkedEditingRanges'
    link: '#linkedEditingRanges'
  • type: 'textDocument/moniker'
    link: '#textDocument_moniker'
  • type: 'MonikerClientCapabilities'
    link: '#monikerClientCapabilities'
  • type: 'MonikerOptions'
    link: '#monikerOptions'
  • type: 'MonikerRegistrationOptions'
    link: '#monikerRegistrationOptions'
  • type: 'MonikerParams'
    link: '#monikerParams'
  • type: 'UniquenessLevel'
    link: '#uniquenessLevel'
  • type: 'MonikerKind'
    link: '#monikerKind'
  • type: 'Moniker'
    link: '#moniker'
  • type: 'TypeHierarchyClientCapabilities'
    link: '#typeHierarchyClientCapabilities'
  • type: 'TypeHierarchyOptions'
    link: '#typeHierarchyOptions'
  • type: 'TypeHierarchyRegistrationOptions'
    link: '#typeHierarchyRegistrationOptions'
  • type: 'TypeHierarchyPrepareParams'
    link: '#typeHierarchyPrepareParams'
  • type: 'TypeHierarchyItem'
    link: '#typeHierarchyItem'
  • type: 'TypeHierarchySupertypesParams'
    link: '#typeHierarchySupertypesParams'
  • type: 'TypeHierarchySubtypesParams'
    link: '#typeHierarchySubtypesParams'
  • type: 'InlayHintClientCapabilities'
    link: '#inlayHintClientCapabilities'
  • type: 'ClientInlayHintResolveOptions'
    link: '#clientInlayHintResolveOptions'
  • type: 'InlayHintOptions'
    link: '#inlayHintOptions'
  • type: 'InlayHintRegistrationOptions'
    link: '#inlayHintRegistrationOptions'
  • type: 'InlayHintParams'
    link: '#inlayHintParams'
  • type: 'InlayHint'
    link: '#inlayHint'
  • type: 'InlayHintLabelPart'
    link: '#inlayHintLabelPart'
  • type: 'InlayHintKind'
    link: '#inlayHintKind'
  • type: 'InlayHintWorkspaceClientCapabilities'
    link: '#inlayHintWorkspaceClientCapabilities'
  • type: 'workspace/inlayHint/refresh'
    link: '#workspace_inlayHint_refresh'
  • type: 'InlineValueClientCapabilities'
    link: '#inlineValueClientCapabilities'
  • type: 'InlineValueOptions'
    link: '#inlineValueOptions'
  • type: 'InlineValueRegistrationOptions'
    link: '#inlineValueRegistrationOptions'
  • type: 'InlineValueParams'
    link: '#inlineValueParams'
  • type: 'InlineValueContext'
    link: '#inlineValueContext'
  • type: 'InlineValueText'
    link: '#inlineValueText'
  • type: 'InlineValueVariableLookup'
    link: '#inlineValueVariableLookup'
  • type: 'InlineValueEvaluatableExpression'
    link: '#inlineValueEvaluatableExpression'
  • type: 'InlineValue'
    link: '#inlineValue'
  • type: 'InlineValueWorkspaceClientCapabilities'
    link: '#inlineValueWorkspaceClientCapabilities'
  • type: 'workspace/inlineValue/refresh'
    link: '#workspace_inlineValue_refresh'
  • type: 'NotebookDocument'
    link: '#notebookDocument'
  • type: 'NotebookCell'
    link: '#notebookCell'
  • type: 'NotebookCellKind'
    link: '#notebookCellKind'
  • type: 'ExecutionSummary'
    link: '#executionSummary'
  • type: 'NotebookCellTextDocumentFilter'
    link: '#notebookCellTextDocumentFilter'
  • type: 'NotebookDocumentFilter'
    link: '#notebookDocumentFilter'
  • type: 'NotebookDocumentSyncClientCapabilities'
    link: '#notebookDocumentSyncClientCapabilities'
  • type: 'NotebookDocumentSyncOptions'
    link: '#notebookDocumentSyncOptions'
  • type: 'NotebookDocumentFilterWithNotebook'
    link: '#notebookDocumentFilterWithNotebook'
  • type: 'NotebookDocumentFilterWithCells'
    link: '#notebookDocumentFilterWithCells'
  • type: 'NotebookCellLanguage'
    link: '#notebookCellLanguage'
  • type: 'NotebookDocumentSyncRegistrationOptions'
    link: '#notebookDocumentSyncRegistrationOptions'
  • type: 'notebookDocument/didOpen'
    link: '#notebookDocument_didOpen'
  • type: 'DidOpenNotebookDocumentParams'
    link: '#didOpenNotebookDocumentParams'
  • type: 'notebookDocument/didChange'
    link: '#notebookDocument_didChange'
  • type: 'DidChangeNotebookDocumentParams'
    link: '#didChangeNotebookDocumentParams'
  • type: 'NotebookDocumentChangeEvent'
    link: '#notebookDocumentChangeEvent'
  • type: 'NotebookDocumentCellChanges'
    link: '#notebookDocumentCellChanges'
  • type: 'NotebookDocumentCellChangeStructure'
    link: '#notebookDocumentCellChangeStructure'
  • type: 'NotebookDocumentCellContentChanges'
    link: '#notebookDocumentCellContentChanges'
  • type: 'NotebookCellArrayChange'
    link: '#notebookCellArrayChange'
  • type: 'notebookDocument/didSave'
    link: '#notebookDocument_didSave'
  • type: 'DidSaveNotebookDocumentParams'
    link: '#didSaveNotebookDocumentParams'
  • type: 'notebookDocument/didClose'
    link: '#notebookDocument_didClose'
  • type: 'DidCloseNotebookDocumentParams'
    link: '#didCloseNotebookDocumentParams'
  • type: 'NotebookDocumentIdentifier'
    link: '#notebookDocumentIdentifier'
  • type: 'VersionedNotebookDocumentIdentifier'
    link: '#versionedNotebookDocumentIdentifier'
  • type: 'DiagnosticClientCapabilities'
    link: '#diagnosticClientCapabilities'
  • type: 'DiagnosticWorkspaceClientCapabilities'
    link: '#diagnosticWorkspaceClientCapabilities'
  • type: 'DiagnosticOptions'
    link: '#diagnosticOptions'
  • type: 'DiagnosticRegistrationOptions'
    link: '#diagnosticRegistrationOptions'
  • type: 'DocumentDiagnosticParams'
    link: '#documentDiagnosticParams'
  • type: 'DocumentDiagnosticReport'
    link: '#documentDiagnosticReport'
  • type: 'DocumentDiagnosticReportKind'
    link: '#documentDiagnosticReportKind'
  • type: 'FullDocumentDiagnosticReport'
    link: '#fullDocumentDiagnosticReport'
  • type: 'UnchangedDocumentDiagnosticReport'
    link: '#unchangedDocumentDiagnosticReport'
  • type: 'RelatedFullDocumentDiagnosticReport'
    link: '#relatedFullDocumentDiagnosticReport'
  • type: 'RelatedUnchangedDocumentDiagnosticReport'
    link: '#relatedUnchangedDocumentDiagnosticReport'
  • type: 'DocumentDiagnosticReportPartialResult'
    link: '#documentDiagnosticReportPartialResult'
  • type: 'DiagnosticServerCancellationData'
    link: '#diagnosticServerCancellationData'
  • type: 'WorkspaceDiagnosticParams'
    link: '#workspaceDiagnosticParams'
  • type: 'PreviousResultId'
    link: '#previousResultId'
  • type: 'WorkspaceDiagnosticReport'
    link: '#workspaceDiagnosticReport'
  • type: 'WorkspaceFullDocumentDiagnosticReport'
    link: '#workspaceFullDocumentDiagnosticReport'
  • type: 'WorkspaceUnchangedDocumentDiagnosticReport'
    link: '#workspaceUnchangedDocumentDiagnosticReport'
  • type: 'WorkspaceDocumentDiagnosticReport'
    link: '#workspaceDocumentDiagnosticReport'
  • type: 'WorkspaceDiagnosticReportPartialResult'
    link: '#workspaceDiagnosticReportPartialResult'
  • type: 'workspace/diagnostic/refresh'
    link: '#diagnostic_refresh'
  • type: 'textDocument/inlineCompletion'
    link: '#textDocument_inlineCompletion'
  • type: 'InlineCompletionClientCapabilities'
    link: '#inlineCompletionClientCapabilities'
  • type: 'InlineCompletionOptions'
    link: '#inlineCompletionOptions'
  • type: 'InlineCompletionRegistrationOptions'
    link: '#inlineCompletionRegistrationOptions'
  • type: 'InlineCompletionParams'
    link: '#inlineCompletionParams'
  • type: 'InlineCompletionContext'
    link: '#inlineCompletionContext'
  • type: 'InlineCompletionTriggerKind'
    link: '#inlineCompletionTriggerKind'
  • type: 'SelectedCompletionInfo'
    link: '#selectedCompletionInfo'
  • type: 'InlineCompletionList'
    link: '#inlineCompletionList'
  • type: 'InlineCompletionItem'
    link: '#inlineCompletionItem'
  • type: 'StringValue'
    link: '#stringValue'
  • type: 'SnippetTextEdit'
    link: '#snippetTextEdit'
  • type: 'TextDocumentContentOptions'
    link: '#textDocumentContentOptions'
  • type: 'TextDocumentContentRegistrationOptions'
    link: '#textDocumentContentRegistrationOptions'
  • type: 'TextDocumentContentParams'
    link: '#textDocumentContentParams'

File: _data/lsif-0-4-0-toc.yml Copy Chapter

• title: Table of Contents
  reveal: _general
  children:
  • title: General
    anchor: _general
    children:
    • title: Introduction
      anchor: lsifIntro
    • title: Motivation
      anchor: lsifMotivation
    • title: Ranges
      anchor: ranges
    • title: Result Sets
      anchor: resultSet
  • title: Language Features
    anchor: _languageFeatures
    children:
    • title: definition
      anchor: definition
    • title: declaration
      anchor: declaration
    • title: hover
      anchor: hover
    • title: references
      anchor: references
    • title: implementation
      anchor: implementation
    • title: typeDefinition
      anchor: typeDefinition
    • title: foldingRange
      anchor: foldingRange
    • title: documentLink
      anchor: documentLink
    • title: documentSymbol
      anchor: documentSymbol
    • title: diagnostic
      anchor: diagnostic
    • title: project
      anchor: projectContext
    • title: Embedding Contents
      anchor: embeddingContents
  • title: Advanced Concepts
    anchor: _advancedConcepts
    children:
    • title: Events
      anchor: events
    • title: Exports and Imports
      anchor: exportsImports
    • title: Result Ranges
      anchor: resultRanges
    • title: Meta Data
      anchor: metaData
    • title: Emitting Constraints
      anchor: emittingConstraints
  • title: Additional Information
    anchor: _additionalInformation
    children:
    • title: Tools
      anchor: tools
    • title: Open Questions
      anchor: openQuestions

File: _data/lsif-0-5-0-toc.yml Copy Chapter

• title: Table of Contents
  reveal: _general
  children:
  • title: General
    anchor: _general
    children:
    • title: Introduction
      anchor: lsifIntro
    • title: Motivation
      anchor: lsifMotivation
    • title: Ranges
      anchor: ranges
    • title: Result Sets
      anchor: resultSet
  • title: Language Features
    anchor: _languageFeatures
    children:
    • title: definition
      anchor: definition
    • title: declaration
      anchor: declaration
    • title: hover
      anchor: hover
    • title: references
      anchor: references
    • title: implementation
      anchor: implementation
    • title: typeDefinition
      anchor: typeDefinition
    • title: foldingRange
      anchor: foldingRange
    • title: documentLink
      anchor: documentLink
    • title: documentSymbol
      anchor: documentSymbol
    • title: diagnostic
      anchor: diagnostic
    • title: project
      anchor: projectContext
    • title: Embedding Contents
      anchor: embeddingContents
  • title: Advanced Concepts
    anchor: _advancedConcepts
    children:
    • title: Events
      anchor: events
    • title: Exports and Imports
      anchor: exportsImports
    • title: Multiple Projects
      anchor: multiProjects
    • title: Package Managers
      anchor: packageManagers
    • title: Result Ranges
      anchor: resultRanges
    • title: Meta Data
      anchor: metaData
    • title: Emitting Constraints
      anchor: emittingConstraints
  • title: Additional Information
    anchor: _additionalInformation
    children:
    • title: Tools
      anchor: tools
    • title: Open Questions
      anchor: openQuestions

File: _data/lsif-0-6-0-toc.yml Copy Chapter

• title: Table of Contents
  reveal: _general
  children:
  • title: General
    anchor: _general
    children:
    • title: Introduction
      anchor: lsifIntro
    • title: Motivation
      anchor: lsifMotivation
    • title: Ranges
      anchor: ranges
    • title: Result Sets
      anchor: resultSet
  • title: Language Features
    anchor: _languageFeatures
    children:
    • title: definition
      anchor: definition
    • title: declaration
      anchor: declaration
    • title: hover
      anchor: hover
    • title: references
      anchor: references
    • title: implementation
      anchor: implementation
    • title: typeDefinition
      anchor: typeDefinition
    • title: foldingRange
      anchor: foldingRange
    • title: documentLink
      anchor: documentLink
    • title: documentSymbol
      anchor: documentSymbol
    • title: diagnostic
      anchor: diagnostic
    • title: project
      anchor: projectContext
    • title: Embedding Contents
      anchor: embeddingContents
  • title: Advanced Concepts
    anchor: _advancedConcepts
    children:
    • title: Events
      anchor: events
    • title: Exports and Imports
      anchor: exportsImports
    • title: Multiple Projects
      anchor: multiProjects
    • title: Package Managers
      anchor: packageManagers
    • title: Result Ranges
      anchor: resultRanges
    • title: Meta Data
      anchor: metaData
    • title: Emitting Constraints
      anchor: emittingConstraints
  • title: Additional Information
    anchor: _additionalInformation
    children:
    • title: Tools
      anchor: tools
    • title: Open Questions
      anchor: openQuestions

File: _data/overviews.yml Copy Chapter

• title: LSP
  url: /overviews/lsp/overview
• title: LSIF
  url: /overviews/lsif/overview

File: _data/specification-3-14-toc.yml Copy Chapter

• title: Message Overview
  reveal: general
  children:
  • title: General
    anchor: general
    children:
    • title: initialize
      anchor: initialize
    • title: initialized
      anchor: initialized
    • title: shutdown
      anchor: shutdown
    • title: exit
      anchor: exit
    • title: $/cancelRequest
      anchor: cancelRequest
  • title: Window
    anchor: window
    children:
    • title: showMessage
      anchor: window_showMessage
    • title: showMessageRequest
      anchor: window_showMessageRequest
    • title: logMessage
      anchor: window_logMessage
  • title: Telemetry
    anchor: telemetry
    children:
    • title: event
      anchor: telemetry_event
  • title: Client
    anchor: client
    children:
    • title: registerCapability
      anchor: client_registerCapability
    • title: unregisterCapability
      anchor: client_unregisterCapability
  • title: Workspace
    anchor: workspace
    children:
    • title: workspaceFolders
      anchor: workspace_workspaceFolders
    • title: didChangeWorkspaceFolders
      anchor: workspace_didChangeWorkspaceFolders
    • title: didChangeConfiguration
      anchor: workspace_didChangeConfiguration
    • title: configuration
      anchor: workspace_configuration
    • title: didChangeWatchedFiles
      anchor: workspace_didChangeWatchedFiles
    • title: symbol
      anchor: workspace_symbol
    • title: executeCommand
      anchor: workspace_executeCommand
    • title: applyEdit
      anchor: workspace_applyEdit
  • title: Text Synchronization
    anchor: textSynchronization
    children:
    • title: didOpen
      anchor: textDocument_didOpen
    • title: didChange
      anchor: textDocument_didChange
    • title: willSave
      anchor: textDocument_willSave
    • title: willSaveWaitUntil
      anchor: textDocument_willSaveWaitUntil
    • title: didSave
      anchor: textDocument_didSave
    • title: didClose
      anchor: textDocument_didClose
  • title: Diagnostics
    anchor: diagnostics
    children:
    • title: publishDiagnostics
      anchor: textDocument_publishDiagnostics
  • title: Language Features
    anchor: languageFeatures
    children:
    • title: completion
      anchor: textDocument_completion
    • title: completion resolve
      anchor: completionItem_resolve
    • title: hover
      anchor: textDocument_hover
    • title: signatureHelp
      anchor: textDocument_signatureHelp
    • title: declaration
      anchor: textDocument_declaration
    • title: definition
      anchor: textDocument_definition
    • title: typeDefinition
      anchor: textDocument_typeDefinition
    • title: implementation
      anchor: textDocument_implementation
    • title: references
      anchor: textDocument_references
    • title: documentHighlight
      anchor: textDocument_documentHighlight
    • title: documentSymbol
      anchor: textDocument_documentSymbol
    • title: codeAction
      anchor: textDocument_codeAction
    • title: codeLens
      anchor: textDocument_codeLens
    • title: codeLens resolve
      anchor: codeLens_resolve
    • title: documentLink
      anchor: textDocument_documentLink
    • title: documentLink resolve
      anchor: documentLink_resolve
    • title: documentColor
      anchor: textDocument_documentColor
    • title: colorPresentation
      anchor: textDocument_colorPresentation
    • title: formatting
      anchor: textDocument_formatting
    • title: rangeFormatting
      anchor: textDocument_rangeFormatting
    • title: onTypeFormatting
      anchor: textDocument_onTypeFormatting
    • title: rename
      anchor: textDocument_rename
    • title: prepareRename
      anchor: textDocument_prepareRename
    • title: foldingRange
      anchor: textDocument_foldingRange
  • title: Change Log
    anchor: changeLog
    children:
    • title: 3.14.0
      anchor: version_3_14_0
    • title: 3.13.0
      anchor: version_3_13_0
    • title: 3.12.0
      anchor: version_3_12_0
    • title: 3.11.0
      anchor: version_3_11_0
    • title: 3.10.0
      anchor: version_3_10_0
    • title: 3.9.0
      anchor: version_3_9_0
    • title: 3.8.0
      anchor: version_3_8_0
    • title: 3.7.0
      anchor: version_3_7_0
    • title: 3.6.0
      anchor: version_3_6_0
    • title: 3.5.0
      anchor: version_3_5_0
    • title: 3.4.0
      anchor: version_3_4_0
    • title: 3.3.0
      anchor: version_3_3_0
    • title: 3.2.0
      anchor: version_3_2_0
    • title: 3.1.0
      anchor: version_3_1_0
    • title: 3.0
      anchor: version_3_0_0

File: _data/specification-3-15-toc.yml Copy Chapter

• title: Message Overview
  reveal: baseProtocol
  children:
  • title: Base Protocol
    anchor: baseProtocol
    children:
    • title: Header Part
      anchor: headerPart
    • title: Content Part
      anchor: contentPart
    • title: Request Message
      anchor: requestMessage
    • title: Response Message
      anchor: responseMessage
    • title: Notification Message
      anchor: notificationMessage
    • title: $/cancelRequest
      anchor: cancelRequest
    • title: $/progress
      anchor: progress
  • title: Basic Structures
    anchor: dataTypes
    children:
    • title: URI
      anchor: uri
    • title: Text Documents
      anchor: textDocuments
    • title: Position
      anchor: position
    • title: Range
      anchor: range
    • title: Location
      anchor: location
    • title: Location Link
      anchor: locationLink
    • title: Diagnostic
      anchor: diagnostic
    • title: Command
      anchor: command
    • title: Text Edit
      anchor: textEdit
    • title: Text Document Edit
      anchor: textDocumentEdit
    • title: File Resource Changes
      anchor: resourceChanges
    • title: Workspace Edit
      anchor: workspaceEdit
    • title: Text Document Identifier
      anchor: textDocumentIdentifier
    • title: Text Document Item
      anchor: textDocumentItem
    • title: Versioned Text Document Identifier
      anchor: versionedTextDocumentIdentifier
    • title: Text Document Position Params
      anchor: textDocumentPositionParams
    • title: Document Filter
      anchor: documentFilter
    • title: Static Registration Options
      anchor: staticRegistrationOptions
    • title: Text Document Registration Options
      anchor: textDocumentRegistrationOptions
    • title: Markup Content
      anchor: markupContent
    • title: Work Done Progress
      anchor: workDoneProgress
    • title: Client Initiated Progress
      anchor: clientInitiatedProgress
    • title: Server Initiated Progress
      anchor: serverInitiatedProgress
    • title: Partial Results
      anchor: partialResults
    • title: Partial Result Params
      anchor: partialResultParams
  • title: General Messages
    anchor: general
    children:
    • title: initialize
      anchor: initialize
    • title: initialized
      anchor: initialized
    • title: shutdown
      anchor: shutdown
    • title: exit
      anchor: exit
  • title: Window
    anchor: window
    children:
    • title: showMessage
      anchor: window_showMessage
    • title: showMessageRequest
      anchor: window_showMessageRequest
    • title: logMessage
      anchor: window_logMessage
    • title: progress/create
      anchor: window_workDoneProgress_create
    • title: progress/cancel
      anchor: window_workDoneProgress_cancel
  • title: Telemetry
    anchor: telemetry
    children:
    • title: event
      anchor: telemetry_event
  • title: Client
    anchor: client
    children:
    • title: registerCapability
      anchor: client_registerCapability
    • title: unregisterCapability
      anchor: client_unregisterCapability
  • title: Workspace
    anchor: workspace
    children:
    • title: workspaceFolders
      anchor: workspace_workspaceFolders
    • title: didChangeWorkspaceFolders
      anchor: workspace_didChangeWorkspaceFolders
    • title: didChangeConfiguration
      anchor: workspace_didChangeConfiguration
    • title: configuration
      anchor: workspace_configuration
    • title: didChangeWatchedFiles
      anchor: workspace_didChangeWatchedFiles
    • title: symbol
      anchor: workspace_symbol
    • title: executeCommand
      anchor: workspace_executeCommand
    • title: applyEdit
      anchor: workspace_applyEdit
  • title: Text Synchronization
    anchor: textSynchronization
    children:
    • title: General Capabilities
      anchor: textDocument_synchronization
    • title: didOpen
      anchor: textDocument_didOpen
    • title: didChange
      anchor: textDocument_didChange
    • title: willSave
      anchor: textDocument_willSave
    • title: willSaveWaitUntil
      anchor: textDocument_willSaveWaitUntil
    • title: didSave
      anchor: textDocument_didSave
    • title: didClose
      anchor: textDocument_didClose
  • title: Diagnostics
    anchor: diagnostics
    children:
    • title: publishDiagnostics
      anchor: textDocument_publishDiagnostics
  • title: Language Features
    anchor: languageFeatures
    children:
    • title: completion
      anchor: textDocument_completion
    • title: completion resolve
      anchor: completionItem_resolve
    • title: hover
      anchor: textDocument_hover
    • title: signatureHelp
      anchor: textDocument_signatureHelp
    • title: declaration
      anchor: textDocument_declaration
    • title: definition
      anchor: textDocument_definition
    • title: typeDefinition
      anchor: textDocument_typeDefinition
    • title: implementation
      anchor: textDocument_implementation
    • title: references
      anchor: textDocument_references
    • title: documentHighlight
      anchor: textDocument_documentHighlight
    • title: documentSymbol
      anchor: textDocument_documentSymbol
    • title: codeAction
      anchor: textDocument_codeAction
    • title: codeLens
      anchor: textDocument_codeLens
    • title: codeLens resolve
      anchor: codeLens_resolve
    • title: documentLink
      anchor: textDocument_documentLink
    • title: documentLink resolve
      anchor: documentLink_resolve
    • title: documentColor
      anchor: textDocument_documentColor
    • title: colorPresentation
      anchor: textDocument_colorPresentation
    • title: formatting
      anchor: textDocument_formatting
    • title: rangeFormatting
      anchor: textDocument_rangeFormatting
    • title: onTypeFormatting
      anchor: textDocument_onTypeFormatting
    • title: rename
      anchor: textDocument_rename
    • title: prepareRename
      anchor: textDocument_prepareRename
    • title: foldingRange
      anchor: textDocument_foldingRange
    • title: selectionRange
      anchor: textDocument_selectionRange
  • title: Change Log
    anchor: changeLog
    children:
    • title: 3.15.0
      anchor: version_3_15_0
    • title: 3.14.0
      anchor: version_3_14_0
    • title: 3.13.0
      anchor: version_3_13_0
    • title: 3.12.0
      anchor: version_3_12_0
    • title: 3.11.0
      anchor: version_3_11_0
    • title: 3.10.0
      anchor: version_3_10_0
    • title: 3.9.0
      anchor: version_3_9_0
    • title: 3.8.0
      anchor: version_3_8_0
    • title: 3.7.0
      anchor: version_3_7_0
    • title: 3.6.0
      anchor: version_3_6_0
    • title: 3.5.0
      anchor: version_3_5_0
    • title: 3.4.0
      anchor: version_3_4_0
    • title: 3.3.0
      anchor: version_3_3_0
    • title: 3.2.0
      anchor: version_3_2_0
    • title: 3.1.0
      anchor: version_3_1_0
    • title: 3.0
      anchor: version_3_0_0

File: _data/specification-3-16-toc.yml Copy Chapter

• title: Message Overview
  reveal: baseProtocol
  children:
  • title: Base Protocol
    anchor: baseProtocol
    children:
    • title: Header Part
      anchor: headerPart
    • title: Content Part
      anchor: contentPart
    • title: Request Message
      anchor: requestMessage
    • title: Response Message
      anchor: responseMessage
    • title: Notification Message
      anchor: notificationMessage
    • title: $/cancelRequest
      anchor: cancelRequest
    • title: $/progress
      anchor: progress
  • title: Basic Structures
    anchor: dataTypes
    children:
    • title: URI
      anchor: uri
    • title: Regular Expression
      anchor: regExp
    • title: Text Documents
      anchor: textDocuments
    • title: Position
      anchor: position
    • title: Range
      anchor: range
    • title: Location
      anchor: location
    • title: Location Link
      anchor: locationLink
    • title: Diagnostic
      anchor: diagnostic
    • title: Command
      anchor: command
    • title: Text Edit
      anchor: textEdit
    • title: Text Document Edit
      anchor: textDocumentEdit
    • title: File Resource Changes
      anchor: resourceChanges
    • title: Workspace Edit
      anchor: workspaceEdit
    • title: Text Document Identifier
      anchor: textDocumentIdentifier
    • title: Text Document Item
      anchor: textDocumentItem
    • title: Versioned Text Document Identifier
      anchor: versionedTextDocumentIdentifier
    • title: Text Document Position Params
      anchor: textDocumentPositionParams
    • title: Document Filter
      anchor: documentFilter
    • title: Static Registration Options
      anchor: staticRegistrationOptions
    • title: Text Document Registration Options
      anchor: textDocumentRegistrationOptions
    • title: Markup Content
      anchor: markupContent
    • title: Work Done Progress
      anchor: workDoneProgress
    • title: Client Initiated Progress
      anchor: clientInitiatedProgress
    • title: Server Initiated Progress
      anchor: serverInitiatedProgress
    • title: Partial Results
      anchor: partialResults
    • title: Partial Result Params
      anchor: partialResultParams
    • title: Trace Value
      anchor: traceValue
  • title: General Messages
    anchor: general
    children:
    • title: initialize
      anchor: initialize
    • title: initialized
      anchor: initialized
    • title: shutdown
      anchor: shutdown
    • title: exit
      anchor: exit
    • title: logTrace
      anchor: logTrace
    • title: setTrace
      anchor: setTrace
  • title: Window
    anchor: window
    children:
    • title: showMessage
      anchor: window_showMessage
    • title: showMessageRequest
      anchor: window_showMessageRequest
    • title: showDocument
      anchor: window_showDocument
    • title: logMessage
      anchor: window_logMessage
    • title: progress/create
      anchor: window_workDoneProgress_create
    • title: progress/cancel
      anchor: window_workDoneProgress_cancel
  • title: Telemetry
    anchor: telemetry
    children:
    • title: event
      anchor: telemetry_event
  • title: Client
    anchor: client
    children:
    • title: registerCapability
      anchor: client_registerCapability
    • title: unregisterCapability
      anchor: client_unregisterCapability
  • title: Workspace
    anchor: workspace
    children:
    • title: workspaceFolders
      anchor: workspace_workspaceFolders
    • title: didChangeWorkspaceFolders
      anchor: workspace_didChangeWorkspaceFolders
    • title: didChangeConfiguration
      anchor: workspace_didChangeConfiguration
    • title: configuration
      anchor: workspace_configuration
    • title: didChangeWatchedFiles
      anchor: workspace_didChangeWatchedFiles
    • title: symbol
      anchor: workspace_symbol
    • title: executeCommand
      anchor: workspace_executeCommand
    • title: applyEdit
      anchor: workspace_applyEdit
    • title: file operations events
      anchor: workspace_willCreateFiles
  • title: Text Synchronization
    anchor: textSynchronization
    children:
    • title: General Capabilities
      anchor: textDocument_synchronization
    • title: didOpen
      anchor: textDocument_didOpen
    • title: didChange
      anchor: textDocument_didChange
    • title: willSave
      anchor: textDocument_willSave
    • title: willSaveWaitUntil
      anchor: textDocument_willSaveWaitUntil
    • title: didSave
      anchor: textDocument_didSave
    • title: didClose
      anchor: textDocument_didClose
  • title: Diagnostics
    anchor: diagnostics
    children:
    • title: publishDiagnostics
      anchor: textDocument_publishDiagnostics
  • title: Language Features
    anchor: languageFeatures
    children:
    • title: completion
      anchor: textDocument_completion
    • title: completion resolve
      anchor: completionItem_resolve
    • title: hover
      anchor: textDocument_hover
    • title: signatureHelp
      anchor: textDocument_signatureHelp
    • title: declaration
      anchor: textDocument_declaration
    • title: definition
      anchor: textDocument_definition
    • title: typeDefinition
      anchor: textDocument_typeDefinition
    • title: implementation
      anchor: textDocument_implementation
    • title: references
      anchor: textDocument_references
    • title: documentHighlight
      anchor: textDocument_documentHighlight
    • title: documentSymbol
      anchor: textDocument_documentSymbol
    • title: codeAction
      anchor: textDocument_codeAction
    • title: codeAction resolve
      anchor: codeAction_resolve
    • title: codeLens
      anchor: textDocument_codeLens
    • title: codeLens resolve
      anchor: codeLens_resolve
    • title: codeLens refresh
      anchor: codeLens_refresh
    • title: documentLink
      anchor: textDocument_documentLink
    • title: documentLink resolve
      anchor: documentLink_resolve
    • title: documentColor
      anchor: textDocument_documentColor
    • title: colorPresentation
      anchor: textDocument_colorPresentation
    • title: formatting
      anchor: textDocument_formatting
    • title: rangeFormatting
      anchor: textDocument_rangeFormatting
    • title: onTypeFormatting
      anchor: textDocument_onTypeFormatting
    • title: rename
      anchor: textDocument_rename
    • title: prepareRename
      anchor: textDocument_prepareRename
    • title: foldingRange
      anchor: textDocument_foldingRange
    • title: selectionRange
      anchor: textDocument_selectionRange
    • title: prepareCallHierarchy
      anchor: textDocument_prepareCallHierarchy
    • title: callHierarchy incoming
      anchor: callHierarchy_incomingCalls
    • title: callHierarchy outgoing
      anchor: callHierarchy_outgoingCalls
    • title: semantic tokens
      anchor: textDocument_semanticTokens
    • title: linkedEditingRange
      anchor: textDocument_linkedEditingRange
    • title: moniker
      anchor: textDocument_moniker
  • title: Change Log
    anchor: changeLog
    children:
    • title: 3.16.0
      anchor: version_3_16_0
    • title: 3.15.0
      anchor: version_3_15_0
    • title: 3.14.0
      anchor: version_3_14_0
    • title: 3.13.0
      anchor: version_3_13_0
    • title: 3.12.0
      anchor: version_3_12_0
    • title: 3.11.0
      anchor: version_3_11_0
    • title: 3.10.0
      anchor: version_3_10_0
    • title: 3.9.0
      anchor: version_3_9_0
    • title: 3.8.0
      anchor: version_3_8_0
    • title: 3.7.0
      anchor: version_3_7_0
    • title: 3.6.0
      anchor: version_3_6_0
    • title: 3.5.0
      anchor: version_3_5_0
    • title: 3.4.0
      anchor: version_3_4_0
    • title: 3.3.0
      anchor: version_3_3_0
    • title: 3.2.0
      anchor: version_3_2_0
    • title: 3.1.0
      anchor: version_3_1_0
    • title: 3.0
      anchor: version_3_0_0

File: _data/specification-3-17-toc.yml Copy Chapter

• title: Message Overview
  reveal: baseProtocol
  children:
  • title: Base Protocol
    anchor: baseProtocol
    children:
    • title: Header Part
      anchor: headerPart
    • title: Content Part
      anchor: contentPart
    • title: Base Types
      anchor: baseTypes
    • title: Request Message
      anchor: requestMessage
    • title: Response Message
      anchor: responseMessage
    • title: Notification Message
      anchor: notificationMessage
    • title: Cancellation Support
      anchor: cancelRequest
    • title: Progress Support
      anchor: progress
  • title: Language Server Protocol
    anchor: languageServerProtocol
    children:
    • title: Overview
      anchor: languageServerProtocol
    • title: Capabilities
      anchor: capabilities
    • title: Message Ordering
      anchor: messageOrdering
    • title: Message Documentation
      anchor: messageDocumentation
  • title: Basic JSON Structures
    anchor: basicJsonStructures
    children:
    • title: URI
      anchor: uri
    • title: Regular Expression
      anchor: regExp
    • title: Enumerations
      anchor: enumerations
    • title: Text Documents
      anchor: textDocuments
    • title: Position
      anchor: position
    • title: Range
      anchor: range
    • title: Text Document Item
      anchor: textDocumentItem
    • title: Text Document Identifier
      anchor: textDocumentIdentifier
    • title: Versioned Text Document Identifier
      anchor: versionedTextDocumentIdentifier
    • title: Text Document Position Params
      anchor: textDocumentPositionParams
    • title: Document Filter
      anchor: documentFilter
    • title: Text Edit
      anchor: textEdit
    • title: Text Edit Array
      anchor: textEditArray
    • title: Text Document Edit
      anchor: textDocumentEdit
    • title: Location
      anchor: location
    • title: Location Link
      anchor: locationLink
    • title: Diagnostic
      anchor: diagnostic
    • title: Command
      anchor: command
    • title: Markup Content
      anchor: markupContent
    • title: File Resource Changes
      anchor: resourceChanges
    • title: Workspace Edit
      anchor: workspaceEdit
    • title: Work Done Progress
      anchor: workDoneProgress
    • title: Client Initiated Progress
      anchor: clientInitiatedProgress
    • title: Server Initiated Progress
      anchor: serverInitiatedProgress
    • title: Partial Results
      anchor: partialResults
    • title: Partial Result Params
      anchor: partialResultParams
    • title: Trace Value
      anchor: traceValue
  • title: Lifecycle Messages
    anchor: lifeCycleMessages
    children:
    • title: Overview
      anchor: lifeCycleMessages
    • title: Initialize
      anchor: initialize
    • title: Initialized
      anchor: initialized
    • title: Register Capability
      anchor: client_registerCapability
    • title: Unregister Capability
      anchor: client_unregisterCapability
    • title: Set Trace
      anchor: setTrace
    • title: Log Trace
      anchor: logTrace
    • title: Shutdown
      anchor: shutdown
    • title: Exit
      anchor: exit
  • title: Document Synchronization
    anchor: textSynchronization
    children:
    • title: Overview - Text Document
      anchor: textDocument_synchronization
    • title: Did Open Text Document
      anchor: textDocument_didOpen
    • title: Did Change Text Document
      anchor: textDocument_didChange
    • title: Will Save Text Document
      anchor: textDocument_willSave
    • title: Will Save Document Wait Until
      anchor: textDocument_willSaveWaitUntil
    • title: Did Save Text Document
      anchor: textDocument_didSave
    • title: Did Close Text Document
      anchor: textDocument_didClose
    • title: Rename a Text Document
      anchor: textDocument_didRename
    • title: Overview - Notebook Document
      anchor: notebookDocument_synchronization
    • title: Did Open Notebook Document
      anchor: notebookDocument_didOpen
    • title: Did Change Notebook Document
      anchor: notebookDocument_didChange
    • title: Did Save Notebook Document
      anchor: notebookDocument_didSave
    • title: Did Close Notebook Document
      anchor: notebookDocument_didClose
  • title: Language Features
    anchor: languageFeatures
    children:
    • title: Overview
      anchor: languageFeatures
    • title: Go to Declaration
      anchor: textDocument_declaration
    • title: Go to Definition
      anchor: textDocument_definition
    • title: Go to Type Definition
      anchor: textDocument_typeDefinition
    • title: Go to Implementation
      anchor: textDocument_implementation
    • title: Find References
      anchor: textDocument_references
    • title: Prepare Call Hierarchy
      anchor: textDocument_prepareCallHierarchy
    • title: Call Hierarchy Incoming Calls
      anchor: callHierarchy_incomingCalls
    • title: Call Hierarchy Outgoing Calls
      anchor: callHierarchy_outgoingCalls
    • title: Prepare Type Hierarchy
      anchor: textDocument_prepareTypeHierarchy
    • title: Type Hierarchy Super Types
      anchor: typeHierarchy_supertypes
    • title: Type Hierarchy Sub Types
      anchor: typeHierarchy_subtypes
    • title: Document Highlight
      anchor: textDocument_documentHighlight
    • title: Document Link
      anchor: textDocument_documentLink
    • title: Document Link Resolve
      anchor: documentLink_resolve
    • title: Hover
      anchor: textDocument_hover
    • title: Code Lens
      anchor: textDocument_codeLens
    • title: Code Lens Refresh
      anchor: codeLens_refresh
    • title: Folding Range
      anchor: textDocument_foldingRange
    • title: Selection Range
      anchor: textDocument_selectionRange
    • title: Document Symbols
      anchor: textDocument_documentSymbol
    • title: Semantic Tokens
      anchor: textDocument_semanticTokens
    • title: Inline Value
      anchor: textDocument_inlineValue
    • title: Inline Value Refresh
      anchor: workspace_inlineValue_refresh
    • title: Inlay Hint
      anchor: textDocument_inlayHint
    • title: Inlay Hint Resolve
      anchor: inlayHint_resolve
    • title: Inlay Hint Refresh
      anchor: workspace_inlayHint_refresh
    • title: Moniker
      anchor: textDocument_moniker
    • title: Completion Proposals
      anchor: textDocument_completion
    • title: Completion Item Resolve
      anchor: completionItem_resolve
    • title: Publish Diagnostics
      anchor: textDocument_publishDiagnostics
    • title: Pull Diagnostics
      anchor: textDocument_pullDiagnostics
    • title: Signature Help
      anchor: textDocument_signatureHelp
    • title: Code Action
      anchor: textDocument_codeAction
    • title: Code Action Resolve
      anchor: codeAction_resolve
    • title: Document Color
      anchor: textDocument_documentColor
    • title: Color Presentation
      anchor: textDocument_colorPresentation
    • title: Formatting
      anchor: textDocument_formatting
    • title: Range Formatting
      anchor: textDocument_rangeFormatting
    • title: On type Formatting
      anchor: textDocument_onTypeFormatting
    • title: Rename
      anchor: textDocument_rename
    • title: Prepare Rename
      anchor: textDocument_prepareRename
    • title: Linked Editing Range
      anchor: textDocument_linkedEditingRange
  • title: Workspace Features
    anchor: workspaceFeatures
    children:
    • title: Workspace Symbols
      anchor: workspace_symbol
    • title: Workspace Symbol Resolve
      anchor: workspace_symbolResolve
    • title: Get Configuration
      anchor: workspace_configuration
    • title: Did Change Configuration
      anchor: workspace_didChangeConfiguration
    • title: Workspace Folders
      anchor: workspace_workspaceFolders
    • title: Did Change Workspace Folders
      anchor: workspace_didChangeWorkspaceFolders
    • title: Will Create Files
      anchor: workspace_willCreateFiles
    • title: Did Create Files
      anchor: workspace_didCreateFiles
    • title: Will Rename Files
      anchor: workspace_willRenameFiles
    • title: Did Rename Files
      anchor: workspace_didRenameFiles
    • title: Will Delete Files
      anchor: workspace_willDeleteFiles
    • title: Did Delete Files
      anchor: workspace_didDeleteFiles
    • title: Did Change Watched Files
      anchor: workspace_didChangeWatchedFiles
    • title: Execute Command
      anchor: workspace_executeCommand
    • title: Apply Edit
      anchor: workspace_applyEdit
  • title: Window Features
    anchor: windowFeatures
    children:
    • title: Show Message Notification
      anchor: window_showMessage
    • title: Show Message Request
      anchor: window_showMessageRequest
    • title: Log Message
      anchor: window_logMessage
    • title: Show Document
      anchor: window_showDocument
    • title: Create Work Done Progress
      anchor: window_workDoneProgress_create
    • title: Cancel a Work Done Progress
      anchor: window_workDoneProgress_cancel
    • title: Sent Telemetry
      anchor: telemetry_event
  • title: Miscellaneous
    anchor: miscellaneous
    children:
    • title: Implementation Considerations
      anchor: implementationConsiderations
    • title: Meta Model
      anchor: metaModel
  • title: Change Log
    anchor: changeLog
    children:
    • title: 3.17.0
      anchor: version_3_17_0
    • title: 3.16.0
      anchor: version_3_16_0
    • title: 3.15.0
      anchor: version_3_15_0
    • title: 3.14.0
      anchor: version_3_14_0
    • title: 3.13.0
      anchor: version_3_13_0
    • title: 3.12.0
      anchor: version_3_12_0
    • title: 3.11.0
      anchor: version_3_11_0
    • title: 3.10.0
      anchor: version_3_10_0
    • title: 3.9.0
      anchor: version_3_9_0
    • title: 3.8.0
      anchor: version_3_8_0
    • title: 3.7.0
      anchor: version_3_7_0
    • title: 3.6.0
      anchor: version_3_6_0
    • title: 3.5.0
      anchor: version_3_5_0
    • title: 3.4.0
      anchor: version_3_4_0
    • title: 3.3.0
      anchor: version_3_3_0
    • title: 3.2.0
      anchor: version_3_2_0
    • title: 3.1.0
      anchor: version_3_1_0
    • title: 3.0
      anchor: version_3_0_0

File: _data/specification-3-18-toc.yml Copy Chapter

• title: Message Overview
  reveal: baseProtocol
  children:
  • title: Base Protocol
    anchor: baseProtocol
    children:
    • title: Header Part
      anchor: headerPart
    • title: Content Part
      anchor: contentPart
    • title: Base Types
      anchor: baseTypes
    • title: Request Message
      anchor: requestMessage
    • title: Response Message
      anchor: responseMessage
    • title: Notification Message
      anchor: notificationMessage
    • title: Cancellation Support
      anchor: cancelRequest
    • title: Progress Support
      anchor: progress
  • title: Language Server Protocol
    anchor: languageServerProtocol
    children:
    • title: Overview
      anchor: languageServerProtocol
    • title: Capabilities
      anchor: capabilities
    • title: Message Ordering
      anchor: messageOrdering
    • title: Message Documentation
      anchor: messageDocumentation
  • title: Basic JSON Structures
    anchor: basicJsonStructures
    children:
    • title: URI
      anchor: uri
    • title: Regular Expression
      anchor: regExp
    • title: Enumerations
      anchor: enumerations
    • title: Text Documents
      anchor: textDocuments
    • title: Position
      anchor: position
    • title: Range
      anchor: range
    • title: Text Document Item
      anchor: textDocumentItem
    • title: Text Document Identifier
      anchor: textDocumentIdentifier
    • title: Versioned Text Document Identifier
      anchor: versionedTextDocumentIdentifier
    • title: Text Document Position Params
      anchor: textDocumentPositionParams
    • title: Patterns
      anchor: patterns
    • title: Document Filter
      anchor: documentFilter
    • title: String Value
      anchor: stringValue
    • title: Text Edit
      anchor: textEdit
    • title: Text Edit Array
      anchor: textEditArray
    • title: Text Document Edit
      anchor: textDocumentEdit
    • title: Location
      anchor: location
    • title: Location Link
      anchor: locationLink
    • title: Diagnostic
      anchor: diagnostic
    • title: Command
      anchor: command
    • title: Markup Content
      anchor: markupContent
    • title: File Resource Changes
      anchor: resourceChanges
    • title: Workspace Edit
      anchor: workspaceEdit
    • title: Work Done Progress
      anchor: workDoneProgress
    • title: Client Initiated Progress
      anchor: clientInitiatedProgress
    • title: Server Initiated Progress
      anchor: serverInitiatedProgress
    • title: Partial Results
      anchor: partialResults
    • title: Partial Result Params
      anchor: partialResultParams
    • title: Trace Value
      anchor: traceValue
  • title: Lifecycle Messages
    anchor: lifeCycleMessages
    children:
    • title: Overview
      anchor: lifeCycleMessages
    • title: Initialize
      anchor: initialize
    • title: Initialized
      anchor: initialized
    • title: Register Capability
      anchor: client_registerCapability
    • title: Unregister Capability
      anchor: client_unregisterCapability
    • title: Set Trace
      anchor: setTrace
    • title: Log Trace
      anchor: logTrace
    • title: Shutdown
      anchor: shutdown
    • title: Exit
      anchor: exit
  • title: Document Synchronization
    anchor: textSynchronization
    children:
    • title: Overview - Text Document
      anchor: textDocument_synchronization
    • title: Did Open Text Document
      anchor: textDocument_didOpen
    • title: Did Change Text Document
      anchor: textDocument_didChange
    • title: Will Save Text Document
      anchor: textDocument_willSave
    • title: Will Save Document Wait Until
      anchor: textDocument_willSaveWaitUntil
    • title: Did Save Text Document
      anchor: textDocument_didSave
    • title: Did Close Text Document
      anchor: textDocument_didClose
    • title: Rename a Text Document
      anchor: textDocument_didRename
    • title: Overview - Notebook Document
      anchor: notebookDocument_synchronization
    • title: Did Open Notebook Document
      anchor: notebookDocument_didOpen
    • title: Did Change Notebook Document
      anchor: notebookDocument_didChange
    • title: Did Save Notebook Document
      anchor: notebookDocument_didSave
    • title: Did Close Notebook Document
      anchor: notebookDocument_didClose
  • title: Language Features
    anchor: languageFeatures
    children:
    • title: Overview
      anchor: languageFeatures
    • title: Go to Declaration
      anchor: textDocument_declaration
    • title: Go to Definition
      anchor: textDocument_definition
    • title: Go to Type Definition
      anchor: textDocument_typeDefinition
    • title: Go to Implementation
      anchor: textDocument_implementation
    • title: Find References
      anchor: textDocument_references
    • title: Prepare Call Hierarchy
      anchor: textDocument_prepareCallHierarchy
    • title: Call Hierarchy Incoming Calls
      anchor: callHierarchy_incomingCalls
    • title: Call Hierarchy Outgoing Calls
      anchor: callHierarchy_outgoingCalls
    • title: Prepare Type Hierarchy
      anchor: textDocument_prepareTypeHierarchy
    • title: Type Hierarchy Super Types
      anchor: typeHierarchy_supertypes
    • title: Type Hierarchy Sub Types
      anchor: typeHierarchy_subtypes
    • title: Document Highlight
      anchor: textDocument_documentHighlight
    • title: Document Link
      anchor: textDocument_documentLink
    • title: Document Link Resolve
      anchor: documentLink_resolve
    • title: Hover
      anchor: textDocument_hover
    • title: Code Lens
      anchor: textDocument_codeLens
    • title: Code Lens Refresh
      anchor: codeLens_refresh
    • title: Folding Range
      anchor: textDocument_foldingRange
    • title: Folding Range Refresh
      anchor: workspace_foldingRange_refresh
    • title: Selection Range
      anchor: textDocument_selectionRange
    • title: Document Symbols
      anchor: textDocument_documentSymbol
    • title: Semantic Tokens
      anchor: textDocument_semanticTokens
    • title: Semantic Tokens Refresh
      anchor: semanticTokens_refreshRequest
    • title: Inline Value
      anchor: textDocument_inlineValue
    • title: Inline Value Refresh
      anchor: workspace_inlineValue_refresh
    • title: Inlay Hint
      anchor: textDocument_inlayHint
    • title: Inlay Hint Resolve
      anchor: inlayHint_resolve
    • title: Inlay Hint Refresh
      anchor: workspace_inlayHint_refresh
    • title: Moniker
      anchor: textDocument_moniker
    • title: Completion Proposals
      anchor: textDocument_completion
    • title: Completion Item Resolve
      anchor: completionItem_resolve
    • title: Publish Diagnostics
      anchor: textDocument_publishDiagnostics
    • title: Pull Diagnostics
      anchor: textDocument_pullDiagnostics
    • title: Diagnostics Refresh
      anchor: diagnostic_refresh
    • title: Signature Help
      anchor: textDocument_signatureHelp
    • title: Code Action
      anchor: textDocument_codeAction
    • title: Code Action Resolve
      anchor: codeAction_resolve
    • title: Document Color
      anchor: textDocument_documentColor
    • title: Color Presentation
      anchor: textDocument_colorPresentation
    • title: Formatting
      anchor: textDocument_formatting
    • title: Range Formatting
      anchor: textDocument_rangeFormatting
    • title: On type Formatting
      anchor: textDocument_onTypeFormatting
    • title: Rename
      anchor: textDocument_rename
    • title: Prepare Rename
      anchor: textDocument_prepareRename
    • title: Linked Editing Range
      anchor: textDocument_linkedEditingRange
  • title: Workspace Features
    anchor: workspaceFeatures
    children:
    • title: Workspace Symbols
      anchor: workspace_symbol
    • title: Workspace Symbol Resolve
      anchor: workspace_symbolResolve
    • title: Get Configuration
      anchor: workspace_configuration
    • title: Did Change Configuration
      anchor: workspace_didChangeConfiguration
    • title: Workspace Folders
      anchor: workspace_workspaceFolders
    • title: Did Change Workspace Folders
      anchor: workspace_didChangeWorkspaceFolders
    • title: Will Create Files
      anchor: workspace_willCreateFiles
    • title: Did Create Files
      anchor: workspace_didCreateFiles
    • title: Will Rename Files
      anchor: workspace_willRenameFiles
    • title: Did Rename Files
      anchor: workspace_didRenameFiles
    • title: Will Delete Files
      anchor: workspace_willDeleteFiles
    • title: Did Delete Files
      anchor: workspace_didDeleteFiles
    • title: Did Change Watched Files
      anchor: workspace_didChangeWatchedFiles
    • title: Execute Command
      anchor: workspace_executeCommand
    • title: Apply Edit
      anchor: workspace_applyEdit
    • title: Text Document Content
      anchor: workspace_textDocumentContent
  • title: Window Features
    anchor: windowFeatures
    children:
    • title: Show Message Notification
      anchor: window_showMessage
    • title: Show Message Request
      anchor: window_showMessageRequest
    • title: Log Message
      anchor: window_logMessage
    • title: Show Document
      anchor: window_showDocument
    • title: Create Work Done Progress
      anchor: window_workDoneProgress_create
    • title: Cancel a Work Done Progress
      anchor: window_workDoneProgress_cancel
    • title: Send Telemetry
      anchor: telemetry_event
  • title: Miscellaneous
    anchor: miscellaneous
    children:
    • title: Implementation Considerations
      anchor: implementationConsiderations
    • title: Meta Model
      anchor: metaModel
  • title: Change Log
    anchor: changeLog
    children:
    • title: 3.18.0
      anchor: version_3_18_0
    • title: 3.17.0
      anchor: version_3_17_0
    • title: 3.16.0
      anchor: version_3_16_0
    • title: 3.15.0
      anchor: version_3_15_0
    • title: 3.14.0
      anchor: version_3_14_0
    • title: 3.13.0
      anchor: version_3_13_0
    • title: 3.12.0
      anchor: version_3_12_0
    • title: 3.11.0
      anchor: version_3_11_0
    • title: 3.10.0
      anchor: version_3_10_0
    • title: 3.9.0
      anchor: version_3_9_0
    • title: 3.8.0
      anchor: version_3_8_0
    • title: 3.7.0
      anchor: version_3_7_0
    • title: 3.6.0
      anchor: version_3_6_0
    • title: 3.5.0
      anchor: version_3_5_0
    • title: 3.4.0
      anchor: version_3_4_0
    • title: 3.3.0
      anchor: version_3_3_0
    • title: 3.2.0
      anchor: version_3_2_0
    • title: 3.1.0
      anchor: version_3_1_0
    • title: 3.0
      anchor: version_3_0_0

File: _data/specifications.yml Copy Chapter

• title: LSP
  anchor: lsp
  children:
  • title: 3.18 (Current)
    version: 3.18
    url: /specifications/lsp/3.18/specification
  • title: 3.19 (Upcoming)
    version: 3.19
    url: /specifications/lsp/3.19/specification
  • title: 3.17 (Previous)
    version: 3.17
    url: /specifications/lsp/3.17/specification
• title: LSIF
  anchor: lsif
  children:
  • title: 0.6.0 (Current)
    url: /specifications/lsif/0.6.0/specification
  • title: 0.5.0 (Previous)
    url: /specifications/lsif/0.5.0/specification
• title: Base Protocol
  anchor: base
  children:
  • title: 0.9 (Upcoming)
    version: 0.9
    url: /specifications/base/0.9/specification

File: _implementors/sdks.md Copy Chapter

layout: implementors title: "SDKs for the LSP" shortTitle: "SDKs" author: Microsoft index: 3 Copy Chapter

If you are missing a SDK please create a pull request in GitHub against this markdown document

File: _implementors/servers.md Copy Chapter

layout: implementors title: "Language Servers" shortTitle: "Language Servers" author: Microsoft index: 1 Copy Chapter

If you are missing a server please create a pull request in GitHub against this markdown document

File: _implementors/tools.md Copy Chapter

layout: implementors title: "Tools supporting the LSP" shortTitle: "Supporting Tools" author: Microsoft index: 2 Copy Chapter

If you are missing a development tool please create a pull request in GitHub against this markdown document

File: _implementors/utilities.md Copy Chapter

layout: implementors title: "Utilities for LSPs" shortTitle: "Utilities" author: Microsoft index: 4 Copy Chapter

If you are missing a utility please create a pull request in GitHub against this markdown document

File: _includes/messages/3.17/exit.md Copy Chapter

[Exit Notification (:arrow_right:)](#exit)

A notification to ask the server to exit its process.
The server should exit with success code 0 if the shutdown request has been received before; otherwise with error code 1.

Notification:

• method: 'exit'
• params: none

File: _includes/messages/3.17/initialized.md Copy Chapter

[Initialized Notification (:arrow_right:)](#initialized)

The initialized notification is sent from the client to the server after the client received the result of the initialize request but before the client is sending any other request or notification to the server. The server can use the initialized notification, for example, to dynamically register capabilities. The initialized notification may only be sent once.

Notification:

• method: 'initialized'
• params: InitializedParams defined as follows:

interface InitializedParams {
}

File: _includes/messages/3.17/logMessage.md Copy Chapter

[LogMessage Notification (:arrow_left:)](#window_logMessage)

The log message notification is sent from the server to the client to ask the client to log a particular message.

Notification:

• method: 'window/logMessage'
• params: LogMessageParams defined as follows:

interface LogMessageParams {
	/**
	 * The message type. See {@link MessageType}
	 */
	type: MessageType;

	/**
	 * The actual message
	 */
	message: string;
}

File: _includes/messages/3.17/logTrace.md Copy Chapter

[LogTrace Notification (:arrow_left:)](#logTrace)

A notification to log the trace of the server's execution.
The amount and content of these notifications depends on the current trace configuration.
If trace is 'off', the server should not send any logTrace notification.
If trace is 'messages', the server should not add the 'verbose' field in the LogTraceParams.

$/logTrace should be used for systematic trace reporting. For single debugging messages, the server should send window/logMessage notifications.

Notification:

• method: '$/logTrace'
• params: LogTraceParams defined as follows:

interface LogTraceParams {
	/**
	 * The message to be logged.
	 */
	message: string;
	/**
	 * Additional information that can be computed if the `trace` configuration
	 * is set to `'verbose'`
	 */
	verbose?: string;
}

File: _includes/messages/3.17/registerCapability.md Copy Chapter

[Register Capability (:arrow_right_hook:)](#client_registerCapability)

The client/registerCapability request is sent from the server to the client to register for a new capability on the client side. Not all clients need to support dynamic capability registration. A client opts in via the dynamicRegistration property on the specific client capabilities. A client can even provide dynamic registration for capability A but not for capability B (see TextDocumentClientCapabilities as an example).

Server must not register the same capability both statically through the initialize result and dynamically for the same document selector. If a server wants to support both static and dynamic registration it needs to check the client capability in the initialize request and only register the capability statically if the client doesn't support dynamic registration for that capability.

Request:

• method: 'client/registerCapability'
• params: RegistrationParams

Where RegistrationParams are defined as follows:

/**
 * General parameters to register for a capability.
 */
export interface Registration {
	/**
	 * The id used to register the request. The id can be used to deregister
	 * the request again.
	 */
	id: string;

	/**
	 * The method / capability to register for.
	 */
	method: string;

	/**
	 * Options necessary for the registration.
	 */
	registerOptions?: LSPAny;
}

export interface RegistrationParams {
	registrations: Registration[];
}

Since most of the registration options require to specify a document selector there is a base interface that can be used. See TextDocumentRegistrationOptions.

An example JSON-RPC message to register dynamically for the textDocument/willSaveWaitUntil feature on the client side is as follows (only details shown):

{
	"method": "client/registerCapability",
	"params": {
		"registrations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil",
				"registerOptions": {
					"documentSelector": [
						{ "language": "javascript" }
					]
				}
			}
		]
	}
}

This message is sent from the server to the client and after the client has successfully executed the request further textDocument/willSaveWaitUntil requests for JavaScript text documents are sent from the client to the server.

Response:

• result: void.
• error: code and message set in case an exception happens during the request.

StaticRegistrationOptions can be used to register a feature in the initialize result with a given server control ID to be able to un-register the feature later on.

/**
 * Static registration options to be returned in the initialize request.
 */
export interface StaticRegistrationOptions {
	/**
	 * The id used to register the request. The id can be used to deregister
	 * the request again. See also Registration#id.
	 */
	id?: string;
}

TextDocumentRegistrationOptions can be used to dynamically register for requests for a set of text documents.

/**
 * General text document registration options.
 */
export interface TextDocumentRegistrationOptions {
	/**
	 * A document selector to identify the scope of the registration. If set to
	 * null the document selector provided on the client side will be used.
	 */
	documentSelector: DocumentSelector | null;
}

File: _includes/messages/3.17/setTrace.md Copy Chapter

[SetTrace Notification (:arrow_right:)](#setTrace)

A notification that should be used by the client to modify the trace setting of the server.

Notification:

• method: '$/setTrace'
• params: SetTraceParams defined as follows:

interface SetTraceParams {
	/**
	 * The new value that should be assigned to the trace setting.
	 */
	value: TraceValue;
}

File: _includes/messages/3.17/showMessage.md Copy Chapter

[ShowMessage Notification (:arrow_left:)](#window_showMessage)

The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

Notification:

• method: 'window/showMessage'
• params: ShowMessageParams defined as follows:

interface ShowMessageParams {
	/**
	 * The message type. See {@link MessageType}.
	 */
	type: MessageType;

	/**
	 * The actual message.
	 */
	message: string;
}

Where the type is defined as follows:

export namespace MessageType {
	/**
	 * An error message.
	 */
	export const Error = 1;
	/**
	 * A warning message.
	 */
	export const Warning = 2;
	/**
	 * An information message.
	 */
	export const Info = 3;
	/**
	 * A log message.
	 */
	export const Log = 4;
	/**
	 * A debug message.
	 *
	 * @since 3.18.0
	 */
	export const Debug = 5;
}

export type MessageType = 1 | 2 | 3 | 4 | 5;

File: _includes/messages/3.17/showMessageRequest.md Copy Chapter

[ShowMessage Request (:arrow_right_hook:)](#window_showMessageRequest)

The show message request is sent from a server to a client to ask the client to display a particular message in the user interface. In addition to the show message notification the request allows to pass actions and to wait for an answer from the client.

Client Capability:

• property path (optional): window.showMessage
• property type: ShowMessageRequestClientCapabilities defined as follows:

/**
 * Show message request client capabilities
 */
export interface ShowMessageRequestClientCapabilities {
	/**
	 * Capabilities specific to the `MessageActionItem` type.
	 */
	messageActionItem?: {
		/**
		 * Whether the client supports additional attributes which
		 * are preserved and sent back to the server in the
		 * request's response.
		 */
		additionalPropertiesSupport?: boolean;
	};
}

Request:

• method: 'window/showMessageRequest'
• params: ShowMessageRequestParams defined as follows:

interface ShowMessageRequestParams {
	/**
	 * The message type. See {@link MessageType}
	 */
	type: MessageType;

	/**
	 * The actual message
	 */
	message: string;

	/**
	 * The message action items to present.
	 */
	actions?: MessageActionItem[];
}

Where the MessageActionItem is defined as follows:

interface MessageActionItem {
	/**
	 * A short title like 'Retry', 'Open Log' etc.
	 */
	title: string;
}

Response:

• result: the selected MessageActionItem | null if none got selected.
• error: code and message set in case an exception happens during showing a message.

File: _includes/messages/3.17/shutdown.md Copy Chapter

[Shutdown Request (:leftwards_arrow_with_hook:)](#shutdown)

The shutdown request is sent from the client to the server. It asks the server to shut down, but to not exit (otherwise the response might not be delivered correctly to the client). There is a separate exit notification that asks the server to exit. Clients must not send any notifications other than exit or requests to a server to which they have sent a shutdown request. Clients should also wait with sending the exit notification until they have received a response from the shutdown request.

If a server receives requests after a shutdown request those requests should error with InvalidRequest.

Request:

• method: 'shutdown'
• params: none

Response:

• result: null
• error: code and message set in case an exception happens during shutdown request.

File: _includes/messages/3.17/telemetryEvent.md Copy Chapter

[Telemetry Notification (:arrow_left:)](#telemetry_event)

The telemetry notification is sent from the server to the client to ask the client to log a telemetry event. The protocol doesn't specify the payload since no interpretation of the data happens in the protocol. Most clients even don't handle the event directly but forward them to the extensions owing the corresponding server issuing the event.

Notification:

• method: 'telemetry/event'
• params: 'object' | 'array';

File: _includes/messages/3.17/unregisterCapability.md Copy Chapter

[Unregister Capability (:arrow_right_hook:)](#client_unregisterCapability)

The client/unregisterCapability request is sent from the server to the client to unregister a previously registered capability.

Request:

• method: 'client/unregisterCapability'
• params: UnregistrationParams

Where UnregistrationParams are defined as follows:

/**
 * General parameters to unregister a capability.
 */
export interface Unregistration {
	/**
	 * The id used to unregister the request or notification. Usually an id
	 * provided during the register request.
	 */
	id: string;

	/**
	 * The method / capability to unregister for.
	 */
	method: string;
}

export interface UnregistrationParams {
	// This should correctly be named `unregistrations`. However changing this
	// is a breaking change and needs to wait until we deliver a 4.x version
	// of the specification.
	unregisterations: Unregistration[];
}

An example JSON-RPC message to unregister the above registered textDocument/willSaveWaitUntil feature looks like this:

{
	"method": "client/unregisterCapability",
	"params": {
		"unregisterations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil"
			}
		]
	}
}

Response:

• result: void.
• error: code and message set in case an exception happens during the request.

File: _includes/messages/3.18/exit.md Copy Chapter

[Exit Notification (:arrow_right:)](#exit)

A notification to ask the server to exit its process.
The server should exit with success code 0 if the shutdown request has been received before; otherwise with error code 1.

Notification:

• method: 'exit'
• params: none

File: _includes/messages/3.18/initialized.md Copy Chapter

[Initialized Notification (:arrow_right:)](#initialized)

The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server. The server can use the initialized notification, for example, to dynamically register capabilities. The initialized notification may only be sent once.

Notification:

• method: 'initialized'
• params: InitializedParams defined as follows:

interface InitializedParams {
}

File: _includes/messages/3.18/logMessage.md Copy Chapter

[LogMessage Notification (:arrow_left:)](#window_logMessage)

The log message notification is sent from the server to the client to ask the client to log a particular message.

Notification:

• method: 'window/logMessage'
• params: LogMessageParams defined as follows:

interface LogMessageParams {
	/**
	 * The message type. See {@link MessageType}.
	 */
	type: MessageType;

	/**
	 * The actual message.
	 */
	message: string;
}

File: _includes/messages/3.18/logTrace.md Copy Chapter

[LogTrace Notification (:arrow_left:)](#logTrace)

A notification to log the trace of the server's execution.
The amount and content of these notifications depends on the current trace configuration.
If trace is 'off', the server should not send any logTrace notification.
If trace is 'messages', the server should not add the 'verbose' field in the LogTraceParams.

$/logTrace should be used for systematic trace reporting. For single debugging messages, the server should send window/logMessage notifications.

Notification:

• method: '$/logTrace'
• params: LogTraceParams defined as follows:

interface LogTraceParams {
	/**
	 * The message to be logged.
	 */
	message: string;
	/**
	 * Additional information that can be computed if the `trace` configuration
	 * is set to `'verbose'`.
	 */
	verbose?: string;
}

File: _includes/messages/3.18/registerCapability.md Copy Chapter

[Register Capability (:arrow_right_hook:)](#client_registerCapability)

The client/registerCapability request is sent from the server to the client to register for a new capability on the client side. Not all clients need to support dynamic capability registration. A client opts in via the dynamicRegistration property on the specific client capabilities. A client can even provide dynamic registration for capability A but not for capability B (see TextDocumentClientCapabilities as an example).

The server must not register the same capability both statically through the initialize result and dynamically for the same document selector. If a server wants to support both static and dynamic registration, it needs to check the client capability in the initialize request and only register the capability statically if the client doesn't support dynamic registration for that capability.

Request:

• method: 'client/registerCapability'
• params: RegistrationParams

Where RegistrationParams are defined as follows:

/**
 * General parameters to register for a capability.
 */
export interface Registration {
	/**
	 * The id used to register the request. The id can be used to deregister
	 * the request again.
	 */
	id: string;

	/**
	 * The method / capability to register for.
	 */
	method: string;

	/**
	 * Options necessary for the registration.
	 */
	registerOptions?: LSPAny;
}

export interface RegistrationParams {
	registrations: Registration[];
}

Since most of the registration options require to specify a document selector there is a base interface that can be used. See TextDocumentRegistrationOptions.

An example JSON-RPC message to register dynamically for the textDocument/willSaveWaitUntil feature on the client side is as follows (only details shown):

{
	"method": "client/registerCapability",
	"params": {
		"registrations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil",
				"registerOptions": {
					"documentSelector": [
						{ "language": "javascript" }
					]
				}
			}
		]
	}
}

This message is sent from the server to the client and after the client has successfully executed the request, further textDocument/willSaveWaitUntil requests for JavaScript text documents are sent from the client to the server.

Response:

• result: void.
• error: code and message set in case an exception happens during the request.

StaticRegistrationOptions can be used to register a feature in the initialize result with a given server control ID to be able to un-register the feature later on.

/**
 * Static registration options to be returned in the initialize request.
 */
export interface StaticRegistrationOptions {
	/**
	 * The id used to register the request. The id can be used to deregister
	 * the request again. See also Registration#id.
	 */
	id?: string;
}

TextDocumentRegistrationOptions can be used to dynamically register for requests for a set of text documents.

/**
 * General text document registration options.
 */
export interface TextDocumentRegistrationOptions {
	/**
	 * A document selector to identify the scope of the registration. If set to
	 * null, the document selector provided on the client side will be used.
	 */
	documentSelector: DocumentSelector | null;
}

File: _includes/messages/3.18/setTrace.md Copy Chapter

[SetTrace Notification (:arrow_right:)](#setTrace)

A notification that should be used by the client to modify the trace setting of the server.

Notification:

• method: '$/setTrace'
• params: SetTraceParams defined as follows:

interface SetTraceParams {
	/**
	 * The new value that should be assigned to the trace setting.
	 */
	value: TraceValue;
}

File: _includes/messages/3.18/showMessage.md Copy Chapter

[ShowMessage Notification (:arrow_left:)](#window_showMessage)

The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

Notification:

• method: 'window/showMessage'
• params: ShowMessageParams defined as follows:

interface ShowMessageParams {
	/**
	 * The message type. See {@link MessageType}.
	 */
	type: MessageType;

	/**
	 * The actual message.
	 */
	message: string;
}

Where the type is defined as follows:

export namespace MessageType {
	/**
	 * An error message.
	 */
	export const Error = 1;
	/**
	 * A warning message.
	 */
	export const Warning = 2;
	/**
	 * An information message.
	 */
	export const Info = 3;
	/**
	 * A log message.
	 */
	export const Log = 4;
	/**
	 * A debug message.
	 *
	 * @since 3.18.0
	 */
	export const Debug = 5;
}

export type MessageType = 1 | 2 | 3 | 4 | 5;

File: _includes/messages/3.18/showMessageRequest.md Copy Chapter

[ShowMessage Request (:arrow_right_hook:)](#window_showMessageRequest)

The show message request is sent from a server to a client to ask the client to display a particular message in the user interface. In addition to the show message notification, the request allows to pass actions and to wait for an answer from the client.

Client Capability:

• property path (optional): window.showMessage
• property type: ShowMessageRequestClientCapabilities defined as follows:

/**
 * Show message request client capabilities
 */
export interface ShowMessageRequestClientCapabilities {
	/**
	 * Capabilities specific to the `MessageActionItem` type.
	 */
	messageActionItem?: ClientShowMessageActionItemOptions;
}

export type ClientShowMessageActionItemOptions = {
	/**
	 * Whether the client supports additional attributes which
	 * are preserved and send back to the server in the
	 * request's response.
	 */
	additionalPropertiesSupport?: boolean;
};

Request:

• method: 'window/showMessageRequest'
• params: ShowMessageRequestParams defined as follows:

interface ShowMessageRequestParams {
	/**
	 * The message type. See {@link MessageType}.
	 */
	type: MessageType;

	/**
	 * The actual message.
	 */
	message: string;

	/**
	 * The message action items to present.
	 */
	actions?: MessageActionItem[];
}

Where the MessageActionItem is defined as follows:

interface MessageActionItem {
	/**
	 * A short title like 'Retry', 'Open Log' etc.
	 */
	title: string;

	/**
	 * Additional attributes that the client preserves and
	 * sends back to the server. This depends on the client
	 * capability window.messageActionItem.additionalPropertiesSupport.
	 */
	[key: string]: string | boolean | integer | object;
}

Response:

• result: the selected MessageActionItem | null if none got selected.
• error: code and message set in case an exception happens during showing a message.

File: _includes/messages/3.18/shutdown.md Copy Chapter

[Shutdown Request (:leftwards_arrow_with_hook:)](#shutdown)

The shutdown request is sent from the client to the server. It asks the server to shut down, but to not exit (otherwise the response might not be delivered correctly to the client). There is a separate exit notification that asks the server to exit. Clients must not send any requests or notifications other than exit to a server to which they have sent a shutdown request. Clients should also wait with sending the exit notification until they have received a response from the shutdown request.

If a server receives requests after a shutdown request those requests should error with InvalidRequest.

Request:

• method: 'shutdown'
• params: none

Response:

• result: null
• error: code and message set in case an exception happens during shutdown request.

File: _includes/messages/3.18/telemetryEvent.md Copy Chapter

[Telemetry Notification (:arrow_left:)](#telemetry_event)

The telemetry notification is sent from the server to the client to ask the client to log a telemetry event. The protocol doesn't specify the payload since no interpretation of the data happens in the protocol. Most clients don't even handle the event directly but forward them to the extensions owing the corresponding server issuing the event.

Notification:

• method: 'telemetry/event'
• params: 'object' | 'array';

File: _includes/messages/3.18/unregisterCapability.md Copy Chapter

[Unregister Capability (:arrow_right_hook:)](#client_unregisterCapability)

The client/unregisterCapability request is sent from the server to the client to unregister a previously registered capability.

Request:

• method: 'client/unregisterCapability'
• params: UnregistrationParams

Where UnregistrationParams are defined as follows:

/**
 * General parameters to unregister a capability.
 */
export interface Unregistration {
	/**
	 * The id used to unregister the request or notification. Usually an id
	 * provided during the register request.
	 */
	id: string;

	/**
	 * The method / capability to unregister for.
	 */
	method: string;
}

export interface UnregistrationParams {
	// This should correctly be named `unregistrations`. However, changing this
	// is a breaking change and needs to wait until we deliver a 4.x version
	// of the specification.
	unregisterations: Unregistration[];
}

An example JSON-RPC message to unregister the above registered textDocument/willSaveWaitUntil feature looks like this:

{
	"method": "client/unregisterCapability",
	"params": {
		"unregisterations": [
			{
				"id": "79eee87c-c409-4664-8102-e03263673f6f",
				"method": "textDocument/willSaveWaitUntil"
			}
		]
	}
}

Response:

• result: void.
• error: code and message set in case an exception happens during the request.

File: _includes/types/enumerations.md Copy Chapter

[Enumerations](#enumerations)

The protocol supports two kind of enumerations: (a) integer based enumerations and (b) string based enumerations. Integer based enumerations usually start with 1. The ones that don't are historical and they were kept to stay backwards compatible. If appropriate, the value set of an enumeration is announced by the defining side (e.g. client or server) and transmitted to the other side during the initialize handshake. An example is the CompletionItemKind enumeration. It is announced by the client using the textDocument.completion.completionItemKind client property.

To support the evolution of enumerations the using side of an enumeration shouldn't fail on an enumeration value it doesn't know. It should simply ignore it as a value it can use and try to do its best to preserve the value on round trips. Lets look at the CompletionItemKind enumeration as an example again: if in a future version of the specification an additional completion item kind with the value n gets added and announced by a client an (older) server not knowing about the value should not fail but simply ignore the value as a usable item kind.

File: _includes/types/traceValue.md Copy Chapter

[TraceValue](#traceValue)

A TraceValue represents the level of verbosity with which the server systematically reports its execution trace using $/logTrace notifications.
The initial trace value is set by the client at initialization and can be modified later using the $/setTrace notification.

export type TraceValue = 'off' | 'messages' | 'verbose';

File: _includes/types/uri.md Copy Chapter

[URI](#uri)

URI's are transferred as strings. The URI's format is defined in https://tools.ietf.org/html/rfc3986

foo://example.com:8042/over/there?name=ferret#nose
  \_/   \______________/\_________/ \_________/ \__/
   |           |            |            |        |
scheme     authority       path        query   fragment
   |   _____________________|__
  / \ /                        \
  urn:example:animal:ferret:nose

We also maintain a node module to parse a string into scheme, authority, path, query, and fragment URI components. The GitHub repository is https://github.com/Microsoft/vscode-uri, and the npm module is https://www.npmjs.com/package/vscode-uri.

Many of the interfaces contain fields that correspond to the URI of a document. For clarity, the type of such a field is declared as a DocumentUri. Over the wire, it will still be transferred as a string, but this guarantees that the contents of that string can be parsed as a valid URI.

Care should be taken to handle encoding in URIs. For example, some clients (such as VS Code) may encode colons in drive letters while others do not. The URIs below are both valid, but clients and servers should be consistent with the form they use themselves to ensure the other party doesn't interpret them as distinct URIs. Clients and servers should not assume that each other are encoding the same way (for example a client encoding colons in drive letters cannot assume server responses will have encoded colons). The same applies to casing of drive letters - one party should not assume the other party will return paths with drive letters cased the same as itself.

file:///c:/project/readme.md
file:///C%3A/project/readme.md

type DocumentUri = string;

There is also a tagging interface for normal non document URIs. It maps to a string as well.

type URI = string;

File: _overviews/lsif/overview.md Copy Chapter

title: Overview topic: LSIF layout: overview sectionid: lsifOverview Copy Chapter

What is the Language Server Index Format? Copy Chapter

As a developer, you spend a lot of your time reading and reviewing code and not necessarily authoring new source code. For example, you may want to browse an existing codebase in a repository like GitHub or you may want to review a colleague's Pull Request.

Typically you would check out a branch or clone a repository pulling down the source code onto your local machine, open your preferred development tool, and then finally you can read and navigate the code. Wouldn't it be cool if you could do this without first cloning the repo? Imagine getting intelligent code features like hover information, Go to Definition, and Find All References without having to download source code. The blog post, First look at a rich code navigation experience, illustrates this scenario for a Pull Request review.

The goal of the Language Server Index Format (LSIF, pronounced like "else if") is to support rich code navigation in development tools or a Web UI without needing a local copy of the source code. The format is similar in spirit to the Language Server Protocol (LSP), which simplifies the integration of rich code editing capabilities into a development tool.

Why not simply use an existing LSP language server? The LSP provides rich code authoring features like auto complete, format on type, and rich code navigation. To provide these features efficiently, a language server requires all source code files be available on a local disk. LSP language servers may also read parts or all of the files into memory and compute abstract syntax trees to power these features. The goal of the Language Server Index Format is to augment the LSP protocol to support rich code navigation features without these requirements. The LSIF defines a standard format for language servers or other programming tools to emit their knowledge about a code workspace. This persisted information can later be used to answer LSP requests for the same workspace without running a language server.

How it works Copy Chapter

LSIF builds on LSP and it uses the same data types as defined in LSP. At a high level, LSIF models the data returned from language server requests. Same as LSP, LSIF doesn't contain any program symbol information nor does the LSIF define any symbol semantics (for example, what makes the definition of a symbol or whether a method overrides another method). The LSIF therefore doesn't define a symbol database, which is consistent with the LSP approach.

Using the existing LSP data types as the base for LSIF has another advantage as LSIF can easily be integrated into tools or servers which already understand LSP.

Let's have a look at an example. We start with a simple Typescript file named sample.ts with the content below:

function bar(): void {
}

Hovering over bar() shows the following hover information in Visual Studio Code:

This hover information is expressed in LSP using the Hover type:

export interface Hover {
    /**
     * The hover's content
     */
    contents: MarkupContent | MarkedString | MarkedString[];
    /**
     * An optional range
     */
    range?: Range;
}

In the above example, the concrete value is:

{
  contents: [
    { language: "typescript", value: "function bar(): void" }
  ]
}

A client tool would retrieve the hover content from a language server by sending a textDocument/hover request for document file:///Users/username/sample.ts at position {line: 0, character: 10}.

LSIF defines a format that language servers or standalone tools emit to describe that the tuple ['textDocument/hover', 'file:///Users/username/sample.ts', {line: 0, character: 10}] resolves to the above hover. The data can then be taken and persisted into a database.

LSP requests are position based, however results often only vary for ranges and not for single positions. In the above hover example, the hover value is the same for all positions of the identifier bar. This means the same hover value is returned when a user hovers over b in bar or over r in bar. To make the emitted data more compact, the LSIF uses ranges instead of positions. For this example, an LSIF tool emits the tuple ['textDocument/hover', 'file:///Users/username/sample.ts', { start: { line: 0, character: 9 }, end: { line: 0, character: 12 }] which includes range information.

LSIF uses graphs to emit this information. In the graph, an LSP request is represented using an edge. Documents, ranges, or request results (for example, the hover) are represented using vertices. This format has the following benefits:

• For a given code range, there can be different results. For a given identifier range, a user is interested in the hover value, the location of the definition, or to Find All References. LSIF therefore links these results with the range.
• Extending the format with additional request types or results can easily be done by adding new edge or vertex kinds.
• It is possible to emit data as soon as it is available. This enables streaming rather than having to store large amounts of data in memory. For example, emitting data for a document should be done for each file as the parsing progresses.

For the hover example, the emitted LSIF graph data looks as follows:

// a vertex representing the document
{ id: 1, type: "vertex", label: "document", uri: "file:///Users/username/sample.ts", languageId: "typescript" }
// a vertex representing the range for the identifier bar
{ id: 4, type: "vertex", label: "range", start: { line: 0, character: 9}, end: { line: 0, character: 12 } }
// an edge saying that the document with id 1 contains the range with id 4
{ id: 5, type: "edge", label: "contains", outV: 1, inV: 4}
// a vertex representing the actual hover result
{ id: 6, type: "vertex", label: "hoverResult",
  result: {
    contents: [
      { language: "typescript", value: "function bar(): void" }
    ]
  }
}
// an edge linking the hover result to the range.
{ id: 7, type: "edge", label: "textDocument/hover", outV: 4, inV: 6 }

The corresponding graph looks like this:

The LSP also supports requests that only take a document as a parameter (they are not position based). Example requests that are useful for code comprehension are for a list of all document symbols or to compute all folding ranges. These requests are modeled in LSIF in the form [request, document] -> result.

Let's look at another example:

function bar(): void {
  console.log('Hello World!');
}

The folding range result for the document containing above function bar is emitted like this:

// a vertex representing the document
{ id: 1, type: "vertex", label: "document", uri: "file:///Users/username/sample.ts", languageId: "typescript" }
// a vertex representing the folding result
{ id: 2, type: "vertex", label: "foldingRangeResult", result: [ { startLine: 0, startCharacter: 20, endLine: 2, endCharacter: 1 } ] }
// an edge connecting the folding result to the document.
{ id: 3, type: "edge", label: "textDocument/foldingRange", outV: 1, inV: 2 }

These are only two examples of LSP requests supported by the LSIF. The current version of the LSIF specification also supports document symbols, document links, Go to Definition, Go to Declaration, Go to Type Definition, Find All References, and Go to Implementation.

We need your feedback! Copy Chapter

We have made good initial progress on the LSIF specification and we want to open the conversation to the community so you can learn what we're working on. For feedback, please comment on the issue Language Server Index Format.

How to get started Copy Chapter

To get started with LSIF, you can have a look at the following resources:

• The LSIF specification - The document also describes some additional optimizations that have been done to keep the emitted data compact.
• LSIF Index for TypeScript - A tool that generates LSIF for TypeScript. The README provides instructions for using the tool.
• Visual Studio Code extension for LSIF - An extension for VS Code that provides language comprehension features using an LSIF JSON dump. If you implement a new LSIF generator, you can use this extension to validate it with arbitrary source code.

File: _overviews/lsp/overview.md Copy Chapter

title: Overview
topic: LSP
layout: overview
sectionid: overview
redirect_from:

• /overview

What is the Language Server Protocol? Copy Chapter

Implementing support for features like autocomplete, goto definition, or documentation on hover for a programming language is a significant effort. Traditionally this work must be repeated for each development tool, as each provides different APIs for implementing the same features.

The idea behind a Language Server is to provide the language-specific smarts inside a server that can communicate with development tooling over a protocol that enables inter-process communication.

The idea behind the Language Server Protocol (LSP) is to standardize the protocol for how tools and servers communicate, so a single Language Server can be re-used in multiple development tools, and tools can support languages with minimal effort.

LSP is a win for both language providers and tooling vendors!

How it works Copy Chapter

A language server runs as a separate process and development tools communicate with the server using the language protocol over JSON-RPC. Below is an example for how a tool and a language server communicate during a routine editing session:

• The user opens a file (referred to as a document) in the tool: The tool notifies the language server that a document is open ('textDocument/didOpen'). From now on, the truth about the contents of the document is no longer on the file system but kept by the tool in memory. The contents now has to be synchronized between the tool and the language server.

• The user makes edits: The tool notifies the server about the document change ('textDocument/didChange') and the language representation of the document is updated by the language server. As this happens, the language server analyses this information and notifies the tool with the detected errors and warnings ('textDocument/publishDiagnostics').

• The user executes "Go to Definition" on a symbol of an open document: The tool sends a 'textDocument/definition' request with two parameters: (1) the document URI and (2) the text position from where the 'Go to Definition' request was initiated to the server. The server responds with the document URI and the position of the symbol's definition inside the document.

• The user closes the document (file): A 'textDocument/didClose' notification is sent from the tool informing the language server that the document is now no longer in memory. The current contents are now up to date on the file system.

This example illustrates how the protocol communicates with the language server at the level of document references (URIs) and document positions. These data types are programming language neutral and apply to all programming languages. The data types are not at the level of a programming language domain model which would usually provide abstract syntax trees and compiler symbols (for example, resolved types, namespaces, ...). The fact that the data types are simple and programming language neutral simplifies the protocol significantly. It is much simpler to standardize a text document URI or a cursor position compared with standardizing an abstract syntax tree and compiler symbols across different programming languages.

Now let's look at the 'textDocument/definition' request in more detail. Below are the payloads that go between the development tool and the language server for the "Go to Definition" request in a C++ document.

This is the request:

{
    "jsonrpc": "2.0",
    "id" : 1,
    "method": "textDocument/definition",
    "params": {
        "textDocument": {
            "uri": "file:///p%3A/mseng/VSCode/Playgrounds/cpp/use.cpp"
        },
        "position": {
            "line": 3,
            "character": 12
        }
    }
}

This is the response:

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "uri": "file:///p%3A/mseng/VSCode/Playgrounds/cpp/provide.cpp",
        "range": {
            "start": {
                "line": 0,
                "character": 4
            },
            "end": {
                "line": 0,
                "character": 11
            }
        }
    }
}

When a user is working with different languages, a development tool usually starts a language server for each programming language. The example below shows a session where the user works on Java and SASS files.

Capabilities Copy Chapter

Not every language server can support all features defined by the protocol. LSP therefore provides 'capabilities'. A capability groups a set of language features. A development tool and the language server announce their supported features using capabilities. As an example, a server announces that it can handle the 'textDocument/definition' request, but it might not handle the 'workspace/symbol' request. Similarly, a development tool announces its ability to provide 'about to save' notifications before a document is saved, so that a server can compute textual edits to format the edited document before it is saved.

Notice the actual integration of a language server into a particular tool is not defined by the language server protocol and is left to the tool implementors.

Libraries (SDKs) for LSP providers and consumers Copy Chapter

To simplify the implementation of language servers and clients, there are libraries or SDKs:

• Development tool SDKs each development tool typically provides a library for integrating language servers. For example, for JavaScript/TypeScript there is the language client npm module.

• Language Server SDKs for the different implementation languages there is an SDK to implement a language server in a particular language. For example, to implement a language server using Node.js there is the language server npm module.