← [[doom-module-index:][Back to module index]]               ! [[doom-module-issues:::checkers grammar][Issues]]  ↖ [[doom-repo:tree/develop/modules/checkers/grammar/][Github]]  ± [[doom-suggest-edit:][Suggest edits]]  ? [[doom-help-modules:][Help]]
--------------------------------------------------------------------------------
#+title:    :checkers grammar
#+subtitle: Tasing grammar mistake every you make
#+created:  January 09, 2020
#+since:    21.12.0

* Description :unfold:
This module adds grammar checking to Emacs to aid your writing by combining
[[doom-package:][lang-tool]] and [[doom-package:][writegood-mode]].

** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:][langtool]]
- [[doom-package:][writegood-mode]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

This module requires [[https://languagetool.org/][LanguageTool]] (which requires =Java 1.8+=).

It is available from either https://languagetool.org/ or your OS's package
manager. E.g.
- macOS: ~$ brew install languagetool~
- Arch Linux: ~$ pacman -S languagetool~

This module tries to guess the location of =languagetool-commandline.jar=. If
you get a warning that Doom ~couldn't find languagetool-commandline.jar~, you
will need to set ~langtool-language-tool-jar~ to its location.

* TODO Usage
#+begin_quote
 🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

** Language Tool
[[https://www.languagetool.org/][Language Tool]] is a polyglot proofreader service that checks for grammar and
stylistic issues in your writing. This requires Java 1.8+.

#+begin_quote
 🚧 This requires Java 1.8+
#+end_quote

*** Commands
- ~M-x langtool-check~
- ~M-x langtool-correct-buffer~

** writegood-mode
This minor mode highlights weasel words, duplication and passive voice.

* TODO Configuration
#+begin_quote
 🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote