turbolabit / php-symfony-basecommand
A minimal Symfony bundle to build your own CLI commands even faster
Installs: 69
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Type:symfony-bundle
Requires
- php: ^8.1
- league/csv: @stable
- league/html-to-markdown: @stable
- symfony/console: @stable
- symfony/lock: @stable
- symfony/string: @stable
- symfony/translation-contracts: @stable
Requires (Dev)
- phpunit/phpunit: @stable
- symfony/config: @stable
- symfony/dependency-injection: @stable
- symfony/http-kernel: @stable
- symfony/yaml: @stable
This package is auto-updated.
Last update: 2024-04-05 08:19:10 UTC
README
An extension of Symfony Console Command to build your own CLI commands better and faster.
🚀 Start your project (without Symfony)
If you are building a simple command and don't want the whole Symfony framework:
composer init
Install the package (see: Install it with composer)
Use this template to generate a MyApp.php
bootstrap file:
<?php use MyVendorName\MyApp\MyAppNameCommand; use TurboLabIt\BaseCommand\Command\AbstractBaseCommand; use Symfony\Component\Console\Input\ArrayInput; use Symfony\Component\Console\Output\ConsoleOutput; require __DIR__ . '/vendor/autoload.php'; $arrCmdArguments = [ MyAppNameCommand::CLI_ARG_MY_ARG => $argv[1], // 💡 https://github.com/TurboLabIt/php-symfony-basecommand/blob/main/src/Traits/CliOptionsTrait.php "--" . \TurboLabIt\BaseCommand\Service\Options::CLI_OPT_DRY_RUN => true, //"--" . \TurboLabIt\BaseCommand\Service\Options::CLI_OPT_BLOCK_MESSAGES => true, ]; ( new MyAppNameCommand() ) ->setName('MyAppName') ->run(new ArrayInput($arrCmdArguments), new ConsoleOutput());
Add a run.sh
for easier execution:
#!/usr/bin/env bash ## https://github.com/TurboLabIt/webstackup/blob/master/script/base.sh source "/usr/local/turbolab.it/webstackup/script/base.sh" fxHeader "🚀 My App" EXPECTED_USER=$(logname) cd $PROJECT_DIR wsuComposer install php MyApp.php MyArg1 fxEndFooter
📦 Install it with composer
symfony composer config repositories.turbolabit/php-symfony-basecommand git https://github.com/TurboLabIt/php-symfony-basecommand.git symfony composer require turbolabit/php-symfony-basecommand:dev-main
🚀 A template for your own Command
You can now use this template to build your own CLI app.
<?php declare(strict_types=1); namespace App\Command; use TurboLabIt\BaseCommand\Command\AbstractBaseCommand; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; #[AsCommand(name: 'MyCommand')] class MyCommand extends AbstractBaseCommand { // 💡 define your own specific --option(s) const CLI_OPT_MY_OPT = "my-opt"; // 💡 set your `$allow` options: https://github.com/TurboLabIt/php-symfony-basecommand/blob/main/src/Traits/CliOptionsTrait.php protected bool $allowParallelExec = ????; protected bool $allowDryRunOpt = ????; protected bool $allowBlockMessagesOpt = ????; protected bool $allowIdOpt = ????; protected bool $allowNoDownloadOpt = ????; protected bool $allowLangOpt = ????; protected bool $langOptIsMandatory = ????; public function __construct(array $arrConfig = []) { parent::__construct($arrConfig); // 💡 inject your own dependencies } protected function configure() : void { parent::configure(); // 💡 add your own specific option(s) $this->addOption(static::CLI_OPT_MY_OPT, null, InputOption::VALUE_NONE, 'Text description'); } protected function execute(InputInterface $input, OutputInterface $output): int { parent::execute($input, $output); // 💡 see https://github.com/TurboLabIt/php-symfony-basecommand/blob/main/src/Command/AbstractBaseCommand.php $this->fxTitle("Doing things..."); // ... $this->fxOK(); // 💡 see other output functions here: https://github.com/TurboLabIt/php-symfony-basecommand/blob/main/src/Traits/BashFxDirectTrait.php // 💡 the **smallest** section of data-changing ops must be wrapped like this $this->fxTitle("Changing some data..."); if( $this->isNotDryRun() ) { // ... $this->fxInfo("Some minor detail you should know"); $this->fxOK(); } // 💡 the **smallest** section of email/message-sending ops must be wrapped like this $this->fxTitle("Sending the report to the manager..."); if( $this->isSendingMessageAllowed() ) { // ... $this->fxInfo("Some minor detail you should know"); $this->fxOK(); } $this->fxTitle("Processing data..."); foreach($this->arrData as $item) { $id = $item->getId(); // 💡 use a guard clause to exclude IDs if ( !$this->isIdFilterMatch() ){ continue; } // ... } // 💡 you can fail-exit the application like this if('something\'s wrong') { return $this->endWithError(); } // 💡 you can access your own option(s) like this $myCustomAdditionalOpt = $this->getCliOptionstatic::CLI_OPT_....); if($myCustomAdditionalOpt) { // ... } // 💡 the last op must be this return $this->endWithSuccess(); } }
🧪 Test it
git clone git@github.com:TurboLabIt/php-symfony-basecommand.git cd php-symfony-basecommand clear && bash scripts/test-runner.sh