README

A set of testing and package development tools for the Artisan's work bench.

Table of Contents

• Bench
  • Table of Contents
• Installation
• Usage Guide
• Running the Tests
  • Licensing

Installation

The tool chain installs into a PHP application like any other PHP package:

composer require --dev artisansdk/bench

Usage Guide

php artisan bench:fix [path] [--rules=/file/path] [--cache=/file/path] [--pretend]
php artisan bench:test [path] [--filter=] [--suite=] [--processes=] [--no-coverage]
php artisan bench:watch [path]
php artisan bench:report [--min-line-coverage=80] [--max-line-duplication=3] [--max-token-duplication=35]

Running the Tests

The package is unit tested with 100% line coverage and path coverage. You can run the tests by simply cloning the source, installing the dependencies, and then running ./vendor/bin/phpunit. Additionally included in the developer dependencies are some Composer scripts which can assist with Code Styling and coverage reporting:

composer test
composer watch
composer fix
composer report

See the composer.json for more details on their execution and reporting output. Note that composer watch relies upon watchman-make. Additionally composer report assumes a Unix system to run line coverage reporting. Configure the command setting the value for min = 80 to set your minimum line coverage requirements.

Licensing

Copyright (c) 2018-2023 Artisan Made, Co.

This package is released under the MIT license. Please see the LICENSE file distributed with every copy of the code for commercial licensing terms.