[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  declare(strict_types=1);
   4  
   5  use dokuwiki\test\rector\DokuWikiPtlnRector;
   6  use dokuwiki\test\rector\DokuWikiRenamePrintToEcho;
   7  use Rector\Caching\ValueObject\Storage\FileCacheStorage;
   8  use Rector\CodeQuality\Rector\Array_\CallableThisArrayToAnonymousFunctionRector;
   9  use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
  10  use Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector;
  11  use Rector\CodeQuality\Rector\If_\CombineIfRector;
  12  use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
  13  use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
  14  use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
  15  use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
  16  use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
  17  use Rector\CodingStyle\Rector\Class_\AddArrayDefaultToArrayPropertyRector;
  18  use Rector\CodingStyle\Rector\Closure\StaticClosureRector;
  19  use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
  20  use Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector;
  21  use Rector\CodingStyle\Rector\FuncCall\StrictArraySearchRector;
  22  use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
  23  use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
  24  use Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector;
  25  use Rector\Config\RectorConfig;
  26  use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector;
  27  use Rector\DeadCode\Rector\If_\RemoveAlwaysTrueIfConditionRector;
  28  use Rector\DeadCode\Rector\If_\RemoveUnusedNonEmptyArrayBeforeForeachRector;
  29  use Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector;
  30  use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
  31  use Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector;
  32  use Rector\Php71\Rector\FuncCall\CountOnNullRector;
  33  use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
  34  use Rector\Php80\Rector\Identical\StrEndsWithRector;
  35  use Rector\Php80\Rector\Identical\StrStartsWithRector;
  36  use Rector\Php80\Rector\NotIdentical\StrContainsRector;
  37  use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
  38  use Rector\Renaming\Rector\Name\RenameClassRector;
  39  use Rector\Set\ValueObject\LevelSetList;
  40  use Rector\Set\ValueObject\SetList;
  41  use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
  42  use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
  43  
  44  return static function (RectorConfig $rectorConfig): void {
  45      // FIXME we may want to autoload these later
  46      require_once  __DIR__ . '/rector/DokuWikiPtlnRector.php';
  47      require_once  __DIR__ . '/rector/DokuWikiRenamePrintToEcho.php';
  48  
  49      $rectorConfig->paths([
  50          __DIR__ . '/../inc/',
  51          __DIR__ . '/../lib/',
  52          __DIR__ . '/../bin/',
  53          __DIR__ . '/../*.php',
  54      ]);
  55  
  56      $rectorConfig->bootstrapFiles([
  57          __DIR__ . '/../inc/init.php',
  58      ]);
  59  
  60      $rectorConfig->importNames();
  61      $rectorConfig->importShortClasses(false);
  62      $rectorConfig->cacheClass(FileCacheStorage::class);
  63      $rectorConfig->cacheDirectory(__DIR__ . '/.rector-cache');
  64  
  65      // supported minimum PHP version can be overridden by environment variable
  66      [$major, $minor] = explode('.', $_SERVER['RECTOR_MIN_PHP'] ?? '' ?: '7.4');
  67      $phpset = LevelSetList::class . '::UP_TO_PHP_' . $major . $minor;
  68      echo "Using PHP set $phpset\n";
  69  
  70      // define sets of rules
  71      $rectorConfig->sets([
  72          constant($phpset),
  73          SetList::CODE_QUALITY,
  74          SetList::DEAD_CODE,
  75          SetList::CODING_STYLE,
  76      ]);
  77  
  78      // future rules for which we have polyfills
  79      $rectorConfig->rule(StrContainsRector::class);
  80      $rectorConfig->rule(StrEndsWithRector::class);
  81      $rectorConfig->rule(StrStartsWithRector::class);
  82  
  83      $rectorConfig->skip([
  84          // skip paths
  85          __DIR__ . '/../inc/lang/*',
  86          __DIR__ . '/../lib/plugins/*/_test/*',
  87          __DIR__ . '/../lib/tpl/*/_test/*',
  88          __DIR__ . '/../lib/plugins/*/lang/*',
  89          __DIR__ . '/../lib/tpl/*/lang/*',
  90          __DIR__ . '/../lib/plugins/*/conf/*', // maybe later
  91          __DIR__ . '/../lib/tpl/*/conf/*',  // maybe later
  92          __DIR__ . '/../lib/plugins/*/vendor/*',
  93          __DIR__ . '/../lib/tpl/*/vendor/*',
  94          __DIR__ . '/../lib/plugins/*/skel/*', // dev plugin
  95          __DIR__ . '/../inc/deprecated.php',
  96          __DIR__ . '/../inc/form.php',
  97  
  98          // third party libs, not yet moved to composer
  99          __DIR__ . '/../inc/DifferenceEngine.php',
 100          __DIR__ . '/../inc/JpegMeta.php',
 101          __DIR__ . '/../lib/plugins/authad/adLDAP',
 102  
 103          // skip rules
 104          SimplifyIfElseToTernaryRector::class,
 105          NewlineAfterStatementRector::class,
 106          CombineIfRector::class,
 107          ExplicitBoolCompareRector::class,
 108          IssetOnPropertyObjectToPropertyExistsRector::class, // maybe?
 109          SymplifyQuoteEscapeRector::class,
 110          CatchExceptionNameMatchingTypeRector::class,
 111          EncapsedStringsToSprintfRector::class,
 112          CallableThisArrayToAnonymousFunctionRector::class,
 113          StaticClosureRector::class,
 114          SimplifyUselessVariableRector::class, // seems to strip constructor property initializations
 115          PostIncDecToPreIncDecRector::class,
 116          RemoveUselessParamTagRector::class,
 117          DisallowedEmptyRuleFixerRector::class,
 118          CountOnNullRector::class, // adds unwanted is_countable checks?
 119          RemoveParentCallWithoutParentRector::class,
 120          WrapEncapsedVariableInCurlyBracesRector::class,
 121          SimplifyIfReturnBoolRector::class,
 122          StrictArraySearchRector::class, // we cannot assume strict search is always wanted
 123          AddArrayDefaultToArrayPropertyRector::class, // may break code differentiating between null and empty array
 124          RemoveUselessVarTagRector::class,
 125          TypedPropertyFromAssignsRector::class, // maybe?
 126          JoinStringConcatRector::class, // this does not count variables, so it creates overlong lines
 127          RemoveExtraParametersRector::class, // this actually broke code
 128          RemoveUnusedNonEmptyArrayBeforeForeachRector::class, // seems unreliable when checking on array keys
 129          RemoveAlwaysTrueIfConditionRector::class, // fails with if(defined(...)) constructs
 130          RemoveUnreachableStatementRector::class, // fails GOTO in authpdo -> should be rewritten with exceptions
 131      ]);
 132  
 133      $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
 134          // see inc/deprecated.php
 135          'RemoteAccessDeniedException' => 'dokuwiki\Remote\AccessDeniedException',
 136          'RemoteException' => 'dokuwiki\Remote\RemoteException',
 137          'setting' => 'dokuwiki\plugin\config\core\Setting\Setting',
 138          'setting_authtype' => 'dokuwiki\plugin\config\core\Setting\SettingAuthtype',
 139          'setting_string' => 'dokuwiki\plugin\config\core\Setting\SettingString',
 140          'PageChangelog' => 'dokuwiki\ChangeLog\PageChangeLog',
 141          'MediaChangelog' => 'dokuwiki\ChangeLog\MediaChangeLog',
 142          'Input' => 'dokuwiki\Input\Input',
 143          'PostInput' => 'dokuwiki\Input\Post',
 144          'GetInput' => 'dokuwiki\Input\Get',
 145          'ServerInput' => 'dokuwiki\Input\Server',
 146          'PassHash' => 'dokuwiki\PassHash',
 147          'HTTPClientException' => 'dokuwiki\HTTP\HTTPClientException',
 148          'HTTPClient' => 'dokuwiki\HTTP\HTTPClient',
 149          'DokuHTTPClient' => 'dokuwiki\HTTP\DokuHTTPClient',
 150          'Doku_Plugin_Controller' => 'dokuwiki\Extension\PluginController',
 151          'Doku_Indexer' => 'dokuwiki\Search\Indexer',
 152          'IXR_Client' => 'dokuwiki\Remote\IXR\Client',
 153          'IXR_ClientMulticall' => 'IXR\Client\ClientMulticall',
 154          'IXR_Server' => 'IXR\Server\Server',
 155          'IXR_IntrospectionServer' => 'IXR\Server\IntrospectionServer',
 156          'IXR_Request' => 'IXR\Request\Request',
 157          'IXR_Message' => 'R\Message\Message',
 158          'IXR_Error' => 'XR\Message\Error',
 159          'IXR_Date' => 'IXR\DataType\Date',
 160          'IXR_Base64' => 'IXR\DataType\Base64',
 161          'IXR_Value' => 'IXR\DataType\Value',
 162  
 163          // see inc/legacy.php
 164          'Doku_Event_Handler' => 'dokuwiki\Extension\EventHandler',
 165          'Doku_Event' => 'dokuwiki\Extension\Event',
 166          'DokuWiki_Action_Plugin' => 'dokuwiki\Extension\ActionPlugin',
 167          'DokuWiki_Admin_Plugin' => 'dokuwiki\Extension\AdminPlugin',
 168          'DokuWiki_Auth_Plugin' => 'dokuwiki\Extension\AuthPlugin',
 169          'DokuWiki_CLI_Plugin' => 'dokuwiki\Extension\CLIPlugin',
 170          'DokuWiki_Plugin' => 'dokuwiki\Extension\Plugin',
 171          'DokuWiki_Remote_Plugin' => 'dokuwiki\Extension\RemotePlugin',
 172          'DokuWiki_Syntax_Plugin' => 'dokuwiki\Extension\SyntaxPlugin',
 173      ]);
 174  
 175      $rectorConfig->ruleWithConfiguration(RenameFunctionRector::class, [
 176          // see inc/deprecated.php
 177          'Doku_Lexer_Escape' => 'dokuwiki\Parsing\Lexer\Lexer::escape',
 178  
 179          // see inc/utf8.php
 180          'utf8_isASCII' => 'dokuwiki\Utf8\Clean::isASCII',
 181          'utf8_strip' => 'dokuwiki\Utf8\Clean::strip',
 182          'utf8_check' => 'dokuwiki\Utf8\Clean::isUtf8',
 183          'utf8_basename' => 'dokuwiki\Utf8\PhpString::basename',
 184          'utf8_strlen' => 'dokuwiki\Utf8\PhpString::strlen',
 185          'utf8_substr' => 'dokuwiki\Utf8\PhpString::substr',
 186          'utf8_substr_replace' => 'dokuwiki\Utf8\PhpString::substr_replace',
 187          'utf8_ltrim' => 'dokuwiki\Utf8\PhpString::ltrim',
 188          'utf8_rtrim' => 'dokuwiki\Utf8\PhpString::rtrim',
 189          'utf8_trim' => 'dokuwiki\Utf8\PhpString::trim',
 190          'utf8_strtolower' => 'dokuwiki\Utf8\PhpString::strtolower',
 191          'utf8_strtoupper' => 'dokuwiki\Utf8\PhpString::strtoupper',
 192          'utf8_ucfirst' => 'dokuwiki\Utf8\PhpString::ucfirst',
 193          'utf8_ucwords' => 'dokuwiki\Utf8\PhpString::ucwords',
 194          'utf8_deaccent' => 'dokuwiki\Utf8\Clean::deaccent',
 195          'utf8_romanize' => 'dokuwiki\Utf8\Clean::romanize',
 196          'utf8_stripspecials' => 'dokuwiki\Utf8\Clean::stripspecials',
 197          'utf8_strpos' => 'dokuwiki\Utf8\PhpString::strpos',
 198          'utf8_tohtml' => 'dokuwiki\Utf8\Conversion::toHtml',
 199          'utf8_unhtml' => 'dokuwiki\Utf8\Conversion::fromHtml',
 200          'utf8_to_unicode' => 'dokuwiki\Utf8\Conversion::fromUtf8',
 201          'unicode_to_utf8' => 'dokuwiki\Utf8\Conversion::toUtf8',
 202          'utf8_to_utf16be' => 'dokuwiki\Utf8\Conversion::toUtf16be',
 203          'utf16be_to_utf8' => 'dokuwiki\Utf8\Conversion::fromUtf16be',
 204          'utf8_bad_replace' => 'dokuwiki\Utf8\Clean::replaceBadBytes',
 205          'utf8_correctIdx' => 'dokuwiki\Utf8\Clean::correctIdx',
 206      ]);
 207  
 208      $rectorConfig->rule(DokuWikiPtlnRector::class);
 209      $rectorConfig->rule(DokuWikiRenamePrintToEcho::class);
 210  };