Flycheck — Modern Emacs syntax checking

_images/logo.png

Flycheck is a modern on-the-fly syntax checking extension for GNU Emacs 24, intended as replacement for the older Flymake extension which is part of GNU Emacs.

It uses various syntax checking and linting tools to automatically check the contents of buffers while you type, and reports warnings and errors directly in the buffer, or in an optional error list:

_images/screenshot.png

Flycheck in an Emacs Lisp buffer, with error highlights, indicators, and the error list. The color theme is Solarized Light, together with the Source Code Pro font.

Contributor guide

This part of the documentation targets contributors to Flycheck. It provides general contribution guidelines, by which we review pull requests and other contributions, and instructions for specific tasks Flycheck contributors need to perform and problems they face.

Index

The index provides a sorted list of all symbols and concepts explained throughout Flycheck’s documentation:

Credits

The following people—listed in alphabetical order—contributed substantial code to Flycheck:

The following people greatly supported Flycheck in other ways:

  • Simon Carter (valuable testing and feedback of automatic syntax checking)
  • Matthias Güdemann (initial version of the Flycheck logo, valuable feedback for the final version)

The Flycheck developers would also like to thank the following people and projects:

  • Bozhidar Batsov for his valuable feedback and his constant support and endorsement of Flycheck from the very beginning. Notably, he added Flycheck to his popular Prelude project at a very early stage and thus brought Flycheck to many new users.
  • Magnar Sveen for his dash.el and s.el libraries, which support considerable parts of Flycheck internals, and greatly helped to overcome the author’s initial aversion to Emacs Lisp.
  • Martin Grenfell for the Vim syntax checking extension Syntastic, which saved the author’s life back when he was using Vim, and served as inspiration for Flycheck and many of its syntax checkers.
  • Pavel Kobyakov for his work on GNU Flymake, which is a great work on its own, despite its flaws and weaknesses
  • Steve Purcell for his valuable feedback, the fruitful discussions and his important ideas about the shape and design of Flycheck, and his indispensible and dedicated work on MELPA, which drives the continuous distribution of Flycheck to its users.

Licensing

Flycheck is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Flycheck is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See GNU General Public License or http://www.gnu.org/licenses/ for a copy of the GNU General Public License.

Permission is granted to copy, distribute and/or modify this documentation under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.

Alternatively, you may copy, distribute and/or modify this documentation under the terms of the Creative Commons Attribution-ShareAlike 4.0 International Public License. A copy of the license can be obtained at https://creativecommons.org/licenses/by-sa/4.0/legalcode.

Permission is granted to copy, distribute and/or modify the Flycheck logo under the terms of the Creative Commons Attribution-ShareAlike 4.0 International Public License. A copy of the license can be obtained at https://creativecommons.org/licenses/by-sa/4.0/legalcode.