Flycheck — Syntax checking for GNU Emacs¶
Flycheck is a modern on-the-fly syntax checking extension for GNU Emacs, intended as replacement for the older Flymake extension which is part of GNU Emacs. For a detailed comparison to Flymake see Flycheck versus Flymake.
Out of the box Flycheck supports over 40 different programming languages with more than 80 different syntax checking tools, and comes with a simple interface to define new syntax checkers.
Many 3rd party extensions provide new syntax checkers and other features like alternative error displays or mode line indicators.
Flycheck needs GNU Emacs 24.3 or newer, and works best on Unix systems. Windows users, please be aware that Flycheck does not support Windows officially, although it should mostly work fine on Windows. See Windows support and watch out for known Windows issues!
To try Flycheck in your Emacs session install some syntax checker tools and type the following in your
*scratch* buffer and
(require 'package) (add-to-list 'package-archives '("MELPA Stable" . "http://stable.melpa.org/packages/") t) (package-initialize) (package-refresh-contents) (package-install 'flycheck) (global-flycheck-mode)
On MacOS also add the following to fix your $PATH environment variable:
(package-install 'exec-path-from-shell) (exec-path-from-shell-initialize)
If Flycheck fails to run properly or gives you any error messages please take a look at the troubleshooting section which covers some common setup issues and helps you debug and fix problems with Flycheck.
The User Guide¶
The User Guide provides installation and usage help for Flycheck. It starts with installation instructions and a quick start tutorial and then focuses on an in-depth references of all parts of Flycheck.
We are currently in the process of converting the old Texinfo manual to Sphinx.
Meanwhile you can read a simple HTML version of the old manual at
- Check buffers
- Syntax checkers
- See errors in buffers
- List all errors
- Interact with errors
- Flycheck versus Flymake
- Detailed review
- Relation to Emacs
- Enabling syntax checking
- Syntax checkers
- Syntax checker selection
- Resource consumption
- Unit tests
The Developer Guide¶
The Developer Guide shows how to write syntax checkers for Flycheck and how to extend Flycheck.
Port the extending section from the old manual
flycheck.html for a simple
HTML version of the old manual.
The Community Guide¶
The Community Guide provides information about Flycheck’s ecosystem and community.
- Flycheck Code of Conduct
- Recommended extensions
- Get help
The Contributor Guide¶
The Contributor Guide explains how to contribute to Flycheck.
- Contributor’s Guide
- Style Guide
- Maintainer’s Guide
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 3 for a copy of the GNU General Public License.
You may copy, distribute and/or modify the Flycheck documentation under the terms of the Creative Commons Attribution-ShareAlike 4.0 International Public License. See Creative Commons Attribution-ShareAlike 4.0 International for a copy of the license.
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. See Creative Commons Attribution-ShareAlike 4.0 International for a copy of the license.