class DumpCompletionCommand
Dumps the completion script for the current shell.
@author Wouter de Jong <wouter@wouterj.nl>
Hierarchy
- class \Symfony\Component\Console\Command\Command
- class \Symfony\Component\Console\Command\DumpCompletionCommand extends \Symfony\Component\Console\Command\Command
Expanded class hierarchy of DumpCompletionCommand
1 file declares its use of DumpCompletionCommand
- Application.php in vendor/
symfony/ console/ Application.php
File
-
vendor/
symfony/ console/ Command/ DumpCompletionCommand.php, line 27
Namespace
Symfony\Component\Console\CommandView source
final class DumpCompletionCommand extends Command {
private array $supportedShells;
protected function configure() : void {
$fullCommand = $_SERVER['PHP_SELF'];
$commandName = basename($fullCommand);
$fullCommand = @realpath($fullCommand) ?: $fullCommand;
$shell = self::guessShell();
[
$rcFile,
$completionFile,
] = match ($shell) { 'fish' => [
'~/.config/fish/config.fish',
"/etc/fish/completions/{$commandName}.fish",
],
'zsh' => [
'~/.zshrc',
'$fpath[1]/_' . $commandName,
],
default => [
'~/.bashrc',
"/etc/bash_completion.d/{$commandName}",
],
};
$supportedShells = implode(', ', $this->getSupportedShells());
$this->setHelp(<<<EOH
The <info>%command.name%</> command dumps the shell completion script required
to use shell autocompletion (currently, {<span class="php-variable">$supportedShells</span>} completion are supported).
<comment>Static installation
-------------------</>
Dump the script to a global completion file and restart your shell:
<info>%command.full_name% {<span class="php-variable">$shell</span>} | sudo tee {<span class="php-variable">$completionFile</span>}</>
Or dump the script to a local file and source it:
<info>%command.full_name% {<span class="php-variable">$shell</span>} > completion.sh</>
<comment># source the file whenever you use the project</>
<info>source completion.sh</>
<comment># or add this line at the end of your "{<span class="php-variable">$rcFile</span>}" file:</>
<info>source /path/to/completion.sh</>
<comment>Dynamic installation
--------------------</>
Add this to the end of your shell configuration file (e.g. <info>"{<span class="php-variable">$rcFile</span>}"</>):
<info>eval "\$({<span class="php-variable">$fullCommand</span>} completion {<span class="php-variable">$shell</span>})"</>
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, $this->getSupportedShells(...))
->addOption('debug', null, InputOption::VALUE_NONE, 'Tail the completion debug log');
}
protected function execute(InputInterface $input, OutputInterface $output) : int {
$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('<error>Detected shell "%s", which is not supported by Symfony shell completion (supported shells: "%s").</>', $shell, implode('", "', $supportedShells)));
}
else {
$output->writeln(\sprintf('<error>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() : string {
return basename($_SERVER['SHELL'] ?? '');
}
private function tailDebugLog(string $commandName, OutputInterface $output) : void {
$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() : array {
if (isset($this->supportedShells)) {
return $this->supportedShells;
}
$shells = [];
foreach (new \DirectoryIterator(__DIR__ . '/../Resources/') as $file) {
if (str_starts_with($file->getBasename(), 'completion.') && $file->isFile()) {
$shells[] = $file->getExtension();
}
}
sort($shells);
return $this->supportedShells = $shells;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Command::$aliases | private | property | 1 | ||
Command::$application | private | property | |||
Command::$code | private | property | |||
Command::$definition | private | property | |||
Command::$description | private | property | 1 | ||
Command::$fullDefinition | private | property | |||
Command::$help | private | property | |||
Command::$helperSet | private | property | |||
Command::$hidden | private | property | |||
Command::$ignoreValidationErrors | private | property | 2 | ||
Command::$name | private | property | |||
Command::$processTitle | private | property | |||
Command::$synopsis | private | property | |||
Command::$usages | private | property | |||
Command::addArgument | public | function | Adds an argument. | 2 | |
Command::addOption | public | function | Adds an option. | 2 | |
Command::addUsage | public | function | Add a command usage example, it'll be prefixed with the command name. | 2 | |
Command::complete | public | function | Supplies suggestions when resolving possible completion options for input (e.g. option or argument). | 5 | |
Command::FAILURE | public | constant | |||
Command::getAliases | public | function | Returns the aliases for the command. | ||
Command::getApplication | public | function | Gets the application instance for this command. | 2 | |
Command::getDefaultDescription | public static | function | |||
Command::getDefaultName | public static | function | |||
Command::getDefinition | public | function | Gets the InputDefinition attached to this Command. | 2 | |
Command::getDescription | public | function | Returns the description for the command. | ||
Command::getHelp | public | function | Returns the help for the command. | 2 | |
Command::getHelper | public | function | Gets a helper instance by name. | 2 | |
Command::getHelperSet | public | function | Gets the helper set. | 1 | |
Command::getName | public | function | Returns the command name. | ||
Command::getNativeDefinition | public | function | Gets the InputDefinition to be used to create representations of this Command. | 2 | |
Command::getProcessedHelp | public | function | Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically. |
2 | |
Command::getSynopsis | public | function | Returns the synopsis for the command. | 2 | |
Command::getUsages | public | function | Returns alternative usages of the command. | 2 | |
Command::ignoreValidationErrors | public | function | Ignores validation errors. | 2 | |
Command::initialize | protected | function | Initializes the command after the input has been bound and before the input is validated. |
4 | |
Command::interact | protected | function | Interacts with the user. | 5 | |
Command::INVALID | public | constant | |||
Command::isEnabled | public | function | Checks whether the command is enabled or not in the current environment. | 2 | |
Command::isHidden | public | function | |||
Command::mergeApplicationDefinition | public | function | Merges the application definition with the command definition. | 2 | |
Command::run | public | function | Runs the command. | 4 | |
Command::setAliases | public | function | Sets the aliases for the command. | ||
Command::setApplication | public | function | 2 | ||
Command::setCode | public | function | Sets the code to execute when running this command. | 2 | |
Command::setDefinition | public | function | Sets an array of argument and option instances. | 2 | |
Command::setDescription | public | function | Sets the description for the command. | ||
Command::setHelp | public | function | Sets the help for the command. | 2 | |
Command::setHelperSet | public | function | 2 | ||
Command::setHidden | public | function | |||
Command::setName | public | function | Sets the name of the command. | ||
Command::setProcessTitle | public | function | Sets the process title of the command. | 2 | |
Command::SUCCESS | public | constant | |||
Command::validateName | private | function | Validates a command name. | ||
Command::__construct | public | function | 15 | ||
DumpCompletionCommand::$supportedShells | private | property | |||
DumpCompletionCommand::configure | protected | function | Configures the current command. | Overrides Command::configure | |
DumpCompletionCommand::execute | protected | function | Executes the current command. | Overrides Command::execute | |
DumpCompletionCommand::getSupportedShells | private | function | |||
DumpCompletionCommand::guessShell | private static | function | |||
DumpCompletionCommand::tailDebugLog | private | function |