Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support for commonly used words/acronyms along with the base dictionary #125

Open
OXY2DEV opened this issue Aug 31, 2024 · 0 comments

Comments

@OXY2DEV
Copy link

OXY2DEV commented Aug 31, 2024

The problem

Screenshot_2024-09-01-00-28-29-057_com termux-edit
1200+ diagnostics from Harper in a markdown file

Currently the plugin only supports words of the dictionary. This unfortunately leads to a lot of false positives when using this LSP on specific types of files.

For example,

In lua, when using luaCATS this causes issues when using these annotations.

---@param
---@nodiscard
---@vararg

As quite a few repositories use release-please to generate a CHANGELOG.md file. The files title is CHANGELOG.

Unfortunately, this gets picked up by this LSP as an incorrect spelling. I think the LSP should ignore it.

This also introduces a new issue as commit messages usually look something like this.

feat(renderer): Added support for custom renderer

This also gets picked up by the LSP. This can lead to a LOT of false positives. I have almost 1200+ in 1000 line file.

It would be nice if the LSP could understand words used in editors(in my case Neovim).

For example,

extmark
autocmd
augroup

But this can be ignored.


As the scope of this is WAY TOO big(as the LSP by default activates in quite a few filetypes) this can either be solved by,

  1. PRs(most likely from users) adding dictonaries for specific languages.

  2. Adding pattern(s) that the LSP would ignore.

But you should decide what will be the best solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant