This linter plugin for SublimeLinter provides an interface to flake8.
SublimeLinter must be installed in order to use this plugin.
Install via Package Control or git clone as usual.
Ensure that a flake8 is actually installed somewhere on your system. Typically, pip install flake8 on the command line will do that.
If you want to use a globally installed flake, make sure that it is available on the PATH. Before going any further, please read and follow the steps in "Finding a linter executable" through "Validating your PATH" in the documentation.
Otherwise configure "executable" or the "python" setting.
If you use pipenv, and you're working on a project with a Pipfile, everything should be automatic.
- SublimeLinter settings: http://sublimelinter.com/en/latest/settings.html
- Linter settings: http://sublimelinter.com/en/latest/linter_settings.html
Additional setting:
- 'ignore_fixables' (Default: True): Filter warnings that Sublime can fix automatically (e.g. trailing white-space) on save.
SublimeLinter-flake8 works with common flake8 configuration files and inline overrides. Note that, by default the working dir is set to an open folder attached to the current window of Sublime. This is of importance if your config files are located in a subfolder for example.
Use "args" if you want to set some arguments just like on the command line.
SublimeLinter-flake8 is compatible with most flake8 plugins out of the box. However, some plugins, such as flake8-aaa and flake8-pyi, select or ignore certain files based on filenames. During linting runs in SublimeLinter-flake8, these filenames are not available to flake8 and its plugins, and these plugins may appear to be "broken". A workaround for flake8 v3.0.0 and higher is to add "--stdin-display-name ${file}" to the "args" setting.