18309234144

Committed 06 Oct 2025 10:44AM UTC coverage: 94.148% (-0.2%) from 94.308%

Build # 18309234144

Build Type

push

github

Committed by

web-flow

Commit Message

docs: more explicit docs on --rules (#9114)

Run Details

28638 of 30418 relevant lines covered (94.15%)

45.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.83

/src/Console/Command/FixCommand.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Console\Command;

use PhpCsFixer\Config;
use PhpCsFixer\ConfigInterface;
use PhpCsFixer\ConfigurationException\InvalidConfigurationException;
use PhpCsFixer\Console\Application;
use PhpCsFixer\Console\ConfigurationResolver;
use PhpCsFixer\Console\Output\ErrorOutput;
use PhpCsFixer\Console\Output\OutputContext;
use PhpCsFixer\Console\Output\Progress\ProgressOutputFactory;
use PhpCsFixer\Console\Output\Progress\ProgressOutputType;
use PhpCsFixer\Console\Report\FixReport\ReporterFactory;
use PhpCsFixer\Console\Report\FixReport\ReportSummary;
use PhpCsFixer\Error\ErrorsManager;
use PhpCsFixer\Fixer\FixerInterface;
use PhpCsFixer\FixerFactory;
use PhpCsFixer\RuleSet\RuleSets;
use PhpCsFixer\Runner\Event\FileProcessed;
use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
use PhpCsFixer\Runner\Runner;
use PhpCsFixer\ToolInfoInterface;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Formatter\OutputFormatter;
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\Console\Terminal;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Stopwatch\Stopwatch;

/**
 * @author Fabien Potencier <fabien@symfony.com>
 * @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * @final
 *
 * @internal
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
#[AsCommand(name: 'fix', description: 'Fixes a directory or a file.')]
/* final */ class FixCommand extends Command
{
    /** @TODO PHP 8.0 - remove the property */
    protected static $defaultName = 'fix';

    /** @TODO PHP 8.0 - remove the property */
    protected static $defaultDescription = 'Fixes a directory or a file.';

    private EventDispatcherInterface $eventDispatcher;

    private ErrorsManager $errorsManager;

    private Stopwatch $stopwatch;

    private ConfigInterface $defaultConfig;

    private ToolInfoInterface $toolInfo;

    private ProgressOutputFactory $progressOutputFactory;

    public function __construct(ToolInfoInterface $toolInfo)
    {
        parent::__construct();

        $this->eventDispatcher = new EventDispatcher();
        $this->errorsManager = new ErrorsManager();
        $this->stopwatch = new Stopwatch();
        $this->defaultConfig = new Config();
        $this->toolInfo = $toolInfo;
        $this->progressOutputFactory = new ProgressOutputFactory();
    }

    /**
     * {@inheritdoc}
     *
     * Override here to only generate the help copy when used.
     */
    public function getHelp(): string
    {
        return <<<'EOF'
            The <info>%command.name%</info> command tries to %command.name% as much coding standards
            problems as possible on a given file or files in a given directory and its subdirectories:

                <info>$ php %command.full_name% /path/to/dir</info>
                <info>$ php %command.full_name% /path/to/file</info>

            By default <comment>--path-mode</comment> is set to `override`, which means, that if you specify the path to a file or a directory via
            command arguments, then the paths provided to a `Finder` in config file will be ignored. You can use <comment>--path-mode=intersection</comment>
            to merge paths from the config file and from the argument:

                <info>$ php %command.full_name% --path-mode=intersection /path/to/dir</info>

            The <comment>--format</comment> option for the output format. Supported formats are `@auto` (default one on v4+), `txt` (default one on v3), `json`, `xml`, `checkstyle`, `junit` and `gitlab`.

            * `@auto` aims to auto-select best reporter for given CI or local execution (resolution into best format is outside of BC promise and is future-ready)
              * `gitlab` for GitLab
            * `@auto,{format}` takes `@auto` under CI, and {format} otherwise

            NOTE: the output for the following formats are generated in accordance with schemas

            * `checkstyle` follows the common `"checkstyle" XML schema </doc/schemas/fix/checkstyle.xsd>`_
            * `gitlab` follows the `codeclimate JSON schema </doc/schemas/fix/codeclimate.json>`_
            * `json` follows the `own JSON schema </doc/schemas/fix/schema.json>`_
            * `junit` follows the `JUnit XML schema from Jenkins </doc/schemas/fix/junit-10.xsd>`_
            * `xml` follows the `own XML schema </doc/schemas/fix/xml.xsd>`_

            The <comment>--quiet</comment> Do not output any message.

            The <comment>--verbose</comment> option will show the applied rules. When using the `txt` format it will also display progress notifications.

            NOTE: if there is an error like "errors reported during linting after fixing", you can use this to be even more verbose for debugging purpose

            * `-v`: verbose
            * `-vv`: very verbose
            * `-vvv`: debug

            EOF. /* @TODO: 4.0 - change to @PER */ <<<'EOF'

            The <comment>--rules</comment> option allows to explicitly select rules to use,
            overriding the default PSR-12 or your own project config:

                <info>$ php %command.full_name% . --rules=line_ending,full_opening_tag,indentation_type</info>

            You can also exclude the rules you don't want by placing a dash in front of the rule name, like <comment>-name_of_fixer</comment>.

                <info>$ php %command.full_name% . --rules=@Symfony,-@PSR1,-blank_line_before_statement,strict_comparison</info>

            Complete configuration for rules can be supplied using a `json` formatted string as well.

                <info>$ php %command.full_name% . --rules='{"concat_space": {"spacing": "none"}}'</info>

            The <comment>--dry-run</comment> flag will run the fixer without making changes to your files.

            The <comment>--sequential</comment> flag will enforce sequential analysis even if parallel config is provided.

            The <comment>--diff</comment> flag can be used to let the fixer output all the changes it makes.

            The <comment>--allow-risky</comment> option (pass `yes` or `no`) allows you to set whether risky rules may run. Default value is taken from config file.
            A rule is considered risky if it could change code behaviour. By default no risky rules are run.

            The <comment>--stop-on-violation</comment> flag stops the execution upon first file that needs to be fixed.

            The <comment>--show-progress</comment> option allows you to choose the way process progress is rendered:

            * <comment>none</comment>: disables progress output;
            * <comment>dots</comment>: multiline progress output with number of files and percentage on each line.
            * <comment>bar</comment>: single line progress output with number of files and calculated percentage.

            If the option is not provided, it defaults to <comment>bar</comment> unless a config file that disables output is used, in which case it defaults to <comment>none</comment>. This option has no effect if the verbosity of the command is less than <comment>verbose</comment>.

                <info>$ php %command.full_name% --verbose --show-progress=dots</info>

            By using <comment>--using-cache</comment> option with `yes` or `no` you can set if the caching
            mechanism should be used.

            The command can also read from standard input, in which case it won't
            automatically fix anything:

                <info>$ cat foo.php | php %command.full_name% --diff -</info>

            Finally, if you don't need BC kept on CLI level, you might use `PHP_CS_FIXER_FUTURE_MODE` to start using options that
            would be default in next MAJOR release and to forbid using deprecated configuration:

                <info>$ PHP_CS_FIXER_FUTURE_MODE=1 php %command.full_name% -v --diff</info>

            Exit code
            ---------

            Exit code of the `%command.name%` command is built using following bit flags:

            *  0 - OK.
            *  1 - General error (or PHP minimal requirement not matched).
            *  4 - Some files have invalid syntax (only in dry-run mode).
            *  8 - Some files need fixing (only in dry-run mode).
            * 16 - Configuration error of the application.
            * 32 - Configuration error of a Fixer.
            * 64 - Exception raised within the application.

            EOF;
    }

    protected function configure(): void
    {
        $reporterFactory = new ReporterFactory();
        $reporterFactory->registerBuiltInReporters();
        $formats = $reporterFactory->getFormats();
        array_unshift($formats, '@auto', '@auto,txt');

        $progressOutputTypes = ProgressOutputType::all();

        $this->setDefinition(
            [
                new InputArgument('path', InputArgument::IS_ARRAY, 'The path(s) that rules will be run against (each path can be a file or directory).'),
                new InputOption('path-mode', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Specify path mode (%s).', ConfigurationResolver::PATH_MODE_VALUES), ConfigurationResolver::PATH_MODE_OVERRIDE, ConfigurationResolver::PATH_MODE_VALUES),
                new InputOption('allow-risky', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Are risky fixers allowed (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),
                new InputOption('config', '', InputOption::VALUE_REQUIRED, 'The path to a config file.'),
                new InputOption('dry-run', '', InputOption::VALUE_NONE, 'Only shows which files would have been modified.'),
                new InputOption('rules', '', InputOption::VALUE_REQUIRED, 'List of rules that should be run against configured paths.', null, static function () {
                    $fixerFactory = new FixerFactory();
                    $fixerFactory->registerBuiltInFixers();
                    $fixers = array_map(static fn (FixerInterface $fixer) => $fixer->getName(), $fixerFactory->getFixers());

                    return array_merge(RuleSets::getSetDefinitionNames(), $fixers);
                }),
                new InputOption('using-cache', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Should cache be used (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),
                new InputOption('allow-unsupported-php-version', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Should the command refuse to run on unsupported PHP version (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),
                new InputOption('cache-file', '', InputOption::VALUE_REQUIRED, 'The path to the cache file.'),
                new InputOption('diff', '', InputOption::VALUE_NONE, 'Prints diff for each file.'),
                new InputOption('format', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('To output results in other formats (%s).', $formats), null, $formats),
                new InputOption('stop-on-violation', '', InputOption::VALUE_NONE, 'Stop execution on first violation.'),
                new InputOption('show-progress', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Type of progress indicator (%s).', $progressOutputTypes), null, $progressOutputTypes),
                new InputOption('sequential', '', InputOption::VALUE_NONE, 'Enforce sequential analysis.'),
            ]
        );
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $verbosity = $output->getVerbosity();

        $passedConfig = $input->getOption('config');
        $passedRules = $input->getOption('rules');

        if (null !== $passedConfig && null !== $passedRules) {
            throw new InvalidConfigurationException('Passing both `--config` and `--rules` options is not allowed.');
        }

        $resolver = new ConfigurationResolver(
            $this->defaultConfig,
            [
                'allow-risky' => $input->getOption('allow-risky'),
                'config' => $passedConfig,
                'dry-run' => $this->isDryRun($input),
                'rules' => $passedRules,
                'path' => $input->getArgument('path'),
                'path-mode' => $input->getOption('path-mode'),
                'using-cache' => $input->getOption('using-cache'),
                'allow-unsupported-php-version' => $input->getOption('allow-unsupported-php-version'),
                'cache-file' => $input->getOption('cache-file'),
                'format' => $input->getOption('format'),
                'diff' => $input->getOption('diff'),
                'stop-on-violation' => $input->getOption('stop-on-violation'),
                'verbosity' => $verbosity,
                'show-progress' => $input->getOption('show-progress'),
                'sequential' => $input->getOption('sequential'),
            ],
            getcwd(), // @phpstan-ignore argument.type
            $this->toolInfo
        );

        $reporter = $resolver->getReporter();

        $stdErr = $output instanceof ConsoleOutputInterface
            ? $output->getErrorOutput()
            : ('txt' === $reporter->getFormat() ? $output : null);

        if (null !== $stdErr) {
            $stdErr->writeln(Application::getAboutWithRuntime(true));

            if (version_compare(\PHP_VERSION, ConfigInterface::PHP_VERSION_SYNTAX_SUPPORTED.'.99', '>')) {
                $message = \sprintf(
                    'PHP CS Fixer currently supports PHP syntax only up to PHP %s, current PHP version: %s.',
                    ConfigInterface::PHP_VERSION_SYNTAX_SUPPORTED,
                    \PHP_VERSION
                );

                if (!$resolver->getUnsupportedPhpVersionAllowed()) {
                    $message .= ' Add Config::setUnsupportedPhpVersionAllowed(true) to allow executions on unsupported PHP versions. Such execution may be unstable and you may experience code modified in a wrong way.';
                    $stdErr->writeln(\sprintf(
                        $stdErr->isDecorated() ? '<bg=red;fg=white;>%s</>' : '%s',
                        $message
                    ));

                    return 1;
                }
                $message .= ' Execution may be unstable. You may experience code modified in a wrong way. Please report such cases at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Remove Config::setUnsupportedPhpVersionAllowed(true) to allow executions only on supported PHP versions.';
                $stdErr->writeln(\sprintf(
                    $stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s',
                    $message
                ));
            }

            $isParallel = $resolver->getParallelConfig()->getMaxProcesses() > 1;

            $stdErr->writeln(\sprintf(
                'Running analysis on %d core%s.',
                $resolver->getParallelConfig()->getMaxProcesses(),
                $isParallel ? \sprintf(
                    's with %d file%s per process',
                    $resolver->getParallelConfig()->getFilesPerProcess(),
                    $resolver->getParallelConfig()->getFilesPerProcess() > 1 ? 's' : ''
                ) : ' sequentially'
            ));

            /** @TODO v4 remove warnings related to parallel runner */
            $availableMaxProcesses = ParallelConfigFactory::detect()->getMaxProcesses();
            if ($isParallel || $availableMaxProcesses > 1) {
                $usageDocs = 'https://cs.symfony.com/doc/usage.html';
                $stdErr->writeln(\sprintf(
                    $stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s',
                    $isParallel
                        ? 'Parallel runner is an experimental feature and may be unstable, use it at your own risk. Feedback highly appreciated!'
                        : \sprintf(
                            'You can enable parallel runner and speed up the analysis! Please see %s for more information.',
                            $stdErr->isDecorated()
                                ? \sprintf('<href=%s;bg=yellow;fg=red;bold>usage docs</>', OutputFormatter::escape($usageDocs))
                                : $usageDocs
                        )
                ));
            }

            $configFile = $resolver->getConfigFile();
            $stdErr->writeln(\sprintf('Loaded config <comment>%s</comment>%s.', $resolver->getConfig()->getName(), null === $configFile ? '' : ' from "'.$configFile.'"'));

            if ($resolver->getUsingCache()) {
                $cacheFile = $resolver->getCacheFile();

                if (is_file($cacheFile)) {
                    $stdErr->writeln(\sprintf('Using cache file "%s".', $cacheFile));
                }
            }
        }

        $finder = new \ArrayIterator(array_filter(
            iterator_to_array($resolver->getFinder()),
            static fn (\SplFileInfo $fileInfo) => false !== $fileInfo->getRealPath(),
        ));

        if (null !== $stdErr && $resolver->configFinderIsOverridden()) {
            $stdErr->writeln(
                \sprintf($stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s', 'Paths from configuration file have been overridden by paths provided as command arguments.')
            );
        }

        $progressType = $resolver->getProgressType();
        $progressOutput = $this->progressOutputFactory->create(
            $progressType,
            new OutputContext(
                $stdErr,
                (new Terminal())->getWidth(),
                \count($finder)
            )
        );

        $runner = new Runner(
            $finder,
            $resolver->getFixers(),
            $resolver->getDiffer(),
            ProgressOutputType::NONE !== $progressType ? $this->eventDispatcher : null,
            $this->errorsManager,
            $resolver->getLinter(),
            $resolver->isDryRun(),
            $resolver->getCacheManager(),
            $resolver->getDirectory(),
            $resolver->shouldStopOnViolation(),
            $resolver->getParallelConfig(),
            $input,
            $resolver->getConfigFile()
        );

        $this->eventDispatcher->addListener(FileProcessed::NAME, [$progressOutput, 'onFixerFileProcessed']);
        $this->stopwatch->start('fixFiles');
        $changed = $runner->fix();
        $this->stopwatch->stop('fixFiles');
        $this->eventDispatcher->removeListener(FileProcessed::NAME, [$progressOutput, 'onFixerFileProcessed']);

        $progressOutput->printLegend();

        $fixEvent = $this->stopwatch->getEvent('fixFiles');

        $reportSummary = new ReportSummary(
            $changed,
            \count($finder),
            (int) $fixEvent->getDuration(), // ignore microseconds fraction
            $fixEvent->getMemory(),
            OutputInterface::VERBOSITY_VERBOSE <= $verbosity,
            $resolver->isDryRun(),
            $output->isDecorated()
        );

        $output->isDecorated()
            ? $output->write($reporter->generate($reportSummary))
            : $output->write($reporter->generate($reportSummary), false, OutputInterface::OUTPUT_RAW);

        $invalidErrors = $this->errorsManager->getInvalidErrors();
        $exceptionErrors = $this->errorsManager->getExceptionErrors();
        $lintErrors = $this->errorsManager->getLintErrors();

        if (null !== $stdErr) {
            $errorOutput = new ErrorOutput($stdErr);

            if (\count($invalidErrors) > 0) {
                $errorOutput->listErrors('linting before fixing', $invalidErrors);
            }

            if (\count($exceptionErrors) > 0) {
                $errorOutput->listErrors('fixing', $exceptionErrors);
                \assert(isset($isParallel));
                if ($isParallel) {
                    $stdErr->writeln('To see details of the error(s), re-run the command with `--sequential -vvv [file]`');
                }
            }

            if (\count($lintErrors) > 0) {
                $errorOutput->listErrors('linting after fixing', $lintErrors);
            }
        }

        $exitStatusCalculator = new FixCommandExitStatusCalculator();

        return $exitStatusCalculator->calculate(
            $resolver->isDryRun(),
            \count($changed) > 0,
            \count($invalidErrors) > 0,
            \count($exceptionErrors) > 0,
            \count($lintErrors) > 0
        );
    }

    protected function isDryRun(InputInterface $input): bool
    {
        return $input->getOption('dry-run'); // @phpstan-ignore symfonyConsole.optionNotFound (Because PHPStan doesn't recognise the method is overridden in the child class and this parameter is _not_ used in the child class.)
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of PHP CS Fixer.
7	*
8	* (c) Fabien Potencier <fabien@symfony.com>
9	* Dariusz Rumiński <dariusz.ruminski@gmail.com>
10	*
11	* This source file is subject to the MIT license that is bundled
12	* with this source code in the file LICENSE.
13	*/
14
15	namespace PhpCsFixer\Console\Command;
16
17	use PhpCsFixer\Config;
18	use PhpCsFixer\ConfigInterface;
19	use PhpCsFixer\ConfigurationException\InvalidConfigurationException;
20	use PhpCsFixer\Console\Application;
21	use PhpCsFixer\Console\ConfigurationResolver;
22	use PhpCsFixer\Console\Output\ErrorOutput;
23	use PhpCsFixer\Console\Output\OutputContext;
24	use PhpCsFixer\Console\Output\Progress\ProgressOutputFactory;
25	use PhpCsFixer\Console\Output\Progress\ProgressOutputType;
26	use PhpCsFixer\Console\Report\FixReport\ReporterFactory;
27	use PhpCsFixer\Console\Report\FixReport\ReportSummary;
28	use PhpCsFixer\Error\ErrorsManager;
29	use PhpCsFixer\Fixer\FixerInterface;
30	use PhpCsFixer\FixerFactory;
31	use PhpCsFixer\RuleSet\RuleSets;
32	use PhpCsFixer\Runner\Event\FileProcessed;
33	use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
34	use PhpCsFixer\Runner\Runner;
35	use PhpCsFixer\ToolInfoInterface;
36	use Symfony\Component\Console\Attribute\AsCommand;
37	use Symfony\Component\Console\Command\Command;
38	use Symfony\Component\Console\Formatter\OutputFormatter;
39	use Symfony\Component\Console\Input\InputArgument;
40	use Symfony\Component\Console\Input\InputInterface;
41	use Symfony\Component\Console\Input\InputOption;
42	use Symfony\Component\Console\Output\ConsoleOutputInterface;
43	use Symfony\Component\Console\Output\OutputInterface;
44	use Symfony\Component\Console\Terminal;
45	use Symfony\Component\EventDispatcher\EventDispatcher;
46	use Symfony\Component\EventDispatcher\EventDispatcherInterface;
47	use Symfony\Component\Stopwatch\Stopwatch;
48
49	/**
50	* @author Fabien Potencier <fabien@symfony.com>
51	* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
52	*
53	* @final
54	*
55	* @internal
56	*
57	* @no-named-arguments Parameter names are not covered by the backward compatibility promise.
58	*/
59	#[AsCommand(name: 'fix', description: 'Fixes a directory or a file.')]
60	/* final */ class FixCommand extends Command
61	{
62	/** @TODO PHP 8.0 - remove the property */
63	protected static $defaultName = 'fix';
64
65	/** @TODO PHP 8.0 - remove the property */
66	protected static $defaultDescription = 'Fixes a directory or a file.';
67
68	private EventDispatcherInterface $eventDispatcher;
69
70	private ErrorsManager $errorsManager;
71
72	private Stopwatch $stopwatch;
73
74	private ConfigInterface $defaultConfig;
75
76	private ToolInfoInterface $toolInfo;
77
78	private ProgressOutputFactory $progressOutputFactory;
79
80	public function __construct(ToolInfoInterface $toolInfo)
81	{
82	parent::__construct();	5✔
83
84	$this->eventDispatcher = new EventDispatcher();	5✔
85	$this->errorsManager = new ErrorsManager();	5✔
86	$this->stopwatch = new Stopwatch();	5✔
87	$this->defaultConfig = new Config();	5✔
88	$this->toolInfo = $toolInfo;	5✔
89	$this->progressOutputFactory = new ProgressOutputFactory();	5✔
90	}
91
92	/**
93	* {@inheritdoc}
94	*
95	* Override here to only generate the help copy when used.
96	*/
97	public function getHelp(): string
98	{
99	return <<<'EOF'	×
100	The <info>%command.name%</info> command tries to %command.name% as much coding standards
101	problems as possible on a given file or files in a given directory and its subdirectories:
102
103	<info>$ php %command.full_name% /path/to/dir</info>
104	<info>$ php %command.full_name% /path/to/file</info>
105
106	By default <comment>--path-mode</comment> is set to `override`, which means, that if you specify the path to a file or a directory via
107	command arguments, then the paths provided to a `Finder` in config file will be ignored. You can use <comment>--path-mode=intersection</comment>
108	to merge paths from the config file and from the argument:
109
110	<info>$ php %command.full_name% --path-mode=intersection /path/to/dir</info>
111
112	The <comment>--format</comment> option for the output format. Supported formats are `@auto` (default one on v4+), `txt` (default one on v3), `json`, `xml`, `checkstyle`, `junit` and `gitlab`.
113
114	* `@auto` aims to auto-select best reporter for given CI or local execution (resolution into best format is outside of BC promise and is future-ready)
115	* `gitlab` for GitLab
116	* `@auto,{format}` takes `@auto` under CI, and {format} otherwise
117
118	NOTE: the output for the following formats are generated in accordance with schemas
119
120	* `checkstyle` follows the common `"checkstyle" XML schema </doc/schemas/fix/checkstyle.xsd>`_
121	* `gitlab` follows the `codeclimate JSON schema </doc/schemas/fix/codeclimate.json>`_
122	* `json` follows the `own JSON schema </doc/schemas/fix/schema.json>`_
123	* `junit` follows the `JUnit XML schema from Jenkins </doc/schemas/fix/junit-10.xsd>`_
124	* `xml` follows the `own XML schema </doc/schemas/fix/xml.xsd>`_
125
126	The <comment>--quiet</comment> Do not output any message.
127
128	The <comment>--verbose</comment> option will show the applied rules. When using the `txt` format it will also display progress notifications.
129
130	NOTE: if there is an error like "errors reported during linting after fixing", you can use this to be even more verbose for debugging purpose
131
132	* `-v`: verbose
133	* `-vv`: very verbose
134	* `-vvv`: debug
135
136	EOF. /* @TODO: 4.0 - change to @PER */ <<<'EOF'	×
137
138	The <comment>--rules</comment> option allows to explicitly select rules to use,
139	overriding the default PSR-12 or your own project config:
140
141	<info>$ php %command.full_name% . --rules=line_ending,full_opening_tag,indentation_type</info>
142
143	You can also exclude the rules you don't want by placing a dash in front of the rule name, like <comment>-name_of_fixer</comment>.
144
145	<info>$ php %command.full_name% . --rules=@Symfony,-@PSR1,-blank_line_before_statement,strict_comparison</info>
146
147	Complete configuration for rules can be supplied using a `json` formatted string as well.
148
149	<info>$ php %command.full_name% . --rules='{"concat_space": {"spacing": "none"}}'</info>
150
151	The <comment>--dry-run</comment> flag will run the fixer without making changes to your files.
152
153	The <comment>--sequential</comment> flag will enforce sequential analysis even if parallel config is provided.
154
155	The <comment>--diff</comment> flag can be used to let the fixer output all the changes it makes.
156
157	The <comment>--allow-risky</comment> option (pass `yes` or `no`) allows you to set whether risky rules may run. Default value is taken from config file.
158	A rule is considered risky if it could change code behaviour. By default no risky rules are run.
159
160	The <comment>--stop-on-violation</comment> flag stops the execution upon first file that needs to be fixed.
161
162	The <comment>--show-progress</comment> option allows you to choose the way process progress is rendered:
163
164	* <comment>none</comment>: disables progress output;
165	* <comment>dots</comment>: multiline progress output with number of files and percentage on each line.
166	* <comment>bar</comment>: single line progress output with number of files and calculated percentage.
167
168	If the option is not provided, it defaults to <comment>bar</comment> unless a config file that disables output is used, in which case it defaults to <comment>none</comment>. This option has no effect if the verbosity of the command is less than <comment>verbose</comment>.
169
170	<info>$ php %command.full_name% --verbose --show-progress=dots</info>
171
172	By using <comment>--using-cache</comment> option with `yes` or `no` you can set if the caching
173	mechanism should be used.
174
175	The command can also read from standard input, in which case it won't
176	automatically fix anything:
177
178	<info>$ cat foo.php \| php %command.full_name% --diff -</info>
179
180	Finally, if you don't need BC kept on CLI level, you might use `PHP_CS_FIXER_FUTURE_MODE` to start using options that
181	would be default in next MAJOR release and to forbid using deprecated configuration:
182
183	<info>$ PHP_CS_FIXER_FUTURE_MODE=1 php %command.full_name% -v --diff</info>
184
185	Exit code
186	---------
187
188	Exit code of the `%command.name%` command is built using following bit flags:
189
190	* 0 - OK.
191	* 1 - General error (or PHP minimal requirement not matched).
192	* 4 - Some files have invalid syntax (only in dry-run mode).
193	* 8 - Some files need fixing (only in dry-run mode).
194	* 16 - Configuration error of the application.
195	* 32 - Configuration error of a Fixer.
196	* 64 - Exception raised within the application.
197
198	EOF;	×
199	}
200
201	protected function configure(): void
202	{
203	$reporterFactory = new ReporterFactory();	5✔
204	$reporterFactory->registerBuiltInReporters();	5✔
205	$formats = $reporterFactory->getFormats();	5✔
206	array_unshift($formats, '@auto', '@auto,txt');	5✔
207
208	$progressOutputTypes = ProgressOutputType::all();	5✔
209
210	$this->setDefinition(	5✔
211	[	5✔
212	new InputArgument('path', InputArgument::IS_ARRAY, 'The path(s) that rules will be run against (each path can be a file or directory).'),	5✔
213	new InputOption('path-mode', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Specify path mode (%s).', ConfigurationResolver::PATH_MODE_VALUES), ConfigurationResolver::PATH_MODE_OVERRIDE, ConfigurationResolver::PATH_MODE_VALUES),	5✔
214	new InputOption('allow-risky', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Are risky fixers allowed (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),	5✔
215	new InputOption('config', '', InputOption::VALUE_REQUIRED, 'The path to a config file.'),	5✔
216	new InputOption('dry-run', '', InputOption::VALUE_NONE, 'Only shows which files would have been modified.'),	5✔
217	new InputOption('rules', '', InputOption::VALUE_REQUIRED, 'List of rules that should be run against configured paths.', null, static function () {	5✔
218	$fixerFactory = new FixerFactory();	×
219	$fixerFactory->registerBuiltInFixers();	×
220	$fixers = array_map(static fn (FixerInterface $fixer) => $fixer->getName(), $fixerFactory->getFixers());	×
221
222	return array_merge(RuleSets::getSetDefinitionNames(), $fixers);	×
223	}),	5✔
224	new InputOption('using-cache', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Should cache be used (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),	5✔
225	new InputOption('allow-unsupported-php-version', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Should the command refuse to run on unsupported PHP version (%s).', ConfigurationResolver::BOOL_VALUES), null, ConfigurationResolver::BOOL_VALUES),	5✔
226	new InputOption('cache-file', '', InputOption::VALUE_REQUIRED, 'The path to the cache file.'),	5✔
227	new InputOption('diff', '', InputOption::VALUE_NONE, 'Prints diff for each file.'),	5✔
228	new InputOption('format', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('To output results in other formats (%s).', $formats), null, $formats),	5✔
229	new InputOption('stop-on-violation', '', InputOption::VALUE_NONE, 'Stop execution on first violation.'),	5✔
230	new InputOption('show-progress', '', InputOption::VALUE_REQUIRED, HelpCommand::getDescriptionWithAllowedValues('Type of progress indicator (%s).', $progressOutputTypes), null, $progressOutputTypes),	5✔
231	new InputOption('sequential', '', InputOption::VALUE_NONE, 'Enforce sequential analysis.'),	5✔
232	]	5✔
233	);	5✔
234	}
235
236	protected function execute(InputInterface $input, OutputInterface $output): int
237	{
238	$verbosity = $output->getVerbosity();	5✔
239
240	$passedConfig = $input->getOption('config');	5✔
241	$passedRules = $input->getOption('rules');	5✔
242
243	if (null !== $passedConfig && null !== $passedRules) {	5✔
244	throw new InvalidConfigurationException('Passing both `--config` and `--rules` options is not allowed.');	×
245	}
246
247	$resolver = new ConfigurationResolver(	5✔
248	$this->defaultConfig,	5✔
249	[	5✔
250	'allow-risky' => $input->getOption('allow-risky'),	5✔
251	'config' => $passedConfig,	5✔
252	'dry-run' => $this->isDryRun($input),	5✔
253	'rules' => $passedRules,	5✔
254	'path' => $input->getArgument('path'),	5✔
255	'path-mode' => $input->getOption('path-mode'),	5✔
256	'using-cache' => $input->getOption('using-cache'),	5✔
257	'allow-unsupported-php-version' => $input->getOption('allow-unsupported-php-version'),	5✔
258	'cache-file' => $input->getOption('cache-file'),	5✔
259	'format' => $input->getOption('format'),	5✔
260	'diff' => $input->getOption('diff'),	5✔
261	'stop-on-violation' => $input->getOption('stop-on-violation'),	5✔
262	'verbosity' => $verbosity,	5✔
263	'show-progress' => $input->getOption('show-progress'),	5✔
264	'sequential' => $input->getOption('sequential'),	5✔
265	],	5✔
266	getcwd(), // @phpstan-ignore argument.type	5✔
267	$this->toolInfo	5✔
268	);	5✔
269
270	$reporter = $resolver->getReporter();	5✔
271
272	$stdErr = $output instanceof ConsoleOutputInterface	5✔
273	? $output->getErrorOutput()	×
274	: ('txt' === $reporter->getFormat() ? $output : null);	5✔
275
276	if (null !== $stdErr) {	5✔
277	$stdErr->writeln(Application::getAboutWithRuntime(true));	5✔
278
279	if (version_compare(\PHP_VERSION, ConfigInterface::PHP_VERSION_SYNTAX_SUPPORTED.'.99', '>')) {	5✔
280	$message = \sprintf(	×
281	'PHP CS Fixer currently supports PHP syntax only up to PHP %s, current PHP version: %s.',	×
282	ConfigInterface::PHP_VERSION_SYNTAX_SUPPORTED,	×
283	\PHP_VERSION	×
284	);	×
285
286	if (!$resolver->getUnsupportedPhpVersionAllowed()) {	×
287	$message .= ' Add Config::setUnsupportedPhpVersionAllowed(true) to allow executions on unsupported PHP versions. Such execution may be unstable and you may experience code modified in a wrong way.';	×
288	$stdErr->writeln(\sprintf(	×
289	$stdErr->isDecorated() ? '<bg=red;fg=white;>%s</>' : '%s',	×
290	$message	×
291	));	×
292
293	return 1;	×
294	}
295	$message .= ' Execution may be unstable. You may experience code modified in a wrong way. Please report such cases at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Remove Config::setUnsupportedPhpVersionAllowed(true) to allow executions only on supported PHP versions.';	×
296	$stdErr->writeln(\sprintf(	×
297	$stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s',	×
298	$message	×
299	));	×
300	}
301
302	$isParallel = $resolver->getParallelConfig()->getMaxProcesses() > 1;	5✔
303
304	$stdErr->writeln(\sprintf(	5✔
305	'Running analysis on %d core%s.',	5✔
306	$resolver->getParallelConfig()->getMaxProcesses(),	5✔
307	$isParallel ? \sprintf(	5✔
308	's with %d file%s per process',	5✔
309	$resolver->getParallelConfig()->getFilesPerProcess(),	5✔
310	$resolver->getParallelConfig()->getFilesPerProcess() > 1 ? 's' : ''	5✔
311	) : ' sequentially'	5✔
312	));	5✔
313
314	/** @TODO v4 remove warnings related to parallel runner */
315	$availableMaxProcesses = ParallelConfigFactory::detect()->getMaxProcesses();	5✔
316	if ($isParallel \|\| $availableMaxProcesses > 1) {	5✔
317	$usageDocs = 'https://cs.symfony.com/doc/usage.html';	5✔
318	$stdErr->writeln(\sprintf(	5✔
319	$stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s',	5✔
320	$isParallel	5✔
321	? 'Parallel runner is an experimental feature and may be unstable, use it at your own risk. Feedback highly appreciated!'	4✔
322	: \sprintf(	1✔
323	'You can enable parallel runner and speed up the analysis! Please see %s for more information.',	1✔
324	$stdErr->isDecorated()	1✔
325	? \sprintf('<href=%s;bg=yellow;fg=red;bold>usage docs</>', OutputFormatter::escape($usageDocs))	×
326	: $usageDocs	5✔
327	)	1✔
328	));	5✔
329	}
330
331	$configFile = $resolver->getConfigFile();	5✔
332	$stdErr->writeln(\sprintf('Loaded config <comment>%s</comment>%s.', $resolver->getConfig()->getName(), null === $configFile ? '' : ' from "'.$configFile.'"'));	5✔
333
334	if ($resolver->getUsingCache()) {	5✔
335	$cacheFile = $resolver->getCacheFile();	×
336
337	if (is_file($cacheFile)) {	×
338	$stdErr->writeln(\sprintf('Using cache file "%s".', $cacheFile));	×
339	}
340	}
341	}
342
343	$finder = new \ArrayIterator(array_filter(	4✔
344	iterator_to_array($resolver->getFinder()),	4✔
345	static fn (\SplFileInfo $fileInfo) => false !== $fileInfo->getRealPath(),	4✔
346	));	4✔
347
348	if (null !== $stdErr && $resolver->configFinderIsOverridden()) {	4✔
349	$stdErr->writeln(	3✔
350	\sprintf($stdErr->isDecorated() ? '<bg=yellow;fg=black;>%s</>' : '%s', 'Paths from configuration file have been overridden by paths provided as command arguments.')	3✔
351	);	3✔
352	}
353
354	$progressType = $resolver->getProgressType();	4✔
355	$progressOutput = $this->progressOutputFactory->create(	4✔
356	$progressType,	4✔
357	new OutputContext(	4✔
358	$stdErr,	4✔
359	(new Terminal())->getWidth(),	4✔
360	\count($finder)	4✔
361	)	4✔
362	);	4✔
363
364	$runner = new Runner(	4✔
365	$finder,	4✔
366	$resolver->getFixers(),	4✔
367	$resolver->getDiffer(),	4✔
368	ProgressOutputType::NONE !== $progressType ? $this->eventDispatcher : null,	4✔
369	$this->errorsManager,	4✔
370	$resolver->getLinter(),	4✔
371	$resolver->isDryRun(),	4✔
372	$resolver->getCacheManager(),	4✔
373	$resolver->getDirectory(),	4✔
374	$resolver->shouldStopOnViolation(),	4✔
375	$resolver->getParallelConfig(),	4✔
376	$input,	4✔
377	$resolver->getConfigFile()	4✔
378	);	4✔
379
380	$this->eventDispatcher->addListener(FileProcessed::NAME, [$progressOutput, 'onFixerFileProcessed']);	3✔
381	$this->stopwatch->start('fixFiles');	3✔
382	$changed = $runner->fix();	3✔
383	$this->stopwatch->stop('fixFiles');	3✔
384	$this->eventDispatcher->removeListener(FileProcessed::NAME, [$progressOutput, 'onFixerFileProcessed']);	3✔
385
386	$progressOutput->printLegend();	3✔
387
388	$fixEvent = $this->stopwatch->getEvent('fixFiles');	3✔
389
390	$reportSummary = new ReportSummary(	3✔
391	$changed,	3✔
392	\count($finder),	3✔
393	(int) $fixEvent->getDuration(), // ignore microseconds fraction	3✔
394	$fixEvent->getMemory(),	3✔
395	OutputInterface::VERBOSITY_VERBOSE <= $verbosity,	3✔
396	$resolver->isDryRun(),	3✔
397	$output->isDecorated()	3✔
398	);	3✔
399
400	$output->isDecorated()	3✔
401	? $output->write($reporter->generate($reportSummary))	×
402	: $output->write($reporter->generate($reportSummary), false, OutputInterface::OUTPUT_RAW);	3✔
403
404	$invalidErrors = $this->errorsManager->getInvalidErrors();	3✔
405	$exceptionErrors = $this->errorsManager->getExceptionErrors();	3✔
406	$lintErrors = $this->errorsManager->getLintErrors();	3✔
407
408	if (null !== $stdErr) {	3✔
409	$errorOutput = new ErrorOutput($stdErr);	3✔
410
411	if (\count($invalidErrors) > 0) {	3✔
412	$errorOutput->listErrors('linting before fixing', $invalidErrors);	×
413	}
414
415	if (\count($exceptionErrors) > 0) {	3✔
416	$errorOutput->listErrors('fixing', $exceptionErrors);	×
417	\assert(isset($isParallel));	×
418	if ($isParallel) {	×
419	$stdErr->writeln('To see details of the error(s), re-run the command with `--sequential -vvv [file]`');	×
420	}
421	}
422
423	if (\count($lintErrors) > 0) {	3✔
424	$errorOutput->listErrors('linting after fixing', $lintErrors);	×
425	}
426	}
427
428	$exitStatusCalculator = new FixCommandExitStatusCalculator();	3✔
429
430	return $exitStatusCalculator->calculate(	3✔
431	$resolver->isDryRun(),	3✔
432	\count($changed) > 0,	3✔
433	\count($invalidErrors) > 0,	3✔
434	\count($exceptionErrors) > 0,	3✔
435	\count($lintErrors) > 0	3✔
436	);	3✔
437	}
438
439	protected function isDryRun(InputInterface $input): bool
440	{
441	return $input->getOption('dry-run'); // @phpstan-ignore symfonyConsole.optionNotFound (Because PHPStan doesn't recognise the method is overridden in the child class and this parameter is _not_ used in the child class.)	5✔
442	}
443	}

keradus / PHP-CS-Fixer / 18309234144

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous