Move trace value to the base protocol (#1744)

* typo

* Move trace value to the base protocol

---------

Co-authored-by: Dirk Bäumer <dirkb@microsoft.com>
This commit is contained in:
Maria José Solano 2023-06-08 05:28:39 -07:00 committed by GitHub
parent 7fda8d30e7
commit 1ec56d2198
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 6 additions and 11 deletions

View file

@ -37,6 +37,8 @@
anchor: cancelRequest
- title: Progress Support
anchor: progress
- title: Trace Value
anchor: traceValue
- title: Lifecycle Messages
anchor: lifecycle
children:

View file

@ -15,7 +15,7 @@ The purpose of the base protocol is to create an abstraction of common editor ex
A motivating example is the [Build Server Protocol](https://build-server-protocol.github.io/). As its specification describes, all notifications and requests are defined using [the base definitions](#basicJsonStructures) of LSP, and messages such `InitializeBuild`, `OnBuildInitialized`, and `OnBuildExit` all match almost exactly with their LSP counterparts. By implementing the base protocol, a server can support multiple protocol specifications without having to reimplement the "common boilerplate" that all of them share.
Do remarks that the base protocol is currently under experimental construction and subject to breaking changes. Its future development will depend on feedback from the community and initial implementors of the protocol.
Do remark that the base protocol is currently under experimental construction and subject to breaking changes. Its future development will depend on feedback from the community and initial implementors of the protocol.
### <a href="#headerPart" name="headerPart" class="anchor"> Header Part </a>
@ -662,6 +662,7 @@ To keep the protocol backwards compatible servers are only allowed to use `windo
};
```
{% include types/traceValue.md %}
## <a href="#lifecycle" name="lifecycle" class="anchor"> Lifecycle Messages </a>

View file

@ -468,7 +468,7 @@ There are quite some JSON structures that are shared between different requests
{% include_relative types/workDoneProgress.md %}
{% include_relative types/partialResults.md %}
{% include_relative types/partialResultParams.md %}
{% include_relative types/traceValue.md %}
{% include types/traceValue.md %}
### <a href="#lifeCycleMessages" name="lifeCycleMessages" class="anchor"> Server lifecycle </a>

View file

@ -465,7 +465,7 @@ There are quite some JSON structures that are shared between different requests
{% include_relative types/workDoneProgress.md %}
{% include_relative types/partialResults.md %}
{% include_relative types/partialResultParams.md %}
{% include_relative types/traceValue.md %}
{% include types/traceValue.md %}
### <a href="#lifeCycleMessages" name="lifeCycleMessages" class="anchor"> Server lifecycle </a>

View file

@ -1,8 +0,0 @@
#### <a href="#traceValue" name="traceValue" class="anchor"> TraceValue </a>
A `TraceValue` represents the level of verbosity with which the server systematically reports its execution trace using [$/logTrace](#logTrace) notifications.
The initial trace value is set by the client at initialization and can be modified later using the [$/setTrace](#setTrace) notification.
```typescript
export type TraceValue = 'off' | 'messages' | 'verbose';
```