1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
---
layout: default
title: Semantic Highlighting for Themes
parent: Ruby LSP
nav_order: 30
---
# Semantic Highlighting for Themes
Ruby LSP supports semantic highlighting, which informs editors about the right token types for each part of the code to
the code to allow for rich and accurate highlighting. If you're a theme developer or want to enhance the Ruby syntax
highlighting in your editor, this guide provides a brief overview of the semantic tokens available and how to use them.
The strategy taken by Ruby LSP is to only return tokens for syntax that is ambiguous in Ruby (as opposed to all existing
tokens) to optimize for performance.
An example of ambiguous syntax in Ruby are local variables and method calls. If you look at this line in isolation:
```ruby
foo
```
it is not possible to tell if `foo` is a local variable or a method call. It depends on whether `foo` was assigned to
something before or not. This is one scenario where semantic highlighting removes the ambiguity for themes, returning
the correct token type by statically analyzing the code.
To enhance a theme's Ruby syntax highlighting using the Ruby LSP, check the information below. You may also want to
check out the [Spinel theme](https://github.com/Shopify/vscode-shopify-ruby/blob/main/themes/dark_spinel.json) as an
example, which uses all of the Ruby LSP's semantic highlighting information.
## Token types
According to the LSP specification, language servers can either use token types and modifiers from the [default
list](https://microsoft.github.io/language-server-protocol/specification#semanticTokenTypes) or contribute new semantic
tokens of their own. Currently, the Ruby LSP does not contribute any new semantic tokens and only uses the ones
contained in the default list.
## Token list
| Syntax | Type.Modifier | Note |
| ------------- | ------------- | ------------- |
| Sorbet annotation methods such as `let` or `cast` | type | Not every annotation is handled |
| Method calls with any syntax | method | |
| Constant references (including classes and modules) | namespace | We don't yet differentiate between module and class references |
| Method definition | method.declaration | |
| self | variable.default_library | |
| Method, block and lambda arguments | parameter | |
| Class declaration | class.declaration | |
| Module declaration | class.declaration | |
|
