forked from fa/breadcrumb-the-shire
fs
ba1186c525
- ConsoleApplication.discoverCommands() scans lib/Console/Commands/ automatically; adding a new command no longer requires editing bin/console - Command base class provides bootstrapApp(), bootstrapModuleApp(), requireBinScript() and projectRoot() helpers — eliminates fragile 4-level relative require_once paths - Per-command --help support via optional usage() method on Command - Docker-compose scheduler updated to use bin/console scheduler:run - Old bin scripts now emit deprecation hint to stderr when called directly Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
72 lines
2.1 KiB
PHP
72 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace MintyPHP\Console;
|
|
|
|
/**
|
|
* Base class for CLI commands.
|
|
*
|
|
* Subclasses define a name (e.g. 'module:sync') and implement execute().
|
|
* Bootstrap helpers provide a stable way to initialize the app without
|
|
* fragile relative paths.
|
|
*/
|
|
abstract class Command
|
|
{
|
|
abstract public function name(): string;
|
|
|
|
abstract public function description(): string;
|
|
|
|
/**
|
|
* Optional usage text shown when --help is passed for this command.
|
|
* Override in subclasses that accept arguments or options.
|
|
*/
|
|
public function usage(): string
|
|
{
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* @param list<string> $args Positional arguments (after the command name)
|
|
* @param array<string, string|bool> $options Parsed --key=value and --flag options
|
|
* @return int Exit code (0 = success)
|
|
*/
|
|
abstract public function execute(array $args, array $options): int;
|
|
|
|
// ─── Bootstrap helpers ──────────────────────────────────────────
|
|
|
|
protected function projectRoot(): string
|
|
{
|
|
return dirname(__DIR__, 2);
|
|
}
|
|
|
|
/**
|
|
* Bootstrap the app for non-module CLI commands.
|
|
* Wraps bin/cli-bootstrap.php with stable path resolution.
|
|
*/
|
|
protected function bootstrapApp(string $channel = 'cli', ?string $path = null): void
|
|
{
|
|
require_once $this->projectRoot() . '/bin/cli-bootstrap.php';
|
|
|
|
cliBootstrapApp($channel, $path ?? 'bin/console ' . $this->name());
|
|
}
|
|
|
|
/**
|
|
* Bootstrap the app for module CLI commands.
|
|
* Loads the module CLI infrastructure (error policy, locking, app container).
|
|
*/
|
|
protected function bootstrapModuleApp(): void
|
|
{
|
|
require_once $this->projectRoot() . '/bin/module-cli-bootstrap.php';
|
|
|
|
moduleCliBootstrapApp();
|
|
}
|
|
|
|
/**
|
|
* Require a bin script by name (e.g. 'module-migrate.php').
|
|
* Resolves the path from projectRoot — no fragile relative paths.
|
|
*/
|
|
protected function requireBinScript(string $filename): void
|
|
{
|
|
require_once $this->projectRoot() . '/bin/' . $filename;
|
|
}
|
|
}
|