Skip to content

Commit

Permalink
New version! Now it standalone script. DELMEAFTER test added
Browse files Browse the repository at this point in the history
  • Loading branch information
worldmind committed Feb 8, 2016
1 parent 54854e6 commit 83b9340
Show file tree
Hide file tree
Showing 27 changed files with 352 additions and 634 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ tmp/
Debian_CPANTS.txt
META.yml
inc/
*.deb
5 changes: 0 additions & 5 deletions Changes

This file was deleted.

1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
7 changes: 0 additions & 7 deletions MANIFEST.SKIP

This file was deleted.

58 changes: 0 additions & 58 deletions Makefile.PL

This file was deleted.

28 changes: 0 additions & 28 deletions README

This file was deleted.

73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Collection of non-functional tests

This utility measures 'quality' of perl code.
Quality here means:
- code must have unit tests
- 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)
- etc.

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.

## Installation

```
git clone [email protected]:worldmind/perlqual.git
cd perlqual
sudo cpanm --installdeps .
# some deps may require force install
sudo make install
```

If you use Debian based system, instead 'make install' you can use:
```
sudo checkinstall
```
For uninstall use:
```
sudo make uninstall
or
dpkg -r perlqual
```

## Using

1. Run
```
perlqual
```
in your project dir
2. Run
```
perlqual <project dir>
```
3. Run
```
PERL5LIB=./lib perlqual
```
if your libraries not installed


## Configuring

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!

## TODO

1. Make copy-paste check based on Code::CutNPaste
2. Variables names spelling?
3. my -> Readonly my ?
Loading

0 comments on commit 83b9340

Please sign in to comment.