Collection of non-functional tests
This utility measures 'quality' of perl code. Quality here means:
- code must have unit tests with needed code coverage
- code must have low cyclomatic complexity
- code must be divided on small pieces
- Perl Best Practice used
- code style
- distribution organized like CPAN module
- code has documentation (POD)
These tests can't say: "This code is good", but they can say: "This code is not ugly, not bad".
In the past it was a collection of tests in 'xt' directory, but now it is a standalone utility.
git clone email@example.com:worldmind/perlqual.git cd perlqual sudo cpanm --installdeps . # some deps may require force install perl Makefile.PL;make;make manifest;sudo make install
If you use Debian based system, instead 'make install' you can use:
For uninstall use:
sudo make uninstall or dpkg -r perlqual
- Run in your project dir
- Outside project dir you can run
perlqual <project dir>
- If your libraries not installed run
PERL5LIB=./lib perlqual &> perlqual.report
Perlqual has one (not required) command line argument - project directory (by default it is current dir). For configuring you must create config file named .perlqual You can place this file in the home directory or in the project directory (if some project need special settings). Example and default config can be copy-pasted from DATA section of perlqual script. Some tests are disabled in default config!
- Make copy-paste check based on Code::CutNPaste
- Variables names spelling
- Immutability testing: my -> Readonly my ?
- Unify test to: test_ok($_) for @perl_files
- HTML output option
- Deep learned neural network that can recognize good code. Big good code base needed.