grasmash / symfony-console-spinner
A utility for creating an animated spinner via Symfony Console.
Installs: 17 602
Dependents: 1
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 3
Requires
- php: >8.0
- symfony/console: ^6
Requires (Dev)
- infection/infection: ^0.26.17
- overtrue/phplint: ^4
- php-coveralls/php-coveralls: ^2.5
- phpstan/phpstan: ^1.9
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.7
This package is not auto-updated.
Last update: 2024-12-22 02:42:47 UTC
README
This utility provides two tools for use with Symfony Console:
- An animated spinner class. This is a wrapper around Symfony's built-in Progress Bar which will show a colored, animated spinner. It requires advance() to be called in order for the spinner to spin.
- A checklist class. This is a wrapper around the Spinner. It allows you to emit a checklist item, display a spinner next to it to indicate that it is in progress, and write a "message detail" under the item.
Usage
Simple Spinner
$output = new \Symfony\Component\Console\Output\ConsoleOutput(); $spinner = new Spinner($output); $spinner->setMessage('Fetching a really big file from far away'); $spinner->start(); while (getting_the_file()) { $spinner->advance(); } $spinner->finish();
Simple Checklist
$output = new \Symfony\Component\Console\Output\ConsoleOutput(); $checklist = new Checklist($output); $checklist->addItem('Fetching a really big file from far away'); while (getting_the_file()) { $checklist->updateProgressBar('Still getting the file'); } $checklist->completePreviousItem(); $checklist->addItem('Doing the next thing');
Advanced Checklist Example
use Symfony\Component\Process\Process; use Symfony\Component\Console\Output\ConsoleOutput; public function runMyCommand() { $output = new ConsoleOutput(); $checklist = new Checklist($output); $checklist->addItem('Running a command with lots of output'); $process = new Process([ 'composer', 'run-script', 'my-script', '--no-interaction', ]); $process->start(); $process->wait(function ($type, $buffer) use ($checklist, $output) { if (!$output->isVerbose() && $checklist->getItems()) { $checklist->updateProgressBar($buffer); } $output->writeln($buffer, OutputInterface::VERBOSITY_VERY_VERBOSE); }); if (!$process->isSuccessful()) { throw new \Exception('Something went wrong! {message}' . $process->getErrorOutput()); } $checklist->completePreviousItem(); }