symfony · norbertosus · Apr 12, 2024 · Jun 3, 2024 · Jun 20, 2024 · Jun 16, 2024
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,5 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/universal:2",
+  "features": {
+  }
+}
diff --git a/Application.php b/Application.php
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,16 @@
 CHANGELOG
 =========
 
+7.2
+---
+
+ * Add support for `FORCE_COLOR` environment variable
+ * Add `verbosity` argument to `mustRun` process helper method
+ * [BC BREAK] Add silent verbosity (`--silent`/`SHELL_VERBOSITY=-2`) to suppress all output, including errors
+ * Add `OutputInterface::isSilent()`, `Output::isSilent()`, `OutputStyle::isSilent()` methods
+ * Add a configurable finished indicator to the progress indicator to show that the progress is finished
+ * Add ability to schedule alarm signals and a `ConsoleAlarmEvent`
+
 7.1
 ---
 

diff --git a/CI/GithubActionReporter.php b/CI/GithubActionReporter.php
@@ -20,8 +20,6 @@
  */
 class GithubActionReporter
 {
-    private OutputInterface $output;
-
     /**
      * @see https://github.com/actions/toolkit/blob/5e5e1b7aacba68a53836a34db4a288c3c1c1585b/packages/core/src/command.ts#L80-L85
      */
@@ -42,9 +40,9 @@ class GithubActionReporter
         ',' => '%2C',
     ];
 
-    public function __construct(OutputInterface $output)
-    {
-        $this->output = $output;
+    public function __construct(
+        private OutputInterface $output,
+    ) {
     }
 
     public static function isGithubActionEnvironment(): bool
@@ -89,11 +87,11 @@ private function log(string $type, string $message, ?string $file = null, ?int $
 
         if (!$file) {
             // No file provided, output the message solely:
-            $this->output->writeln(sprintf('::%s::%s', $type, $message));
+            $this->output->writeln(\sprintf('::%s::%s', $type, $message));
 
             return;
         }
 
-        $this->output->writeln(sprintf('::%s file=%s,line=%s,col=%s::%s', $type, strtr($file, self::ESCAPED_PROPERTIES), strtr($line ?? 1, self::ESCAPED_PROPERTIES), strtr($col ?? 0, self::ESCAPED_PROPERTIES), $message));
+        $this->output->writeln(\sprintf('::%s file=%s,line=%s,col=%s::%s', $type, strtr($file, self::ESCAPED_PROPERTIES), strtr($line ?? 1, self::ESCAPED_PROPERTIES), strtr($col ?? 0, self::ESCAPED_PROPERTIES), $message));
     }
 }
diff --git a/Color.php b/Color.php
@@ -60,7 +60,7 @@ public function __construct(string $foreground = '', string $background = '', ar
 
         foreach ($options as $option) {
             if (!isset(self::AVAILABLE_OPTIONS[$option])) {
-                throw new InvalidArgumentException(sprintf('Invalid option specified: "%s". Expected one of (%s).', $option, implode(', ', array_keys(self::AVAILABLE_OPTIONS))));
+                throw new InvalidArgumentException(\sprintf('Invalid option specified: "%s". Expected one of (%s).', $option, implode(', ', array_keys(self::AVAILABLE_OPTIONS))));
             }
 
             $this->options[$option] = self::AVAILABLE_OPTIONS[$option];
@@ -88,7 +88,7 @@ public function set(): string
             return '';
         }
 
-        return sprintf("\033[%sm", implode(';', $setCodes));
+        return \sprintf("\033[%sm", implode(';', $setCodes));
     }
 
     public function unset(): string
@@ -107,7 +107,7 @@ public function unset(): string
             return '';
         }
 
-        return sprintf("\033[%sm", implode(';', $unsetCodes));
+        return \sprintf("\033[%sm", implode(';', $unsetCodes));
     }
 
     private function parseColor(string $color, bool $background = false): string
@@ -128,6 +128,6 @@ private function parseColor(string $color, bool $background = false): string
             return ($background ? '10' : '9').self::BRIGHT_COLORS[$color];
         }
 
-        throw new InvalidArgumentException(sprintf('Invalid "%s" color; expected one of (%s).', $color, implode(', ', array_merge(array_keys(self::COLORS), array_keys(self::BRIGHT_COLORS)))));
+        throw new InvalidArgumentException(\sprintf('Invalid "%s" color; expected one of (%s).', $color, implode(', ', array_merge(array_keys(self::COLORS), array_keys(self::BRIGHT_COLORS)))));
     }
 }
