lsp-ltex

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

🔧 Configuration

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

• ltex.enabled via lsp-ltex-enabled
• ltex.language via lsp-ltex-language
• ltex.dictionary via lsp-ltex-dictionary
• ltex.disabledRules via lsp-ltex-disabled-rules
• ltex.enabledRules via lsp-ltex-enabled-rules
• ltex.hiddenFalsePositives via lsp-ltex-hidden-false-positives
• ltex.bibtex.fields via lsp-ltex-bibtex-fields
• ltex.latex.commands via lsp-ltex-latex-commands
• ltex.latex.environments via lsp-ltex-latex-environments
• ltex.markdown.nodes via lsp-ltex-markdown-nodes
• ltex.additionalRules.enablePickyRules via lsp-ltex-additional-rules-enable-picky-rules
• ltex.additionalRules.motherTongue via lsp-ltex-mother-tongue
• ltex.additionalRules.languageModel via lsp-ltex-additional-rules-language-model
• ltex.additionalRules.neuralNetworkModel via lsp-ltex-additional-rules-neural-network-model
• ltex.additionalRules.word2VecModel via lsp-ltex-additional-rules-word-2-vec-model
• ltex.languageToolHttpServerUri via lsp-ltex-languagetool-http-server-uri
• ltex.languageToolOrg.username via lsp-ltex-languagetool-org-username
• ltex.languageToolOrg.apiKey via lsp-ltex-languagetool-org-api-key
• ltex.ltex-ls.path via lsp-ltex-ls-path
• ltex.ltex-ls.logLevel via lsp-ltex-log-level
• ltex.java.path via lsp-ltex-java-path
• ltex.java.initialHeapSize via lsp-ltex-java-initial-heap-size
• ltex.java.maximumHeapSize via lsp-ltex-java-maximum-heap-size
• ltex.sentenceCacheSize via lsp-ltex-sentence-cache-size
• ltex.completionEnabled via lsp-ltex-completion-enabled (currently, not implemented)
• ltex.diagnosticSeverity via lsp-ltex-diagnostic-severity
• ltex.checkFrequency via lsp-ltex-check-frequency
• ltex.clearDiagnosticsWhenClosingFile via lsp-ltex-clear-diagnostics-when-closing-file
• ltex.statusBarItem via lsp-ltex-status-bar-item (currently, not implemented)
• ltex.trace.server via lsp-ltex-trace-server

Contribute

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!