doom-emacs/modules/checkers/syntax
2024-05-21 17:16:27 +02:00
..
autoload.el
config.el
packages.el
README.org

:checkers syntax

Description   unfold

This module provides syntax checking and error highlighting, powered by doom-package:flycheck.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+childframe
Display errors/warnings in a child frame rather than an overlay or tooltip. Requires GUI Emacs.
+flymake
Leverages the inbuilt doom-package:flymake for error and diagnostics highlighting.

Hacks

  • If lsp-ui-mode is active, most of the aesthetic functionality of this module is turned off, as they show the same information.

TODO Changelog

This module does not have a changelog yet.

Installation

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

󱌣 This module's usage documentation is incomplete. Complete it?

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

Evil Specific:

Keybind Description
SPC t f Toggle Flycheck
SPC c x List errors
] e Next error
[ e Prevous error

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

Troubleshooting

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. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?