README

This package provides a Laravel console command to quickly run a set of CLI commands and summarize their outcome.

Dev Audit is intended to encapsulate a series of audits regularly run together as part of a development process, such as a pre-merge routine.

The package ships with an opinionated set of default audits based upon the author's workflow but is easily modified to suit yours instead.

Out of the box, Dev Audit runs:

• Tests (phpunit)
• Static Analysis (phpstan)
• Lint check against changed PHP files (pint)
• Lint check against changed javascript files (prettier)
• Composer audit
• Npm audit

Note that this includes phpstan and prettier which require separate installation and configuration in a Laravel project.

Once installed, Dev Audit can be run at any time using artisan dev:audit.

Under the hood, Dev Audit executes the commands from the configuration via an instance of Symfony/Process and serves as a UI wrapper to summarize the results while removing feedback clutter.

Typical output looks something like this:

Linters

This package also contains a command, dev:lint to run linters. You can run this command at any time you choose. You can also run the linters as part of the audit by adding the --lint flag thusly: php artisan dev:audit --lint.

If you always want the linters to run as part of the audit process, you can get control this by setting settings.always_lint to true in the dev-audit configuration file.

Installation

To get started, you need only to install the package via composer:

It is recommended to only require the package for development.

composer require --dev jamesclark32/dev-audit

Once installed, Dev Audit can be run at any time using artisan dev:audit.

Configuration

To adjust the audits to be run, simply publish and modify the config file.

You can publish the config file to config/dev-audit.php with:

php artisan vendor:publish --tag="dev-audit-config"

The config files contains the details of the audits to run. Audits can be added, removed, modified, or have their order adjusted.

Any new audits need only a title for display purposes and the command to run.

failure_hint content is optional, but provides the opportunity to display commands needed for likely next steps in the case of a failure.

The default audit configuration looks like this, requiring a few third-party packages:

return [
    'settings' => [
        'always_lint' => false,
    ],
    'audits' => [
        [
            'title' => 'Tests',
            'command' => './vendor/bin/pest',
        ],
        [
            'title' => 'Test coverage',
            'command' => './vendor/bin/pest --coverage --min=80',
        ],
        [
            'title' => 'Type coverage',
            'command' => './vendor/bin/pest --type-coverage --min=100',
        ],
        [
            'title' => 'PHPStan type check',
            'command' => './vendor/bin/phpstan analyze -v --memory-limit=-1',
        ],
        [
            'title' => 'Pint PHP linting (dirty files only)',
            'command' => './vendor/bin/pint --dirty --test',
        ],
        [
            'title' => 'Prettier JS linting (dirty files only)',
            'command' => 'npm run format:check:dirty',
            'failure_hint' => 'Run "npm run format:check:dirty',
        ],
        [
            'title' => 'Peck typo check',
            'command' => './vendor/bin/peck',
        ],
        [
            'title' => 'Rector code quality',
            'command' => './vendor/bin/rector --dry-run',
        ],
        [
            'title' => 'Composer Audit',
            'command' => 'composer audit',
        ],
        [
            'title' => 'NPM Audit',
            'command' => 'npm audit',
        ],
    ],
    'linters' => [
        [
            'title' => 'Pint (dirty files only)',
            'command' => './vendor/bin/pint --dirty',
        ],
        [
            'title' => 'Rector',
            'command' => './vendor/bin/rector',
        ],
        [
            'title' => 'Prettier (dirty files only)',
            'command' => 'npm run format:dirty',
        ],
        [
            'title' => 'ESX',
            'command' => 'npm run lint',
        ],
    ],
];

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• James Clark

License

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