Supported languages

Flycheck supports the following 43 languages with 73 syntax checkers.

Each language has one or more syntax checkers, whose names follow a language-tool convention, where language is the programming language supported by this syntax checker, and tool the specific syntax checker tool.

There are some 3rd party extensions which add support for more languages:

Ada

Flycheck Syntax Checker ada-gnat
An Ada syntax checker using GNAT.

Uses the GNAT compiler from GCC.  See URL
`https://gcc.gnu.org/onlinedocs/gnat_ugn_unw/'.

Options

User Option flycheck-gnat-args
A list of additional arguments for Symbol('ada-gnat').

The value of this variable is a list of strings with additional
command line arguments.

This variable is an option for the syntax checker `ada-gnat'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gnat-include-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of include directories for GNAT.

The value of this variable is a list of strings, where each
string is a directory to add to the include path of gcc.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `ada-gnat'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gnat-language-standard

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The language standard to use in GNAT.

The value of this variable is either a string denoting a language
standard, or nil, to use the default standard. When non-nil, pass
the language standard via the `-std' option.

This variable is an option for the syntax checker `ada-gnat'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gnat-warnings

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of additional Ada warnings to enable in GNAT.

The value of this variable is a list of strings, where each
string is the name of a warning category to enable. By default,
most optional warnings are recommended, as in `-gnata'.

Refer to Info Node `(gnat_ugn_unw)Warning Message Control' for
more information about GNAT warnings.

This variable is an option for the syntax checker `ada-gnat'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

AsciiDoc

Flycheck Syntax Checker asciidoc
A AsciiDoc syntax checker using the AsciiDoc compiler.

See URL `http://www.methods.co.nz/asciidoc'.

C/C++

Flycheck Syntax Checker c/c++-clang

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. c/c++-cppcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A C/C++ syntax checker using Clang.

See URL `http://clang.llvm.org/'.

Options

User Option flycheck-clang-args
A list of additional arguments for Symbol('c/c++-clang').

The value of this variable is a list of strings with additional
command line arguments.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.22 of the flycheck package.

User Option flycheck-clang-blocks

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Enable blocks in Clang.

When non-nil, enable blocks in Clang with `-fblocks'.  See URL
`http://clang.llvm.org/docs/BlockLanguageSpec.html' for more
information about blocks.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-clang-definitions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Additional preprocessor definitions for Clang.

The value of this variable is a list of strings, where each
string is an additional definition to pass to Clang, via the `-D'
option.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.15 of the flycheck package.

User Option flycheck-clang-include-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of include directories for Clang.

The value of this variable is a list of strings, where each
string is a directory to add to the include path of Clang.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

User Option flycheck-clang-includes

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of additional include files for Clang.

The value of this variable is a list of strings, where each
string is a file to include before syntax checking.  Relative
paths are relative to the file being checked.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.15 of the flycheck package.

User Option flycheck-clang-language-standard

Variable properties

Automatically becomes buffer-local when set. This variable is safe as a file local variable if its value satisfies the predicate stringp.

The language standard to use in Clang.

The value of this variable is either a string denoting a language
standard, or nil, to use the default standard.  When non-nil,
pass the language standard via the `-std' option.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.15 of the flycheck package.

User Option flycheck-clang-ms-extensions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to enable Microsoft extensions to C/C++ in Clang.

When non-nil, enable Microsoft extensions to C/C++ via
`-fms-extensions'.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

User Option flycheck-clang-no-exceptions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to disable exceptions in Clang.

When non-nil, disable exceptions for syntax checks, via
`-fno-exceptions'.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-clang-no-rtti

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to disable RTTI in Clang.

When non-nil, disable RTTI for syntax checks, via `-fno-rtti'.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.15 of the flycheck package.

User Option flycheck-clang-standard-library

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The standard library to use for Clang.

The value of this variable is the name of a standard library as
string, or nil to use the default standard library.

Refer to the Clang manual at URL
`http://clang.llvm.org/docs/UsersManual.html' for more
information about the standard library.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.15 of the flycheck package.

User Option flycheck-clang-warnings

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of additional warnings to enable in Clang.

