Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 1.93 KB

README.md

File metadata and controls

69 lines (47 loc) · 1.93 KB

Phecks: PHP Checks

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

To-do, describe this package.

Installation

You can install the package via composer:

composer require juampi92/phecks

You can publish the config file with:

php artisan vendor:publish --tag="phecks:config"

This is the contents of the published config file:

return [
    'checks' => [],
    'baseline' => '.phecks.baseline.json',
];

Usage

php artisan phecks:run

Testing

composer test

Contribution

List of tasks missing for the release:

  • Improve Console formatter to list tips and errors in a clearer way (more similar to PHPStan).
  • Make a progress bar for the checks.
  • Make an ArtisanSource (php artisan list).
  • Figure out how to use the filter + map together. Solution: split into two methods like PHPStan does.
  • Finish the idea of Extractors. Pipe? Transformers?
  • Wiki!
  • More tests!

Ideas for future releases:

  • Be able to run only one Check.
  • Allow configuration of Checks (using the config).

Credits

License

The MIT License (MIT). Please see License File for more information.