2016-09-30 16:21:29 +02:00
|
|
|
# Vigil Code Monitor
|
|
|
|
|
|
|
|
|
|
### Summary
|
|
|
|
|
|
|
|
|
|
Vigil shows a list of status reports for a given codebase, and keeps them
|
|
|
|
|
up to date as the codebase changes.
|
2015-12-26 20:52:39 +00:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
2016-10-15 12:51:26 +02:00
|
|
|
To run vigil: (Tested in Ubuntu 16.10 in gnome-terminal and stterm)
|
2015-12-26 20:52:39 +00:00
|
|
|
|
|
|
|
|
# git clone https://github.com/ahamilton/vigil
|
|
|
|
|
# cd vigil
|
|
|
|
|
# ./install-dependencies
|
|
|
|
|
# ./vigil <directory_path>
|
2016-02-19 09:42:55 +00:00
|
|
|
|
|
|
|
|
and to test its working properly:
|
|
|
|
|
|
|
|
|
|
# ./test-all
|
2016-09-30 16:50:35 +02:00
|
|
|
|
|
|
|
|
To run on an older ubuntu you can checkout an older version of vigil.
|
|
|
|
|
e.g. After cloning do:
|
|
|
|
|
|
|
|
|
|
# git checkout ubuntu-15.10
|
2016-11-19 13:50:07 +01:00
|
|
|
|
|
|
|
|
### Tools
|
|
|
|
|
|
2016-11-19 15:58:21 +01:00
|
|
|
Extensions | Tools
|
|
|
|
|
---------- | -----
|
2016-11-19 17:42:47 +01:00
|
|
|
.py | python_syntax • python_unittests • pydoc • [mypy](http://www.mypy-lang.org/) • [python_coverage](http://nedbatchelder.com/code/coverage/) • python_profile • [pycodestyle](https://pypi.python.org/pypi/pycodestyle) • [pyflakes](https://launchpad.net/pyflakes) • [pylint](http://www.pylint.org/) • python_gut • python_modulefinder • [python_mccabe](https://github.com/flintwork/mccabe) • [bandit](https://wiki.openstack.org/wiki/Security/Projects/Bandit)
|
2016-11-19 15:58:21 +01:00
|
|
|
.pyc | disassemble_pyc
|
2016-11-19 16:26:23 +01:00
|
|
|
.pl .pm .t | perl_syntax • perldoc • perltidy
|
2016-11-19 15:58:21 +01:00
|
|
|
.pod .pod6 | perldoc
|
2016-11-19 17:42:47 +01:00
|
|
|
.java | [uncrustify](http://uncrustify.sourceforge.net/)
|
|
|
|
|
.c .h | [splint](http://www.splint.org/) • [uncrustify](http://uncrustify.sourceforge.net/)
|
2016-11-19 16:26:23 +01:00
|
|
|
.o | objdump_headers • objdump_disassemble • readelf
|
2016-11-19 17:42:47 +01:00
|
|
|
.cpp | bcpp • [uncrustify](http://uncrustify.sourceforge.net/)
|
|
|
|
|
.pdf | [pdf2txt](http://www.unixuser.org/~euske/python/pdfminer/)
|
|
|
|
|
.html | [html_syntax](http://www.html-tidy.org/) • [tidy](http://www.html-tidy.org/) • [html2text](http://www.mbayer.de/html2text/)
|
2016-11-19 15:58:21 +01:00
|
|
|
.php | php5_syntax
|
2016-11-19 17:42:47 +01:00
|
|
|
.zip | [unzip](http://www.info-zip.org/UnZip.html)
|
2016-11-19 15:58:21 +01:00
|
|
|
.tar.gz .tgz | tar_gz
|
|
|
|
|
.tar.bz2 | tar_bz2
|
|
|
|
|
.a .so | nm
|
