2018-09-25 10:41:55 +10:00
|
|
|
# Eris Codebase Monitor
|
2016-09-30 16:21:29 +02:00
|
|
|
|
|
|
|
|
### Summary
|
|
|
|
|
|
2018-09-17 23:59:38 +10:00
|
|
|
Eris maintains an up-to-date set of reports for every file in a codebase.
|
2015-12-26 20:52:39 +00:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
2018-12-27 14:47:39 +10:00
|
|
|
(Tested in Ubuntu 18.10)
|
2015-12-26 20:52:39 +00:00
|
|
|
|
2018-09-17 23:59:38 +10:00
|
|
|
# git clone https://github.com/ahamilton/eris
|
|
|
|
|
# cd eris
|
2015-12-26 20:52:39 +00:00
|
|
|
# ./install-dependencies
|
2018-09-02 15:54:18 +10:00
|
|
|
# python3.7 -m pip install .
|
2017-07-10 18:38:18 +01:00
|
|
|
|
|
|
|
|
To test its working properly:
|
|
|
|
|
|
|
|
|
|
# ./test-all
|
2016-02-19 09:42:55 +00:00
|
|
|
|
2017-06-27 14:20:30 +01:00
|
|
|
then to run:
|
2016-02-19 09:42:55 +00:00
|
|
|
|
2018-09-17 23:59:38 +10:00
|
|
|
# eris <directory_path>
|
2016-09-30 16:50:35 +02:00
|
|
|
|
2018-06-01 09:48:42 +10:00
|
|
|
### Tools
|
2016-11-19 13:50:07 +01:00
|
|
|
|
2018-09-27 19:27:35 +10:00
|
|
|
Extensions(94) | Tools(61)
|
2018-06-05 08:16:49 +10:00
|
|
|
----------:| -----
|
2017-12-29 11:21:11 +10:00
|
|
|
.* | [contents](http://pygments.org/) • metadata • [git_blame](https://git-scm.com/docs/git-blame) • [git_log](https://git-scm.com/docs/git-log)
|
2018-12-27 14:47:39 +10:00
|
|
|
.py | [python_syntax](https://en.wikipedia.org/wiki/Python_syntax_and_semantics) • [python_unittests](https://docs.python.org/3/library/unittest.html) • [pydoc](https://docs.python.org/3/library/pydoc.html) • [mypy](http://mypy-lang.org/) • [python_coverage](https://coverage.readthedocs.io/) • [pycodestyle](http://pycodestyle.pycqa.org/en/latest/) • [pydocstyle](http://pycodestyle.pycqa.org/en/latest/) • [pyflakes](https://pypi.org/project/pyflakes/) • [pylint](https://www.pylint.org/) • [python_gut](https://github.com/ahamilton/eris/blob/master/gut.py) • [python_modulefinder](https://docs.python.org/3/library/modulefinder.html) • [dis](https://docs.python.org/3/library/dis.html) • [python_mccabe](https://pypi.org/project/mccabe/) • [bandit](https://pypi.org/project/bandit/)
|
2016-11-19 19:44:00 +01:00
|
|
|
.pl .pm .t | [perl_syntax](https://en.wikipedia.org/wiki/Perl) • [perldoc](http://perldoc.perl.org/) • [perltidy](http://perltidy.sourceforge.net/)
|
|
|
|
|
.pod .pod6 | [perldoc](http://perldoc.perl.org/)
|
2017-04-12 10:14:36 +02:00
|
|
|
.java | [uncrustify](https://github.com/uncrustify/uncrustify)
|
2018-06-09 11:45:11 +10:00
|
|
|
.c .h | [c_syntax_gcc](https://gcc.gnu.org/) • [splint](http://www.splint.org/) • [uncrustify](https://github.com/uncrustify/uncrustify) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/) • [clang_format](https://clang.llvm.org/docs/ClangFormat.html)
|
|
|
|
|
.cc .cpp .hpp | [cpp_syntax_gcc](https://gcc.gnu.org/) • bcpp • [uncrustify](https://github.com/uncrustify/uncrustify) • [cppcheck](http://sourceforge.net/p/cppcheck/wiki/Home/) • [clang_format](https://clang.llvm.org/docs/ClangFormat.html)
|
2018-06-05 07:06:58 +10:00
|
|
|
.rb | [ruby_syntax](http://www.ruby-lang.org/)
|
2018-06-05 08:55:18 +10:00
|
|
|
.lua | [lua_syntax](http://www.lua.org) • [lua_check](https://github.com/mpeterv/luacheck)
|
2018-06-09 11:45:11 +10:00
|
|
|
.js | [js_syntax](http://nodejs.org/) • [clang_format](https://clang.llvm.org/docs/ClangFormat.html)
|
2018-06-05 21:30:59 +10:00
|
|
|
.php | [php7_syntax](https://en.wikipedia.org/wiki/PHP)
|
|
|
|
|
.go | [gofmt](https://golang.org) • [go_vet](https://golang.org) • [golint](https://github.com/golang/lint) • [godoc](http://golang.org/x/tools)
|
2018-12-27 14:47:39 +10:00
|
|
|
.bash .sh .dash .ksh | [shellcheck](https://www.shellcheck.net/)
|
|
|
|
|
.pdf | [pdf2txt](https://euske.github.io/pdfminer/)
|
2018-06-03 23:57:45 +10:00
|
|
|
.html .htm | [html_syntax](http://www.html-tidy.org/) • [tidy](http://www.html-tidy.org/) • [html2text](http://www.mbayer.de/html2text/) • [pandoc](https://pandoc.org/)
|
2018-06-05 21:30:59 +10:00
|
|
|
.yaml .yml | [yamllint](https://github.com/adrienverge/yamllint)
|
|
|
|
|
.md .epub .docx .odt .rst | [pandoc](https://pandoc.org/)
|
2018-06-04 10:59:03 +10:00
|
|
|
.zip .jar .apk .egg .whl | [zipinfo](http://www.info-zip.org/UnZip.html)
|
2016-11-19 19:44:00 +01:00
|
|
|
.tar.gz .tgz | [tar_gz](http://www.gnu.org/software/tar/manual/tar.html)
|
|
|
|
|
.tar.bz2 | [tar_bz2](http://www.gnu.org/software/tar/manual/tar.html)
|
2018-06-04 08:27:34 +10:00
|
|
|
.rar | [unrar](http://www.rarlabs.com/)
|
2018-06-05 09:01:46 +10:00
|
|
|
.7z | [7z](http://p7zip.sourceforge.net/)
|
2018-06-04 08:39:12 +10:00
|
|
|
.xz | [unxz](http://tukaani.org/xz/)
|
2018-06-04 08:51:07 +10:00
|
|
|
.a | [ar](https://en.wikipedia.org/wiki/Ar_(Unix)) • [nm](https://linux.die.net/man/1/nm)
|
2018-06-05 21:30:59 +10:00
|
|
|
.o | [objdump_headers](https://en.wikipedia.org/wiki/Objdump) • [objdump_disassemble](https://en.wikipedia.org/wiki/Objdump) • [readelf](https://en.wikipedia.org/wiki/Objdump)
|
2018-06-04 08:51:07 +10:00
|
|
|
.so | [nm](https://linux.die.net/man/1/nm)
|
2018-06-05 21:30:59 +10:00
|
|
|
.deb | [dpkg_contents](https://wiki.debian.org/Teams/Dpkg) • [dpkg_info](https://wiki.debian.org/Teams/Dpkg)
|
|
|
|
|
.rpm | [rpm](http://rpm.org/)
|
2018-09-27 14:02:46 +10:00
|
|
|
.png .jpg .gif .bmp .tif .tiff .tga | [mediainfo](https://mediaarea.net/MediaInfo) • [pil](http://python-pillow.github.io/)
|
2018-06-04 08:30:14 +10:00
|
|
|
.mkv .mka .mks .ogg .ogm .avi .wav .mpeg .mpg .vob .mp4 .mpgv .mpv .m1v .m2v .mp2 .mp3 .asf .wma .wmv .qt .mov .rm .rmvb .ra .ifo .ac3 .dts .aac .flac .aiff .aifc .au .iff .flv .srt .ssa .ass .sami | [mediainfo](https://mediaarea.net/MediaInfo)
|
2018-09-27 19:27:35 +10:00
|
|
|
.iso | [isoinfo](https://manpages.debian.org/jessie/genisoimage/isoinfo.1.en.html)
|
