Skip to content

implement incremental checking based on built-in sentence navigation #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<img align="right" src="./etc/logo.png" with="138" height="46">

# flymake-languagetool

> Flymake support for LanguageTool.

[![CI](https://github.com/emacs-languagetool/flymake-languagetool/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-languagetool/flymake-languagetool/actions/workflows/test.yml)
Expand All @@ -21,6 +22,7 @@ The instruction to use this plugin.
2. Consider adding one of the following snippets to your configuration.

#### Local LanguageTool Server

```el
(use-package flymake-languagetool
:ensure t
Expand All @@ -35,6 +37,7 @@ The instruction to use this plugin.
```

#### Free LanguageTool Account

```el
(use-package flymake-languagetool
:ensure t
Expand All @@ -49,6 +52,7 @@ The instruction to use this plugin.
```

#### Premium LanguageTool Account

```el
(use-package flymake-languagetool
:ensure t
Expand Down Expand Up @@ -77,7 +81,16 @@ included in `flymake-languagetool-active-modes`.

## 🧪 Configuration

### Sentence Awareness

`flymake-languagetool` now uses emacs sentence navigation to send only portions
of the text that have been modified rather than the entire buffer. In order for
this to behave in an expected manner, you may have to modify
`sentence-end-double-space`. The default is set to `true` and may cause some
contextual issues if you only use a single space to separate sentences.

### Language

The language used for flymake can be customized by using
`flymake-languagetool-language` (Default `"en-US"`)

Expand Down
4 changes: 4 additions & 0 deletions example.org
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,7 @@ Moreover, hour new office will be bigger than before.
I didn’t no the answer, but he person told me the correct answer. We
want too go to the museum no, but Peter isn’t here yet. Sara past the
test yesterday. I lent him same money. Please turn of your phones.

# Local Variables:
# sentence-end-double-space: nil
# End:
Loading