Add documentation to semantic token config #85
Conversation
Agree, that would be nice! And, especially for kinds/modifiers which are not part of the standard ones listed in LSP, a short description would also be very useful. |
|
@daiyousei-qz A friendly reminder about this PR. LLVM 17 (the version in which the new configs will ship) has branched and will be released in about 5-6 weeks. |
|
Sorry for the long absence. I've updated features.md and added a section of semantic highlighting, including a few tables discussing available kinds/modifiers. The available version was read from the git submit date of the enum and I picked a release that's at least a month away. I don't check with different versions of clangd. As the pick is conservative, some items may be available one version earlier. The deployment of the website in README isn't very friendly to Windows user. Could you please help me ensure that table is well formatted in the website? Thanks! |
features.md
Outdated
|
|
||
| | Kind | LSP Name | Note | ||
| |------------------------|---------------|-------------------------- | ||
| | Variable{.v9} | variable | |
There was a problem hiding this comment.
I don't think we need separate columns for clangd's internal kind and the LSP kind. The internal kind is not exposed to the client in any way.
Let's just combine them into one column, we can call it LSP Kind. (And e.g. variable only needs one row.)
There was a problem hiding this comment.
clangd's internal kinds are needed for https://reviews.llvm.org/D148489, where we use that as configuration items.
There was a problem hiding this comment.
Ah, good point! When reviewing https://reviews.llvm.org/D148489, I didn't fully realize the implication that we were exposing the internal kinds via this config mechanism. In retrospect, it would probably have been better to have the config keys be the LSP names, but it's too late for that now. (We can still consider a future change to make the internal kinds be 1:1 with the LSP kinds.)
features.md
Outdated
|
|
||
| | Modifier | LSP Name | Note | ||
| |----------------------|----------------|----------- | ||
| | Declaration{.v12} | declaration | |
There was a problem hiding this comment.
Likewise here, we don't need a separate column for the internal modifier.
|
|
||
| clangd supports following standard LSP token kinds: | ||
|
|
||
| | Kind | LSP Name | Since Version | Note |
There was a problem hiding this comment.
Maybe we should add an explanation here, like:
Kindis the name recognized in the config file,LSP Nameis the name sent to the client.
(And a similar line for modifiers)
There was a problem hiding this comment.
I added the explanation to the config page.
|
@HighCommander4 Do you want me to also squash the commits into one? |
daiyousei-qz
force-pushed
the
doc_semantic_token_config
branch
from
07fcfd4
to
525b3b8
Compare
This is documentation for configuration added by https://reviews.llvm.org/D148489.
From a maintainability point of view, I think the complete list of kinds/modifiers should be added to "features.md". What do you think? @HighCommander4