Command Validator
A simple laravel package to validate console commands arguments and options.
Installation
Require/Install the package using composer:
composer require touhidurabir/command-validator
Usage
Drop the trait HasCommandValidator in any command and then put the validation rules . thats all .
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Touhidurabir\CommandValidator\HasCommandValidator;
class Test extends Command {
use HasCommandValidator;
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'run:test
{arg : The command argument}
{--opt1= : The command option 1}
{--opt2= : The command option 2}';
/**
* The command arguments and options validation rules
*
* @return array
*/
protected function rules(): array {
return [
'arg' => ['integer', 'required', 'min:100'],
'opt1' => ['integer', 'required', 'max:10'],
'opt2' => ['sometimes', 'nullable', 'string'],
];
}
}
This package also support the message or attribute override ability provided by laravel validation itself .
To override the validation message put method in the command class and fill up as needed
/**
* Any custom error message
*
* @return array
*/
protected function messages(): array {
return [];
}
To override the validation attributes put method in the command class and fill up as needed
/**
* Any custom arrtibute names to associated with error messages
*
* @return array
*/
protected function attributes(): array {
return [];
}
By default this validator do not throw an exception when the validation of arguments or options failed but print those as error in the console in a formatted way to check what is missing/failed . But if want to throw exception rather than console printing , override the method allowValidationFailureOnConsole to return false as
/**
* Should the validation error print on the console
*
* @return bool
*/
protected function allowValidationFailureOnConsole() {
return false;
}
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
1 Nov 24, 2021
56 Jul 19, 2022
56 Jul 19, 2022
6 Dec 17, 2022
3 Jul 19, 2022
28 Dec 19, 2022
22 Nov 17, 2022
3 Jul 26, 2022
7 Jan 9, 2022
10 Nov 27, 2021
125 Dec 17, 2022
12 Nov 24, 2022
2 Sep 2, 2022
4 Dec 17, 2022
1 Nov 20, 2021
1.7k Dec 28, 2022
2 Oct 7, 2022
152 Dec 15, 2022
13 Feb 8, 2022