Skip to content

Latest commit

 

History

History
123 lines (85 loc) · 4.22 KB

README.md

File metadata and controls

123 lines (85 loc) · 4.22 KB
Raw

License: GPL v3 MELPA MELPA Stable

flycheck-languagetool

Flycheck support for LanguageTool.

CI

💾 Installation

The instruction to use this plugin.

  1. Download LanguageTool from https://languagetool.org/download/.
  2. Extract on to your local machine.
  3. Consider adding the following snippet to your configuration.
(use-package flycheck-languagetool
  :ensure t
  :hook (text-mode . flycheck-languagetool-setup)
  :init
  (setq flycheck-languagetool-server-jar "path/to/LanguageTool-X.X/languagetool-server.jar"))
  1. 🎉 Done! Now open a text file and hit M-x flycheck-mode!

🔧 Configuration

  • flycheck-languagetool-url
  • flycheck-languagetool-server-jar
  • flycheck-languagetool-server-port (Default: 8081)
  • flycheck-languagetool-server-args
  • flycheck-languagetool-server-command
  • flycheck-languagetool-active-modes (Default: text-mode, latex-mode, org-mode, markdown-mode, message-mode)
  • flycheck-languagetool-language (Default: "en-US")
  • flycheck-languagetool-check-params

You’ll need to set at least one of flycheck-languagetool-server-jar or flycheck-languagetool-url. The rest are optional.

📖 Spellchecking

LanguageTool’s spellchecking will be disabled if flyspell-mode or jinx-mode is active. Disable those modes if you would prefer LanguageTool to check for spelling mistakes.

❓ Troubleshooting

You can find log messages from a local LanguageTool server in a hidden buffer called *LanguageTool server*.

🛠️ 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.