Skip to content

Commit

Permalink
chore: add documentation on error reporting with flycheck and flymake
Browse files Browse the repository at this point in the history
  • Loading branch information
justinbarclay committed Nov 5, 2024
1 parent db8a088 commit 0f48ea9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,21 @@ Options:
#+begin_quote
default: safe
#+end_quote
** Error reporting
parinfer-rust-mode uses flycheck and flymake to report parsing errors.
*** Flymake
There should be no config needed to work in ==flymake-mode== is enabled.
*** Flycheck
parinfer-rust-mode is set-up to be chained with the ==emacs-lisp== checker.

However, if you want it to work alongside other checkers you'll need to [[https://www.flycheck.org/en/latest/user/syntax-checkers.html#configuring-checker-chains][chain]] it yourself.
#+begin_src emacs-lisp
(use-package parinfer-rust-mode
:config
(flycheck-add-next-checker 'emacs-lisp 'parinfer-rust t))
#+end_src
*** Message buffer
If neither Flycheck or Flymake are enabled then ==parinfer-rust-mode== will output the error to ==*Messages*== buffer.
** parinfer-mode
There is an alternate implementation of Parinfer for Emacs called [[https://github.com/DogLooksGood/parinfer-mode][parinfer-mode]]. It currently has support for Parinfer's "paren" and "indent". Additionally, it has had experimental support for "smart" mode, however, this has remained hidden on a branch and not accessible from MELPA for over a year.
parinfer-smart-mode aims to be a simpler adaptation of Parinfer that just offers "smart mode", leveraging the parinfer-rust plugin to do most of the heavy lifting.
Expand Down

0 comments on commit 0f48ea9

Please sign in to comment.