vericode 1.0.1

Multi-language code verification tool

VeriCode

A plugin-based python tool that to be used with various code checkers. The tool currently has plugins for pylint, flake8 and pydocstyle. It will have support for TypeScript in the future.

How to use

The tool can be used by running the following command:

python3 vericode.py -t <tool> -s <source>

Examples

Standard flake8 test of the code in the given directory:

python3 vericode.py -t flake8 -s directory or file

Only report files that have a certain flake8 error:

python3 vericode.py --select error_code -t flake8 -s directory or file

Standard pylint test of the code in the given directory. In this mode, the tool reports processed files, their individual pylint scores and the average score for the directory:

python3 vericode.py -t pylint -s directory or file

Pure pylint error reporting:

python3 vericode.py --errors-only -t pylint -s directory or file

Only report files that have a pylint score below a certain threshold:

python3 vericode.py --scores-less-than threshold -t pylint -s directory or file

In the case there are such files, the tool will print them out and consider the run failed.

Standard pydocstyle test of the code in the given directory:

python3 vericode.py -t pydocstyle -s directory or file

Limitations

• Only one directory or file can be processed at a time. If a directory is given, the tool will process all files in the directory and its subdirectories.
• --select flag is only supported for flake8 tests.