Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.08 KB

README.md

File metadata and controls

76 lines (56 loc) · 2.08 KB

LTEX LS Client for NeoVim

Small plugin that adds handlers for code actions fired by LTEX Language Server:

  • Add to dictionary
  • Disable rule
  • Hide false positive

Installation

First, you have to make sure LTEX Language Server is installed and configured. Please follow the instructions on the ltex-ls page. Please refer to my configuration for the example. Then, this plugin could be installed like this:

Using packer:

use("icewind/ltex-client.nvim")

Or lazy:

return {
    "icewind/ltex-client.nvim",
    event = { "BufReadPre", "BufNewFile" },
    opts = {},
}

Please pay attention, in order to call the setup, lazy.nvim requires opts key to be any truthy value.

Configuration

Name Default Value
user_dictionaries_path ${HOME}/.ltex/dictionaries

The plugin will create three files there: dictionary.json, disabled_rules.json, false_positives.json.

In case you're using lazy.nvim, and default configuration works for you, there is no need to take any additional steps. Otherwise, the plugin could be configured by calling setup function manually like this:

return {
    "icewind/ltex-client.nvim",
    event = { "BufReadPre", "BufNewFile" },
    opts = {
        user_dictionaries_path = vim.env.HOME .. 'some/other/path'
    }
}

Commands

Command Description
:LTeXSetLanguage Sets the language for the current document
:LTexStatus Shows a floating window with a status from LTeX-ls

Hints

In order to make sure ltex-client is installed along with LTeX-ls, for lazy.nvim and Mason, you can define it like this:

return {
    { 
        "williamboman/mason.nvim",
        opts = function(_, opts)
            vim.list_extend(opts.ensure_installed, { "ltex-ls" })
        end,
    },
    {
        "icewind/ltex-client.nvim",
        opts = {},
    },
}