dotfiles-misc/protesilaos.dotfiles
1
0
Fork 0
mirror of https://github.com/protesilaos/dotfiles.git synced 2026-09-10 07:16:20 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

emacs: document flymake section

Browse source
This commit is contained in:
Protesilaos Stavrou 2024-01-07 18:19:53 +02:00
parent 5d5fc91046
commit 35c01d809e
No known key found for this signature in database
GPG key ID: 99BD6459CD5CA3EA
2 changed files with 25 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
emacs/.emacs.d/prot-emacs-modules/prot-emacs-langs.el
View file

@ -139,8 +139,8 @@ Meant to be added to `prog-mode-hook'."
(:delay 30)
(setq flymake-fringe-indicator-position 'left-fringe)
(setq flymake-suppress-zero-counters t)
(setq flymake-start-on-flymake-mode t)
(setq flymake-no-changes-timeout nil)
(setq flymake-start-on-flymake-mode t)
(setq flymake-start-on-save-buffer t)
(setq flymake-proc-compilation-prevents-syntax-check t)
(setq flymake-wrap-around nil)

26
emacs/.emacs.d/prot-emacs.org
View file

@ -7614,19 +7614,41 @@ not even bother trying as I seldom have that need.
"C-M-$" #'prot-spell-change-dictionary))
#+end_src
*** TODO The =prot-emacs-langs.el= settings for code linting (~flymake~)
*** The =prot-emacs-langs.el= settings for code linting (~flymake~)
:PROPERTIES:
:CUSTOM_ID: h:df6d1b52-0306-4ace-9099-17dded11fbed
:END:
The built-in ~flymake~ feature defines an interface for viewing the
output of linter programs. A "linter" parses a file and reports
possible notes/warnings/errors in it. With ~flymake~ we get these
diagnostics in the form of a standalone buffer as well as inline
highlights (typically underlines combined with fringe indicators) for
the portion of text in question. The linter report is displayed with
the command ~flymake-show-buffer-diagnostics~, or ~flymake-show-project-diagnostics~.
Highlights are shown in the context of the file.
The built-in ~eglot~ feature uses ~flymake~ internally to handle the
LSP linter output ([[#h:92258aa8-0d8c-4c12-91b4-5f44420435ce][The =prot-emacs-langs.el= settings for ~eglot~]]).
As for what I have in this configuration block, the essentials for me
are the user options ~flymake-start-on-save-buffer~ and ~flymake-start-on-flymake-mode~
as they make the linter update its report when the buffer is saved and
when ~flymake-mode~ is started, respectively. Otherwise, we have to
run it manually, which is cumbersome.
The ~package-lint-flymake~ package by Steve Purcell adds the glue code
to make ~flymake~ report issues with Emacs Lisp files for the purposes
of packaging. I use it whenever I work on my numerous Emacs packages.
#+begin_src emacs-lisp :tangle "prot-emacs-modules/prot-emacs-langs.el"
;;; Flymake
(prot-emacs-package flymake
(:delay 30)
(setq flymake-fringe-indicator-position 'left-fringe)
(setq flymake-suppress-zero-counters t)
(setq flymake-start-on-flymake-mode t)
(setq flymake-no-changes-timeout nil)
(setq flymake-start-on-flymake-mode t)
(setq flymake-start-on-save-buffer t)
(setq flymake-proc-compilation-prevents-syntax-check t)
(setq flymake-wrap-around nil)