Command.php
2 years ago
CompleteCommand.php
2 years ago
DumpCompletionCommand.php
2 years ago
HelpCommand.php
2 years ago
LazyCommand.php
2 years ago
ListCommand.php
2 years ago
LockableTrait.php
2 years ago
SignalableCommandInterface.php
2 years ago
DumpCompletionCommand.php
125 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWP_SCOPED\Symfony\Component\Console\Command; |
| 12 | |
| 13 | use IAWP_SCOPED\Symfony\Component\Console\Completion\CompletionInput; |
| 14 | use IAWP_SCOPED\Symfony\Component\Console\Completion\CompletionSuggestions; |
| 15 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputArgument; |
| 16 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputInterface; |
| 17 | use IAWP_SCOPED\Symfony\Component\Console\Input\InputOption; |
| 18 | use IAWP_SCOPED\Symfony\Component\Console\Output\ConsoleOutputInterface; |
| 19 | use IAWP_SCOPED\Symfony\Component\Console\Output\OutputInterface; |
| 20 | use IAWP_SCOPED\Symfony\Component\Process\Process; |
| 21 | /** |
| 22 | * Dumps the completion script for the current shell. |
| 23 | * |
| 24 | * @author Wouter de Jong <wouter@wouterj.nl> |
| 25 | * @internal |
| 26 | */ |
| 27 | final class DumpCompletionCommand extends Command |
| 28 | { |
| 29 | protected static $defaultName = 'completion'; |
| 30 | protected static $defaultDescription = 'Dump the shell completion script'; |
| 31 | public function complete(CompletionInput $input, CompletionSuggestions $suggestions) : void |
| 32 | { |
| 33 | if ($input->mustSuggestArgumentValuesFor('shell')) { |
| 34 | $suggestions->suggestValues($this->getSupportedShells()); |
| 35 | } |
| 36 | } |
| 37 | protected function configure() |
| 38 | { |
| 39 | $fullCommand = $_SERVER['PHP_SELF']; |
| 40 | $commandName = \basename($fullCommand); |
| 41 | $fullCommand = @\realpath($fullCommand) ?: $fullCommand; |
| 42 | $this->setHelp(<<<EOH |
| 43 | The <info>%command.name%</> command dumps the shell completion script required |
| 44 | to use shell autocompletion (currently only bash completion is supported). |
| 45 | |
| 46 | <comment>Static installation |
| 47 | -------------------</> |
| 48 | |
| 49 | Dump the script to a global completion file and restart your shell: |
| 50 | |
| 51 | <info>%command.full_name% bash | sudo tee /etc/bash_completion.d/{$commandName}</> |
| 52 | |
| 53 | Or dump the script to a local file and source it: |
| 54 | |
| 55 | <info>%command.full_name% bash > completion.sh</> |
| 56 | |
| 57 | <comment># source the file whenever you use the project</> |
| 58 | <info>source completion.sh</> |
| 59 | |
| 60 | <comment># or add this line at the end of your "~/.bashrc" file:</> |
| 61 | <info>source /path/to/completion.sh</> |
| 62 | |
| 63 | <comment>Dynamic installation |
| 64 | --------------------</> |
| 65 | |
| 66 | Add this to the end of your shell configuration file (e.g. <info>"~/.bashrc"</>): |
| 67 | |
| 68 | <info>eval "\$({$fullCommand} completion bash)"</> |
| 69 | EOH |
| 70 | )->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')->addOption('debug', null, InputOption::VALUE_NONE, 'Tail the completion debug log'); |
| 71 | } |
| 72 | protected function execute(InputInterface $input, OutputInterface $output) : int |
| 73 | { |
| 74 | $commandName = \basename($_SERVER['argv'][0]); |
| 75 | if ($input->getOption('debug')) { |
| 76 | $this->tailDebugLog($commandName, $output); |
| 77 | return 0; |
| 78 | } |
| 79 | $shell = $input->getArgument('shell') ?? self::guessShell(); |
| 80 | $completionFile = __DIR__ . '/../Resources/completion.' . $shell; |
| 81 | if (!\file_exists($completionFile)) { |
| 82 | $supportedShells = $this->getSupportedShells(); |
| 83 | if ($output instanceof ConsoleOutputInterface) { |
| 84 | $output = $output->getErrorOutput(); |
| 85 | } |
| 86 | if ($shell) { |
| 87 | $output->writeln(\sprintf('<error>Detected shell "%s", which is not supported by Symfony shell completion (supported shells: "%s").</>', $shell, \implode('", "', $supportedShells))); |
| 88 | } else { |
| 89 | $output->writeln(\sprintf('<error>Shell not detected, Symfony shell completion only supports "%s").</>', \implode('", "', $supportedShells))); |
| 90 | } |
| 91 | return 2; |
| 92 | } |
| 93 | $output->write(\str_replace(['{{ COMMAND_NAME }}', '{{ VERSION }}'], [$commandName, $this->getApplication()->getVersion()], \file_get_contents($completionFile))); |
| 94 | return 0; |
| 95 | } |
| 96 | private static function guessShell() : string |
| 97 | { |
| 98 | return \basename($_SERVER['SHELL'] ?? ''); |
| 99 | } |
| 100 | private function tailDebugLog(string $commandName, OutputInterface $output) : void |
| 101 | { |
| 102 | $debugFile = \sys_get_temp_dir() . '/sf_' . $commandName . '.log'; |
| 103 | if (!\file_exists($debugFile)) { |
| 104 | \touch($debugFile); |
| 105 | } |
| 106 | $process = new Process(['tail', '-f', $debugFile], null, null, null, 0); |
| 107 | $process->run(function (string $type, string $line) use($output) : void { |
| 108 | $output->write($line); |
| 109 | }); |
| 110 | } |
| 111 | /** |
| 112 | * @return string[] |
| 113 | */ |
| 114 | private function getSupportedShells() : array |
| 115 | { |
| 116 | $shells = []; |
| 117 | foreach (new \DirectoryIterator(__DIR__ . '/../Resources/') as $file) { |
| 118 | if (\str_starts_with($file->getBasename(), 'completion.') && $file->isFile()) { |
| 119 | $shells[] = $file->getExtension(); |
| 120 | } |
| 121 | } |
| 122 | return $shells; |
| 123 | } |
| 124 | } |
| 125 |