* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Console\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\ConsoleOutputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Process\Process; /** * Dumps the completion script for the current shell. * * @author Wouter de Jong */ final class DumpCompletionCommand extends Command { /** * @deprecated since Symfony 6.1 */ protected static $defaultName = 'completion'; /** * @deprecated since Symfony 6.1 */ protected static $defaultDescription = 'Dump the shell completion script'; /** * @var mixed[] */ private $supportedShells; protected function configure() { $fullCommand = $_SERVER['PHP_SELF']; $commandName = basename($fullCommand); $fullCommand = @realpath($fullCommand) ?: $fullCommand; $shell = $this->guessShell(); switch ($shell) { case 'fish': [$rcFile, $completionFile] = ['~/.config/fish/config.fish', "/etc/fish/completions/$commandName.fish"]; break; case 'zsh': [$rcFile, $completionFile] = ['~/.zshrc', '$fpath[1]/_'.$commandName]; break; default: [$rcFile, $completionFile] = ['~/.bashrc', "/etc/bash_completion.d/$commandName"]; break; } $supportedShells = implode(', ', $this->getSupportedShells()); $this ->setHelp(<<%command.name% command dumps the shell completion script required to use shell autocompletion (currently, {$supportedShells} completion are supported). Static installation ------------------- Dump the script to a global completion file and restart your shell: %command.full_name% {$shell} | sudo tee {$completionFile} Or dump the script to a local file and source it: %command.full_name% {$shell} > completion.sh # source the file whenever you use the project source completion.sh # or add this line at the end of your "{$rcFile}" file: source /path/to/completion.sh Dynamic installation -------------------- Add this to the end of your shell configuration file (e.g. "{$rcFile}"): eval "$({$fullCommand} completion {$shell})" EOH ) ->addArgument('shell', InputArgument::OPTIONAL, 'The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given', null, \Closure::fromCallable([$this, 'getSupportedShells'])) ->addOption('debug', null, InputOption::VALUE_NONE, 'Tail the completion debug log') ; } /** * @param \Symfony\Component\Console\Input\InputInterface $input * @param \Symfony\Component\Console\Output\OutputInterface $output */ protected function execute($input, $output) { $commandName = basename($_SERVER['argv'][0]); if ($input->getOption('debug')) { $this->tailDebugLog($commandName, $output); return 0; } $shell = $input->getArgument('shell') ?? self::guessShell(); $completionFile = __DIR__.'/../Resources/completion.'.$shell; if (!file_exists($completionFile)) { $supportedShells = $this->getSupportedShells(); if ($output instanceof ConsoleOutputInterface) { $output = $output->getErrorOutput(); } if ($shell) { $output->writeln(sprintf('Detected shell "%s", which is not supported by Symfony shell completion (supported shells: "%s").', $shell, implode('", "', $supportedShells))); } else { $output->writeln(sprintf('Shell not detected, Symfony shell completion only supports "%s").', implode('", "', $supportedShells))); } return 2; } $output->write(str_replace(['{{ COMMAND_NAME }}', '{{ VERSION }}'], [$commandName, CompleteCommand::COMPLETION_API_VERSION], file_get_contents($completionFile))); return 0; } private static function guessShell() { return basename($_SERVER['SHELL'] ?? ''); } /** * @param string $commandName * @param \Symfony\Component\Console\Output\OutputInterface $output */ private function tailDebugLog($commandName, $output) { $debugFile = sys_get_temp_dir().'/sf_'.$commandName.'.log'; if (!file_exists($debugFile)) { touch($debugFile); } $process = new Process(['tail', '-f', $debugFile], null, null, null, 0); $process->run(function (string $type, string $line) use ($output): void { $output->write($line); }); } /** * @return string[] */ private function getSupportedShells() { if (isset($this->supportedShells)) { return $this->supportedShells; } $shells = []; foreach (new \DirectoryIterator(__DIR__.'/../Resources/') as $file) { if (strncmp($file->getBasename(), 'completion.', strlen('completion.')) === 0 && $file->isFile()) { $shells[] = $file->getExtension(); } } sort($shells); return $this->supportedShells = $shells; } }