README

Phecks

Phecks (stands for PHP-Checks) is a custom Check Runner. It will run custom checks in your codebase and will make a report of violations that need fixing.

What is it for?

For big teams to align on a styleguide beyond linting.
Used as an extra set of eyes during the Code Review.
Teams make their own checks according to their architectural decisions and styleguides.

See what checks are for.

On its own, Phecks doesn't contain any checks. You and your team are responsible for defining and implementing these checks based on your architectural decisions.

Phecks will provide you with a structure to develop and run these checks easily.

Installation

You can install the package via composer:

composer require juampi92/phecks --dev

Read the full installation instructions in the documentation.

Usage

Create a Check to make sure your team's architectural decisions are respected:

/**
 * @implements Check<ReflectionClass>
 */
class ConsoleClassesMustBeSuffixedWithCommandCheck implements Check
{
    public function __construct(
        private readonly ClassSource $source,
    ) {}

    /**
     * This method will get all the possible matches.
     */
    public function getMatches(): MatchCollection
    {
        return $this->source
            ->directory('./app/Console')
            ->run()
            ->reject(fn (ReflectionClass $class): bool => $class->isAbstract())
            ->pipe(new WhereExtendsClassFilter(\Illuminate\Console\Command::class));
    }

    /**
     * processMatch will check if the matches are
     * actual violations, and format them properly.
     */
    public function processMatch($match, FileMatch $file): array
    {
        if (Str::endsWith($match->getName(), 'Command')) {
            return [];
        }

        return [
            ViolationBuilder::make()->message('Command classes must be suffixed with \'Command\''),
        ];
    }
}

Add the class in the config phecks.checks

And run the following:

php artisan phecks:run

Testing

composer test

Credits

License

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

juampi92 / phecks

Maintainers

Details