Default configuration difference with Zed extension

[kascote]

Hi, I'm trying your extension with Neovim and it works okay, but out of the box doesn't work as I expected.

The documentation says to specify a --dictionary argument, that seems to be the dictionary where new words are added. If I don't add this argument, it seems the words are added to an in-memory dictionary because when I close and reload Neovim, the words are unrecognized again.

I have a cspell.json file in my root project folder that Zed is able to find and the new words are added there like

{
   "words": [
     "...",
   ]
}

I don't see that the Zed plugin is adding any configuration to the LSP, and out of the box it more or less works as I expect. Meaning, use the cspell dictionary defined, and have the ability to have a per-project dictionary.

Is there a way in Neovim and I think by extension Helix, to set it up like Zed does ? I was unable to find a way.

TIA
:: nelson

this is my cspell.json configuration

{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "version": "0.2",
  "import": [
    "@cspell/dict-en_us/cspell-ext.json",
    "@cspell/dict-filetypes/cspell-ext.json",
    "@cspell/dict-git/cspell-ext.json",
    "@cspell/dict-lua/cspell-ext.json",
    "@cspell/dict-markdown/cspell-ext.json",
    "@cspell/dict-shell/cspell-ext.json",
    "@cspell/dict-software-terms/cspell-ext.json",
    "@cspell/dict-vim/cspell-ext.json"
  ],
  "useGitignore": true,
  "allowCompoundWords": true,
  "languageSettings": [
    {
      "languageId": "lua",
      "caseSensitive": false
    },
    {
      "languageId": "markdown",
      "caseSensitive": true
    }
  ],
  "dictionaryDefinitions": [
    {
      "name": "project-dict",
      "path": "./project-dict.txt",
      "addWords": true
    }
  ],
  "dictionaries": [
    "project-dict",
    "filetypes",
    "git",
    "lua",
    "markdown",
    "shell",
    "software-terms",
    "vim"
  ],
  "ignorePaths": [
    ".git",
    ".vscode",
    "queries",
    "spell"
  ],
}

[vlabo]

That is a good point. I will look into the cspell.json config.

By the way you can try out the fork from mantou132. Its the person maintaining the Zed plugin. And it seems like that version support the cspell.json in the lsp already.
https://github.com/mantou132/cspell-lsp

[vlabo]

I added basic support for cspell.json. it read and writes only the "words" array.
I will look into the other options in and see what else is worth adding.

[vlabo]

I just did a v1.1.0 pre release. Which supports the cspell.json format. I will test it for some time and then publish it to npm.

Let me know if you find any issues if you decide to join with testing.

PS:
I decided to completely remove the old format as it makes no sense supporting them both.

[kascote]

Hi, sorry I was head down on other things.
I just installed it (version 1.1.0), and so far seems too work ok !!
But the lsp config still need the full path to the cspell.json. This will be a requirement ? could not be derived from the root directory from the lsp (usually .git or some other marker) ?

This is the LspInfo response I see:

vim.lsp: Active Clients ~
- cspell (id: 1)
  - Version: ? (no serverInfo.version response)
  - Root directory: ~/.config/nvim
  - Command: { "cspell-lsp", "--stdio", "--config", "/Users/nelson/.config/nvim/cspell.json" }
  - Settings: {}
  - Attached buffers: 7, 15

If can use the root directory from the lsp, I think that will allow to have a different cspell.json by project.

[vlabo]

If you dont specify the path it should try to load it from the root of the project. I haven't done extensive testing with different editors. Just helix.

Thanks for the feedback, I will improve the documentation.