fidry/console

Library to create CLI applications

Fund package maintenance!
theofidry

0.5.5 2022-12-18 10:49 UTC

This package is auto-updated.

Last update: 2023-01-16 09:38:18 UTC


README

Motivation: this library purpose is to provide a lighter and more robust API for console commands and/or applications to symfony/console.

It can be used either in combination with FrameworkBundle to facilitate the creation of commands or as a stand-alone package to create a CLI application app.

Key differences:

  • Leverages an IO object instead of Input + Output + SymfonyStyle which offers:
    • The API of SymfonyStyle but still access to the Input and Output objects
    • A typed API for arguments and options (the input is validated when coercing it to a stricter type)
  • Implement explicit interfaces instead of extending god classes

Table of Contents

Installation with Symfony

$ composer require theofidry/console

The Symfony Flex plugin should add the following:

<?php declare(strict_types=1);
// config/bundles.php

return [
    // ...
    // Symfony\Bundle\FrameworkBundle\Symfony\Bundle\FrameworkBundle()
    // ...
    Fidry\Console\FidryConsoleBundle::class => ['all' => true],
];

Usage preview

To implement a command you have to implement the Fidry\Console\Command\Command interface as follows:

<?php declare(strict_types=1);

namespace Acme;

use Acme\MyService;
use Fidry\Console\{ Command\Command, Command\Configuration, ExitCode, Input\IO };
use Symfony\Component\Console\Input\InputArgument;

final class CommandWithService implements Command
{
    private MyService $service;

    public function __construct(MyService $service)
    {
        $this->service = $service;
    }

    public function getConfiguration(): Configuration
    {
        return new Configuration(
            'app:foo',
            'Calls MyService',
            <<<'EOT'
            The <info>%command.name</info> command calls MyService
            EOT,
            [
                new InputArgument(
                    'username',
                    InputArgument::REQUIRED,
                    'Name of the user',
                ),
                new InputArgument(
                    'age',
                    InputArgument::OPTIONAL,
                    'Age of the user',
                ),
            ],
        );
    }

    public function execute(IO $io): int
    {
        $this->service->call(
            $io->getArgument('username')->asStringNonEmptyList(),
            $io->getArgument('age')->asNullablePositiveInteger(),
        );

        return ExitCode::SUCCESS;
    }
}

With the bundle enabled, those services are auto-configured into traditional Symfony commands.

Known limitations

Some limitations are due to lack of time dedicated to those or based on the assumption they are not necessary. Those choices may be revisited depending on of the use case presented.

  • Support for hidden commands (see doc)
  • Support for command aliases
  • Support for command usage configuration
  • Some obscure methods of Application

Inspirations

Contributing

The project provides a Makefile in which the most common commands have been registered such as fixing the coding style or running the test.

# Print the list of available commands
make
# or
make help