https://github.com/emacs-languagetool/flycheck-languagetool
Flycheck support for LanguageTool
https://github.com/emacs-languagetool/flycheck-languagetool
checker emacs flycheck languagetool
Last synced: 6 months ago
JSON representation
Flycheck support for LanguageTool
- Host: GitHub
- URL: https://github.com/emacs-languagetool/flycheck-languagetool
- Owner: emacs-languagetool
- License: gpl-3.0
- Created: 2021-04-02T17:05:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T00:21:59.000Z (7 months ago)
- Last Synced: 2025-04-07T01:24:50.976Z (7 months ago)
- Topics: checker, emacs, flycheck, languagetool
- Language: Emacs Lisp
- Homepage:
- Size: 142 KB
- Stars: 55
- Watchers: 4
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://melpa.org/#/flycheck-languagetool)
[](https://stable.melpa.org/#/flycheck-languagetool)
# flycheck-languagetool
> Flycheck support for LanguageTool.
[](https://github.com/emacs-languagetool/flycheck-languagetool/actions/workflows/test.yml)
## 💾 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.
```el
(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"))
```
4. :tada: 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`](https://www.gnu.org/software/emacs/manual/html_node/emacs/Spelling.html)
or [`jinx-mode`](https://github.com/minad/jinx) 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
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
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:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
eask install-deps --dev
```
To test the package's installation:
```sh
eask package
eask install
```
To test compilation:
```sh
eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
eask lint checkdoc
```
The standard `package` linter:
```sh
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 .
See [`LICENSE`](./LICENSE.txt) for details.