phil/console-bundle

alpha

Des commandes de console Symfony plus sûres

phil/console-bundle protège les commandes qui ne doivent pas s'exécuter n'importe où, ou pas sans réfléchir. #[ForbidEnvironment('prod')] refuse une commande dans les environnements du noyau indiqués. #[ConfirmEnvironment('prod')] demande le nom de l'environnement avant l'exécution et refuse une exécution non interactive, sauf si --force-environment est fourni. Chaque commande reçoit --timestamps, qui place l'heure devant chaque ligne qu'elle écrit, et, avec Monolog, --debug-phil, qui affiche les journaux de débogage des canaux choisis. Un sommaire de la durée, de la mémoire et du code de sortie est écrit à la fin de la commande, et lint:console-guards énumère les commandes protégées. Rien n'est conservé entre deux commandes : un processus de longue durée exécute chacune à neuf.

État

Partie	État
`#[ForbidEnvironment]` et `#[ConfirmEnvironment]` sur les classes, `__invoke()` et les commandes de niveau méthode	Implémenté et testé
`--force-environment` pour les exécutions non interactives, code de sortie 77 en cas de refus	Implémenté et testé
`--timestamps` en ISO 8601 ou relatif au départ, ou par configuration	Implémenté et testé
`--debug-phil` avec les canaux Monolog	Implémenté et testé
Le sommaire de la durée et de la mémoire	Implémenté et testé
`lint:console-guards` en tableau ou en JSON	Implémenté et testé

Documentation

Document	Ce qu'il couvre
Installation	Les prérequis, le bundle, le mode worker.
Configuration	Chaque option, avec un exemple.
Protéger les commandes	Les deux attributs, la confirmation, le code de sortie, la commande de vérification.
Sortie	Les horodatages, les journaux de débogage, le sommaire.
Points d'extension	L'interrupteur de débogage, la jauge de mémoire, l'horloge.
Tests	Les tests du bundle et son banc d'essai.
Référence	Chaque classe du bundle.

Démarrage rapide

// config/bundles.php
Phil\ConsoleBundle\PhilConsoleBundle::class => ['all' => true],

use Phil\ConsoleBundle\Domain\Attribute\ConfirmEnvironment;
use Phil\ConsoleBundle\Domain\Attribute\ForbidEnvironment;
use Symfony\Component\Console\Attribute\AsCommand;

#[AsCommand('app:database:reset')]
#[ForbidEnvironment('prod', 'staging')]
final class ResetDatabase
{
    public function __invoke(): int
}

#[AsCommand('app:customers:anonymize')]
final class AnonymizeCustomers
{
    #[ConfirmEnvironment('prod')]
    public function __invoke(): int
}

bin/console app:customers:anonymize --timestamps=relative --debug-phil=doctrine -v
bin/console app:customers:anonymize --no-interaction --force-environment
bin/console lint:console-guards

Prérequis

PHP 8.5 ou plus récent et Symfony 8.2 ou plus récent ; Monolog pour --debug-phil.

Contribuer

Les contributions sont les bienvenues sur le monodépôt PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

État

Documentation

Démarrage rapide

Prérequis

Contribuer

Licence