2021-01-16 13:23:37 +01:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
2021-01-16 13:23:37 +01:00
namespace Rector\Composer\Rector ;
2021-03-03 22:28:27 +01:00
use Rector\Composer\Contract\Rector\ComposerRectorInterface ;
2021-08-16 07:19:49 +00:00
use RectorPrefix20210816\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson ;
2021-01-16 13:23:37 +01:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
/**
2021-03-12 23:20:25 +01:00
* @ see \Rector\Tests\Composer\Rector\RemovePackageComposerRector\RemovePackageComposerRectorTest
2021-01-16 13:23:37 +01:00
*/
2021-05-10 22:23:08 +00:00
final class RemovePackageComposerRector implements \Rector\Composer\Contract\Rector\ComposerRectorInterface
2021-01-16 13:23:37 +01:00
{
/**
* @ var string
*/
public const PACKAGE_NAMES = 'package_names' ;
/**
* @ var string []
*/
private $packageNames = [];
2021-08-16 07:19:49 +00:00
public function refactor ( \RectorPrefix20210816\Symplify\ComposerJsonManipulator\ValueObject\ComposerJson $composerJson ) : void
2021-01-16 13:23:37 +01:00
{
foreach ( $this -> packageNames as $packageName ) {
$composerJson -> removePackage ( $packageName );
}
}
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2021-01-16 13:23:37 +01:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Remove package from "require" and "require-dev" in `composer.json`' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ( <<< 'CODE_SAMPLE'
2021-01-16 13:23:37 +01:00
{
" require " : {
" symfony/console " : " ^3.4 "
}
}
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2021-01-16 13:23:37 +01:00
{
}
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, [ self :: PACKAGE_NAMES => [ 'symfony/console' ]])]);
2021-01-16 13:23:37 +01:00
}
/**
* @ param array < string , string [] > $configuration
*/
2021-05-09 20:15:43 +00:00
public function configure ( array $configuration ) : void
2021-01-16 13:23:37 +01:00
{
$this -> packageNames = $configuration [ self :: PACKAGE_NAMES ] ? ? [];
}
}