A utility to get a number of stats about your source code: sloc, # of comments etc...
It is designed to be easily extensible:
- language support: currently, it is limited to python, but adding other languages would be mostly as easy as defining regexp for that language
- reporters: currently, reports are output to the console, but other reporters (e.g. html) could be done
It is still WIP.
Ignores files matching .gitignore. Ignores files matching a given blacklist (such as LICENSE, README.md etc...)
I initiated this as I was reviewing a third party repo with almost no comments, and no empty lines to delimit blocks. The code itself was ok, but reading the source was annoying. Also, I stumbled upon this stackoverflow question, and decided it would be a nice exercise to implement such a tool.
$ src/main.py -h
usage: main.py [-h] [-v] pathFor instance, it can provide stats about its own source code:
src/main.py src/