emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/checkers/syntax
History
Henrik Lissner 037b018cdd
feat: add .doommodule files 
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
autoload.el Move :tools fly{check,spell} to :checkers {syntax,spell} 2020-01-09 22:56:26 -05:00
config.el tweak(syntax): use close-circle-outline icon for errors 2024-07-12 15:44:50 -04:00
packages.el bump: flymake-popon 2024-08-31 13:49:16 -04:00
README.org feat(flycheck): add +icons flag 2024-07-10 20:35:30 -04:00

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.
+icons
Use unicode icons rather than ASCII prefixes in error tooltips or childframes.

Packages

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 childframes are enabled, and the flycheck childframe is shown, it will be hidden on the next user input (as well as the default behavior: to hide it the next time the user is idle for flycheck-display-errors-delay seconds).

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?