*/ private const ESCALATE_WARNINGS_SNIFF = [AssignmentInConditionSniff::class, PropertyDeclarationSniff::class, MethodDeclarationSniff::class, CommentedOutCodeSniff::class, UnusedFunctionParameterSniff::class, TodoSniff::class]; /** * @readonly * @var \PHP_CodeSniffer\Fixer */ private $fixer; /** * @readonly * @var \Symplify\EasyCodingStandard\SniffRunner\File\FileFactory */ private $fileFactory; /** * @readonly * @var \PhpCsFixer\Differ\DifferInterface */ private $differ; /** * @readonly * @var \Symplify\EasyCodingStandard\SniffRunner\DataCollector\SniffMetadataCollector */ private $sniffMetadataCollector; /** * @readonly * @var \Symplify\EasyCodingStandard\Error\FileDiffFactory */ private $fileDiffFactory; /** * @var Sniff[] */ private $sniffs = []; /** * @var array */ private $tokenListeners = []; /** * @param Sniff[] $sniffs */ public function __construct(Fixer $fixer, FileFactory $fileFactory, DifferInterface $differ, SniffMetadataCollector $sniffMetadataCollector, FileDiffFactory $fileDiffFactory, array $sniffs) { $this->fixer = $fixer; $this->fileFactory = $fileFactory; $this->differ = $differ; $this->sniffMetadataCollector = $sniffMetadataCollector; $this->fileDiffFactory = $fileDiffFactory; foreach ($sniffs as $sniff) { $this->addSniff($sniff); } } /** * @return Sniff[] */ public function getCheckers() : array { return $this->sniffs; } /** * @return array{file_diffs?: FileDiff[], coding_standard_errors?: CodingStandardError[]} */ public function processFile(string $filePath, Configuration $configuration) : array { $this->sniffMetadataCollector->reset(); $errorsAndDiffs = []; $file = $this->fileFactory->createFromFile($filePath); $this->fixFile($file, $this->fixer, $filePath, $this->tokenListeners, self::ESCALATE_WARNINGS_SNIFF); // add coding standard errors $codingStandardErrors = $this->sniffMetadataCollector->getCodingStandardErrors(); if ($codingStandardErrors !== []) { $errorsAndDiffs[Bridge::CODING_STANDARD_ERRORS] = $codingStandardErrors; } $fileContents = FileSystem::read($filePath); // add diff if ($fileContents !== $this->fixer->getContents()) { $diff = $this->differ->diff($fileContents, $this->fixer->getContents()); $appliedCheckers = $this->sniffMetadataCollector->getAppliedSniffs(); $fileDiff = $this->fileDiffFactory->createFromDiffAndAppliedCheckers($filePath, $diff, $appliedCheckers); $errorsAndDiffs[Bridge::FILE_DIFFS][] = $fileDiff; } if ($configuration->isFixer()) { FileSystem::write($file->getFilename(), $this->fixer->getContents(), null); } return $errorsAndDiffs; } /** * For tests or printing contenet */ public function processFileToString(string $filePath) : string { $file = $this->fileFactory->createFromFile($filePath); $this->fixFile($file, $this->fixer, $filePath, $this->tokenListeners, []); return $this->fixer->getContents(); } private function addSniff(Sniff $sniff) : void { $this->sniffs[] = $sniff; $tokens = $sniff->register(); foreach ($tokens as $token) { $this->tokenListeners[$token][] = $sniff; } } /** * Mimics @see \PHP_CodeSniffer\Files\File::process() * * @see \PHP_CodeSniffer\Fixer::fixFile() * * @param array $tokenListeners * @param array> $reportSniffClassesWarnings */ private function fixFile(File $file, Fixer $fixer, string $filePath, array $tokenListeners, array $reportSniffClassesWarnings) : void { $previousContent = FileSystem::read($filePath); $this->fixer->loops = 0; do { // Only needed once file content has changed. $content = $previousContent; // set property value PrivatesAccessorHelper::setPropertyValue($fixer, 'inConflict', \false); $file->setContent($content); $file->processWithTokenListenersAndFilePath($tokenListeners, $filePath, $reportSniffClassesWarnings); // fixed content $previousContent = $fixer->getContents(); ++$this->fixer->loops; if ($previousContent !== $content && $this->fixer->loops >= self::MAX_FIXER_LOOPS) { $diff = $this->differ->diff($previousContent, $content); $appliedCheckers = $this->sniffMetadataCollector->getAppliedSniffs(); throw new RuntimeException(\sprintf("Contents of file \"%s\" did not stabilize after %d fix iterations.\nLast diff was:\n%s\n" . "There are probably checkers that cancel changes of each other. Try to reconfigure the checkers.\n" . "Applied checkers:\n" . "- %s\n", $filePath, $this->fixer->loops, $diff, \implode("\n- ", \array_unique($appliedCheckers)))); } } while ($previousContent !== $content); } }