cauditor / analyzer
Generates & submits the metrics for cauditor.org
Requires
- php: ^5.3|^7.0
- ext-curl: *
- matthiasmullie/ci-sniffer: ^1.2
- matthiasmullie/path-converter: ^1.0
- pdepend/pdepend: ^2.1
- symfony/yaml: ^2.0|^3.0
Requires (Dev)
- fabpot/php-cs-fixer: ^1.0
- matthiasmullie/php-skeleton: 1.0.2
- phpunit/phpunit: ^4.8|^5.0
README
Setting it up is a ridiculously easy 2-step process:
Installation
1. Composer
Simply add a dependency on cauditor/analyzer to your composer.json file if you use Composer to manage the dependencies of your project:
composer require cauditor/analyzer --dev
This will make this library available in your CI server.
2. CI build
Add this to your .travis.yml's after_success
statements:
.travis.yml
after_success: - vendor/bin/cauditor
It'll instruct Travis CI to generate the metrics & submit them to cauditor.org.
This should also work on other CI providers, as long as you make sure
composer install --dev
is run so this client gets installed.
3. Look at those pretty metrics!
Point your browser to https://www.cauditor.org/you/your-project and look at the results!
Configuration
Add a .cauditor.yml file to the root of your project. Available configuration options (and their defaults) are:
.cauditor.yml
# path where metrics data will be exported to build_path: build/cauditor # folders to be excluded when analyzing code exclude_folders: [tests, vendor]
Note that, in addition to whatever is configured, folders 'vendors', '.git' & '.svn' are always excluded.