emres / avy-flycheck

Jump to and fix syntax errors using `flycheck' with `avy' interface

avy-flycheck

avy-flycheck is a GNU Emacs package for syntax errors navigation. It depends on flycheck to provide syntax error checking and avy for easy navigation.

Jump to and fix syntax errors using flycheck with avy interface

Configuration overview

you need install flycheck and avy

you can get them from flycheck github and avy github.

add path of this package to your load-path

(add-to-list 'load-path
	     "path/to/the/directory/of/avy-flycheck")

then simply require the package

(require 'avy-flycheck)

bind to a key for your convenience.

the package provides a function called avy-flycheck-setup to bind avy-flycheck-goto-error to C-c ! g

(avy-flycheck-setup)

or you can choose your own binding. Example: bind to C-'

(global-flycheck-mode)
(global-set-key (kbd "C-c '") #'avy-flycheck-goto-error)

A few customizations are provided.

Set Method for displaying avy overlays.

(setq avy-flycheck-style 'pre)

Custom avy-flycheck-dispatch-alist: config avy-action available for avy-flycheck-goto-error.

(setq avy-flycheck-dispatch-alist
      '((?x . avy-action-kill-move)
        (?X . avy-action-kill-stay)
        (?m . avy-action-mark)
        (?n . avy-action-copy)
        (?i . avy-action-ispell)))

Contributing

Copyright Assignment

avy-flycheck is subject to the same copyright assignment policy as Emacs itself, org-mode, CEDET and other packages in GNU ELPA. Any legally significant contributions can only be accepted after the author has completed their paperwork. Please see the request form if you want to proceed.

The copyright assignment isn't a big deal, it just says that the copyright for your submitted changes to Emacs belongs to the FSF. This assignment works for all projects related to Emacs. To obtain it, you need to send one email, then send one letter (if you live in the US, it's digital), and wait for some time (in my case, I had to wait for one month).

Style

Use your own judgment for the commit messages, I recommend a verbose style using magit-commit-add-log.