Skip to content

emacs-languagetool/lsp-ltex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License: GPL v3 MELPA MELPA Stable

lsp-ltex

LSP Clients for LTEX

CI Activate

lsp-mode client leveraging LTEX Language Server.

💾 Quickstart

(use-package lsp-ltex
  :ensure t
  :hook (text-mode . (lambda ()
                       (require 'lsp-ltex)
                       (lsp)))  ; or lsp-deferred
  :init
  (setq lsp-ltex-version "15.2.0"))  ; make sure you have set this, see below

For lsp-ltex to run you need to have ltex-ls installed and available. Go to https://valentjn.github.io/ltex/ltex-ls/installation.html, download the appropriate version, uncompress, and place it under ~/.emacs.d/.cache/lsp/ltex-ls . As explained there, if you download the archive that corresponds to your platform, no Java installation is needed. If you use the platform-independent file, you will need Java in your computer and you will need to set the JAVA_HOME environment variable.

In the configuration for lsp-ltex you will probably want to set the version you want to use; for example (setq lsp-ltex-version "15.2.0") in the init section of use-package.

📇 Commands

Commands Description
lsp-ltex-upgrade-ls Upgrade LTEX server, if not found install it instead.

🔧 Configuration

lsp-ltex supports following configuration. Each configuration is described in detail in LTEX Settings.

🛠️ Contribute

PRs Welcome Elisp styleguide Donate on paypal Become a patron

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.