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