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