microsoft / microsoft/language-server-protocol
Proposal: Standardise `CompletionItemKind: Color` documentation format to always include the hex color at the end
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13k
- Forks
- 1k
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 10
Description
Language servers such as vscode-css, tailwindcss, dart-ls which send CompletionItemKind: Color completions, tend to include the hex color at the end of documentation.
This is useful to be able to make colored completion boxes next to each item, as what happens in the Helix editor:
But, it is hard to rely on each language server to properly send the response to contain the hex color at the end of the documentation
This is why it would be useful to make it a part of the LSP spec.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the LSP specification and the existing CompletionItemKind: Color documentation. Define the required documentation format and update the relevant specification text; done means the spec clearly states where the hex color appears and clients can rely on it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100