diff --git a/Command/Command.php b/Command/Command.php
@@ -395,7 +395,7 @@ public function getDefinition(): InputDefinition
      */
     public function getNativeDefinition(): InputDefinition
     {
-        return $this->definition ?? throw new LogicException(sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', static::class));
+        return $this->definition ?? throw new LogicException(\sprintf('Command class "%s" is not correctly initialized. You probably forgot to call the parent constructor.', static::class));
     }
 
     /**
@@ -603,7 +603,7 @@ public function getSynopsis(bool $short = false): string
         $key = $short ? 'short' : 'long';
 
         if (!isset($this->synopsis[$key])) {
-            $this->synopsis[$key] = trim(sprintf('%s %s', $this->name, $this->definition->getSynopsis($short)));
+            $this->synopsis[$key] = trim(\sprintf('%s %s', $this->name, $this->definition->getSynopsis($short)));
         }
 
         return $this->synopsis[$key];
@@ -617,7 +617,7 @@ public function getSynopsis(bool $short = false): string
     public function addUsage(string $usage): static
     {
         if (!str_starts_with($usage, $this->name)) {
-            $usage = sprintf('%s %s', $this->name, $usage);
+            $usage = \sprintf('%s %s', $this->name, $usage);
         }
 
         $this->usages[] = $usage;
@@ -642,7 +642,7 @@ public function getUsages(): array
     public function getHelper(string $name): HelperInterface
     {
         if (null === $this->helperSet) {
-            throw new LogicException(sprintf('Cannot retrieve helper "%s" because there is no HelperSet defined. Did you forget to add your command to the application or to set the application on the command using the setApplication() method? You can also set the HelperSet directly using the setHelperSet() method.', $name));
+            throw new LogicException(\sprintf('Cannot retrieve helper "%s" because there is no HelperSet defined. Did you forget to add your command to the application or to set the application on the command using the setApplication() method? You can also set the HelperSet directly using the setHelperSet() method.', $name));
         }
 
         return $this->helperSet->get($name);
@@ -658,7 +658,7 @@ public function getHelper(string $name): HelperInterface
     private function validateName(string $name): void
     {
         if (!preg_match('/^[^\:]++(\:[^\:]++)*$/', $name)) {
-            throw new InvalidArgumentException(sprintf('Command name "%s" is invalid.', $name));
+            throw new InvalidArgumentException(\sprintf('Command name "%s" is invalid.', $name));
         }
     }
 }
diff --git a/Command/CompleteCommand.php b/Command/CompleteCommand.php
@@ -74,7 +74,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             // "symfony" must be kept for compat with the shell scripts generated by Symfony Console 5.4 - 6.1
             $version = $input->getOption('symfony') ? '1' : $input->getOption('api-version');
             if ($version && version_compare($version, self::COMPLETION_API_VERSION, '<')) {
-                $message = sprintf('Completion script version is not supported ("%s" given, ">=%s" required).', $version, self::COMPLETION_API_VERSION);
+                $message = \sprintf('Completion script version is not supported ("%s" given, ">=%s" required).', $version, self::COMPLETION_API_VERSION);
                 $this->log($message);
 
                 $output->writeln($message.' Install the Symfony completion script again by using the "completion" command.');
@@ -88,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
 
             if (!$completionOutput = $this->completionOutputs[$shell] ?? false) {
-                throw new \RuntimeException(sprintf('Shell completion is not supported for your shell: "%s" (supported: "%s").', $shell, implode('", "', array_keys($this->completionOutputs))));
+                throw new \RuntimeException(\sprintf('Shell completion is not supported for your shell: "%s" (supported: "%s").', $shell, implode('", "', array_keys($this->completionOutputs))));
             }
 
             $completionInput = $this->createCompletionInput($input);
@@ -98,13 +98,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 '',
                 '<comment>'.date('Y-m-d H:i:s').'</>',
                 '<info>Input:</> <comment>("|" indicates the cursor position)</>',
-                '  '.(string) $completionInput,
+                '  '.$completionInput,
                 '<info>Command:</>',
-                '  '.(string) implode(' ', $_SERVER['argv']),
+                '  '.implode(' ', $_SERVER['argv']),
                 '<info>Messages:</>',
             ]);
 
-            $command = $this->findCommand($completionInput, $output);
+            $command = $this->findCommand($completionInput);
             if (null === $command) {
                 $this->log('  No command found, completing using the Application class.');
 
@@ -185,7 +185,7 @@ private function createCompletionInput(InputInterface $input): CompletionInput
         return $completionInput;
     }
 
-    private function findCommand(CompletionInput $completionInput, OutputInterface $output): ?Command
+    private function findCommand(CompletionInput $completionInput): ?Command
     {
         try {
             $inputName = $completionInput->getFirstArgument();

diff --git a/Command/DumpCompletionCommand.php b/Command/DumpCompletionCommand.php
@@ -35,7 +35,7 @@ protected function configure(): void
         $commandName = basename($fullCommand);
         $fullCommand = @realpath($fullCommand) ?: $fullCommand;
 
-        $shell = $this->guessShell();
+        $shell = self::guessShell();
         [$rcFile, $completionFile] = match ($shell) {
             'fish' => ['~/.config/fish/config.fish', "/etc/fish/completions/$commandName.fish"],
             'zsh' => ['~/.zshrc', '$fpath[1]/_'.$commandName],
@@ -98,9 +98,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $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)));
+                $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)));
+                $output->writeln(\sprintf('<error>Shell not detected, Symfony shell completion only supports "%s").</>', implode('", "', $supportedShells)));
             }
 
             return 2;

diff --git a/CommandLoader/ContainerCommandLoader.php b/CommandLoader/ContainerCommandLoader.php
@@ -34,7 +34,7 @@ public function __construct(
     public function get(string $name): Command
     {
         if (!$this->has($name)) {
-            throw new CommandNotFoundException(sprintf('Command "%s" does not exist.', $name));
+            throw new CommandNotFoundException(\sprintf('Command "%s" does not exist.', $name));
         }
 
         return $this->container->get($this->commandMap[$name]);

diff --git a/CommandLoader/FactoryCommandLoader.php b/CommandLoader/FactoryCommandLoader.php
@@ -37,7 +37,7 @@ public function has(string $name): bool
     public function get(string $name): Command
     {
         if (!isset($this->factories[$name])) {
-            throw new CommandNotFoundException(sprintf('Command "%s" does not exist.', $name));
+            throw new CommandNotFoundException(\sprintf('Command "%s" does not exist.', $name));
         }
 
         $factory = $this->factories[$name];

diff --git a/Completion/CompletionInput.php b/Completion/CompletionInput.php
@@ -123,13 +123,13 @@ public function bind(InputDefinition $definition): void
         if ($this->currentIndex >= \count($this->tokens)) {
             if (!isset($this->arguments[$argumentName]) || $this->definition->getArgument($argumentName)->isArray()) {
                 $this->completionName = $argumentName;
-                $this->completionValue = '';
             } else {
                 // we've reached the end
                 $this->completionType = self::TYPE_NONE;
                 $this->completionName = null;
-                $this->completionValue = '';
             }
+
+            $this->completionValue = '';
         }
     }
 
@@ -226,7 +226,7 @@ private function isCursorFree(): bool
         return $this->currentIndex >= $nrOfTokens;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         $str = '';
         foreach ($this->tokens as $i => $token) {

diff --git a/Cursor.php b/Cursor.php
@@ -36,7 +36,7 @@ public function __construct(
      */
     public function moveUp(int $lines = 1): static
     {
-        $this->output->write(sprintf("\x1b[%dA", $lines));
+        $this->output->write(\sprintf("\x1b[%dA", $lines));
 
         return $this;
     }
@@ -46,7 +46,7 @@ public function moveUp(int $lines = 1): static
      */
     public function moveDown(int $lines = 1): static
     {
-        $this->output->write(sprintf("\x1b[%dB", $lines));
+        $this->output->write(\sprintf("\x1b[%dB", $lines));
 
         return $this;
     }
@@ -56,7 +56,7 @@ public function moveDown(int $lines = 1): static
      */
     public function moveRight(int $columns = 1): static
     {
-        $this->output->write(sprintf("\x1b[%dC", $columns));
+        $this->output->write(\sprintf("\x1b[%dC", $columns));
 
         return $this;
     }
@@ -66,7 +66,7 @@ public function moveRight(int $columns = 1): static
      */
     public function moveLeft(int $columns = 1): static
     {
-        $this->output->write(sprintf("\x1b[%dD", $columns));
+        $this->output->write(\sprintf("\x1b[%dD", $columns));
 
         return $this;
     }
@@ -76,7 +76,7 @@ public function moveLeft(int $columns = 1): static
      */
     public function moveToColumn(int $column): static
     {
-        $this->output->write(sprintf("\x1b[%dG", $column));
+        $this->output->write(\sprintf("\x1b[%dG", $column));
 
         return $this;
     }
@@ -86,7 +86,7 @@ public function moveToColumn(int $column): static
      */
     public function moveToPosition(int $column, int $row): static
     {
-        $this->output->write(sprintf("\x1b[%d;%dH", $row + 1, $column));
+        $this->output->write(\sprintf("\x1b[%d;%dH", $row + 1, $column));
 
         return $this;
     }
@@ -195,7 +195,7 @@ public function getCurrentPosition(): array
 
         $code = trim(fread($this->input, 1024));
 
-        shell_exec(sprintf('stty %s', $sttyMode));
+        shell_exec(\sprintf('stty %s', $sttyMode));
 
         sscanf($code, "\033[%d;%dR", $row, $col);
 

diff --git a/DataCollector/CommandDataCollector.php b/DataCollector/CommandDataCollector.php
@@ -118,7 +118,7 @@ public function getCommand(): array
     public function getInterruptedBySignal(): ?string
     {
         if (isset($this->data['interrupted_by_signal'])) {
-            return sprintf('%s (%d)', SignalMap::getSignalName($this->data['interrupted_by_signal']), $this->data['interrupted_by_signal']);
+            return \sprintf('%s (%d)', SignalMap::getSignalName($this->data['interrupted_by_signal']), $this->data['interrupted_by_signal']);
         }
 
         return null;
@@ -204,15 +204,15 @@ public function getInteractiveInputs(): array
     public function getSignalable(): array
     {
         return array_map(
-            static fn (int $signal): string => sprintf('%s (%d)', SignalMap::getSignalName($signal), $signal),
+            static fn (int $signal): string => \sprintf('%s (%d)', SignalMap::getSignalName($signal), $signal),
             $this->data['signalable']
         );
     }
 
     public function getHandledSignals(): array
     {
         $keys = array_map(
-            static fn (int $signal): string => sprintf('%s (%d)', SignalMap::getSignalName($signal), $signal),
+            static fn (int $signal): string => \sprintf('%s (%d)', SignalMap::getSignalName($signal), $signal),
             array_keys($this->data['handled_signals'])
         );
 

diff --git a/DependencyInjection/AddConsoleCommandPass.php b/DependencyInjection/AddConsoleCommandPass.php
@@ -45,15 +45,15 @@ public function process(ContainerBuilder $container): void
                 $aliases = $tags[0]['command'];
             } else {
                 if (!$r = $container->getReflectionClass($class)) {
-                    throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
+                    throw new InvalidArgumentException(\sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
                 }
                 if (!$r->isSubclassOf(Command::class)) {
-                    throw new InvalidArgumentException(sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
+                    throw new InvalidArgumentException(\sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
                 }
                 $aliases = str_replace('%', '%%', $class::getDefaultName() ?? '');
             }
 
-            $aliases = explode('|', $aliases ?? '');
+            $aliases = explode('|', $aliases);
             $commandName = array_shift($aliases);
 
             if ($isHidden = '' === $commandName) {
@@ -102,10 +102,10 @@ public function process(ContainerBuilder $container): void
 
             if (!$description) {
                 if (!$r = $container->getReflectionClass($class)) {
-                    throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
+                    throw new InvalidArgumentException(\sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
                 }
                 if (!$r->isSubclassOf(Command::class)) {
-                    throw new InvalidArgumentException(sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
+                    throw new InvalidArgumentException(\sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, 'console.command', Command::class));
                 }
                 $description = str_replace('%', '%%', $class::getDefaultDescription() ?? '');
             }

diff --git a/Descriptor/ApplicationDescription.php b/Descriptor/ApplicationDescription.php
@@ -70,7 +70,7 @@ public function getCommands(): array
     public function getCommand(string $name): Command
     {
         if (!isset($this->commands[$name]) && !isset($this->aliases[$name])) {
-            throw new CommandNotFoundException(sprintf('Command "%s" does not exist.', $name));
+            throw new CommandNotFoundException(\sprintf('Command "%s" does not exist.', $name));
         }
 
         return $this->commands[$name] ?? $this->aliases[$name];

diff --git a/Descriptor/Descriptor.php b/Descriptor/Descriptor.php
@@ -38,7 +38,7 @@ public function describe(OutputInterface $output, object $object, array $options
             $object instanceof InputDefinition => $this->describeInputDefinition($object, $options),
             $object instanceof Command => $this->describeCommand($object, $options),
             $object instanceof Application => $this->describeApplication($object, $options),
-            default => throw new InvalidArgumentException(sprintf('Object of type "%s" is not describable.', get_debug_type($object))),
+            default => throw new InvalidArgumentException(\sprintf('Object of type "%s" is not describable.', get_debug_type($object))),
         };
     }