The value of this variable is a list of strings, where each string
is the name of a warning category to enable.  By default, all
recommended warnings and some extra warnings are enabled (as by
`-Wall' and `-Wextra' respectively).

Refer to the Clang manual at URL
`http://clang.llvm.org/docs/UsersManual.html' for more
information about warnings.

This variable is an option for the syntax checker `c/c++-clang'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

Flycheck Syntax Checker c/c++-gcc

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. c/c++-cppcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A C/C++ syntax checker using GCC.

Requires GCC 4.8 or newer.  See URL `https://gcc.gnu.org/'.

Options

User Option flycheck-gcc-args
A list of additional arguments for Symbol('c/c++-gcc').

The value of this variable is a list of strings with additional
command line arguments.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.22 of the flycheck package.

User Option flycheck-gcc-definitions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Additional preprocessor definitions for GCC.

The value of this variable is a list of strings, where each
string is an additional definition to pass to GCC, via the `-D'
option.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-include-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of include directories for GCC.

The value of this variable is a list of strings, where each
string is a directory to add to the include path of gcc.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-includes

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of additional include files for GCC.

The value of this variable is a list of strings, where each
string is a file to include before syntax checking.  Relative
paths are relative to the file being checked.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-language-standard

Variable properties

Automatically becomes buffer-local when set. This variable is safe as a file local variable if its value satisfies the predicate stringp.

The language standard to use in GCC.

The value of this variable is either a string denoting a language
standard, or nil, to use the default standard.  When non-nil,
pass the language standard via the `-std' option.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-no-exceptions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to disable exceptions in GCC.

When non-nil, disable exceptions for syntax checks, via
`-fno-exceptions'.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-no-rtti

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to disable RTTI in GCC.

When non-nil, disable RTTI for syntax checks, via `-fno-rtti'.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gcc-openmp

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to enable OpenMP in GCC.

When non-nil, enable OpenMP for syntax checkers, via
`-fopenmp'.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.21 of the flycheck package.

User Option flycheck-gcc-warnings

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of additional warnings to enable in GCC.

The value of this variable is a list of strings, where each string
is the name of a warning category to enable.  By default, all
recommended warnings and some extra warnings are enabled (as by
`-Wall' and `-Wextra' respectively).

Refer to the gcc manual at URL
`https://gcc.gnu.org/onlinedocs/gcc/' for more information about
warnings.

This variable is an option for the syntax checker `c/c++-gcc'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

Flycheck Syntax Checker c/c++-cppcheck
A C/C++ checker using cppcheck.

See URL `http://cppcheck.sourceforge.net/'.

Options

User Option flycheck-cppcheck-checks

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Enabled checks for Cppcheck.

The value of this variable is a list of strings, where each
string is the name of an additional check to enable.  By default,
all coding style checks are enabled.

See section "Enable message" in the Cppcheck manual at URL
`http://cppcheck.sourceforge.net/manual.pdf', and the
documentation of the `--enable' option for more information,
including a list of supported checks.

This variable is an option for the syntax checker `c/c++-cppcheck'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

User Option flycheck-cppcheck-inconclusive

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to enable Cppcheck inconclusive checks.

When non-nil, enable Cppcheck inconclusive checks.  This allows Cppcheck to
report warnings it's not certain of, but it may result in false positives.

This will have no effect when using Cppcheck 1.53 and older.

This variable is an option for the syntax checker `c/c++-cppcheck'.

This user option was introduced, or its default value was changed, in version 0.19 of the flycheck package.

See also

flycheck-irony adds an alternative syntax checker for C, C++ and Objective C which uses Irony Mode server to check buffers.

The flycheck-google-cpplint extension adds a syntax checker using Google’s C++ style checker.

CFEngine

Flycheck Syntax Checker cfengine
A CFEngine syntax checker using cf-promises.

See URL `http://cfengine.com/'.

Chef

See also

Chef

Flycheck Syntax Checker chef-foodcritic
A Chef cookbooks syntax checker using Foodcritic.

See URL `http://acrmp.github.io/foodcritic/'.

Coffeescript

Flycheck Syntax Checker coffee

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. coffee-coffeelint, if there are no errors above level warning

The first suitable syntax checker is used.

A CoffeeScript syntax checker using coffee.

See URL `http://coffeescript.org/'.
Flycheck Syntax Checker coffee-coffeelint
A CoffeeScript style checker using coffeelint.

This syntax checker requires coffeelint 1.0 or newer.

See URL `http://www.coffeelint.org/'.

Configuration file

User Option flycheck-coffeelintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `coffee-coffeelint'.

Coq

Flycheck Syntax Checker coq
A Coq syntax checker using the Coq compiler.

See URL `http://coq.inria.fr/'.

CSS

Flycheck Syntax Checker css-csslint
A CSS syntax and style checker using csslint.

See URL `https://github.com/CSSLint/csslint'.

D

Flycheck Syntax Checker d-dmd
A D syntax checker using the DMD compiler.

Requires DMD 2.066 or newer.  See URL `http://dlang.org/'.

Options

User Option flycheck-dmd-include-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of include directories for dmd.

The value of this variable is a list of strings, where each
string is a directory to add to the include path of dmd.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `d-dmd'.

This user option was introduced, or its default value was changed, in version 0.18 of the flycheck package.

See also

The flycheck-d-unittest extension adds a syntax checker that runs D unit tests on the fly.

Elixir

Flycheck Syntax Checker elixir
An Elixir syntax checker using the Elixir interpreter.

See URL `http://elixir-lang.org/'.

Emacs Lisp

Flycheck Syntax Checker emacs-lisp

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. emacs-lisp-checkdoc

The first suitable syntax checker is used.

An Emacs Lisp syntax checker using the Emacs Lisp Byte compiler.

See Info Node `(elisp)Byte Compilation'.

Options

User Option flycheck-emacs-lisp-initialize-packages

Variable properties

This variable may be risky if used as a file-local variable.

Whether to initialize packages in the Emacs Lisp syntax checker.

To initialize packages, call `package-initialize' before
byte-compiling the file to check.

When nil, never initialize packages.  When `auto', initialize
packages only when checking files from `user-emacs-directory'.
For any other non-nil value, always initialize packages.

This variable is an option for the syntax checker `emacs-lisp'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

User Option flycheck-emacs-lisp-load-path

Variable properties

This variable may be risky if used as a file-local variable.

Load path to use in the Emacs Lisp syntax checker.

When set to `inherit', use the `load-path' of the current Emacs
session during syntax checking.

When set to a list of strings, add each directory in this list to
the `load-path' before invoking the byte compiler.  Relative
paths in this list are expanded against the `default-directory'
of the buffer to check.

When nil, do not explicitly set the `load-path' during syntax
checking.  The syntax check only uses the built-in `load-path' of
Emacs in this case.

Note that changing this variable can lead to wrong results of the
syntax check, e.g. if an unexpected version of a required library
is used.

This variable is an option for the syntax checker `emacs-lisp'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

User Option flycheck-emacs-lisp-package-user-dir

Variable properties

This variable may be risky if used as a file-local variable.

Package directory for the Emacs Lisp syntax checker.

When set to a string, set `package-user-dir' to the value of this
variable before initializing packages.

This variable has no effect, if
`flycheck-emacs-lisp-initialize-packages' is nil.

This variable is an option for the syntax checker `emacs-lisp'.

This user option was introduced, or its default value was changed, in version 0.14 of the flycheck package.

See also

With the flycheck-cask extension this syntax checker automatically uses packages from Cask projects.

Flycheck Syntax Checker emacs-lisp-checkdoc
An Emacs Lisp style checker using CheckDoc.

The checker runs `checkdoc-current-buffer'.

Erlang

Flycheck Syntax Checker erlang
An Erlang syntax checker using the Erlang interpreter.

See URL `http://www.erlang.org/'.

ERuby

Flycheck Syntax Checker eruby-erubis
A eRuby syntax checker using the `erubis' command.

See URL `http://www.kuwata-lab.com/erubis/'.

Fortran

Flycheck Syntax Checker fortran-gfortran
An Fortran syntax checker using GCC.

Uses GCC's Fortran compiler gfortran.  See URL
`https://gcc.gnu.org/onlinedocs/gfortran/'.

Options

User Option flycheck-gfortran-args
A list of additional arguments for Symbol('fortran-gfortran').

The value of this variable is a list of strings with additional
command line arguments.

This variable is an option for the syntax checker `fortran-gfortran'.

This user option was introduced, or its default value was changed, in version 0.22 of the flycheck package.

User Option flycheck-gfortran-include-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of include directories for GCC Fortran.

The value of this variable is a list of strings, where each
string is a directory to add to the include path of gcc.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `fortran-gfortran'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gfortran-language-standard

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The language standard to use in GFortran.

The value of this variable is either a string denoting a language
standard, or nil, to use the default standard.  When non-nil,
pass the language standard via the `-std' option.

This variable is an option for the syntax checker `fortran-gfortran'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-gfortran-layout
The source code layout to use in GFortran.

The value of this variable is one of the following symbols:

nil
     Let gfortran determine the layout from the extension

`free'
     Use free form layout


`fixed'
     Use fixed form layout

In any other case, an error is signaled.

This variable is an option for the syntax checker `fortran-gfortran'.
User Option flycheck-gfortran-warnings
A list of warnings for GCC Fortran.

The value of this variable is a list of strings, where each string
is the name of a warning category to enable.  By default, all
recommended warnings and some extra warnings are enabled (as by
`-Wall' and `-Wextra' respectively).

Refer to the gfortran manual at URL
`https://gcc.gnu.org/onlinedocs/gfortran/' for more information
about warnings

This variable is an option for the syntax checker `fortran-gfortran'.

Go

Flycheck Syntax Checker go-gofmt

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. go-golint, if there are no errors above level warning
  2. go-vet, if there are no errors above level warning
  3. go-build, if there are no errors above level warning
  4. go-test, if there are no errors above level warning
  5. go-errcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A Go syntax and style checker using the gofmt utility.

See URL `http://golang.org/cmd/gofmt/'.
Flycheck Syntax Checker go-golint

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. go-vet
  2. go-build
  3. go-test
  4. go-errcheck

The first suitable syntax checker is used.

A Go style checker using Golint.

See URL `https://github.com/golang/lint'.
Flycheck Syntax Checker go-vet

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. go-build
  2. go-test
  3. go-errcheck

The first suitable syntax checker is used.

A Go syntax checker using the go tool vet command.

See URL `http://golang.org/cmd/go/' and URL
`http://godoc.org/code.google.com/p/go.tools/cmd/vet'.

Options

User Option flycheck-go-vet-print-functions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A comma-separated list of print-like functions for go tool vet.

Go vet will check these functions for format string problems and
issues, such as a mismatch between the number of formats used,
and the number of arguments given.

Each entry is in the form Name:N where N is the zero-based
argument position of the first argument involved in the print:
either the format or the first print argument for non-formatted
prints.  For example, if you have Warn and Warnf functions that
take an io.Writer as their first argument, like Fprintf,
-printfuncs=Warn:1,Warnf:1 

This variable is an option for the syntax checker `go-vet'.
Flycheck Syntax Checker go-build

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. go-errcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A Go syntax and type checker using the go build command.

See URL `http://golang.org/cmd/go'.
Flycheck Syntax Checker go-test

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. go-errcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A Go syntax and type checker using the go test command.

See URL `http://golang.org/cmd/go'.
Flycheck Syntax Checker go-errcheck
A Go checker for unchecked errors.

See URL `https://github.com/kisielk/errcheck'.

Haml

Flycheck Syntax Checker haml
A Haml syntax checker using the Haml compiler.

See URL `http://haml.info'.

Handlebars

Flycheck Syntax Checker handlebars
A Handlebars syntax checker using the Handlebars compiler.

See URL `http://handlebarsjs.com/'.

Haskell

Flycheck Syntax Checker haskell-ghc

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. haskell-hlint, if there are no errors above level warning

The first suitable syntax checker is used.

A Haskell syntax and type checker using ghc.

See URL `http://www.haskell.org/ghc/'.

Options

User Option flycheck-ghc-args
A list of additional arguments for Symbol('haskell-ghc').

The value of this variable is a list of strings with additional
command line arguments.

This variable is an option for the syntax checker `haskell-ghc'.

This user option was introduced, or its default value was changed, in version 0.22 of the flycheck package.

User Option flycheck-ghc-language-extensions

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Language extensions for GHC.

The value of this variable is a list of strings, where each
string is a Haskell language extension, as in the LANGUAGE
pragma.  Each extension is enabled via `-X'.

This variable is an option for the syntax checker `haskell-ghc'.

This user option was introduced, or its default value was changed, in version 0.19 of the flycheck package.

User Option flycheck-ghc-no-user-package-database

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to disable the user package database in GHC.

When non-nil, disable the user package database in GHC, via
`-no-user-package-db'.

This variable is an option for the syntax checker `haskell-ghc'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

User Option flycheck-ghc-package-databases

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Additional module databases for GHC.

The value of this variable is a list of strings, where each
string is a directory of a package database.  Each package
database is given to GHC via `-package-db'.

This variable is an option for the syntax checker `haskell-ghc'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

User Option flycheck-ghc-search-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

Module search path for GHC.

The value of this variable is a list of strings, where each
string is a directory containing Haskell modules.  Each directory
is added to the GHC search path via `-i'.

This variable is an option for the syntax checker `haskell-ghc'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

See also

The flycheck-haskell extension configures this syntax checker according to the corresponding Cabal project, and adds Cabal sandboxes.

Flycheck Syntax Checker haskell-hlint
A Haskell style checker using hlint.

See URL `https://github.com/ndmitchell/hlint'.

See also

The flycheck-hdevtools extension adds a Haskell syntax checker using hdevtools.

HTML

Flycheck Syntax Checker html-tidy
A HTML syntax and style checker using Tidy.

See URL `https://github.com/w3c/tidy-html5'.

Configuration file

User Option flycheck-tidyrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `html-tidy'.

Javascript

Flycheck Syntax Checker javascript-jshint
A JavaScript syntax and style checker using jshint.

See URL `http://www.jshint.com'.

Configuration file

User Option flycheck-jshintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `javascript-jshint'.
Flycheck Syntax Checker javascript-eslint
A JavaScript syntax and style checker using eslint.

See URL `https://github.com/eslint/eslint'.

Options

User Option flycheck-eslint-rulesdir

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The directory of custom rules for ESLint.

The value of this variable is either a string containing the path
to a directory with custom rules, or nil, to not give any custom
rules to ESLint.

Refer to the ESLint manual at URL
`https://github.com/eslint/eslint/tree/master/docs/command-line-interface#--rulesdir'
for more information about the custom directory.

This variable is an option for the syntax checker `javascript-eslint'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

Configuration file

User Option flycheck-eslintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `javascript-eslint'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

Flycheck Syntax Checker javascript-gjslint
A JavaScript syntax and style checker using Closure Linter.

See URL `https://developers.google.com/closure/utilities'.

Configuration file

User Option flycheck-gjslintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `javascript-gjslint'.

JSON

Flycheck Syntax Checker json-jsonlint
A JSON syntax and style checker using jsonlint.

See URL `https://github.com/zaach/jsonlint'.

LESS

Flycheck Syntax Checker less
A LESS syntax checker using lessc.

At least version 1.4 of lessc is required.

See URL `http://lesscss.org'.

Lua

Flycheck Syntax Checker lua
A Lua syntax checker using the Lua compiler.

See URL `http://www.lua.org/'.

Make

Flycheck Syntax Checker make
A Makefile syntax checker using the POSIX compatible Make command.

See URL `http://pubs.opengroup.org/onlinepubs/9699919799/utilities/make.html'.

Perl

Flycheck Syntax Checker perl

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. perl-perlcritic

The first suitable syntax checker is used.

A Perl syntax checker using the Perl interpreter.

See URL `http://www.perl.org'.
Flycheck Syntax Checker perl-perlcritic
A Perl syntax checker using Perl::Critic.

See URL `https://metacpan.org/pod/Perl::Critic'.

Options

User Option flycheck-perlcritic-severity

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate integerp.

The message severity for Perl Critic.

The value of this variable is a severity level as integer, for
the `--severity' option to Perl Critic.

This variable is an option for the syntax checker `perl-perlcritic'.

This user option was introduced, or its default value was changed, in version 0.18 of the flycheck package.

PHP

Flycheck Syntax Checker php

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. php-phpmd, if there are no errors above level warning
  2. php-phpcs, if there are no errors above level warning

The first suitable syntax checker is used.

A PHP syntax checker using the PHP command line interpreter.

See URL `http://php.net/manual/en/features.commandline.php'.
Flycheck Syntax Checker php-phpmd

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. php-phpcs

The first suitable syntax checker is used.

A PHP style checker using PHP Mess Detector.

See URL `http://phpmd.org/'.

Options

User Option flycheck-phpmd-rulesets

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

The rule sets for PHP Mess Detector.

Set default rule sets and custom rule set files.

See section "Using multiple rule sets" in the PHP Mess Detector
manual at URL `http://phpmd.org/documentation/index.html'.

This variable is an option for the syntax checker `php-phpmd'.
Flycheck Syntax Checker php-phpcs
A PHP style checker using PHP_CodeSniffer.

See URL `http://pear.php.net/package/PHP_CodeSniffer/'.

Options

User Option flycheck-phpcs-standard

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The coding standard for PHP CodeSniffer.

When nil, use the default standard from the global PHP
CodeSniffer configuration.  When set to a string, pass the string
to PHP CodeSniffer which will interpret it as name as a standard,
or as path to a standard specification.

This variable is an option for the syntax checker `php-phpcs'.

Puppet

Flycheck Syntax Checker puppet-parser

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. puppet-lint, if there are no errors above level warning

The first suitable syntax checker is used.

A Puppet DSL syntax checker using puppet's own parser.

See URL `http://puppetlabs.com/'.
Flycheck Syntax Checker puppet-lint
A Puppet DSL style checker using puppet-lint.

See URL `http://puppet-lint.com/'.

Python

Flycheck Syntax Checker python-flake8
A Python syntax and style checker using Flake8.

Requires Flake8 2.0 or newer. See URL
`https://pypi.python.org/pypi/flake8'.

Options

User Option flycheck-flake8-error-level-alist
An alist mapping flake8 error IDs to Flycheck error levels.

Each item in this list is a cons cell (PATTERN . LEVEL) where
PATTERN is a regular expression matched against the error ID, and
LEVEL is a Flycheck error level symbol.

Each PATTERN is matched in the order of appearance in this list
against the error ID.  If it matches the ID, the level of the
corresponding error is set to LEVEL.  An error that is not
matched by any PATTERN defaults to warning level.

This option exists because flake8 categorises errors by the
underlying tool that produced them (e.g. F for pyflakes messages,
E for pep8 messages, etc.).  These categorisations do not map
directly to Flycheck error levels.  Hence, this option exists to
allow for a custom mapping.  The default value handles all of the
built-in tools of flake8, and naming errors from pep8-naming.

This variable is an option for the syntax checker `python-flake8'.

This user option was introduced, or its default value was changed, in version 0.22 of the flycheck package.

User Option flycheck-flake8-maximum-complexity

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate integerp.

The maximum McCabe complexity of methods.

If nil, do not check the complexity of methods.  If set to an
integer, report any complexity greater than the value of this
variable as warning.

If set to an integer, this variable overrules any similar setting
in the configuration file denoted by `flycheck-flake8rc'.

This variable is an option for the syntax checker `python-flake8'.
User Option flycheck-flake8-maximum-line-length

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate integerp.

The maximum length of lines.

If set to an integer, the value of this variable denotes the
maximum length of lines, overruling any similar setting in the
configuration file denoted by `flycheck-flake8rc'.  An error will
be reported for any line longer than the value of this variable.

If set to nil, use the maximum line length from the configuration
file denoted by `flycheck-flake8rc', or the PEP 8 recommendation
of 79 characters if there is no configuration with this setting.

This variable is an option for the syntax checker `python-flake8'.

Configuration file

User Option flycheck-flake8rc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `python-flake8'.
Flycheck Syntax Checker python-pylint
A Python syntax and style checker using Pylint.

This syntax checker requires Pylint 1.0 or newer.

See URL `http://www.pylint.org/'.

Configuration file

User Option flycheck-pylintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `python-pylint'.
Flycheck Syntax Checker python-pycompile
A Python syntax checker using Python's builtin compiler.

See URL `https://docs.python.org/3.4/library/py_compile.html'.

See also

flycheck-pyflakes adds a Python syntax checker using Pyflakes.

Racket

Flycheck Syntax Checker racket
A Racket syntax checker using the Racket compiler.

See URL `http://racket-lang.org/'.

RPM SPEC

Flycheck Syntax Checker rpm-rpmlint
A RPM SPEC file syntax checker using rpmlint.

See URL `http://sourceforge.net/projects/rpmlint/'.

ReStructuredText

Flycheck Syntax Checker rst
A ReStructuredText (RST) syntax checker using Docutils.

See URL `http://docutils.sourceforge.net/'.
Flycheck Syntax Checker rst-sphinx
A ReStructuredText (RST) syntax checker using Sphinx.

Requires Sphinx 1.2 or newer.  See URL `http://sphinx-doc.org'.

Options

User Option flycheck-sphinx-warn-on-missing-references

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to warn about missing references in Sphinx.

When non-nil (the default), warn about all missing references in
Sphinx via `-n'.

This variable is an option for the syntax checker `rst-sphinx'.

This user option was introduced, or its default value was changed, in version 0.17 of the flycheck package.

Ruby

Flycheck Syntax Checker ruby-rubocop

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. ruby-rubylint, if there are no errors above level warning

The first suitable syntax checker is used.

A Ruby syntax and style checker using the RuboCop tool.

See URL `http://batsov.com/rubocop/'.

Options

User Option flycheck-rubocop-lint-only

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to only report code issues in Rubocop.

When non-nil, only report code issues in Rubocop, via `--lint'.
Otherwise report style issues as well.

This variable is an option for the syntax checker `ruby-rubocop'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

Configuration file

User Option flycheck-rubocoprc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `ruby-rubocop'.
Flycheck Syntax Checker ruby-rubylint
A Ruby syntax and code analysis checker using ruby-lint.

Requires ruby-lint 2.0 or newer.  To use `flycheck-rubylintrc',
ruby-lint 2.0.2 or newer is required.  See URL
`https://github.com/YorickPeterse/ruby-lint'.

Configuration file

User Option flycheck-rubylintrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `ruby-rubylint'.

Warning

You need ruby-lint version 2.0.2 or newer to use this variable.

Flycheck Syntax Checker ruby

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. ruby-rubylint, if there are no errors above level warning

The first suitable syntax checker is used.

A Ruby syntax checker using the standard Ruby interpreter.

Please note that the output of different Ruby versions and
implementations varies wildly.  This syntax checker supports
current versions of MRI and JRuby, but may break when used with
other implementations or future versions of these
implementations.

Please consider using `ruby-rubocop' or `ruby-rubylint' instead.

See URL `https://www.ruby-lang.org/'.
Flycheck Syntax Checker ruby-jruby

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. ruby-rubylint, if there are no errors above level warning

The first suitable syntax checker is used.

A Ruby syntax checker using the JRuby interpreter.

This syntax checker is very primitive, and may break on future
versions of JRuby.

Please consider using `ruby-rubocop' or `ruby-rubylint' instead.

See URL `http://jruby.org/'.

Rust

Flycheck Syntax Checker rust
A Rust syntax checker using Rust compiler.

This syntax checker needs Rust 0.10 or newer.

See URL `http://www.rust-lang.org'.

Options

User Option flycheck-rust-check-tests

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to check test code in Rust.

When non-nil, `rustc' is passed the `--test' flag, which will
check any code marked with the #[cfg(test)] attribute and any
functions marked with #[test]. Otherwise, `rustc' is not passed
`--test' and test code will not be checked.  Skipping `--test' is
necessary when using #![no_std], because compiling the test
runner requires `std'.

This variable is an option for the syntax checker `rust'.
User Option flycheck-rust-crate-root

Variable properties

Automatically becomes buffer-local when set. This variable is safe as a file local variable if its value satisfies the predicate stringp.

A path to the crate root for the current buffer.

The value of this variable is either a string with the path to
the crate root for the current buffer, or nil if the current buffer
is a crate.  A relative path is relative to the current buffer.

If this variable is non nil the current buffer will only be checked
if it is not modified, i.e. after it has been saved.

This variable is an option for the syntax checker `rust'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

User Option flycheck-rust-crate-type

Variable properties

Automatically becomes buffer-local when set. This variable is safe as a file local variable if its value satisfies the predicate stringp.

The type of the Rust Crate to check.

The value of this variable is a string denoting the crate type,
for the `--crate-type' flag.

This variable is an option for the syntax checker `rust'.
User Option flycheck-rust-library-path

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of library directories for Rust.

The value of this variable is a list of strings, where each
string is a directory to add to the library path of Rust.
Relative paths are relative to the file being checked.

This variable is an option for the syntax checker `rust'.

This user option was introduced, or its default value was changed, in version 0.18 of the flycheck package.

See also

The flycheck-rust extension customizes this syntax checker according to the Cargo project layout and settings.

Sass

Flycheck Syntax Checker sass
A Sass syntax checker using the Sass compiler.

See URL `http://sass-lang.com'.

Options

User Option flycheck-sass-compass

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to enable the Compass CSS framework.

When non-nil, enable the Compass CSS framework, via `--compass'.

This variable is an option for the syntax checker `sass'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

Scala

Flycheck Syntax Checker scala

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. scala-scalastyle, if there are no errors above level warning

The first suitable syntax checker is used.

A Scala syntax checker using the Scala compiler.

See URL `http://www.scala-lang.org/'.
Flycheck Syntax Checker scala-scalastyle
A Scala style checker using scalastyle.

Note that this syntax checker is not used if
`flycheck-scalastyle-jar' or `flycheck-scalastylerc' are nil or
point to non-existing files.

See URL `http://www.scalastyle.org'.

Options

User Option flycheck-scalastyle-jar

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

The path to the main JAR file of Scalastyle.

If this option is nil, or points to a non-existing file,
`scala-scalastyle' can not be used.

This variable is an option for the syntax checker `scala-scalastyle'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

Configuration file

User Option flycheck-scalastylerc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `scala-scalastyle'.

This user option was introduced, or its default value was changed, in version 0.20 of the flycheck package.

Scss

Flycheck Syntax Checker scss
A SCSS syntax checker using the SCSS compiler.

See URL `http://sass-lang.com'.

Options

User Option flycheck-scss-compass

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate booleanp.

Whether to enable the Compass CSS framework.

When non-nil, enable the Compass CSS framework, via `--compass'.

This variable is an option for the syntax checker `scss'.

This user option was introduced, or its default value was changed, in version 0.16 of the flycheck package.

Shell script languages

Flycheck Syntax Checker sh-bash

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. sh-shellcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A Bash syntax checker using the Bash shell.

See URL `http://www.gnu.org/software/bash/'.
Flycheck Syntax Checker sh-posix-dash

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. sh-shellcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A POSIX Shell syntax checker using the Dash shell.

See URL `http://gondor.apana.org.au/~herbert/dash/'.
Flycheck Syntax Checker sh-posix-bash

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. sh-shellcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A POSIX Shell syntax checker using the Bash shell.

See URL `http://www.gnu.org/software/bash/'.
Flycheck Syntax Checker sh-zsh

Chained syntax checkers

The following syntax checkers are chained after this syntax checker:

  1. sh-shellcheck, if there are no errors above level warning

The first suitable syntax checker is used.

A Zsh syntax checker using the Zsh shell.

See URL `http://www.zsh.org/'.
Flycheck Syntax Checker sh-shellcheck
A shell script syntax and style checker using Shellcheck.

See URL `https://github.com/koalaman/shellcheck/'.

Options

User Option flycheck-shellcheck-excluded-warnings

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate flycheck-string-list-p.

A list of excluded warnings for ShellCheck.

The value of this variable is a list of strings, where each
string is a warning code to be excluded from ShellCheck reports.
By default, no warnings are excluded.

This variable is an option for the syntax checker `sh-shellcheck'.

This user option was introduced, or its default value was changed, in version 0.21 of the flycheck package.

Slim

Flycheck Syntax Checker slim
A Slim syntax checker using the Slim compiler.

See URL `http://slim-lang.com'.

TeX/LaTeX

See also

LaTeX, TeX Live

Flycheck Syntax Checker tex-chktex
A TeX and LaTeX syntax and style checker using chktex.

See URL `http://www.nongnu.org/chktex/'.

Configuration file

User Option flycheck-chktexrc

Variable properties

This variable is safe as a file local variable if its value satisfies the predicate stringp.

Configuration file for `tex-chktex'.
Flycheck Syntax Checker tex-lacheck
A LaTeX syntax and style checker using lacheck.

See URL `http://www.ctan.org/pkg/lacheck'.

Texinfo

Flycheck Syntax Checker texinfo
A Texinfo syntax checker using makeinfo.

See URL `http://www.gnu.org/software/texinfo/'.

Verilog

Flycheck Syntax Checker verilog-verilator
A Verilog syntax checker using the Verilator Verilog HDL simulator.

See URL `http://www.veripool.org/wiki/verilator'.

XML

Flycheck Syntax Checker xml-xmlstarlet
A XML syntax checker and validator using the xmlstarlet utility.

See URL `http://xmlstar.sourceforge.net/'.
Flycheck Syntax Checker xml-xmllint
A XML syntax checker and validator using the xmllint utility.

The xmllint is part of libxml2, see URL
`http://www.xmlsoft.org/'.

YAML

Flycheck Syntax Checker yaml-jsyaml
A YAML syntax checker using JS-YAML.

See URL `https://github.com/nodeca/js-yaml'.
Flycheck Syntax Checker yaml-ruby
A YAML syntax checker using Ruby's YAML parser.

This syntax checker uses the YAML parser from Ruby's standard
library.

See URL `http://www.ruby-doc.org/stdlib-2.0.0/libdoc/yaml/rdoc/YAML.html'.