Skip to main content

Simple source code validator with file reformatting option (remove trailing WS, pretty print XML, ..)

Project description

Simple source code validator with file reformatting option (remove trailing WS, pretty print XML, ..).

For Python code formatting it can either use autopep8 or the builtin copy of PythonTidy.

Requirements

  • Python 2.7+
  • lxml (for XML formatting)
  • pep8 (for Python checking)
  • autopep8 (for Python formatting)
  • pyflakes (for static Python code checking)
  • Jalopy (for Java code formatting)
  • coffeelint (for CoffeeScript validation)
  • PHP_CodeSniffer (for PHP style checking)
  • Puppet (for Puppet manifest validation)
  • sqlparse
  • jshint (for JavaScript checking)

On Ubuntu you can install most packages easily:

sudo apt-get install python-lxml pep8 pyflakes nodejs npm
sudo npm install -g jshint

Getting Started

Validating test files with builtin default configuration:

./codevalidator.py test/*

Fixing test files (removing trailing whitespace, XML format):

./codevalidator.py -f test/*

Using custom configuration file:

./codevalidator.py -c test/config.json test/*

Validate and fix a whole directory tree:

./codevalidator.py -c myconfig.json -rf /path/to/mydirectory

Validate a single PHP file and print detailed error messages (needs PHP_CodeSniffer with PSR standards installed!):

./codevalidator.py -v test/test.php

Running in very verbose (debug) mode to see what is validated:

./codevalidator.py -vvrc test/config.json test

Using the filter mode to “fix” stdin and write to stdout:

echo 'print 1' | ./codevalidator.py --fix --filter foobar.py && echo success

If you are annoyed by the .XX.pre-cvfix backup files you can disable them either on the command line (--no-backup) or in the config file.

Advanced Usages

You can use the --fix --filter combination to directly filter your current buffer in VIM:

:%!codevalidator.py --fix --filter %

The --fix --filter was also designed to be used with GIT filters.

To apply a formatting rule once without changing you configuration file, you can use the -a option. Formatting a Python file once with the pythontidy rule looks like:

./codevalidator.py -a pythontidy myfile.py

Known Issues

  • PythonTidy cannot parse dict comprehensions. As a workaround you can use list comprehensions and wrap it with dict.

Project details


Release history Release notifications

History Node

0.8.2

History Node

0.8.1

This version
History Node

0.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
codevalidator-0.8.tar.gz (32.9 kB) Copy SHA256 hash SHA256 Source None May 4, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page