rector/rules/Composer/Rector/RemovePackageComposerRector.php
Tomas Votruba f3d9b9c31c Updated Rector to commit 5493b6dc13
5493b6dc13 [DX] Re-use configure() in docs + remove prefixing of ValueObjectInliner (#1410)
2021-12-06 21:12:03 +00:00

56 lines
1.9 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Composer\Rector;
use Rector\Composer\Contract\Rector\ComposerRectorInterface;
use RectorPrefix20211206\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix20211206\Webmozart\Assert\Assert;
/**
* @see \Rector\Tests\Composer\Rector\RemovePackageComposerRector\RemovePackageComposerRectorTest
*/
final class RemovePackageComposerRector implements \Rector\Composer\Contract\Rector\ComposerRectorInterface
{
/**
* @var string
*/
public const PACKAGE_NAMES = 'package_names';
/**
* @var string[]
*/
private $packageNames = [];
public function refactor(\RectorPrefix20211206\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson $composerJson) : void
{
foreach ($this->packageNames as $packageName) {
$composerJson->removePackage($packageName);
}
}
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Remove package from "require" and "require-dev" in `composer.json`', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
{
"require": {
"symfony/console": "^3.4"
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
{
}
CODE_SAMPLE
, ['symfony/console'])]);
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
{
$packagesNames = $configuration[self::PACKAGE_NAMES] ?? $configuration;
\RectorPrefix20211206\Webmozart\Assert\Assert::isArray($packagesNames);
\RectorPrefix20211206\Webmozart\Assert\Assert::allString($packagesNames);
$this->packageNames = $packagesNames;
}
}