_test/rector.php

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