microsoft / microsoft/language-server-protocol

Delimitate regions eligible for spell checking.

Open
#1,017 4 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request new request
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

A discussion started at neovim about the benefits that LSP could bring to spell checking, but I'm not sure whether this has been discussed here yet.

The LSP server is very aware of the file structure and programming language specificities, which makes it a very good candidate for delimiting regions eligible to spellchecking (comments, docstrings, strings maybe, variable names maybe, etc.).

Could this spellcheck-regions-delimiting activity be part of the protocol? What would it imply in terms of coordination with existing spellcheckers/editors?

The most basic support would be to not delimitate anything and return the whole file as one big region, leaving the burden of ignoring keywords, etc. to the spellchecker itself. Such a trivial implementation is dummy, but it would still be useful in 2 cases I think:

  • For a not-a-programming-language-LSP server, dedicated to parse plain, free .txt-like files written in natural language.
  • For transient, basic support in other LSP servers, as a temporary solution so they comply to the protocol even though they have not implemented precise region-delimiting logic yet.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading this issue and the linked Neovim discussion to understand the proposed spell-checking regions and coordination concerns. Define the protocol requirements and affected specification sections before implementation; done requires an agreed design rather than an isolated code change.

Written by the indexing model from the issue text.

Assessment

Domain
api, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.