Download the PHP package jamesclark32/dev-audit without Composer
On this page you can find all versions of the php package jamesclark32/dev-audit. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jamesclark32/dev-audit
More information about jamesclark32/dev-audit
Files in jamesclark32/dev-audit
Package dev-audit
Short Description Quickly run a set of CLI commands and summarize their outcome
License MIT
Homepage https://github.com/jamesclark32/dev-audit
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dev-audit
Dev Audit
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.
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:
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:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of dev-audit with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0