Linter¶
By Lex Li
This article shows how the linter works.
Overview¶
This extension can detect and launch various linters in the background to scan
the source files and report back common issues under PROBLEMS tab (which
can be opened via View | Problems menu item).
Note
As many linting rules are also available in Esbonio, you don’t need to install a specific linter if you don’t need its specific features.
Settings¶
To learn more about the settings, refer to Configuration.
Supported Linters¶
Three linters are currently supported,
rst-lint¶
This linter provides essential rules. To install it,
pip install restructuredtext_lint
doc8¶
This linter provides enhanced rules. To install it,
pip install doc8
Note
doc8 supersedes rst-lint, so rst-lint is disabled if doc8 is enabled.
rstcheck¶
This linter provides enhanced rules. To install it,
pip install -Iv rstcheck==5.0.0
Warning
rstcheck 6 is includes too many breaking changes, so it is not supported.