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