artarts36/laravel-schedule-documentator

Laravel Schedule Documentator

0.2.2 2022-01-25 01:41 UTC

Requires

• php: >= 8.0
• artarts36/ci-git-sender: ^0.1.1
• illuminate/console: ^8.0 | ^6.0 | ^7.0 | ^5.6
• illuminate/support: ^8.0 | ^6.0 | ^7.0 | ^5.6
• lorisleiva/cron-translator: ^0.2.0

Requires (Dev)

• artarts36/php-cs-fixer-good-fixers: ^0.1.1
• nunomaduro/larastan: *
• orchestra/testbench: *
• phpunit/phpunit: *

MIT

• ArtARTs36

README

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:

$generator = app(\ArtARTs36\LaravelScheduleDocumentator\Services\DocGenerateHandler::class);

$generator->handle('md', '/path/to/file.md');
$generator->handle('json', '/path/to/file.json');
$generator->handle('csv', '/path/to/file.csv');

Console Commands

Available Formats

Installation:

1. Run: composer require artarts36/laravel-schedule-documentator
2. Add LaravelScheduleDocumentatorProvider into providers
3. Run: 'php artisan vendor:publish --tag=schedule_doc'

Add Custom Format

1. Create new Documentator (by contract \ArtARTs36\LaravelScheduleDocumentator\Contracts\Documentator)
2. Add entry "extension/documentator" into config/schedule_doc.php in field "ext_documentator"

    [
        'ext_documentator' => [
            // other documentators
            'zip' => MyZipDocumentator::class,
        ],
    ]

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.