SemanticTokensClientCapabilityOptions

SemanticTokensClientCapabilityOptions = object

Properties

augmentsSyntaxTokens?

readonly optional augmentsSyntaxTokens?: boolean

Whether the client uses semantic tokens alongside the colour it already has rather than instead of it. Deliberately the host’s answer and per server, because whether this editor already has syntactic colour for a file depends on which grammar the host registered for that language id — which the host knows and this package does not.

---

formats?

readonly optional formats?: readonly SemanticTokenFormat[]

Defaults to ['relative'], which is the only format the protocol defines.

---

multilineTokenSupport?

readonly optional multilineTokenSupport?: boolean

Whether the client accepts a token whose span crosses a newline.

Declarable since the paint layer was proved to render one across two mounted rows. It stays opt-in rather than default-on because it is a statement about the host’s pipeline as much as the editor’s: a host that re-derives spans from {line, character} pairs of its own may not be able to honour it even though the layer can.

---

requests

readonly requests: SemanticTokensRequestOptions

---

tokenModifiers?

readonly optional tokenModifiers?: readonly string[]

Defaults to SEMANTIC_TOKEN_MODIFIERS.

---

tokenTypes?

readonly optional tokenTypes?: readonly string[]

Defaults to SEMANTIC_TOKEN_TYPES.