Changes¶
32 (Mar 28, 2022)¶
Highlights
Many checkers and compiler, such as
ocaml
,rust
,eslint
, and others, include end-line and end-column information. Flycheck can now highlight the exact region that they report. Authors of checker definitions can use the new:end-line
and:end-column
arguments inflycheck-error-new
, or the newend-line
andend-column
fields in error patterns. [GH-1400]Errors that checkers return for other files will now be displayed on the first line of the current buffer instead of begin discarded. The error list indicates which file each error came from, and navigation moves automatically moves between files. This change helps with compiled languages, where an error in another file may cause the current file to be considered invalid. Variables
flycheck-relevant-error-other-file-show
andflycheck-relevant-error-other-file-minimum-level
control this behavior. [GH-1427]Flycheck can now draw error indicators in margins in addition to fringes. Margins can contain arbitrary characters and images, not just monochrome bitmaps, allowing for a better experience on high-DPI screens.
flycheck-indication-mode
controls this behavior, andflycheck-set-indication-mode
can be used to automatically adjust the fringes and margins. Additionally, Flycheck’s will now use high-resolution fringe bitmaps if the fringe is wide enough [GH-1742, GH-1744]Error highlighting is now configurable, using the new
flycheck-highlighting-style
variable: instead of applying level-dependent faces (typically with wavy underlines), Flycheck can now insert delimiters around errors, or mix styles depending on how many lines an error covers. Additionally, stipples are added in the fringes to indicate errors that span multiple lines. [GH-1743]
New features and improvements
Flycheck can now trigger a syntax check automatically after switching buffers, using the
idle-buffer-switch
option inflycheck-check-syntax-automatically
. This is useful when errors in a file are due to problems in a separate file. Variablesflycheck-idle-buffer-switch-delay
andflycheck-buffer-switch-check-intermediate-buffers
control the functionality. [GH-1297]Flycheck will now use Emacs’ native XML parsing when libXML fails. This behavior can be changed by customizing
flycheck-xml-parser
. [GH-1349]flycheck-verify-setup
now shows more clearly which checkers will run in the buffer, and which are misconfigured. [GH-1478]Flycheck now locates checker executables using a customizable function,
flycheck-executable-find
. The default value of this function allows relative paths (set e.g. in file or dir-local variables) in addition to absolute paths and executable names. [GH-1485]Checkers that report error positions as a single offset from the start of the file can use the new
flycheck-error-new-at-pos
constructor instead of converting that position to a line and a column. [GH-1400]Config-file variables can now be set to a list of file names. This is useful for checkers like mypy which don’t run correctly when called from a subdirectory without passing an explicit config file. [GH-1711]
New syntax checkers:
Awk with
gawk
[GH-1708]Bazel with
bazel-buildifier
[GH-1613]CUDA with
cuda-nvcc
[GH-1508]CWL with
schema-salad-tool
[GH-1361]Elixir with
credo
[GH-1062]JSON with
json-jq
[GH-1568]Jsonnet with
jsonnet
[GH-1345]MarkdownLint CLI with
markdownlint
[GH-1366]mypy with
python-mypy
[GH-1354]Nix with
nix-linter
[GH-1530]Opam with
opam lint
[GH-1532]protobuf-prototool with
prototool
[GH-1591]Rust with
rust-clippy
[GH-1385]Ruumba with
eruby-ruumba
[GH-1616]Staticcheck with
go-staticheck
[GH-1541]terraform with
terraform fmt
,tflint
[GH-1586]Tcl with
nagelfar
[GH-1365]Text prose with
textlint
[GH-1534]VHDL with
ghdl
[GH-1160]
Checker improvements:
python-pylint
andpython-flake8
are now invoked withpython -c
, to make it easier to change between Python 2 and Python 3. [GH-1113]Add
flycheck-perl-module-list
to use specified modules when syntax checking code with theperl
checker. [GH-1207]rust-cargo
now usescargo check
andcargo test
. [GH-1289]Add
flycheck-ghc-stack-project-file
for thehaskell-stack-ghc
checker. [GH-1316]Add
flycheck-cppcheck-suppressions-file
to pass a suppressions file to cppcheck. [GH-1329]Add
--force-exclusion
flag torubocop
command. [GH-1348]Flycheck now uses ESLint’s JSON output instead of checkstyle XML. [GH-1350]
Add
flychjeck-eslint-args
to pass arguments tojavascript-eslint
. [GH-1360]Flycheck will now execute
rubocop
from the directory where aGemfile
is located. If aGemfile
does not exist, the old behaviour of running the command from the directory where.rubocop.yml
is found will be used. [GH-1368]Add
flycheck-sh-bash-args
to pass arguments tosh-bash
. [GH-1439]haskell-stack-ghc
will not try to install GHC anymore. [GH-1443]Add
flycheck-ghdl-ieee-library
to select which standard IEEE library to use for ghdl. [GH-1547]The
javascript-eslint
checker now supportstypescript-mode
by default.Add
flycheck-erlang-rebar3-profile
to select which profile to use when compiling erlang with rebar3. [GH-1560]Add
flycheck-relevant-error-other-file-show
to avoid showing errors from other files. [GH-1579]The
nix-linter
checker now has an error explainer. [GH-1586]The Emacs Lisp checker can now run in buffers not backed by files. [GH-1695]
Breaking changes
Remove the
javascript-jscs
checker. [GH-1024]Remove the
elixir-dogma
checker. [GH-1450]rust-cargo
now requires Rust 1.17 or newer. [GH-1289]rust
now requires 1.18 or newer. [GH-1501]Rename
flycheck-cargo-rustc-args
toflycheck-cargo-check-args
. [GH-1289]rust-cargo
does not use the variableflycheck-rust-args
anymore. [GH-1289]Improve detection of default directory for
haskell-ghc
to considerhpack
project files. [GH-1435]Replace
go tool vet
withgo vet
. [GH-1548]Remove the deprecated
go-megacheck
checker, which is replaced bygo-staticcheck
. [GH-1583]
31 (Oct 07, 2017)¶
Breaking changes
rust-cargo
now requires Rust 1.15 or newer [GH-1201]Remove javascript-gjslint checker
New syntax checkers:
Protobuf with
protoc
[GH-1125]systemd-analyze with
systemd-analyze
[GH-1135]Nix with
nix-instantiate
[GH-1164]Dockerfile with
hadolint
[GH-1194]AsciiDoc with
asciidoctor
[GH-1167]CSS/SCSS/LESS with
stylelint
[GH-903]Ruby with
reek
[GH-1244]Go with
megacheck
[GH-1290]LLVM IR with
llc
[GH-1302]Text prose with
proselint
[GH-1304]
New features:
Add
flycheck-xml-xmlstarlet-xsd-path
andflycheck-xml-xmllint-xsd-path
to specify an XSD schema to validate XML documents against [GH-1272]Add
flycheck-tslint-args
to pass additional arguments to tslint [GH-1186]Add an error explainer to the
rpm-rpmlint
checker usingrpmlint -I
[GH-1235]Add
flycheck-emacs-lisp-check-declare
to check function declaration in theemacs-lisp
checker [GH-1286]Add
flycheck-shellcheck-follow-sources
to check included files when using thesh-shellcheck
checker [GH-1256]
Improvements:
Use option
flycheck-go-build-tags
forgo-test
,go-vet
andgo-errcheck
as well.Add a revert function to
flycheck-verify-setup
, so hittingg
reloads the buffer.Make sure the erlang compiler is only run on compilable files.
flycheck-tslint
does not crash any more on deprecation notices [GH-1174]rust-cargo
now checks integration tests, examples and benchmarks [GH-1206]rust-cargo
does not useflycheck-rust-library-path
anymore, as dependencies are taken care of by Cargo [GH-1206]c/c++-gcc
checker now works from GCC 4.4 and up [GH-1226]
30 (Oct 12, 2016)¶
Breaking changes
Flycheck now requires flake8 3.0 or newer
Remove
--config
option inlua-luacheck
in favour ofluacheck
’s own.luacheckrc
detection. Thereforeflycheck-luacheckrc
is no longer used [GH-1057]:modes
is now mandatory for syntax checker definitions [GH-1071]Remove
javascript-eslintrc
and instead rely on eslint’s own configuration file search [GH-1085]C-c ! e
explains errors now [GH-1122]
New syntax checkers:
New features:
Add
flycheck-cargo-rustc-args
to pass multiple arguments to cargo rustc subcommand [GH-1079]Add
:error-explainer
toflycheck-define-checker
andflycheck-explain-error-at-point
to display explanations of errors [GH-1122]Add an error explainer to the
rust
andrust-cargo
checkers usingrustc --explain
[GH-1122]Add
:enabled
property toflycheck-define-checker
[GH-1089]
Improvements:
29 (Aug 28, 2016)¶
Breaking changes
New syntax checkers:
New features:
Improvements:
Add default directory for
haskell-stack-ghc
andhaskell-ghc
checkers [GH-1007]rust
andrust-cargo
checkers now support the new error format of rust 1.12 [GH-1016]flycheck-verify-checker
andflycheck-verify-setup
now include information about configuration files of syntax checkers [GH-1021] [GH-1038]
28 (Jun 05, 2016)¶
27 (May 08, 2016)¶
Breaking changes
Require PHP Code Sniffer 2.6 or newer for
php-phpcs
[GH-921]
New syntax checkers:
Improvements:
Pass checkdoc settings from Emacs to
emacs-lisp-checkdoc
[GH-741] [GH-937]
Bug fixes:
26 (Apr 27, 2016)¶
Flycheck now has a Code of Conduct which defines the acceptable behaviour and the moderation guidelines for the Flycheck community. [GH-819]
Flycheck also provides a Gitter channel now for questions and discussions about development. [GH-820]
The native Texinfo manual is again replaced with a Sphinx based documentation. We hope that this change makes the manual easier to edit and to maintain and more welcoming for new contributors. The downside is that we can not longer include a Info manual in Flycheck’s MELPA packages.
From this release onward Flycheck will use a single continuously increasing version number. Breaking changes may occur at any point.
Breaking changes:
Remove
flycheck-copy-messages-as-kill
, obsolete since Flycheck 0.22Remove
flycheck-perlcritic-verbosity
, obsolete since Flycheck 0.22Replace
flycheck-completion-system
withflycheck-completing-read-function
[GH-870]JSON syntax checkers now require
json-mode
and do not check in Javascript Mode anymorePrefer eslint over jshint for Javascript
Obsolete
flycheck-info
in favour of the newflycheck-manual
command
New syntax checkers:
New features:
Add
flycheck-puppet-lint-rc
to customise the location of the puppetlint configuration file [GH-846]Add
flycheck-puppet-lint-disabled-checks
to disable specific checks of puppetlint [GH-824]New library
flycheck-buttercup
to support writing Buttercup specs for FlycheckAdd
flycheck-perlcriticrc
to set a configuration file for Perl::Critic [GH-851]Add
flycheck-jshint-extract-javascript
to extract Javascript from HTML [GH-825]Add
flycheck-cppcheck-language-standard
to set the language standard for cppcheck [GH-862]Add
flycheck-mode-line-prefix
to customise the prefix of Flycheck’s mode line lighter [GH-879] [GH-880]Add
flycheck-go-vet-shadow
to check for shadowed variables withgo vet
[GH-765] [GH-897]Add
flycheck-ghc-stack-use-nix
to enable Nix support for Stack GHC [GH-913]
Improvements:
Map error IDs from flake8-pep257 to Flycheck error levels
Explicitly display errors at point with
C-c ! h
[GH-834]Merge message and checker columns in the error list to remove redundant ellipsis [GH-828]
Indicate disabled checkers in verification buffers [GH-749]
Do not enable Flycheck Mode in
fundamental-mode
buffers [GH-883]Write
go test
output to a temporary files [GH-887]Check whether
lintr
is actually installed [GH-911]
Bug fixes:
Fix folding of C/C++ errors from included files [GH-783]
Fix verification of SCSS-Lint checkstyle reporter
Don’t fall back to
rust
ifrust-cargo
should be used [GH-817]Don’t change current buffer when closing the error message buffer [GH-648]
Never display error message buffer in current window [GH-822]
Work around a caching issue in Rubocop [GH-844]
Fix checkdoc failure with some Emacs Lisp syntax [GH-833] [GH-845] [GH-898]
Correctly parse Haskell module name with exports right after the module name [GH-848]
Don’t hang when sending buffers to node.js processes on Windows [GH-794][GH-850]
Parse suggestions from
hlint
[GH-874]Go errcheck handles multiple
$GOPATH
entries correctly now [GH-580][GH-906]Properly handle Go build failing in a directory with multiple packages [GH-676] [GH-904]
Make cppcheck recognise C++ header files [GH-909]
Don’t run phpcs on empty buffers [GH-907]