docs(:checkers): update READMEs to new format
This commit is contained in:
Henrik Lissner
Henrik Lissner
parent
5b354ae4f3
commit
b898fbe303
4 changed files with 248 additions and 199 deletions
|
|
@ -1,9 +1,8 @@
|
|||
← [[doom-module-index:][Back to module index]] ↙ [[doom-changelog-search:::checkers nil][Changelog]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
← [[doom-module-index:][Back to module index]] ↖ [[doom-module-source:checkers][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :checkers
|
||||
#+CREATED: August 1, 2021
|
||||
#+SINCE: v21.12.0
|
||||
#+SETUPFILE: ../../docs/.setupfile.org
|
||||
#+TITLE: :checkers
|
||||
#+CREATED: August 01, 2021
|
||||
#+SINCE: 21.12.0
|
||||
|
||||
* Description
|
||||
For modules dedicated to linting text.
|
||||
For modules dedicated to linting plain text (primarily code and prose).
|
||||
|
|
|
|||
|
|
@ -1,68 +1,77 @@
|
|||
#+TITLE: checkers/grammar
|
||||
#+DATE: January 9, 2020
|
||||
#+SINCE: v3.0.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::checkers grammar][Issues]] ↖ [[doom-module-source:checkers/grammar][Source]] ± [[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
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#language-tool][Language Tool]]
|
||||
- [[#commands][Commands]]
|
||||
- [[#writegood-mode][writegood-mode]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
* Description :unfold:
|
||||
This module adds grammar checking to Emacs to aid your writing by combining
|
||||
=lang-tool= and =writegood-mode=.
|
||||
[[doom-package:][lang-tool]] and [[doom-package:][writegood-mode]].
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers.
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags.
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/mhayashi1120/Emacs-langtool][langtool]]
|
||||
+ [[https://github.com/bnbeckwith/writegood-mode][writegood-mode]]
|
||||
** Packages
|
||||
- [[doom-package:][langtool]]
|
||||
- [[doom-package:][writegood-mode]]
|
||||
|
||||
* Prerequisites
|
||||
This module requires langtool (which requires =Java 1.8+=).
|
||||
** Hacks
|
||||
/No hacks documented for this module./
|
||||
|
||||
It can be acquired either from https://languagetool.org/ or your OS's package
|
||||
manager:
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
+ macOS: ~brew install languagetool~
|
||||
+ Arch Linux: ~pacman -S languagetool~
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
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.
|
||||
This module requires [[https://languagetool.org/][LanguageTool]] (which requires =Java 1.8+=).
|
||||
|
||||
* Features
|
||||
An in-depth list of features, how to use them, and their dependencies.
|
||||
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+
|
||||
🚧 This requires Java 1.8+
|
||||
#+end_quote
|
||||
|
||||
*** Commands
|
||||
- ~langtool-check~
|
||||
- ~langtool-correct-buffer~
|
||||
- ~M-x langtool-check~
|
||||
- ~M-x langtool-correct-buffer~
|
||||
|
||||
** writegood-mode
|
||||
This minor mode highlights weasel words, duplication and passive voice.
|
||||
|
||||
* Configuration
|
||||
How to configure this module, including common problems and how to address them.
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* Troubleshooting
|
||||
Common issues and their solution, or places to look for help.
|
||||
/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
|
||||
|
|
|
|||
|
|
@ -1,149 +1,155 @@
|
|||
#+TITLE: checkers/spell
|
||||
#+DATE: February 20, 2017
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::checkers spell][Issues]] ↖ [[doom-module-source:checkers/spell][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :checkers spell
|
||||
#+SUBTITLE: Tasing you for misspelling mispelling
|
||||
#+CREATED: February 20, 2017
|
||||
#+SINCE: 2.0.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#aspell][Aspell]]
|
||||
- [[#hunspell][Hunspell]]
|
||||
- [[#enchant][Enchant]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#changing-how-quickly-spell-fu-spellchecks-after-changes][Changing how quickly spell-fu spellchecks after changes]]
|
||||
- [[#spell-fu-users][Spell-fu users]]
|
||||
- [[#flyspell-users][Flyspell users]]
|
||||
- [[#reducing-false-positives-by-disabling-spelling-on-certain-faces][Reducing false positives by disabling spelling on certain faces]]
|
||||
- [[#spell-fu-users-1][Spell-fu users]]
|
||||
- [[#flyspell-users-1][Flyspell users]]
|
||||
- [[#adding-or-removing-words-to-your-personal-dictionary][Adding or removing words to your personal dictionary]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
This modules provides spellchecking powered by =aspell=, =hunspell= or =enchant=.
|
||||
* Description :unfold:
|
||||
This modules provides spellchecking powered by =aspell=, =hunspell= or
|
||||
=enchant=.
|
||||
|
||||
Spellcheck is automatically loaded in many ~text-mode~ derivatives, which
|
||||
includes ~org-mode~, ~markdown-mode~, the Git Commit buffer (from magit),
|
||||
~mu4e-compose-mode~, and others.
|
||||
|
||||
- Spell checking and correction using =aspell=, =hunspell= or =enchant=.
|
||||
- Ignores source code inside org or markdown files.
|
||||
- Lazily spellchecking recent changes only when idle.
|
||||
- Choosing suggestions using completion interfaces ([[doom-package:][ivy]] or [[doom-package:][helm]]).
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers.
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module Flags
|
||||
+ =+flyspell= Use =flyspell= instead of =spell-fu=. It's significantly slower,
|
||||
but supports multiple languages and dictionaries.
|
||||
+ =+aspell= Use =aspell= as a backend for correcting words.
|
||||
+ =+hunspell= Use =hunspell= as a backend for correcting words.
|
||||
+ =+enchant= Use =enchant-2= as a backend for correcting words.
|
||||
+ =+everywhere= Spell check in programming modes as well (in comments).
|
||||
** Module flags
|
||||
- +aspell ::
|
||||
Use =aspell= as a backend for correcting words.
|
||||
- +enchant ::
|
||||
Use =enchant-2= as a backend for correcting words.
|
||||
- +everywhere ::
|
||||
Spell check in programming modes as well (in comments only).
|
||||
- +flyspell ::
|
||||
Use [[doom-package:][flyspell]] instead of [[doom-package:][spell-fu]]. It's significantly slower, but supports
|
||||
multiple languages and dictionaries.
|
||||
- +hunspell ::
|
||||
Use =hunspell= as a backend for correcting words.
|
||||
|
||||
** Plugins
|
||||
+ if =+flyspell=
|
||||
+ [[https://github.com/d12frosted/flyspell-correct][flyspell-correct]]
|
||||
+ [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-ivy-interface][flyspell-correct-ivy]] (=completion/ivy=)
|
||||
+ [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-helm-interface][flyspell-correct-helm]] (=completion/helm=)
|
||||
+ [[https://github.com/d12frosted/flyspell-correct#flyspell-correct-popup-interface][flyspell-correct-popup]] (if *neither* =completion/ivy=, =completion/helm= or =completion/vertico=)
|
||||
+ [[https://github.com/rolandwalker/flyspell-lazy][flyspell-lazy]]
|
||||
+ else
|
||||
+ [[https://gitlab.com/ideasman42/emacs-spell-fu][spell-fu]]
|
||||
** Packages
|
||||
- if [[doom-module:][+flyspell]]
|
||||
- [[doom-package:][flyspell-correct]]
|
||||
- [[doom-package:][flyspell-correct-ivy]] if [[doom-module:][:completion ivy]]
|
||||
- [[doom-package:][flyspell-correct-helm]] if [[doom-module:][:completion helm]]
|
||||
- [[doom-package:][flyspell-correct-popup]] unless [[doom-module:][:completion ivy]], [[doom-module:][:completion helm]], or
|
||||
[[doom-module:][:completion vertico]]
|
||||
- [[doom-package:][flyspell-lazy]]
|
||||
- else
|
||||
- [[doom-package:][spell-fu]]
|
||||
|
||||
* Prerequisites
|
||||
This module requires one of =aspell=, =hunspell= or =enchant-2=
|
||||
installed on your system and in your ~PATH~.
|
||||
They also need dictionaries for your language(s).
|
||||
** 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 one of =aspell=, =hunspell= or =enchant-2= installed on
|
||||
your system and in your =$PATH=. They also need dictionaries for your
|
||||
language(s).
|
||||
|
||||
#+begin_quote
|
||||
If you *are not* using =+flyspell=, you will need aspell (and a dictionary)
|
||||
installed whether or not you have =+hunspell= or =+enchant= enabled.
|
||||
This is because =spell-fu= does not support generating the word list
|
||||
with anything other than =aspell= yet.
|
||||
🚧 If you *are not* using [[doom-module:][+flyspell]], you will need =aspell= (and a dictionary)
|
||||
installed whether or not you have [[doom-module:][+hunspell]] or [[doom-module:][+enchant]] enabled. This is
|
||||
because [[doom-package:][spell-fu]] does not support generating the word list with anything
|
||||
other than =aspell= yet.
|
||||
#+end_quote
|
||||
|
||||
** Aspell
|
||||
+ Ubuntu: ~apt-get install aspell aspell-en~
|
||||
+ macOS: ~brew install aspell~
|
||||
+ Arch Linux: ~pacman -S aspell aspell-en~
|
||||
+ NixOS:
|
||||
#+BEGIN_SRC nix
|
||||
- Ubuntu: ~$ apt-get install aspell aspell-en~
|
||||
- macOS: ~$ brew install aspell~
|
||||
- Arch Linux: ~$ pacman -S aspell aspell-en~
|
||||
- NixOS:
|
||||
#+begin_src nix
|
||||
{
|
||||
environment.systemPackages = with pkgs; [
|
||||
(aspellWithDicts (dicts: with dicts; [ en en-computers en-science ]))
|
||||
];
|
||||
}
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
** Hunspell
|
||||
+ Ubuntu: ~apt-get install hunspell~
|
||||
+ macOS: ~brew install hunspell~
|
||||
+ Arch Linux: ~pacman -S hunspell~
|
||||
+ NixOS:
|
||||
#+BEGIN_SRC nix
|
||||
- Ubuntu: ~$ apt-get install hunspell~
|
||||
- macOS: ~$ brew install hunspell~
|
||||
- Arch Linux: ~$ pacman -S hunspell~
|
||||
- NixOS:
|
||||
#+begin_src nix
|
||||
{
|
||||
environment.systemPackages = with pkgs; [
|
||||
hunspell
|
||||
];
|
||||
}
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
** Enchant
|
||||
+ Ubuntu: ~apt-get install enchant-2~
|
||||
+ macOS: ~brew install enchant~
|
||||
+ Arch Linux: ~pacman -S enchant~
|
||||
+ NixOS:
|
||||
#+BEGIN_SRC nix
|
||||
- Ubuntu: ~$ apt-get install enchant-2~
|
||||
- macOS: ~$ brew install enchant~
|
||||
- Arch Linux: ~$ pacman -S enchant~
|
||||
- NixOS:
|
||||
#+begin_src nix
|
||||
{
|
||||
environment.systemPackages = with pkgs; [
|
||||
enchant
|
||||
];
|
||||
}
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
Enchant is just a wrapper for other spelling libraries
|
||||
and you will need to have at least one of the supported backends installed as well.
|
||||
Enchant is just a wrapper for other spelling libraries and you will need to
|
||||
have at least one of the supported backends installed as well.
|
||||
|
||||
* Features
|
||||
+ Spell checking and correction using =aspell=, =hunspell= or =enchant=.
|
||||
+ Ignores source code inside org or markdown files.
|
||||
+ Lazily spellchecking recent changes only when idle.
|
||||
+ Choosing suggestions using completion interfaces (=ivy= or =helm=).
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
When using =+everywhere=, spell checking is performed for as many major modes as
|
||||
When using [[doom-module:][+everywhere]], spell checking is performed for as many major modes as
|
||||
possible, and not only ~text-mode~ derivatives. e.g. in comments for programming
|
||||
major modes.
|
||||
|
||||
* Configuration
|
||||
Dictionary is set by =ispell-dictionary= variable. Can be changed locally with
|
||||
the function =ispell-change-dictionary=.
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
** Changing how quickly spell-fu spellchecks after changes
|
||||
Dictionary is set by ~ispell-dictionary~ variable. Can be changed locally with
|
||||
the function ~ispell-change-dictionary~.
|
||||
|
||||
** Changing how quickly spelling is checked after changes
|
||||
*** Spell-fu users
|
||||
Adjust ~spell-fu-idle-delay~ to change how long Emacs waits to spellcheck after
|
||||
recent changes.
|
||||
#+BEGIN_SRC elisp
|
||||
recent changes:
|
||||
#+begin_src emacs-lisp
|
||||
(after! spell-fu
|
||||
(setq spell-fu-idle-delay 0.5)) ; default is 0.25
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
*** Flyspell users
|
||||
Lazy spellcheck is provided by =flyspell-lazy= package.
|
||||
Lazy spellcheck is provided by [[doom-package:][flyspell-lazy]] package.
|
||||
|
||||
=flyspell-lazy-idle-seconds= sets how many idle seconds until spellchecking
|
||||
recent changes (default as 1), while =flyspell-lazy-window-idle-seconds= sets
|
||||
how many seconds until the whole window is spellchecked (default as 3).
|
||||
#+BEGIN_SRC elisp
|
||||
~flyspell-lazy-idle-seconds~ sets how many idle seconds until spellchecking
|
||||
recent changes (default as 1), while ~flyspell-lazy-window-idle-seconds~ sets
|
||||
how many seconds until the whole window is spellchecked (default as 3):
|
||||
#+begin_src emacs-lisp
|
||||
(after! flyspell
|
||||
(setq flyspell-lazy-idle-seconds 2))
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
** Reducing false positives by disabling spelling on certain faces
|
||||
*** Spell-fu users
|
||||
Users can exclude what faces to preform spellchecking on by adjusting
|
||||
~+spell-excluded-faces-alist~ in a buffer-local hook:
|
||||
#+BEGIN_SRC elisp
|
||||
#+begin_src emacs-lisp
|
||||
(setf (alist-get 'markdown-mode +spell-excluded-faces-alist)
|
||||
'(markdown-code-face
|
||||
markdown-reference-face
|
||||
|
|
@ -153,18 +159,19 @@ Users can exclude what faces to preform spellchecking on by adjusting
|
|||
markdown-html-attr-value-face
|
||||
markdown-html-attr-name-face
|
||||
markdown-html-tag-name-face))
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
*** Flyspell users
|
||||
Flyspell will run a series of predicate functions to determine if a word should be spell checked. You can add your own with ~set-flyspell-predicate!~:
|
||||
#+BEGIN_SRC elisp
|
||||
Flyspell will run a series of predicate functions to determine if a word should
|
||||
be spell checked. You can add your own with ~set-flyspell-predicate!~:
|
||||
#+begin_src emacs-lisp
|
||||
(set-flyspell-predicate! '(markdown-mode gfm-mode)
|
||||
#'+markdown-flyspell-word-p)
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
Flyspell predicates take no arguments and must return a boolean to determine if
|
||||
the word at point should be spell checked. For example:
|
||||
#+BEGIN_SRC elisp
|
||||
#+begin_src emacs-lisp
|
||||
(defun +markdown-flyspell-word-p ()
|
||||
"Return t if point is on a word that should be spell checked.
|
||||
|
||||
|
|
@ -183,13 +190,28 @@ Return nil if on a link url, markup, html, or references."
|
|||
for face in faces
|
||||
if (memq face unsafe-faces)
|
||||
return t)))))
|
||||
#+END_SRC
|
||||
#+end_src
|
||||
|
||||
** Adding or removing words to your personal dictionary
|
||||
Use ~M-x +spell/add-word~ and ~M-x +spell/remove-word~ to whitelist words that
|
||||
you know are not misspellings. For evil users these are bound to =zg= and =zw=,
|
||||
respectively. =+flyspell= users can also add/remove words from the
|
||||
~flyspell-correct~ popup interface (there will be extra options on the list of
|
||||
you know are not misspellings. For evil users these are bound to [[kbd:][zg]] and [[kbd:][zw]],
|
||||
respectively. [[doom-module:][+flyspell]] users can also add/remove words from the
|
||||
[[doom-package:][flyspell-correct]] popup interface (there will be extra options on the list of
|
||||
corrections for "save word to dictionary").
|
||||
|
||||
* TODO Troubleshooting
|
||||
* Troubleshooting
|
||||
[[doom-report:][Report an issue?]]
|
||||
|
||||
** spell-fu highlights every single word
|
||||
[[doom-package:][spell-fu]] caches its word list. If it was activated before your dictionaries were
|
||||
installed, it will generate an empty word list, causing it to highlight all
|
||||
words as incorrect. Delete its cache files in =$EMACSDIR/.local/etc/spell-fu/=
|
||||
to fix this.
|
||||
|
||||
* 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
|
||||
|
|
|
|||
|
|
@ -1,66 +1,85 @@
|
|||
#+TITLE: checkers/syntax
|
||||
#+DATE: February 20, 2017
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
← [[doom-module-index:][Back to module index]] ↙ [[doom-module-issues:::checkers syntax][Issues]] ↖ [[doom-module-source:checkers/syntax][Source]] ± [[doom-suggest-edit:][Suggest edits]] ? [[doom-help-modules:][Help]]
|
||||
--------------------------------------------------------------------------------
|
||||
#+TITLE: :checkers syntax
|
||||
#+SUBTITLE: Tasing you for every semicolon you forget
|
||||
#+CREATED: May 29, 2021
|
||||
#+SINCE: 2.0.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#hacks][Hacks]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
This module provides syntax checking and error highlighting, powered by [[https://github.com/flycheck/flycheck][flycheck]]
|
||||
|
||||
+ If possible, include a brief list of feature highlights here
|
||||
+ Like code completion, syntax checking or available snippets
|
||||
+ Include links to packages & external things where possible
|
||||
* Description :unfold:
|
||||
This module provides syntax checking and error highlighting, powered by
|
||||
[[doom-package:][flycheck]].
|
||||
|
||||
** Maintainers
|
||||
This module has no dedicated maintainers.
|
||||
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** Module Flags
|
||||
+ =+childframe= Enables displaying completion candidates in a child frame, rather than an overlay or tooltip (among with other UI enhancements).
|
||||
** Module flags
|
||||
- +childframe ::
|
||||
Display errors/warnings in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than an overlay or tooltip.
|
||||
*Requires GUI Emacs.*
|
||||
|
||||
|
||||
** Plugins
|
||||
+ [[https://github.com/flycheck/flycheck][flycheck]]
|
||||
+ [[https://github.com/flycheck/flycheck-popup-tip][flycheck-popup-tip]]
|
||||
+ =+childframe=
|
||||
+ [[https://github.com/alexmurray/flycheck-posframe][flycheck-posframe]]
|
||||
** Packages
|
||||
- [[doom-package:][flycheck]]
|
||||
- [[doom-package:][flycheck-popup-tip]]
|
||||
- [[doom-package:][flycheck-posframe]] if [[doom-module:][+childframe]]
|
||||
|
||||
** Hacks
|
||||
If =lsp-ui-mode= is active, most of the aesthetic functionality of this module is turned off, as they show the same information.
|
||||
- If ~lsp-ui-mode~ is active, most of the aesthetic functionality of this module
|
||||
is turned off, as they show the same information.
|
||||
|
||||
* Prerequisites
|
||||
This module has no direct prerequisites.
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
However, some major modes may require a specific linter or program to work, and some major modes may not work at all. The best way to find these dependencies is by either reading the documentation for that module, or running =doom doctor=.
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module has no direct requirements, but some languages may have their own
|
||||
requirements to fulfill before you get syntax checking in them (and some
|
||||
languages may lack syntax checking support altogether). Run ~$ doom doctor~ to
|
||||
find out if you're missing any dependencies.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
Most of flycheck's features are under [[kbd:][C-c !]], regardless of whether evil mode is
|
||||
used.
|
||||
|
||||
* Features
|
||||
Most of flycheck's features are under =C-c !=, regardless of whether evil mode is used.
|
||||
| Keybind | Description |
|
||||
| C-c ! ? | Describe Checker ] |
|
||||
| C-c ! c | Check syntax in buffer |
|
||||
| C-c ! l | List errors |
|
||||
| C-c ! n | Next Error |
|
||||
| C-c ! p | Previous error |
|
||||
| C-c ! C | Clear all errors in buffer |
|
||||
| C-c ! e | Explain error at point |
|
||||
| C-c ! h | Display all errors at point |
|
||||
|---------+-----------------------------|
|
||||
| [[kbd:][C-c ! ?]] | Describe Checker |
|
||||
| [[kbd:][C-c ! c]] | Check syntax in buffer |
|
||||
| [[kbd:][C-c ! l]] | List errors |
|
||||
| [[kbd:][C-c ! n]] | Next Error |
|
||||
| [[kbd:][C-c ! p]] | Previous error |
|
||||
| [[kbd:][C-c ! C]] | Clear all errors in buffer |
|
||||
| [[kbd:][C-c ! e]] | Explain error at point |
|
||||
| [[kbd:][C-c ! h]] | Display all errors at point |
|
||||
|
||||
Evil Specific
|
||||
Evil Specific:
|
||||
| Keybind | Description |
|
||||
| SPC t f | Toggle Flycheck |
|
||||
| SPC c x | List errors |
|
||||
| ] e | Next error |
|
||||
| [ e | Prevous error |
|
||||
|---------+-----------------|
|
||||
| [[kbd:][SPC t f]] | Toggle Flycheck |
|
||||
| [[kbd:][SPC c x]] | List errors |
|
||||
| [[kbd:][] e]] | Next error |
|
||||
| [[kbd:][[ e]] | Prevous error |
|
||||
|
||||
* TODO Configuration
|
||||
#+begin_quote
|
||||
🔨 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
||||
#+end_quote
|
||||
|
||||
* TODO Troubleshooting
|
||||
* Troubleshooting
|
||||
[[doom-report:][Report an issue?]]
|
||||
|
||||
- Use ~M-x flycheck-verify-setup~ to determine what checkers are available in a
|
||||
buffer and whether they're active or not (and why).
|
||||
|
||||
* 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue