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