Add completion to commands options and arguments

[GromNaN]

Fix #10292

How to use ?

Install bash and bash_completion on your system.

# Ubuntu
sudo apt install bash-completion
# Mac
brew install bash bash-completion@2

Init completion script

bin/composer completion bash > completion.bash
source completion.bash

bin/composer <tab,tab>

Code requires symfony/console >= 5.4 to work and PHP >= 7.1 to not fail (void return type). The dependency updates are only for testing.

Note: for testing I use the debug command described here symfony/symfony#43594 (comment)

[Seldaek]

Thanks for getting started on this, looking forward to having it available!

[dkarlovi]

Amazing work! 🚀

[dkarlovi]

Hands on experience.

[dkarlovi]

The fact that we're limiting to 150 here has non-obvious consequences when used, see #10325. This part needs some special attention to polish the UX here.

[Seldaek]

I did improve this in 55dc808 - for vendor names though when going through packagist.org results there are still so many that it's kind of a mess and you'll in most cases have to type enough of what you want to get it, but then it completes packages names within the vendor which is already quite useful IMO.

[private-packagist]

The composer.lock diff comment has been updated to reflect new changes in this PR.

[Seldaek]

Please rebase on latest main branch :)

[GromNaN]

I rebased, fixed some phpstan warnings.

[GromNaN]

Completion of subcommand is hard. I have this for beginning; but the global state of the application must be modified.

        if ($application->has($commandName = $input->getArgument('command-name'))) {
            $input = CompletionInput::fromString(preg_replace(['{\bg(?:l(?:o(?:b(?:a(?:l)?)?)?)?)?\b}', '{|$}'], ['', ''], $input->__toString(), 1), 3);
            $command = $this->getApplication()->find($commandName);
            $input->bind($command->getDefinition());
            $command->complete($input, $suggestions);
        }

[Seldaek]

Not sure what you mean by "the global state of the application must be modified"?

[GromNaN]

All the things that are done in the run method.

composer/src/Composer/Command/GlobalCommand.php

Lines 90 to 116 in 5e4a8a8

	// The COMPOSER env var should not apply to the global execution scope
	if (Platform::getEnv('COMPOSER')) {
	Platform::clearEnv('COMPOSER');
	}
	// change to global dir
	$config = Factory::createConfig();
	$home = $config->get('home');
	if (!is_dir($home)) {
	$fs = new Filesystem();
	$fs->ensureDirectoryExists($home);
	if (!is_dir($home)) {
	throw new \RuntimeException('Could not create home directory');
	}
	}
	try {
	chdir($home);
	} catch (\Exception $e) {
	throw new \RuntimeException('Could not switch to home directory "'.$home.'"', 0, $e);
	}
	$this->getIO()->writeError('<info>Changed current directory to '.$home.'</info>');
	// create new input without "global" command prefix
	$input = new StringInput(Preg::replace('{\bg(?:l(?:o(?:b(?:a(?:l)?)?)?)?)?\b}', '', $input->__toString(), 1));
	$this->getApplication()->resetComposer();

That said ... that's not so complex.

[Seldaek]

Ahh I see. Yes that should be easy to extract in a method to avoid duplication?

[Seldaek]

See dd2e2d7 - I tried doing it but it doesn't seem to work, I think I missed something, perhaps you can have a look?

[Seldaek]

OK PR is good to merge for me now except for the glitches in the global command. @GromNaN do you think you have time to look at that soon? Otherwise I'd probably merge as is and it can be done in a follow-up PR.

[GromNaN]

OK PR is good to merge for me now except for the glitches in the global command. @GromNaN do you think you have time to look at that soon? Otherwise I'd probably merge as is and it can be done in a follow-up PR.

Completion on global command needs some hooks in the Composer\Console\Application. I don't have anything conclusive ATM. Better work on it in a separate PR.

[GromNaN]

Next step will be the setup the completion script with composer.phar.
This line may be removed.

composer/src/Composer/Compiler.php

Line 123 in 575fbfb

->notPath('symfony/console/Resources/completion.bash')

[Seldaek]

Thanks @GromNaN! Let's look at the global command in a further PR then whenever you have a chance :)