Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Automatically runs pylint, pep8 and pymetrics on your code, and notifies you of the results.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lintswitch
Octocat-spinner-32 plugin
Octocat-spinner-32 LICENSE.txt
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.md
Octocat-spinner-32 setup.py
README.md

lintswitch runs pylint, pep8 and pymetrics on your Python code, and jshint on your JS code, in the background.

You must tell lintswitch which files to lint. A vim plugin is included, in the contrib directory, which calls lintswitch every time you save a file.

With lintswitch, your code is constantly being watched and linted in the background, without interrupting your workflow. You view the results in a browser.

Linters and file types currently supported:

  • Python: pylint, pep8, pymetrics
  • Javascript: jshint

lintswitch has only been tested on Ubuntu, but in theory should work anywhere Python does, as long as you install the linters.

Installation

git clone git://github.com/grahamking/lintswitch.git
cd lintswitch
sudo setup.py install

Then copy: plugin/lintswitch.vim to ~/.vim/plugin/.

Dependencies

sudo apt-get install pymetrics
sudo pip install pylint
sudo pip install pep8

Note that 'pymetrics' in pypi (pip) is a different project, and won't work with lintswitch.

For jshint:

  • install nodejs: https://github.com/joyent/node/wiki/Installation
  • install jshint: npm install jshint -g

lintswitch will search your system path and virtualenv bin to find those dependencies.

All depencies are optional - if a linter is absent it will simply be ignored.

Output

Browse to localhost:8008 to view the output. Leave that window open whilst you work - it will auto-update to always display results for the file you just saved (server-sent events!).

If you have Chrome, and click 'Enable Notifications' in the top right of the window, errors will be displaying using desktop notifications.

Daemonize

In case you find lintswitch so awesome that you want to run it all the time, an upstart is included. Copy contrib/lintswitch.conf as /etc/init/lintswitch.conf, and replace my username / group with yours.

That script will start lintswitch on boot. You can also manage it manually: sudo [start|stop|restart|status] lintswitch

Configuration

All the configuration options are command line switches. See lintswitch --help for details.

Not using vim?

To use lintswitch from other editors, you need to connect to a socket and send the filename. In Python, that looks like this:

import socket
s = socket.create_connection(('127.0.0.1', 4008), 2)
s.send('%s\n' % full_path_of_file_you_want_to_lint)
s.close()

If you write a plugin for another editor, please send it my way and I will include it in contrib.

Virtualenv aware

If the file being checked is in a virtualenv, lintswitch will also look for the checkers in the virtualenv's bin directory.

pylint notes

lintswitch will change into the root of your project before running pylint, and use a .pylintrc file if there is one there. The root of your project is determined to be the first directory that does not contain an init.py file, i.e. the first directory that is not a python module.

Contribute

I'd love to add linters for other languages, so if you do that locally, please send it my way. Thanks!

Something went wrong with that request. Please try again.