Download the PHP package artarts36/laravel-schedule-documentator without Composer
On this page you can find all versions of the php package artarts36/laravel-schedule-documentator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download artarts36/laravel-schedule-documentator
More information about artarts36/laravel-schedule-documentator
Files in artarts36/laravel-schedule-documentator
Package laravel-schedule-documentator
Short Description Laravel Schedule Documentator
License MIT
Informations about the package laravel-schedule-documentator
Laravel Schedule Documentator
This package provides automatic generation of documentation for your app schedule
Installation
Run commands:
composer require artarts36/laravel-schedule-documentator
php artisan vendor:publish --provider="ArtARTs36\LaravelScheduleDocumentator\Providers\LaravelScheduleDocumentatorProvider" --tag=config
Simple generation:
Console Commands
Command | Description |
---|---|
artisan schedule:doc {format} {path} | Generate documentation |
Available Formats
Format | Documentator Class |
---|---|
Json | ArtARTs36\LaravelScheduleDocumentator\Documentators\JsonDocumentator |
Csv | ArtARTs36\LaravelScheduleDocumentator\Documentators\CsvDocumentator |
Md | ArtARTs36\LaravelScheduleDocumentator\Documentators\MarkdownDocumentator |
Installation:
- Run:
composer require artarts36/laravel-schedule-documentator
- Add LaravelScheduleDocumentatorProvider into providers
- Run: 'php artisan vendor:publish --tag=schedule_doc'
Add Custom Format
- Create new Documentator (by contract \ArtARTs36\LaravelScheduleDocumentator\Contracts\Documentator)
- Add entry "extension/documentator" into config/schedule_doc.php in field "ext_documentator"
Command Description
Must fill property description
in console commands for full documentation.
Use the PHP CS Fixer rule PhpCsFixerGoodFixers/laravel_command_no_empty_description
to prevent undescribed commands from entering your repository.
All versions of laravel-schedule-documentator with dependencies
illuminate/console Version ^8.0 | ^6.0 | ^7.0 | ^5.6
illuminate/support Version ^8.0 | ^6.0 | ^7.0 | ^5.6
lorisleiva/cron-translator Version ^0.2.0
artarts36/ci-git-sender Version ^0.1.1