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