/SublimeLinter-flake8

SublimeLinter plugin for python, using flake8.

Primary LanguagePythonMIT LicenseMIT

SublimeLinter-flake8

Build Status

This linter plugin for SublimeLinter provides an interface to flake8. It will be used with files that have the “Python” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that flake8 is installed on your system. To install flake8, do the following:

  1. Install Python and pip (Python 3 requires pip3).

  2. Install flake8 by typing the following in a terminal:

    # For python2
[sudo] pip install flake8

# For python 3
[sudo] pip3 install flake8

Note: This plugin requires flake8 2.1 or later.

Linter configuration

In order for flake8 to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once flake8 is installed and configured, you can proceed to install the SublimeLinter-flake8 plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type flake8. Among the entries you should see SublimeLinter-flake8. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-flake8 provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Setting Inline Override
@python A meta setting that indicates the python version of your source files. Use this inline or at the global level, not within the linter’s settings. ✓
select A comma-separated list of error codes to select, overrides ignore ✓
ignore A comma-separated list of error codes to ignore ✓
builtins A comma-separated string with external names that should be considered defined (e.g. "foo,bar") ✓
max-line-length The maximum allowed line length. null uses the PEP8 default of 79. ✓
max-complexity The maximum allowed code complexity. -1 allows unlimited complexity. ✓
show-code Displays the flake8 error code in the message, False by default. ✓

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!